/mandos/release : revision 237.7.333

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

36

37

from future_builtins import *

38

39

import SocketServer as socketserver

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

40

43

import socket

41

44

import argparse

42

45

import datetime

47

50

import gnutls.library.functions

48

51

import gnutls.library.constants

49

52

import gnutls.library.types

50

import ConfigParser as configparser

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

51

57

import sys

52

58

import re

53

59

import os

62

68

import struct

63

69

import fcntl

64

70

import functools

65

import cPickle as pickle

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

66

75

import multiprocessing

67

76

import types

68

77

import binascii

69

78

import tempfile

70

79

import itertools

80

import collections

81

import codecs

71

82

72

83

import dbus

73

84

import dbus.service

74

import gobject

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

75

89

import avahi

76

90

from dbus.mainloop.glib import DBusGMainLoop

77

91

import ctypes

78

92

import ctypes.util

79

93

import xml.dom.minidom

80

94

import inspect

81

import GnuPGInterface

82

95

83

96

try:

84

97

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

88

101

except ImportError:

89

102

SO_BINDTODEVICE = None

90

103

91

version = "1.5.3"

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

92

108

stored_state_file = "clients.pickle"

93

109

94

110

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

111

syslogger = None

98

112

99

113

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

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

103

116

except (OSError, AttributeError):

117

104

118

def if_nametoindex(interface):

105

119

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

106

120

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

107

121

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

108

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

123

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

124

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

113

125

return interface_index

114

126

115

127

116

128

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

117

129

"""init logger and add loglevel"""

118

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

119

135

syslogger.setFormatter(logging.Formatter

120

136

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

121

137

' %(message)s'))

138

154

139

155

class PGPEngine(object):

140

156

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

157

141

158

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

159

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

self.gnupg.options.extra_args.extend(['--force-mdc',

148

'--quiet',

149

'--no-use-agent'])

160

self.gnupgargs = ['--batch',

161

'--home', self.tempdir,

162

'--force-mdc',

163

'--quiet',

164

'--no-use-agent']

150

165

151

166

def __enter__(self):

152

167

return self

153

168

154

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

169

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

155

170

self._cleanup()

156

171

return False

157

172

174

189

def password_encode(self, password):

175

190

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

176

191

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

177

return b"mandos" + binascii.hexlify(password)

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

178

199

179

200

def encrypt(self, data, password):

180

self.gnupg.passphrase = self.password_encode(password)

181

with open(os.devnull, "w") as devnull:

182

try:

183

proc = self.gnupg.run(['--symmetric'],

184

create_fhs=['stdin', 'stdout'],

185

attach_fhs={'stderr': devnull})

186

with contextlib.closing(proc.handles['stdin']) as f:

187

f.write(data)

188

with contextlib.closing(proc.handles['stdout']) as f:

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

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)

194

216

return ciphertext

195

217

196

218

def decrypt(self, data, password):

197

self.gnupg.passphrase = self.password_encode(password)

198

with open(os.devnull, "w") as devnull:

199

try:

200

proc = self.gnupg.run(['--decrypt'],

201

create_fhs=['stdin', 'stdout'],

202

attach_fhs={'stderr': devnull})

203

with contextlib.closing(proc.handles['stdin']) as f:

204

f.write(data)

205

with contextlib.closing(proc.handles['stdout']) as f:

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

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)

211

234

return decrypted_plaintext

212

235

213

236

214

237

class AvahiError(Exception):

215

238

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

216

239

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

240

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

241

**kwargs)

242

220

243

221

244

class AvahiServiceError(AvahiError):

222

245

pass

223

246

247

224

248

class AvahiGroupError(AvahiError):

225

249

pass

226

250

233

257

Used to optionally bind to the specified interface.

234

258

name: string; Example: 'Mandos'

235

259

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

236

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

260

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

237

261

port: integer; what port to announce

238

262

TXT: list of strings; TXT record for the service

239

263

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

246

270

bus: dbus.SystemBus()

247

271

"""

248

272

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

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

253

284

self.interface = interface

254

285

self.name = name

255

286

self.type = servicetype

265

296

self.bus = bus

266

297

self.entry_group_state_changed_match = None

267

298

268

def rename(self):

299

def rename(self, remove=True):

269

300

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

270

301

if self.rename_count >= self.max_renames:

271

302

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

272

303

" after %i retries, exiting.",

273

304

self.rename_count)

274

305

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

277

309

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

278

310

self.name)

279

self.remove()

311

if remove:

312

self.remove()

280

313

try:

281

314

self.add()

282

315

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

316

if (error.get_dbus_name()

317

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

318

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

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

287

324

288

325

def remove(self):

289

326

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

327

364

self.rename()

328

365

elif state == avahi.ENTRY_GROUP_FAILURE:

329

366

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

330

unicode(error))

331

raise AvahiGroupError("State changed: {0!s}"

332

.format(error))

367

str(error))

368

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

333

369

334

370

def cleanup(self):

335

371

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

345

381

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

346

382

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

347

383

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

384

bad_states = {

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

avahi.SERVER_REGISTERING: None,

387

avahi.SERVER_COLLISION: "Zeroconf server name collision",

388

avahi.SERVER_FAILURE: "Zeroconf server failure",

389

}

355

390

if state in bad_states:

356

391

if bad_states[state] is not None:

357

392

if error is None:

360

395

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

361

396

self.cleanup()

362

397

elif state == avahi.SERVER_RUNNING:

363

self.add()

398

try:

399

self.add()

400

except dbus.exceptions.DBusException as error:

401

if (error.get_dbus_name()

402

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

403

logger.info("Local Zeroconf service name"

404

" collision.")

405

return self.rename(remove=False)

406

else:

407

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

408

self.cleanup()

409

os._exit(1)

364

410

else:

365

411

if error is None:

366

412

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

376

422

follow_name_owner_changes=True),

377

423

avahi.DBUS_INTERFACE_SERVER)

378

424

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

425

self.server_state_changed)

380

426

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

381

427

382

428

383

429

class AvahiServiceToSyslog(AvahiService):

384

def rename(self):

430

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

385

431

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

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

('Mandos ({0}) [%(process)d]:'

389

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

390

.format(self.name)))

432

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

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

391

436

return ret

392

437

393

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

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

400

447

401

448

class Client(object):

402

449

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

429

476

last_checker_status: integer between 0 and 255 reflecting exit

430

477

status of last checker. -1 reflects crashed

431

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

432

481

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

433

482

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

434

483

D-Bus identifiers

439

488

runtime_expansions: Allowed attributes for runtime expansion.

440

489

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

441

490

disabled, or None

491

server_settings: The server_settings dict from main()

442

492

"""

443

493

444

494

runtime_expansions = ("approval_delay", "approval_duration",

445

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

446

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

495

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

496

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

497

"last_approval_request", "last_checked_ok",

447

498

"last_enabled", "name", "timeout")

448

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

449

"extended_timeout": "15m",

450

"interval": "2m",

451

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

452

"host": "",

453

"approval_delay": "0s",

454

"approval_duration": "1s",

455

"approved_by_default": "True",

456

"enabled": "True",

457

}

458

459

def timeout_milliseconds(self):

460

"Return the 'timeout' attribute in milliseconds"

461

return timedelta_to_milliseconds(self.timeout)

462

463

def extended_timeout_milliseconds(self):

464

"Return the 'extended_timeout' attribute in milliseconds"

465

return timedelta_to_milliseconds(self.extended_timeout)

466

467

def interval_milliseconds(self):

468

"Return the 'interval' attribute in milliseconds"

469

return timedelta_to_milliseconds(self.interval)

470

471

def approval_delay_milliseconds(self):

472

return timedelta_to_milliseconds(self.approval_delay)

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

}

473

510

474

511

@staticmethod

475

512

def config_parser(config):

491

528

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

492

529

"enabled")

493

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

494

534

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

495

535

.replace(" ", ""))

496

536

if "secret" in section:

501

541

"rb") as secfile:

502

542

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

503

543

else:

504

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

544

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

505

545

.format(section))

506

546

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

507

547

client["extended_timeout"] = string_to_delta(

518

558

519

559

return settings

520

560

521

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

561

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

522

562

self.name = name

563

if server_settings is None:

564

server_settings = {}

565

self.server_settings = server_settings

523

566

# adding all client settings

524

for setting, value in settings.iteritems():

567

for setting, value in settings.items():

525

568

setattr(self, setting, value)

526

569

527

570

if self.enabled:

535

578

self.expires = None

536

579

537

580

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

538

# Uppercase and remove spaces from fingerprint for later

539

# comparison purposes with return value from the fingerprint()

540

# function

541

581

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

542

582

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

543

583

datetime.datetime.utcnow())

550

590

self.current_checker_command = None

551

591

self.approved = None

552

592

self.approvals_pending = 0

553

self.changedstate = (multiprocessing_manager

554

.Condition(multiprocessing_manager

555

.Lock()))

556

self.client_structure = [attr for attr in

557

self.__dict__.iterkeys()

593

self.changedstate = multiprocessing_manager.Condition(

594

multiprocessing_manager.Lock())

595

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

558

597

if not attr.startswith("_")]

559

598

self.client_structure.append("client_structure")

560

599

561

for name, t in inspect.getmembers(type(self),

562

lambda obj:

563

isinstance(obj,

564

property)):

600

for name, t in inspect.getmembers(

601

type(self), lambda obj: isinstance(obj, property)):

565

602

if not name.startswith("_"):

566

603

self.client_structure.append(name)

567

604

609

646

# and every interval from then on.

610

647

if self.checker_initiator_tag is not None:

611

648

gobject.source_remove(self.checker_initiator_tag)

612

self.checker_initiator_tag = (gobject.timeout_add

613

(self.interval_milliseconds(),

614

self.start_checker))

649

self.checker_initiator_tag = gobject.timeout_add(

650

int(self.interval.total_seconds() * 1000),

651

self.start_checker)

615

652

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

616

653

if self.disable_initiator_tag is not None:

617

654

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(self.timeout_milliseconds(),

620

self.disable))

655

self.disable_initiator_tag = gobject.timeout_add(

656

int(self.timeout.total_seconds() * 1000), self.disable)

621

657

# Also start a new checker *right now*.

622

658

self.start_checker()

623

659

624

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

660

def checker_callback(self, source, condition, connection,

661

command):

625

662

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

626

663

self.checker_callback_tag = None

627

664

self.checker = None

628

if os.WIFEXITED(condition):

629

self.last_checker_status = os.WEXITSTATUS(condition)

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

630

672

if self.last_checker_status == 0:

631

673

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

632

674

vars(self))

633

675

self.checked_ok()

634

676

else:

635

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

636

vars(self))

677

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

637

678

else:

638

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

639

681

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

640

682

vars(self))

683

return False

641

684

642

685

def checked_ok(self):

643

686

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

644

687

self.last_checked_ok = datetime.datetime.utcnow()

645

688

self.last_checker_status = 0

689

self.last_checker_signal = None

646

690

self.bump_timeout()

647

691

648

692

def bump_timeout(self, timeout=None):

653

697

gobject.source_remove(self.disable_initiator_tag)

654

698

self.disable_initiator_tag = None

655

699

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

656

self.disable_initiator_tag = (gobject.timeout_add

657

(timedelta_to_milliseconds

658

(timeout), self.disable))

700

self.disable_initiator_tag = gobject.timeout_add(

701

int(timeout.total_seconds() * 1000), self.disable)

659

702

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

660

703

661

704

def need_approval(self):

675

718

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

676

719

# should be.

677

720

678

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

679

try:

680

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

681

except (AttributeError, OSError) as error:

682

if (isinstance(error, OSError)

683

and error.errno != errno.ECHILD):

684

raise error

685

else:

686

if pid:

687

logger.warning("Checker was a zombie")

688

gobject.source_remove(self.checker_callback_tag)

689

self.checker_callback(pid, status,

690

self.current_checker_command)

721

if self.checker is not None and not self.checker.is_alive():

722

logger.warning("Checker was not alive; joining")

723

self.checker.join()

724

self.checker = None

691

725

# Start a new checker if needed

692

726

if self.checker is None:

693

727

# Escape attributes for the shell

694

escaped_attrs = dict(

695

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

696

for attr in

697

self.runtime_expansions)

728

escaped_attrs = {

729

attr: re.escape(str(getattr(self, attr)))

730

for attr in self.runtime_expansions }

698

731

try:

699

732

command = self.checker_command % escaped_attrs

700

733

except TypeError as error:

701

734

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

735

self.checker_command,

736

exc_info=error)

737

return True # Try again later

704

738

self.current_checker_command = command

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

except OSError as error:

716

logger.error("Failed to start subprocess",

717

exc_info=error)

718

self.checker_callback_tag = (gobject.child_watch_add

719

(self.checker.pid,

720

self.checker_callback,

721

data=command))

722

# The checker may have completed before the gobject

723

# watch was added. Check for this.

724

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

725

if pid:

726

gobject.source_remove(self.checker_callback_tag)

727

self.checker_callback(pid, status, 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)

728

764

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

729

765

return True

730

766

736

772

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

737

773

return

738

774

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

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

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

743

# self.checker.kill()

744

except OSError as error:

745

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

746

raise

775

self.checker.terminate()

747

776

self.checker = None

748

777

749

778

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

752

783

"""Decorators for marking methods of a DBusObjectWithProperties to

753

784

become properties on the D-Bus.

754

785

763

794

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

764

795

if byte_arrays and signature != "ay":

765

796

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

766

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

797

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

798

767

799

def decorator(func):

768

800

func._dbus_is_property = True

769

801

func._dbus_interface = dbus_interface

774

806

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

775

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

776

808

return func

809

777

810

return decorator

778

811

779

812

788

821

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

789

822

"false"}

790

823

"""

824

791

825

def decorator(func):

792

826

func._dbus_is_interface = True

793

827

func._dbus_interface = dbus_interface

794

828

func._dbus_name = dbus_interface

795

829

return func

830

796

831

return decorator

797

832

798

833

800

835

"""Decorator to annotate D-Bus methods, signals or properties

801

836

Usage:

802

837

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

803

841

@dbus_service_property("org.example.Interface", signature="b",

804

842

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

808

843

def Property_dbus_property(self):

809

844

return dbus.Boolean(False)

845

846

See also the DBusObjectWithAnnotations class.

810

847

"""

848

811

849

def decorator(func):

812

850

func._dbus_annotations = annotations

813

851

return func

852

814

853

return decorator

815

854

816

855

817

856

class DBusPropertyException(dbus.exceptions.DBusException):

818

857

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

819

858

"""

820

def __unicode__(self):

821

return unicode(str(self))

859

pass

822

860

823

861

824

862

class DBusPropertyAccessException(DBusPropertyException):

833

871

pass

834

872

835

873

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

874

class DBusObjectWithAnnotations(dbus.service.Object):

875

"""A D-Bus object with annotations.

838

876

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

877

Classes inheriting from this can use the dbus_annotations

878

decorator to add annotations to methods or signals.

842

879

"""

843

880

844

881

@staticmethod

848

885

If called like _is_dbus_thing("method") it returns a function

849

886

suitable for use as predicate to inspect.getmembers().

850

887

"""

851

return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),

888

return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),

852

889

False)

853

890

854

891

def _get_all_dbus_things(self, thing):

855

892

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

856

893

"""

857

return ((getattr(athing.__get__(self), "_dbus_name",

858

name),

894

return ((getattr(athing.__get__(self), "_dbus_name", name),

859

895

athing.__get__(self))

860

896

for cls in self.__class__.__mro__

861

897

for name, athing in

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

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

964

"""A D-Bus object with properties.

965

966

Classes inheriting from this can use the dbus_service_property

967

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

968

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

969

"""

864

970

865

971

def _get_dbus_property(self, interface_name, property_name):

866

972

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

867

973

property with the specified name and interface.

868

974

"""

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

975

for cls in self.__class__.__mro__:

976

for name, value in inspect.getmembers(

977

cls, self._is_dbus_thing("property")):

873

978

if (value._dbus_name == property_name

874

979

and value._dbus_interface == interface_name):

875

980

return value.__get__(self)

876

981

877

982

# No such property

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

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

983

raise DBusPropertyNotFound("{}:{}.{}".format(

984

self.dbus_object_path, interface_name, property_name))

985

986

@classmethod

987

def _get_all_interface_names(cls):

988

"""Get a sequence of all interfaces supported by an object"""

989

return (name for name in set(getattr(getattr(x, attr),

990

"_dbus_interface", None)

991

for x in (inspect.getmro(cls))

992

for attr in dir(x))

993

if name is not None)

994

995

@dbus.service.method(dbus.PROPERTIES_IFACE,

996

in_signature="ss",

883

997

out_signature="v")

884

998

def Get(self, interface_name, property_name):

885

999

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

903

1017

# The byte_arrays option is not supported yet on

904

1018

# signatures other than "ay".

905

1019

if prop._dbus_signature != "ay":

906

raise ValueError

1020

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

1021

"'ay' signature {!r}"

1022

.format(prop._dbus_signature))

907

1023

value = dbus.ByteArray(b''.join(chr(byte)

908

1024

for byte in value))

909

1025

prop(value)

910

1026

911

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

1027

@dbus.service.method(dbus.PROPERTIES_IFACE,

1028

in_signature="s",

912

1029

out_signature="a{sv}")

913

1030

def GetAll(self, interface_name):

914

1031

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

929

1046

if not hasattr(value, "variant_level"):

930

1047

properties[name] = value

931

1048

continue

932

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

933

value.variant_level+1)

1049

properties[name] = type(value)(

1050

value, variant_level = value.variant_level + 1)

934

1051

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

935

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

1060

936

1061

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

937

1062

out_signature="s",

938

1063

path_keyword='object_path',

942

1067

943

1068

Inserts property tags and interface annotation tags.

944

1069

"""

945

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

946

connection)

1070

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1071

object_path,

1072

connection)

947

1073

try:

948

1074

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

1075

949

1076

def make_tag(document, name, prop):

950

1077

e = document.createElement("property")

951

1078

e.setAttribute("name", name)

952

1079

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

953

1080

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

954

1081

return e

1082

955

1083

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

956

1084

# Add property tags

957

1085

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

960

1088

if prop._dbus_interface

961

1089

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

962

1090

if_tag.appendChild(tag)

963

# Add annotation tags

964

for typ in ("method", "signal", "property"):

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

if (name == tag.getAttribute("name")

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_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)

994

1107

# Add the names to the return values for the

995

1108

# "org.freedesktop.DBus.Properties" methods

996

1109

if (if_tag.getAttribute("name")

1014

1127

exc_info=error)

1015

1128

return xmlstring

1016

1129

1017

1018

def datetime_to_dbus (dt, variant_level=0):

1130

try:

1131

dbus.OBJECT_MANAGER_IFACE

1132

except AttributeError:

1133

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

1134

1135

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1136

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

1137

1138

Classes inheriting from this exposes the standard

1139

GetManagedObjects call and the InterfacesAdded and

1140

InterfacesRemoved signals on the standard

1141

"org.freedesktop.DBus.ObjectManager" interface.

1142

1143

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

1144

manually.

1145

"""

1146

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1147

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

1148

def GetManagedObjects(self):

1149

"""This function must be overridden"""

1150

raise NotImplementedError()

1151

1152

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1153

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

1154

def InterfacesAdded(self, object_path, interfaces_and_properties):

1155

pass

1156

1157

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1158

signature = "oas")

1159

def InterfacesRemoved(self, object_path, interfaces):

1160

pass

1161

1162

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1163

out_signature = "s",

1164

path_keyword = 'object_path',

1165

connection_keyword = 'connection')

1166

def Introspect(self, object_path, connection):

1167

"""Overloading of standard D-Bus method.

1168

1169

Override return argument name of GetManagedObjects to be

1170

"objpath_interfaces_and_properties"

1171

"""

1172

xmlstring = DBusObjectWithAnnotations(self, object_path,

1173

connection)

1174

try:

1175

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

1176

1177

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

1178

# Fix argument name for the GetManagedObjects method

1179

if (if_tag.getAttribute("name")

1180

== dbus.OBJECT_MANAGER_IFACE):

1181

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

1182

if (cn.getAttribute("name")

1183

== "GetManagedObjects"):

1184

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

1185

if (arg.getAttribute("direction")

1186

== "out"):

1187

arg.setAttribute(

1188

"name",

1189

"objpath_interfaces"

1190

"_and_properties")

1191

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

1192

document.unlink()

1193

except (AttributeError, xml.dom.DOMException,

1194

xml.parsers.expat.ExpatError) as error:

1195

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

1196

exc_info = error)

1197

return xmlstring

1198

1199

def datetime_to_dbus(dt, variant_level=0):

1019

1200

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

1020

1201

if dt is None:

1021

1202

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1203

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

1024

1204

1025

1205

1026

1206

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1029

1209

interface names according to the "alt_interface_names" mapping.

1030

1210

Usage:

1031

1211

1032

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

1033

"net.example.AlternateInterface"})

1212

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

1213

"net.example.AlternateInterface"})

1034

1214

class SampleDBusObject(dbus.service.Object):

1035

1215

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

1036

1216

def SampleDBusMethod():

1046

1226

(from DBusObjectWithProperties) and interfaces (from the

1047

1227

dbus_interface_annotations decorator).

1048

1228

"""

1229

1049

1230

def wrapper(cls):

1050

1231

for orig_interface_name, alt_interface_name in (

1051

alt_interface_names.iteritems()):

1232

alt_interface_names.items()):

1052

1233

attr = {}

1053

1234

interface_names = set()

1054

1235

# Go though all attributes of the class

1056

1237

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

1057

1238

# with the wrong interface name

1058

1239

if (not hasattr(attribute, "_dbus_interface")

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1240

or not attribute._dbus_interface.startswith(

1241

orig_interface_name)):

1061

1242

continue

1062

1243

# Create an alternate D-Bus interface name based on

1063

1244

# the current name

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1245

alt_interface = attribute._dbus_interface.replace(

1246

orig_interface_name, alt_interface_name)

1067

1247

interface_names.add(alt_interface)

1068

1248

# Is this a D-Bus signal?

1069

1249

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

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1250

if sys.version_info.major == 2:

1251

# Extract the original non-method undecorated

1252

# function by black magic

1253

nonmethod_func = (dict(

1073

1254

zip(attribute.func_code.co_freevars,

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1255

attribute.__closure__))

1256

["func"].cell_contents)

1257

else:

1258

nonmethod_func = attribute

1076

1259

# Create a new, but exactly alike, function

1077

1260

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

1078

1261

# with the alternate D-Bus interface name

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

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

1088

1279

# Copy annotations, if any

1089

1280

try:

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1281

new_function._dbus_annotations = dict(

1282

attribute._dbus_annotations)

1092

1283

except AttributeError:

1093

1284

pass

1094

1285

# Define a creator of a function to call both the

1099

1290

"""This function is a scope container to pass

1100

1291

func1 and func2 to the "call_both" function

1101

1292

outside of its arguments"""

1293

1102

1294

def call_both(*args, **kwargs):

1103

1295

"""This function will emit two D-Bus

1104

1296

signals by calling func1 and func2"""

1105

1297

func1(*args, **kwargs)

1106

1298

func2(*args, **kwargs)

1299

1107

1300

return call_both

1108

1301

# Create the "call_both" function and add it to

1109

1302

# the class

1114

1307

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

1115

1308

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

1116

1309

# to the class.

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1310

attr[attrname] = (

1311

dbus.service.method(

1312

alt_interface,

1313

attribute._dbus_in_signature,

1314

attribute._dbus_out_signature)

1315

(types.FunctionType(attribute.func_code,

1316

attribute.func_globals,

1317

attribute.func_name,

1318

attribute.func_defaults,

1319

attribute.func_closure)))

1127

1320

# Copy annotations, if any

1128

1321

try:

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1322

attr[attrname]._dbus_annotations = dict(

1323

attribute._dbus_annotations)

1131

1324

except AttributeError:

1132

1325

pass

1133

1326

# Is this a D-Bus property?

1136

1329

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

1137

1330

# property with the alternate D-Bus interface

1138

1331

# name. Add it to the class.

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1332

attr[attrname] = (dbus_service_property(

1333

alt_interface, attribute._dbus_signature,

1334

attribute._dbus_access,

1335

attribute._dbus_get_args_options

1336

["byte_arrays"])

1337

(types.FunctionType(

1338

attribute.func_code,

1339

attribute.func_globals,

1340

attribute.func_name,

1341

attribute.func_defaults,

1342

attribute.func_closure)))

1152

1343

# Copy annotations, if any

1153

1344

try:

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1345

attr[attrname]._dbus_annotations = dict(

1346

attribute._dbus_annotations)

1156

1347

except AttributeError:

1157

1348

pass

1158

1349

# Is this a D-Bus interface?

1161

1352

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

1162

1353

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

1163

1354

# to the class.

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1355

attr[attrname] = (

1356

dbus_interface_annotations(alt_interface)

1357

(types.FunctionType(attribute.func_code,

1358

attribute.func_globals,

1359

attribute.func_name,

1360

attribute.func_defaults,

1361

attribute.func_closure)))

1172

1362

if deprecate:

1173

1363

# Deprecate all alternate interfaces

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1364

iname="_AlternateDBusNames_interface_annotation{}"

1175

1365

for interface_name in interface_names:

1366

1176

1367

@dbus_interface_annotations(interface_name)

1177

1368

def func(self):

1178

1369

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

1179

"true" }

1370

"true" }

1180

1371

# Find an unused name

1181

1372

for aname in (iname.format(i)

1182

1373

for i in itertools.count()):

1186

1377

if interface_names:

1187

1378

# Replace the class with a new subclass of it with

1188

1379

# methods, signals, etc. as created above.

1189

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

1190

(cls,), attr)

1380

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

1381

(cls, ), attr)

1191

1382

return cls

1383

1192

1384

return wrapper

1193

1385

1194

1386

1195

1387

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

1196

"se.bsnet.fukt.Mandos"})

1388

"se.bsnet.fukt.Mandos"})

1197

1389

class ClientDBus(Client, DBusObjectWithProperties):

1198

1390

"""A Client class using D-Bus

1199

1391

1203

1395

"""

1204

1396

1205

1397

runtime_expansions = (Client.runtime_expansions

1206

+ ("dbus_object_path",))

1398

+ ("dbus_object_path", ))

1399

1400

_interface = "se.recompile.Mandos.Client"

1207

1401

1208

1402

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

1209

1403

1212

1406

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

1213

1407

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

1214

1408

# the D-Bus

1215

client_object_name = unicode(self.name).translate(

1409

client_object_name = str(self.name).translate(

1216

1410

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

1217

1411

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

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1412

self.dbus_object_path = dbus.ObjectPath(

1413

"/clients/" + client_object_name)

1220

1414

DBusObjectWithProperties.__init__(self, self.bus,

1221

1415

self.dbus_object_path)

1222

1416

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1417

def notifychangeproperty(transform_func, dbus_name,

1418

type_func=lambda x: x,

1419

variant_level=1,

1420

invalidate_only=False,

1421

_interface=_interface):

1226

1422

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

1227

1423

its changes to DBus.

1228

1424

1233

1429

to the D-Bus. Default: no transform

1234

1430

variant_level: D-Bus variant level. Default: 1

1235

1431

"""

1236

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

1432

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

1433

1237

1434

def setter(self, value):

1238

1435

if hasattr(self, "dbus_object_path"):

1239

1436

if (not hasattr(self, attrname) or

1240

1437

type_func(getattr(self, attrname, None))

1241

1438

!= type_func(value)):

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1439

if invalidate_only:

1440

self.PropertiesChanged(

1441

_interface, dbus.Dictionary(),

1442

dbus.Array((dbus_name, )))

1443

else:

1444

dbus_value = transform_func(

1445

type_func(value),

1446

variant_level = variant_level)

1447

self.PropertyChanged(dbus.String(dbus_name),

1448

dbus_value)

1449

self.PropertiesChanged(

1450

_interface,

1451

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

1452

dbus_value }),

1453

dbus.Array())

1247

1454

setattr(self, attrname, value)

1248

1455

1249

1456

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

1255

1462

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

1256

1463

last_enabled = notifychangeproperty(datetime_to_dbus,

1257

1464

"LastEnabled")

1258

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

1259

type_func = lambda checker:

1260

checker is not None)

1465

checker = notifychangeproperty(

1466

dbus.Boolean, "CheckerRunning",

1467

type_func = lambda checker: checker is not None)

1261

1468

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1262

1469

"LastCheckedOK")

1263

1470

last_checker_status = notifychangeproperty(dbus.Int16,

1266

1473

datetime_to_dbus, "LastApprovalRequest")

1267

1474

approved_by_default = notifychangeproperty(dbus.Boolean,

1268

1475

"ApprovedByDefault")

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1476

approval_delay = notifychangeproperty(

1477

dbus.UInt64, "ApprovalDelay",

1478

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

1273

1479

approval_duration = notifychangeproperty(

1274

1480

dbus.UInt64, "ApprovalDuration",

1275

type_func = timedelta_to_milliseconds)

1481

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

1276

1482

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

1277

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

1278

type_func =

1279

timedelta_to_milliseconds)

1483

timeout = notifychangeproperty(

1484

dbus.UInt64, "Timeout",

1485

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

1280

1486

extended_timeout = notifychangeproperty(

1281

1487

dbus.UInt64, "ExtendedTimeout",

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1488

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

1489

interval = notifychangeproperty(

1490

dbus.UInt64, "Interval",

1491

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

1287

1492

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

1493

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

1494

invalidate_only=True)

1288

1495

1289

1496

del notifychangeproperty

1290

1497

1297

1504

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

1298

1505

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

1299

1506

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1507

def checker_callback(self, source, condition,

1508

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

1509

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

1510

connection, command, *args,

1511

**kwargs)

1512

exitstatus = self.last_checker_status

1513

if exitstatus >= 0:

1306

1514

# Emit D-Bus signal

1307

1515

self.CheckerCompleted(dbus.Int16(exitstatus),

1308

dbus.Int64(condition),

1516

# This is specific to GNU libC

1517

dbus.Int64(exitstatus << 8),

1309

1518

dbus.String(command))

1310

1519

else:

1311

1520

# Emit D-Bus signal

1312

1521

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

1313

dbus.Int64(condition),

1522

dbus.Int64(

1523

# This is specific to GNU libC

1524

(exitstatus << 8)

1525

| self.last_checker_signal),

1314

1526

dbus.String(command))

1315

1316

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

1317

*args, **kwargs)

1527

return ret

1318

1528

1319

1529

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1530

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

1325

1531

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

1326

1532

# Only if new checker process was started

1327

1533

if (self.checker is not None

1336

1542

1337

1543

def approve(self, value=True):

1338

1544

self.approved = value

1339

gobject.timeout_add(timedelta_to_milliseconds

1340

(self.approval_duration),

1341

self._reset_approved)

1545

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

1546

* 1000), self._reset_approved)

1342

1547

self.send_changedstate()

1343

1548

1344

1549

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1550

1347

1551

## Interfaces

1348

1552

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

1553

## Signals

1355

1554

1356

1555

# CheckerCompleted - signal

1366

1565

pass

1367

1566

1368

1567

# PropertyChanged - signal

1568

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

1369

1569

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

1370

1570

def PropertyChanged(self, property, value):

1371

1571

"D-Bus signal"

1405

1605

self.checked_ok()

1406

1606

1407

1607

# Enable - method

1608

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

1408

1609

@dbus.service.method(_interface)

1409

1610

def Enable(self):

1410

1611

"D-Bus method"

1411

1612

self.enable()

1412

1613

1413

1614

# StartChecker - method

1615

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

1414

1616

@dbus.service.method(_interface)

1415

1617

def StartChecker(self):

1416

1618

"D-Bus method"

1417

1619

self.start_checker()

1418

1620

1419

1621

# Disable - method

1622

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

1420

1623

@dbus.service.method(_interface)

1421

1624

def Disable(self):

1422

1625

"D-Bus method"

1423

1626

self.disable()

1424

1627

1425

1628

# StopChecker - method

1629

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

1426

1630

@dbus.service.method(_interface)

1427

1631

def StopChecker(self):

1428

1632

self.stop_checker()

1435

1639

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

1436

1640

1437

1641

# ApprovedByDefault - property

1438

@dbus_service_property(_interface, signature="b",

1642

@dbus_service_property(_interface,

1643

signature="b",

1439

1644

access="readwrite")

1440

1645

def ApprovedByDefault_dbus_property(self, value=None):

1441

1646

if value is None: # get

1443

1648

self.approved_by_default = bool(value)

1444

1649

1445

1650

# ApprovalDelay - property

1446

@dbus_service_property(_interface, signature="t",

1651

@dbus_service_property(_interface,

1652

signature="t",

1447

1653

access="readwrite")

1448

1654

def ApprovalDelay_dbus_property(self, value=None):

1449

1655

if value is None: # get

1450

return dbus.UInt64(self.approval_delay_milliseconds())

1656

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

1657

* 1000)

1451

1658

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

1452

1659

1453

1660

# ApprovalDuration - property

1454

@dbus_service_property(_interface, signature="t",

1661

@dbus_service_property(_interface,

1662

signature="t",

1455

1663

access="readwrite")

1456

1664

def ApprovalDuration_dbus_property(self, value=None):

1457

1665

if value is None: # get

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

1666

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

1667

* 1000)

1460

1668

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

1461

1669

1462

1670

# Name - property

1671

@dbus_annotations(

1672

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

1463

1673

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

1464

1674

def Name_dbus_property(self):

1465

1675

return dbus.String(self.name)

1466

1676

1467

1677

# Fingerprint - property

1678

@dbus_annotations(

1679

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

1468

1680

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

1469

1681

def Fingerprint_dbus_property(self):

1470

1682

return dbus.String(self.fingerprint)

1471

1683

1472

1684

# Host - property

1473

@dbus_service_property(_interface, signature="s",

1685

@dbus_service_property(_interface,

1686

signature="s",

1474

1687

access="readwrite")

1475

1688

def Host_dbus_property(self, value=None):

1476

1689

if value is None: # get

1477

1690

return dbus.String(self.host)

1478

self.host = unicode(value)

1691

self.host = str(value)

1479

1692

1480

1693

# Created - property

1694

@dbus_annotations(

1695

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

1481

1696

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

1482

1697

def Created_dbus_property(self):

1483

1698

return datetime_to_dbus(self.created)

1488

1703

return datetime_to_dbus(self.last_enabled)

1489

1704

1490

1705

# Enabled - property

1491

@dbus_service_property(_interface, signature="b",

1706

@dbus_service_property(_interface,

1707

signature="b",

1492

1708

access="readwrite")

1493

1709

def Enabled_dbus_property(self, value=None):

1494

1710

if value is None: # get

1499

1715

self.disable()

1500

1716

1501

1717

# LastCheckedOK - property

1502

@dbus_service_property(_interface, signature="s",

1718

@dbus_service_property(_interface,

1719

signature="s",

1503

1720

access="readwrite")

1504

1721

def LastCheckedOK_dbus_property(self, value=None):

1505

1722

if value is not None:

1508

1725

return datetime_to_dbus(self.last_checked_ok)

1509

1726

1510

1727

# LastCheckerStatus - property

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

1728

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

1513

1729

def LastCheckerStatus_dbus_property(self):

1514

1730

return dbus.Int16(self.last_checker_status)

1515

1731

1524

1740

return datetime_to_dbus(self.last_approval_request)

1525

1741

1526

1742

# Timeout - property

1527

@dbus_service_property(_interface, signature="t",

1743

@dbus_service_property(_interface,

1744

signature="t",

1528

1745

access="readwrite")

1529

1746

def Timeout_dbus_property(self, value=None):

1530

1747

if value is None: # get

1531

return dbus.UInt64(self.timeout_milliseconds())

1748

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

1532

1749

old_timeout = self.timeout

1533

1750

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

1534

1751

# Reschedule disabling

1543

1760

is None):

1544

1761

return

1545

1762

gobject.source_remove(self.disable_initiator_tag)

1546

self.disable_initiator_tag = (

1547

gobject.timeout_add(

1548

timedelta_to_milliseconds(self.expires - now),

1549

self.disable))

1763

self.disable_initiator_tag = gobject.timeout_add(

1764

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

1765

self.disable)

1550

1766

1551

1767

# ExtendedTimeout - property

1552

@dbus_service_property(_interface, signature="t",

1768

@dbus_service_property(_interface,

1769

signature="t",

1553

1770

access="readwrite")

1554

1771

def ExtendedTimeout_dbus_property(self, value=None):

1555

1772

if value is None: # get

1556

return dbus.UInt64(self.extended_timeout_milliseconds())

1773

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

1774

* 1000)

1557

1775

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

1558

1776

1559

1777

# Interval - property

1560

@dbus_service_property(_interface, signature="t",

1778

@dbus_service_property(_interface,

1779

signature="t",

1561

1780

access="readwrite")

1562

1781

def Interval_dbus_property(self, value=None):

1563

1782

if value is None: # get

1564

return dbus.UInt64(self.interval_milliseconds())

1783

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

1565

1784

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

1566

1785

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

1567

1786

return

1568

1787

if self.enabled:

1569

1788

# Reschedule checker run

1570

1789

gobject.source_remove(self.checker_initiator_tag)

1571

self.checker_initiator_tag = (gobject.timeout_add

1572

(value, self.start_checker))

1573

self.start_checker() # Start one now, too

1790

self.checker_initiator_tag = gobject.timeout_add(

1791

value, self.start_checker)

1792

self.start_checker() # Start one now, too

1574

1793

1575

1794

# Checker - property

1576

@dbus_service_property(_interface, signature="s",

1795

@dbus_service_property(_interface,

1796

signature="s",

1577

1797

access="readwrite")

1578

1798

def Checker_dbus_property(self, value=None):

1579

1799

if value is None: # get

1580

1800

return dbus.String(self.checker_command)

1581

self.checker_command = unicode(value)

1801

self.checker_command = str(value)

1582

1802

1583

1803

# CheckerRunning - property

1584

@dbus_service_property(_interface, signature="b",

1804

@dbus_service_property(_interface,

1805

signature="b",

1585

1806

access="readwrite")

1586

1807

def CheckerRunning_dbus_property(self, value=None):

1587

1808

if value is None: # get

1592

1813

self.stop_checker()

1593

1814

1594

1815

# ObjectPath - property

1816

@dbus_annotations(

1817

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

1818

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

1595

1819

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

1596

1820

def ObjectPath_dbus_property(self):

1597

1821

return self.dbus_object_path # is already a dbus.ObjectPath

1598

1822

1599

1823

# Secret = property

1600

@dbus_service_property(_interface, signature="ay",

1601

access="write", byte_arrays=True)

1824

@dbus_annotations(

1825

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

1826

"invalidates"})

1827

@dbus_service_property(_interface,

1828

signature="ay",

1829

access="write",

1830

byte_arrays=True)

1602

1831

def Secret_dbus_property(self, value):

1603

self.secret = str(value)

1832

self.secret = bytes(value)

1604

1833

1605

1834

del _interface

1606

1835

1610

1839

self._pipe = child_pipe

1611

1840

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

1612

1841

if not self._pipe.recv():

1613

raise KeyError()

1842

raise KeyError(fpr)

1614

1843

1615

1844

def __getattribute__(self, name):

1616

1845

if name == '_pipe':

1620

1849

if data[0] == 'data':

1621

1850

return data[1]

1622

1851

if data[0] == 'function':

1852

1623

1853

def func(*args, **kwargs):

1624

1854

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

1625

1855

return self._pipe.recv()[1]

1856

1626

1857

return func

1627

1858

1628

1859

def __setattr__(self, name, value):

1640

1871

def handle(self):

1641

1872

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

1642

1873

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

1643

unicode(self.client_address))

1874

str(self.client_address))

1644

1875

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

1645

1876

self.server.child_pipe.fileno())

1646

1877

1647

session = (gnutls.connection

1648

.ClientSession(self.request,

1649

gnutls.connection

1650

.X509Credentials()))

1878

session = gnutls.connection.ClientSession(

1879

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

1651

1880

1652

1881

# Note: gnutls.connection.X509Credentials is really a

1653

1882

# generic GnuTLS certificate credentials object so long as

1662

1891

priority = self.server.gnutls_priority

1663

1892

if priority is None:

1664

1893

priority = "NORMAL"

1665

(gnutls.library.functions

1666

.gnutls_priority_set_direct(session._c_object,

1667

priority, None))

1894

gnutls.library.functions.gnutls_priority_set_direct(

1895

session._c_object, priority, None)

1668

1896

1669

1897

# Start communication using the Mandos protocol

1670

1898

# Get protocol number

1672

1900

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

1673

1901

try:

1674

1902

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

1675

raise RuntimeError

1903

raise RuntimeError(line)

1676

1904

except (ValueError, IndexError, RuntimeError) as error:

1677

1905

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

1678

1906

return

1690

1918

approval_required = False

1691

1919

try:

1692

1920

try:

1693

fpr = self.fingerprint(self.peer_certificate

1694

(session))

1921

fpr = self.fingerprint(

1922

self.peer_certificate(session))

1695

1923

except (TypeError,

1696

1924

gnutls.errors.GNUTLSError) as error:

1697

1925

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

1712

1940

while True:

1713

1941

if not client.enabled:

1714

1942

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

1715

client.name)

1943

client.name)

1716

1944

if self.server.use_dbus:

1717

1945

# Emit D-Bus signal

1718

1946

client.Rejected("Disabled")

1727

1955

if self.server.use_dbus:

1728

1956

# Emit D-Bus signal

1729

1957

client.NeedApproval(

1730

client.approval_delay_milliseconds(),

1731

client.approved_by_default)

1958

client.approval_delay.total_seconds()

1959

* 1000, client.approved_by_default)

1732

1960

else:

1733

1961

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

1734

1962

client.name)

1740

1968

#wait until timeout or approved

1741

1969

time = datetime.datetime.now()

1742

1970

client.changedstate.acquire()

1743

client.changedstate.wait(

1744

float(timedelta_to_milliseconds(delay)

1745

/ 1000))

1971

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

1746

1972

client.changedstate.release()

1747

1973

time2 = datetime.datetime.now()

1748

1974

if (time2 - time) >= delay:

1767

1993

logger.warning("gnutls send failed",

1768

1994

exc_info=error)

1769

1995

return

1770

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

1771

sent, len(client.secret)

1772

- (sent_size + sent))

1996

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

1997

len(client.secret) - (sent_size

1998

+ sent))

1773

1999

sent_size += sent

1774

2000

1775

2001

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

1792

2018

def peer_certificate(session):

1793

2019

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

1794

2020

# If not an OpenPGP certificate...

1795

if (gnutls.library.functions

1796

.gnutls_certificate_type_get(session._c_object)

2021

if (gnutls.library.functions.gnutls_certificate_type_get(

2022

session._c_object)

1797

2023

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1798

2024

# ...do the normal thing

1799

2025

return session.peer_certificate

1813

2039

def fingerprint(openpgp):

1814

2040

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1815

2041

# New GnuTLS "datum" with the OpenPGP public key

1816

datum = (gnutls.library.types

1817

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

1818

ctypes.POINTER

1819

(ctypes.c_ubyte)),

1820

ctypes.c_uint(len(openpgp))))

2042

datum = gnutls.library.types.gnutls_datum_t(

2043

ctypes.cast(ctypes.c_char_p(openpgp),

2044

ctypes.POINTER(ctypes.c_ubyte)),

2045

ctypes.c_uint(len(openpgp)))

1821

2046

# New empty GnuTLS certificate

1822

2047

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1823

(gnutls.library.functions

1824

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2048

gnutls.library.functions.gnutls_openpgp_crt_init(

2049

ctypes.byref(crt))

1825

2050

# Import the OpenPGP public key into the certificate

1826

(gnutls.library.functions

1827

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

1828

gnutls.library.constants

1829

.GNUTLS_OPENPGP_FMT_RAW))

2051

gnutls.library.functions.gnutls_openpgp_crt_import(

2052

crt, ctypes.byref(datum),

2053

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1830

2054

# Verify the self signature in the key

1831

2055

crtverify = ctypes.c_uint()

1832

(gnutls.library.functions

1833

.gnutls_openpgp_crt_verify_self(crt, 0,

1834

ctypes.byref(crtverify)))

2056

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

2057

crt, 0, ctypes.byref(crtverify))

1835

2058

if crtverify.value != 0:

1836

2059

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1837

raise (gnutls.errors.CertificateSecurityError

1838

("Verify failed"))

2060

raise gnutls.errors.CertificateSecurityError(

2061

"Verify failed")

1839

2062

# New buffer for the fingerprint

1840

2063

buf = ctypes.create_string_buffer(20)

1841

2064

buf_len = ctypes.c_size_t()

1842

2065

# Get the fingerprint from the certificate into the buffer

1843

(gnutls.library.functions

1844

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

1845

ctypes.byref(buf_len)))

2066

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

2067

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

1846

2068

# Deinit the certificate

1847

2069

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

2070

# Convert the buffer to a Python bytestring

1854

2076

1855

2077

class MultiprocessingMixIn(object):

1856

2078

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

2079

1857

2080

def sub_process_main(self, request, address):

1858

2081

try:

1859

2082

self.finish_request(request, address)

1871

2094

1872

2095

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1873

2096

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

2097

1874

2098

def process_request(self, request, client_address):

1875

2099

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

1876

2100

1885

2109

1886

2110

def add_pipe(self, parent_pipe, proc):

1887

2111

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

1888

raise NotImplementedError

2112

raise NotImplementedError()

1889

2113

1890

2114

1891

2115

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1897

2121

interface: None or a network interface name (string)

1898

2122

use_ipv6: Boolean; to use IPv6 or not

1899

2123

"""

2124

1900

2125

def __init__(self, server_address, RequestHandlerClass,

1901

interface=None, use_ipv6=True):

2126

interface=None,

2127

use_ipv6=True,

2128

socketfd=None):

2129

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

2130

creating a new one with socket.socket().

2131

"""

1902

2132

self.interface = interface

1903

2133

if use_ipv6:

1904

2134

self.address_family = socket.AF_INET6

2135

if socketfd is not None:

2136

# Save the file descriptor

2137

self.socketfd = socketfd

2138

# Save the original socket.socket() function

2139

self.socket_socket = socket.socket

2140

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

2141

#

2142

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

2143

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

2144

# patching socket.socket.)

2145

#

2146

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

2147

@functools.wraps(socket.socket)

2148

def socket_wrapper(*args, **kwargs):

2149

# Restore original function so subsequent calls are

2150

# not affected.

2151

socket.socket = self.socket_socket

2152

del self.socket_socket

2153

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

2154

# saved file descriptor.

2155

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

2156

# Replace socket.socket() function with wrapper

2157

socket.socket = socket_wrapper

2158

# The socketserver.TCPServer.__init__ will call

2159

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

2160

# socket_wrapper(), if socketfd was set.

1905

2161

socketserver.TCPServer.__init__(self, server_address,

1906

2162

RequestHandlerClass)

2163

1907

2164

def server_bind(self):

1908

2165

"""This overrides the normal server_bind() function

1909

2166

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

1915

2172

self.interface)

1916

2173

else:

1917

2174

try:

1918

self.socket.setsockopt(socket.SOL_SOCKET,

1919

SO_BINDTODEVICE,

1920

str(self.interface

1921

+ '\0'))

2175

self.socket.setsockopt(

2176

socket.SOL_SOCKET, SO_BINDTODEVICE,

2177

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

1922

2178

except socket.error as error:

1923

2179

if error.errno == errno.EPERM:

1924

logger.error("No permission to"

1925

" bind to interface %s",

1926

self.interface)

2180

logger.error("No permission to bind to"

2181

" interface %s", self.interface)

1927

2182

elif error.errno == errno.ENOPROTOOPT:

1928

2183

logger.error("SO_BINDTODEVICE not available;"

1929

2184

" cannot bind to interface %s",

1930

2185

self.interface)

1931

2186

elif error.errno == errno.ENODEV:

1932

logger.error("Interface %s does not"

1933

" exist, cannot bind",

1934

self.interface)

2187

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

2188

" cannot bind", self.interface)

1935

2189

else:

1936

2190

raise

1937

2191

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

1940

2194

if self.address_family == socket.AF_INET6:

1941

2195

any_address = "::" # in6addr_any

1942

2196

else:

1943

any_address = socket.INADDR_ANY

2197

any_address = "0.0.0.0" # INADDR_ANY

1944

2198

self.server_address = (any_address,

1945

2199

self.server_address[1])

1946

2200

elif not self.server_address[1]:

1947

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

1948

0)

2201

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

1949

2202

# if self.interface:

1950

2203

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

1951

2204

# 0, # port

1965

2218

1966

2219

Assumes a gobject.MainLoop event loop.

1967

2220

"""

2221

1968

2222

def __init__(self, server_address, RequestHandlerClass,

1969

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

1970

gnutls_priority=None, use_dbus=True):

2223

interface=None,

2224

use_ipv6=True,

2225

clients=None,

2226

gnutls_priority=None,

2227

use_dbus=True,

2228

socketfd=None):

1971

2229

self.enabled = False

1972

2230

self.clients = clients

1973

2231

if self.clients is None:

1977

2235

IPv6_TCPServer.__init__(self, server_address,

1978

2236

RequestHandlerClass,

1979

2237

interface = interface,

1980

use_ipv6 = use_ipv6)

2238

use_ipv6 = use_ipv6,

2239

socketfd = socketfd)

2240

1981

2241

def server_activate(self):

1982

2242

if self.enabled:

1983

2243

return socketserver.TCPServer.server_activate(self)

1987

2247

1988

2248

def add_pipe(self, parent_pipe, proc):

1989

2249

# Call "handle_ipc" for both data and EOF events

1990

gobject.io_add_watch(parent_pipe.fileno(),

1991

gobject.IO_IN | gobject.IO_HUP,

1992

functools.partial(self.handle_ipc,

1993

parent_pipe =

1994

parent_pipe,

1995

proc = proc))

2250

gobject.io_add_watch(

2251

parent_pipe.fileno(),

2252

gobject.IO_IN | gobject.IO_HUP,

2253

functools.partial(self.handle_ipc,

2254

parent_pipe = parent_pipe,

2255

proc = proc))

1996

2256

1997

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

1998

proc = None, client_object=None):

2257

def handle_ipc(self, source, condition,

2258

parent_pipe=None,

2259

proc = None,

2260

client_object=None):

1999

2261

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

2000

2262

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

2001

2263

# Wait for other process to exit

2024

2286

parent_pipe.send(False)

2025

2287

return False

2026

2288

2027

gobject.io_add_watch(parent_pipe.fileno(),

2028

gobject.IO_IN | gobject.IO_HUP,

2029

functools.partial(self.handle_ipc,

2030

parent_pipe =

2031

parent_pipe,

2032

proc = proc,

2033

client_object =

2034

client))

2289

gobject.io_add_watch(

2290

parent_pipe.fileno(),

2291

gobject.IO_IN | gobject.IO_HUP,

2292

functools.partial(self.handle_ipc,

2293

parent_pipe = parent_pipe,

2294

proc = proc,

2295

client_object = client))

2035

2296

parent_pipe.send(True)

2036

2297

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

2037

2298

# same fileno

2043

2304

2044

2305

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

2045

2306

funcname)(*args,

2046

**kwargs)))

2307

**kwargs)))

2047

2308

2048

2309

if command == 'getattr':

2049

2310

attrname = request[1]

2050

if callable(client_object.__getattribute__(attrname)):

2051

parent_pipe.send(('function',))

2311

if isinstance(client_object.__getattribute__(attrname),

2312

collections.Callable):

2313

parent_pipe.send(('function', ))

2052

2314

else:

2053

parent_pipe.send(('data', client_object

2054

.__getattribute__(attrname)))

2315

parent_pipe.send((

2316

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

2055

2317

2056

2318

if command == 'setattr':

2057

2319

attrname = request[1]

2061

2323

return True

2062

2324

2063

2325

2326

def rfc3339_duration_to_delta(duration):

2327

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

2328

2329

>>> rfc3339_duration_to_delta("P7D")

2330

datetime.timedelta(7)

2331

>>> rfc3339_duration_to_delta("PT60S")

2332

datetime.timedelta(0, 60)

2333

>>> rfc3339_duration_to_delta("PT60M")

2334

datetime.timedelta(0, 3600)

2335

>>> rfc3339_duration_to_delta("PT24H")

2336

datetime.timedelta(1)

2337

>>> rfc3339_duration_to_delta("P1W")

2338

datetime.timedelta(7)

2339

>>> rfc3339_duration_to_delta("PT5M30S")

2340

datetime.timedelta(0, 330)

2341

>>> rfc3339_duration_to_delta("P1DT3M20S")

2342

datetime.timedelta(1, 200)

2343

"""

2344

2345

# Parsing an RFC 3339 duration with regular expressions is not

2346

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

2347

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

2348

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

2349

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

2350

# avoid excessive use of external libraries.

2351

2352

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

2353

Token = collections.namedtuple("Token", (

2354

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

2355

# a "group" containing digits

2356

"value", # datetime.timedelta or None

2357

"followers")) # Tokens valid after this token

2358

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

2359

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

2360

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

2361

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

2362

datetime.timedelta(seconds=1),

2363

frozenset((token_end, )))

2364

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

2365

datetime.timedelta(minutes=1),

2366

frozenset((token_second, token_end)))

2367

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

2368

datetime.timedelta(hours=1),

2369

frozenset((token_minute, token_end)))

2370

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

2371

None,

2372

frozenset((token_hour, token_minute,

2373

token_second)))

2374

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

2375

datetime.timedelta(days=1),

2376

frozenset((token_time, token_end)))

2377

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

2378

datetime.timedelta(weeks=4),

2379

frozenset((token_day, token_end)))

2380

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

2381

datetime.timedelta(weeks=52),

2382

frozenset((token_month, token_end)))

2383

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

2384

datetime.timedelta(weeks=1),

2385

frozenset((token_end, )))

2386

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

2387

frozenset((token_year, token_month,

2388

token_day, token_time,

2389

token_week)))

2390

# Define starting values

2391

value = datetime.timedelta() # Value so far

2392

found_token = None

2393

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

2394

s = duration # String left to parse

2395

# Loop until end token is found

2396

while found_token is not token_end:

2397

# Search for any currently valid tokens

2398

for token in followers:

2399

match = token.regexp.match(s)

2400

if match is not None:

2401

# Token found

2402

if token.value is not None:

2403

# Value found, parse digits

2404

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

2405

# Add to value so far

2406

value += factor * token.value

2407

# Strip token from string

2408

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

2409

# Go to found token

2410

found_token = token

2411

# Set valid next tokens

2412

followers = found_token.followers

2413

break

2414

else:

2415

# No currently valid tokens were found

2416

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

2417

.format(duration))

2418

# End token found

2419

return value

2420

2421

2064

2422

def string_to_delta(interval):

2065

2423

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

2066

2424

2077

2435

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

2078

2436

datetime.timedelta(0, 330)

2079

2437

"""

2438

2439

try:

2440

return rfc3339_duration_to_delta(interval)

2441

except ValueError:

2442

pass

2443

2080

2444

timevalue = datetime.timedelta(0)

2081

2445

for s in interval.split():

2082

2446

try:

2083

suffix = unicode(s[-1])

2447

suffix = s[-1]

2084

2448

value = int(s[:-1])

2085

2449

if suffix == "d":

2086

2450

delta = datetime.timedelta(value)

2093

2457

elif suffix == "w":

2094

2458

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

2095

2459

else:

2096

raise ValueError("Unknown suffix {0!r}"

2097

.format(suffix))

2098

except (ValueError, IndexError) as e:

2460

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

2461

except IndexError as e:

2099

2462

raise ValueError(*(e.args))

2100

2463

timevalue += delta

2101

2464

return timevalue

2117

2480

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

2118

2481

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

2119

2482

raise OSError(errno.ENODEV,

2120

"{0} not a character device"

2483

"{} not a character device"

2121

2484

.format(os.devnull))

2122

2485

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

2123

2486

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

2133

2496

2134

2497

parser = argparse.ArgumentParser()

2135

2498

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

2136

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

2499

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

2137

2500

help="show version number and exit")

2138

2501

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

2139

2502

help="Bind to interface IF")

2145

2508

help="Run self-test")

2146

2509

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

2147

2510

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

2148

" to terminal")

2511

" to terminal", default=None)

2149

2512

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

2150

2513

help="Debug level for stdout output")

2151

2514

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

2158

2521

" files")

2159

2522

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

2160

2523

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

2161

" system bus interface")

2524

" system bus interface", default=None)

2162

2525

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

2163

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

2526

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

2527

default=None)

2164

2528

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

2165

2529

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

2166

" state")

2530

" state", default=None)

2531

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

2532

help="Specify a file descriptor to a network"

2533

" socket to use instead of creating one")

2167

2534

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

2168

2535

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

2536

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

2537

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

2538

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

2539

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

2540

default=None)

2169

2541

2170

2542

options = parser.parse_args()

2171

2543

2172

2544

if options.check:

2173

2545

import doctest

2174

doctest.testmod()

2175

sys.exit()

2546

fail_count, test_count = doctest.testmod()

2547

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

2176

2548

2177

2549

# Default values for config file for server-global settings

2178

2550

server_defaults = { "interface": "",

2180

2552

"port": "",

2181

2553

"debug": "False",

2182

2554

"priority":

2183

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

2555

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

2556

":+SIGN-DSA-SHA256",

2184

2557

"servicename": "Mandos",

2185

2558

"use_dbus": "True",

2186

2559

"use_ipv6": "True",

2187

2560

"debuglevel": "",

2188

2561

"restore": "True",

2189

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

2190

}

2562

"socket": "",

2563

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

2564

"foreground": "False",

2565

"zeroconf": "True",

2566

}

2191

2567

2192

2568

# Parse config file for server-global settings

2193

2569

server_config = configparser.SafeConfigParser(server_defaults)

2194

2570

del server_defaults

2195

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

2196

"mandos.conf"))

2571

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

2197

2572

# Convert the SafeConfigParser object to a dict

2198

2573

server_settings = server_config.defaults()

2199

2574

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

2200

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

2575

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

2201

2576

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

2202

2577

option)

2203

2578

if server_settings["port"]:

2204

2579

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

2205

2580

"port")

2581

if server_settings["socket"]:

2582

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

2583

"socket")

2584

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

2585

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

2586

# happen with a supplied network socket.

2587

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

2588

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

2589

["socket"])

2206

2590

del server_config

2207

2591

2208

2592

# Override the settings from the config file with command line

2209

2593

# options, if set.

2210

2594

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

2211

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

2212

"use_dbus", "use_ipv6", "debuglevel", "restore",

2213

"statedir"):

2595

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

2596

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

2597

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

2214

2598

value = getattr(options, option)

2215

2599

if value is not None:

2216

2600

server_settings[option] = value

2217

2601

del options

2218

2602

# Force all strings to be unicode

2219

2603

for option in server_settings.keys():

2220

if type(server_settings[option]) is str:

2221

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

2604

if isinstance(server_settings[option], bytes):

2605

server_settings[option] = (server_settings[option]

2606

.decode("utf-8"))

2607

# Force all boolean options to be boolean

2608

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

2609

"foreground", "zeroconf"):

2610

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

2611

# Debug implies foreground

2612

if server_settings["debug"]:

2613

server_settings["foreground"] = True

2222

2614

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

2223

2615

2224

2616

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

2225

2617

2618

if (not server_settings["zeroconf"]

2619

and not (server_settings["port"]

2620

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

2621

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

2622

2226

2623

# For convenience

2227

2624

debug = server_settings["debug"]

2228

2625

debuglevel = server_settings["debuglevel"]

2230

2627

use_ipv6 = server_settings["use_ipv6"]

2231

2628

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

2232

2629

stored_state_file)

2630

foreground = server_settings["foreground"]

2631

zeroconf = server_settings["zeroconf"]

2233

2632

2234

2633

if debug:

2235

2634

initlogger(debug, logging.DEBUG)

2241

2640

initlogger(debug, level)

2242

2641

2243

2642

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

2244

syslogger.setFormatter(logging.Formatter

2245

('Mandos ({0}) [%(process)d]:'

2246

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

2247

.format(server_settings

2248

["servicename"])))

2643

syslogger.setFormatter(

2644

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

2645

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

2646

server_settings["servicename"])))

2249

2647

2250

2648

# Parse config file with clients

2251

2649

client_config = configparser.SafeConfigParser(Client

2256

2654

global mandos_dbus_service

2257

2655

mandos_dbus_service = None

2258

2656

2259

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

2260

server_settings["port"]),

2261

ClientHandler,

2262

interface=(server_settings["interface"]

2263

or None),

2264

use_ipv6=use_ipv6,

2265

gnutls_priority=

2266

server_settings["priority"],

2267

use_dbus=use_dbus)

2268

if not debug:

2269

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

2657

socketfd = None

2658

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

2659

socketfd = server_settings["socket"]

2660

tcp_server = MandosServer(

2661

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

2662

ClientHandler,

2663

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

2664

use_ipv6=use_ipv6,

2665

gnutls_priority=server_settings["priority"],

2666

use_dbus=use_dbus,

2667

socketfd=socketfd)

2668

if not foreground:

2669

pidfilename = "/run/mandos.pid"

2670

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

2671

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

2672

pidfile = None

2270

2673

try:

2271

pidfile = open(pidfilename, "w")

2674

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

2272

2675

except IOError as e:

2273

2676

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

2274

2677

exc_info=e)

2288

2691

os.setuid(uid)

2289

2692

except OSError as error:

2290

2693

if error.errno != errno.EPERM:

2291

raise error

2694

raise

2292

2695

2293

2696

if debug:

2294

2697

# Enable all possible GnuTLS debugging

2301

2704

def debug_gnutls(level, string):

2302

2705

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

2303

2706

2304

(gnutls.library.functions

2305

.gnutls_global_set_log_function(debug_gnutls))

2707

gnutls.library.functions.gnutls_global_set_log_function(

2708

debug_gnutls)

2306

2709

2307

2710

# Redirect stdin so all checkers get /dev/null

2308

2711

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

2311

2714

os.close(null)

2312

2715

2313

2716

# Need to fork before connecting to D-Bus

2314

if not debug:

2717

if not foreground:

2315

2718

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

2316

2719

daemon()

2317

2720

2721

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

2722

# need to inform gobject that threads will be used.

2318

2723

gobject.threads_init()

2319

2724

2320

2725

global main_loop

2326

2731

if use_dbus:

2327

2732

try:

2328

2733

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

2329

bus, do_not_queue=True)

2330

old_bus_name = (dbus.service.BusName

2331

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

2332

do_not_queue=True))

2333

except dbus.exceptions.NameExistsException as e:

2734

bus,

2735

do_not_queue=True)

2736

old_bus_name = dbus.service.BusName(

2737

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

2738

do_not_queue=True)

2739

except dbus.exceptions.DBusException as e:

2334

2740

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

2335

2741

use_dbus = False

2336

2742

server_settings["use_dbus"] = False

2337

2743

tcp_server.use_dbus = False

2338

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2339

service = AvahiServiceToSyslog(name =

2340

server_settings["servicename"],

2341

servicetype = "_mandos._tcp",

2342

protocol = protocol, bus = bus)

2343

if server_settings["interface"]:

2344

service.interface = (if_nametoindex

2345

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

2744

if zeroconf:

2745

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2746

service = AvahiServiceToSyslog(

2747

name = server_settings["servicename"],

2748

servicetype = "_mandos._tcp",

2749

protocol = protocol,

2750

bus = bus)

2751

if server_settings["interface"]:

2752

service.interface = if_nametoindex(

2753

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

2346

2754

2347

2755

global multiprocessing_manager

2348

2756

multiprocessing_manager = multiprocessing.Manager()

2355

2763

old_client_settings = {}

2356

2764

clients_data = {}

2357

2765

2766

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

2767

global wnull

2768

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

2769

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

2770

# mode

2771

if debug or not foreground:

2772

wnull.close()

2773

2358

2774

# Get client data and settings from last running state.

2359

2775

if server_settings["restore"]:

2360

2776

try:

2361

2777

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

2362

clients_data, old_client_settings = (pickle.load

2363

(stored_state))

2778

clients_data, old_client_settings = pickle.load(

2779

stored_state)

2364

2780

os.remove(stored_state_path)

2365

2781

except IOError as e:

2366

2782

if e.errno == errno.ENOENT:

2367

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

2368

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

2783

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

2784

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

2369

2785

else:

2370

2786

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

2371

2787

exc_info=e)

2372

2788

raise

2373

2789

except EOFError as e:

2374

2790

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

2375

"EOFError:", exc_info=e)

2791

"EOFError:",

2792

exc_info=e)

2376

2793

2377

2794

with PGPEngine() as pgp:

2378

for client_name, client in clients_data.iteritems():

2795

for client_name, client in clients_data.items():

2796

# Skip removed clients

2797

if client_name not in client_settings:

2798

continue

2799

2379

2800

# Decide which value to use after restoring saved state.

2380

2801

# We have three different values: Old config file,

2381

2802

# new config file, and saved state.

2386

2807

# For each value in new config, check if it

2387

2808

# differs from the old config value (Except for

2388

2809

# the "secret" attribute)

2389

if (name != "secret" and

2390

value != old_client_settings[client_name]

2391

[name]):

2810

if (name != "secret"

2811

and (value !=

2812

old_client_settings[client_name][name])):

2392

2813

client[name] = value

2393

2814

except KeyError:

2394

2815

pass

2395

2816

2396

2817

# Clients who has passed its expire date can still be

2397

# enabled if its last checker was successful. Clients

2818

# enabled if its last checker was successful. A Client

2398

2819

# whose checker succeeded before we stored its state is

2399

2820

# assumed to have successfully run all checkers during

2400

2821

# downtime.

2402

2823

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

2403

2824

if not client["last_checked_ok"]:

2404

2825

logger.warning(

2405

"disabling client {0} - Client never "

2406

"performed a successful checker"

2407

.format(client_name))

2826

"disabling client {} - Client never "

2827

"performed a successful checker".format(

2828

client_name))

2408

2829

client["enabled"] = False

2409

2830

elif client["last_checker_status"] != 0:

2410

2831

logger.warning(

2411

"disabling client {0} - Client "

2412

"last checker failed with error code {1}"

2413

.format(client_name,

2414

client["last_checker_status"]))

2832

"disabling client {} - Client last"

2833

" checker failed with error code"

2834

" {}".format(

2835

client_name,

2836

client["last_checker_status"]))

2415

2837

client["enabled"] = False

2416

2838

else:

2417

client["expires"] = (datetime.datetime

2418

.utcnow()

2419

+ client["timeout"])

2839

client["expires"] = (

2840

datetime.datetime.utcnow()

2841

+ client["timeout"])

2420

2842

logger.debug("Last checker succeeded,"

2421

" keeping {0} enabled"

2422

.format(client_name))

2843

" keeping {} enabled".format(

2844

client_name))

2423

2845

try:

2424

client["secret"] = (

2425

pgp.decrypt(client["encrypted_secret"],

2426

client_settings[client_name]

2427

["secret"]))

2846

client["secret"] = pgp.decrypt(

2847

client["encrypted_secret"],

2848

client_settings[client_name]["secret"])

2428

2849

except PGPError:

2429

2850

# If decryption fails, we use secret from new settings

2430

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

2431

.format(client_name))

2432

client["secret"] = (

2433

client_settings[client_name]["secret"])

2851

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

2852

client_name))

2853

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

2854

["secret"])

2434

2855

2435

2856

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

2436

2857

for client_name in (set(old_client_settings)

2441

2862

clients_data[client_name] = client_settings[client_name]

2442

2863

2443

2864

# Create all client objects

2444

for client_name, client in clients_data.iteritems():

2865

for client_name, client in clients_data.items():

2445

2866

tcp_server.clients[client_name] = client_class(

2446

name = client_name, settings = client)

2867

name = client_name,

2868

settings = client,

2869

server_settings = server_settings)

2447

2870

2448

2871

if not tcp_server.clients:

2449

2872

logger.warning("No clients defined")

2450

2873

2451

if not debug:

2452

try:

2453

with pidfile:

2454

pid = os.getpid()

2455

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

2456

del pidfile

2457

except IOError:

2458

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

2459

pidfilename, pid)

2460

except NameError:

2461

# "pidfile" was never created

2462

pass

2874

if not foreground:

2875

if pidfile is not None:

2876

pid = os.getpid()

2877

try:

2878

with pidfile:

2879

print(pid, file=pidfile)

2880

except IOError:

2881

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

2882

pidfilename, pid)

2883

del pidfile

2463

2884

del pidfilename

2464

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

2465

2885

2466

2886

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

2467

2887

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

2468

2888

2469

2889

if use_dbus:

2470

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

2471

"se.bsnet.fukt.Mandos"})

2472

class MandosDBusService(DBusObjectWithProperties):

2890

2891

@alternate_dbus_interfaces(

2892

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

2893

class MandosDBusService(DBusObjectWithObjectManager):

2473

2894

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

2895

2474

2896

def __init__(self):

2475

2897

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

2898

2476

2899

_interface = "se.recompile.Mandos"

2477

2900

2478

@dbus_interface_annotations(_interface)

2479

def _foo(self):

2480

return { "org.freedesktop.DBus.Property"

2481

".EmitsChangedSignal":

2482

"false"}

2483

2484

2901

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

2485

2902

def ClientAdded(self, objpath):

2486

2903

"D-Bus signal"

2491

2908

"D-Bus signal"

2492

2909

pass

2493

2910

2911

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

2912

"true"})

2494

2913

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

2495

2914

def ClientRemoved(self, objpath, name):

2496

2915

"D-Bus signal"

2497

2916

pass

2498

2917

2918

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

2919

"true"})

2499

2920

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

2500

2921

def GetAllClients(self):

2501

2922

"D-Bus method"

2502

return dbus.Array(c.dbus_object_path

2503

for c in

2923

return dbus.Array(c.dbus_object_path for c in

2504

2924

tcp_server.clients.itervalues())

2505

2925

2926

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

2927

"true"})

2506

2928

@dbus.service.method(_interface,

2507

2929

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

2508

2930

def GetAllClientsWithProperties(self):

2509

2931

"D-Bus method"

2510

2932

return dbus.Dictionary(

2511

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

2512

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

2933

{ c.dbus_object_path: c.GetAll(

2934

"se.recompile.Mandos.Client")

2935

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

2513

2936

signature="oa{sv}")

2514

2937

2515

2938

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

2519

2942

if c.dbus_object_path == object_path:

2520

2943

del tcp_server.clients[c.name]

2521

2944

c.remove_from_connection()

2522

# Don't signal anything except ClientRemoved

2945

# Don't signal the disabling

2523

2946

c.disable(quiet=True)

2524

# Emit D-Bus signal

2525

self.ClientRemoved(object_path, c.name)

2947

# Emit D-Bus signal for removal

2948

self.client_removed_signal(c)

2526

2949

return

2527

2950

raise KeyError(object_path)

2528

2951

2529

2952

del _interface

2953

2954

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

2955

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

2956

def GetManagedObjects(self):

2957

"""D-Bus method"""

2958

return dbus.Dictionary(

2959

{ client.dbus_object_path:

2960

dbus.Dictionary(

2961

{ interface: client.GetAll(interface)

2962

for interface in

2963

client._get_all_interface_names()})

2964

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

2965

2966

def client_added_signal(self, client):

2967

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

2968

if use_dbus:

2969

# New standard signal

2970

self.InterfacesAdded(

2971

client.dbus_object_path,

2972

dbus.Dictionary(

2973

{ interface: client.GetAll(interface)

2974

for interface in

2975

client._get_all_interface_names()}))

2976

# Old signal

2977

self.ClientAdded(client.dbus_object_path)

2978

2979

def client_removed_signal(self, client):

2980

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

2981

if use_dbus:

2982

# New standard signal

2983

self.InterfacesRemoved(

2984

client.dbus_object_path,

2985

client._get_all_interface_names())

2986

# Old signal

2987

self.ClientRemoved(client.dbus_object_path,

2988

client.name)

2530

2989

2531

2990

mandos_dbus_service = MandosDBusService()

2532

2991

2533

2992

def cleanup():

2534

2993

"Cleanup function; run on exit"

2535

service.cleanup()

2994

if zeroconf:

2995

service.cleanup()

2536

2996

2537

2997

multiprocessing.active_children()

2998

wnull.close()

2538

2999

if not (tcp_server.clients or client_settings):

2539

3000

return

2540

3001

2551

3012

2552

3013

# A list of attributes that can not be pickled

2553

3014

# + secret.

2554

exclude = set(("bus", "changedstate", "secret",

2555

"checker"))

2556

for name, typ in (inspect.getmembers

2557

(dbus.service.Object)):

3015

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

3016

"checker", "server_settings" }

3017

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

3018

.Object):

2558

3019

exclude.add(name)

2559

3020

2560

3021

client_dict["encrypted_secret"] = (client

2567

3028

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

2568

3029

2569

3030

try:

2570

with (tempfile.NamedTemporaryFile

2571

(mode='wb', suffix=".pickle", prefix='clients-',

2572

dir=os.path.dirname(stored_state_path),

2573

delete=False)) as stored_state:

3031

with tempfile.NamedTemporaryFile(

3032

mode='wb',

3033

suffix=".pickle",

3034

prefix='clients-',

3035

dir=os.path.dirname(stored_state_path),

3036

delete=False) as stored_state:

2574

3037

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

2575

tempname=stored_state.name

3038

tempname = stored_state.name

2576

3039

os.rename(tempname, stored_state_path)

2577

3040

except (IOError, OSError) as e:

2578

3041

if not debug:

2581

3044

except NameError:

2582

3045

pass

2583

3046

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

2584

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

3047

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

2585

3048

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

2586

3049

else:

2587

3050

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

2588

3051

exc_info=e)

2589

raise e

3052

raise

2590

3053

2591

3054

# Delete all clients, and settings from config

2592

3055

while tcp_server.clients:

2593

3056

name, client = tcp_server.clients.popitem()

2594

3057

if use_dbus:

2595

3058

client.remove_from_connection()

2596

# Don't signal anything except ClientRemoved

3059

# Don't signal the disabling

2597

3060

client.disable(quiet=True)

2598

if use_dbus:

2599

# Emit D-Bus signal

2600

mandos_dbus_service.ClientRemoved(client

2601

.dbus_object_path,

2602

client.name)

3061

# Emit D-Bus signal for removal

3062

mandos_dbus_service.client_removed_signal(client)

2603

3063

client_settings.clear()

2604

3064

2605

3065

atexit.register(cleanup)

2606

3066

2607

3067

for client in tcp_server.clients.itervalues():

2608

3068

if use_dbus:

2609

# Emit D-Bus signal

2610

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3069

# Emit D-Bus signal for adding

3070

mandos_dbus_service.client_added_signal(client)

2611

3071

# Need to initiate checking of clients

2612

3072

if client.enabled:

2613

3073

client.init_checker()

2616

3076

tcp_server.server_activate()

2617

3077

2618

3078

# Find out what port we got

2619

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

3079

if zeroconf:

3080

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

2620

3081

if use_ipv6:

2621

3082

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

2622

3083

" flowinfo %d, scope_id %d",

2628

3089

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

2629

3090

2630

3091

try:

2631

# From the Avahi example code

2632

try:

2633

service.activate()

2634

except dbus.exceptions.DBusException as error:

2635

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

2636

cleanup()

2637

sys.exit(1)

2638

# End of Avahi example code

3092

if zeroconf:

3093

# From the Avahi example code

3094

try:

3095

service.activate()

3096

except dbus.exceptions.DBusException as error:

3097

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

3098

cleanup()

3099

sys.exit(1)

3100

# End of Avahi example code

2639

3101

2640

3102

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

2641

3103

lambda *args, **kwargs:

2656

3118

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

2657

3119

cleanup()

2658

3120

3121

2659

3122

if __name__ == '__main__':

2660

3123

main()