/mandos/release : revision 237.7.127

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

63

65

import cPickle as pickle

64

66

import multiprocessing

65

67

import types

68

import binascii

69

import tempfile

70

import itertools

66

71

67

72

import dbus

68

73

import dbus.service

73

78

import ctypes.util

74

79

import xml.dom.minidom

75

80

import inspect

81

import GnuPGInterface

76

82

77

83

try:

78

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

88

except ImportError:

83

89

SO_BINDTODEVICE = None

84

90

85

86

version = "1.3.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

91

version = "1.5.3"

92

stored_state_file = "clients.pickle"

93

94

logger = logging.getLogger()

90

95

syslogger = (logging.handlers.SysLogHandler

91

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

97

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

93

syslogger.setFormatter(logging.Formatter

94

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

95

' %(message)s'))

96

logger.addHandler(syslogger)

97

98

console = logging.StreamHandler()

99

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

100

' %(levelname)s:'

101

' %(message)s'))

102

logger.addHandler(console)

98

99

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

103

except (OSError, AttributeError):

104

def if_nametoindex(interface):

105

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

106

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

107

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

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

113

return interface_index

114

115

116

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

117

"""init logger and add loglevel"""

118

119

syslogger.setFormatter(logging.Formatter

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

124

if debug:

125

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

132

133

134

class PGPError(Exception):

135

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

136

pass

137

138

139

class PGPEngine(object):

140

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

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

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

150

151

def __enter__(self):

152

return self

153

154

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

155

self._cleanup()

156

return False

157

158

def __del__(self):

159

self._cleanup()

160

161

def _cleanup(self):

162

if self.tempdir is not None:

163

# Delete contents of tempdir

164

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

165

topdown = False):

166

for filename in files:

167

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

168

for dirname in dirs:

169

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

170

# Remove tempdir

171

os.rmdir(self.tempdir)

172

self.tempdir = None

173

174

def password_encode(self, password):

175

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

176

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

177

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

178

179

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

194

return ciphertext

195

196

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

211

return decrypted_plaintext

212

103

213

104

214

class AvahiError(Exception):

105

215

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

135

245

server: D-Bus Server

136

246

bus: dbus.SystemBus()

137

247

"""

248

138

249

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

139

250

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

140

251

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

153

264

self.server = None

154

265

self.bus = bus

155

266

self.entry_group_state_changed_match = None

267

156

268

def rename(self):

157

269

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

158

270

if self.rename_count >= self.max_renames:

164

276

.GetAlternativeServiceName(self.name))

165

277

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

166

278

self.name)

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

279

self.remove()

172

280

try:

173

281

self.add()

174

282

except dbus.exceptions.DBusException as error:

175

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

283

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

176

284

self.cleanup()

177

285

os._exit(1)

178

286

self.rename_count += 1

287

179

288

def remove(self):

180

289

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

181

290

if self.entry_group_state_changed_match is not None:

183

292

self.entry_group_state_changed_match = None

184

293

if self.group is not None:

185

294

self.group.Reset()

295

186

296

def add(self):

187

297

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

188

298

self.remove()

193

303

avahi.DBUS_INTERFACE_ENTRY_GROUP)

194

304

self.entry_group_state_changed_match = (

195

305

self.group.connect_to_signal(

196

'StateChanged', self .entry_group_state_changed))

306

'StateChanged', self.entry_group_state_changed))

197

307

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

198

308

self.name, self.type)

199

309

self.group.AddService(

205

315

dbus.UInt16(self.port),

206

316

avahi.string_array_to_txt_array(self.TXT))

207

317

self.group.Commit()

318

208

319

def entry_group_state_changed(self, state, error):

209

320

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

210

321

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

217

328

elif state == avahi.ENTRY_GROUP_FAILURE:

218

329

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

219

330

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

331

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

332

.format(error))

333

222

334

def cleanup(self):

223

335

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

224

336

if self.group is not None:

225

337

try:

226

338

self.group.Free()

227

339

except (dbus.exceptions.UnknownMethodException,

228

dbus.exceptions.DBusException) as e:

340

dbus.exceptions.DBusException):

229

341

pass

230

342

self.group = None

231

343

self.remove()

344

232

345

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

233

346

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

234

347

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

253

366

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

254

367

else:

255

368

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

369

256

370

def activate(self):

257

371

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

258

372

if self.server is None:

265

379

self.server_state_changed)

266

380

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

267

381

382

class AvahiServiceToSyslog(AvahiService):

383

def rename(self):

384

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

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

390

return ret

268

391

269

def _timedelta_to_milliseconds(td):

392

def timedelta_to_milliseconds(td):

270

393

"Convert a datetime.timedelta() to milliseconds"

271

394

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

272

395

+ (td.seconds * 1000)

273

396

+ (td.microseconds // 1000))

274

397

275

398

class Client(object):

276

399

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

277

400

278

401

Attributes:

279

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

402

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

280

403

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

281

404

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

282

405

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

289

412

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

290

413

checker_initiator_tag: a gobject event source tag, or None

291

414

created: datetime.datetime(); (UTC) object creation

415

client_structure: Object describing what attributes a client has

416

and is used for storing the client at exit

292

417

current_checker_command: string; current running checker_command

293

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

294

418

disable_initiator_tag: a gobject event source tag, or None

295

419

enabled: bool()

296

420

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

299

423

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

300

424

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

301

425

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

302

last_enabled: datetime.datetime(); (UTC)

426

last_checker_status: integer between 0 and 255 reflecting exit

427

status of last checker. -1 reflects crashed

428

checker, -2 means no checker completed yet.

429

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

303

430

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

304

431

D-Bus identifiers

305

432

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

306

433

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

307

434

until this client is disabled

308

extended_timeout: extra long timeout when password has been sent

435

extended_timeout: extra long timeout when secret has been sent

309

436

runtime_expansions: Allowed attributes for runtime expansion.

310

437

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

311

438

disabled, or None

315

442

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

316

443

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

317

444

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

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

318

455

319

456

def timeout_milliseconds(self):

320

457

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

458

return timedelta_to_milliseconds(self.timeout)

322

459

323

460

def extended_timeout_milliseconds(self):

324

461

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

462

return timedelta_to_milliseconds(self.extended_timeout)

326

463

327

464

def interval_milliseconds(self):

328

465

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

466

return timedelta_to_milliseconds(self.interval)

330

467

331

468

def approval_delay_milliseconds(self):

332

return _timedelta_to_milliseconds(self.approval_delay)

333

334

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

335

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

336

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

337

attribute."""

469

return timedelta_to_milliseconds(self.approval_delay)

470

471

@staticmethod

472

def config_parser(config):

473

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

474

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

475

with exceptions for any special settings as defined above.

476

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

477

value given the same arguments.

478

"""

479

settings = {}

480

for client_name in config.sections():

481

section = dict(config.items(client_name))

482

client = settings[client_name] = {}

483

484

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

485

# Reformat values from string types to Python types

486

client["approved_by_default"] = config.getboolean(

487

client_name, "approved_by_default")

488

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

489

"enabled")

490

491

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

492

.replace(" ", ""))

493

if "secret" in section:

494

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

495

elif "secfile" in section:

496

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

497

(section["secfile"])),

498

"rb") as secfile:

499

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

500

else:

501

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

502

.format(section))

503

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

504

client["extended_timeout"] = string_to_delta(

505

section["extended_timeout"])

506

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

507

client["approval_delay"] = string_to_delta(

508

section["approval_delay"])

509

client["approval_duration"] = string_to_delta(

510

section["approval_duration"])

511

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

512

client["last_approval_request"] = None

513

client["last_checked_ok"] = None

514

client["last_checker_status"] = -2

515

516

return settings

517

518

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

338

519

self.name = name

339

if config is None:

340

config = {}

520

# adding all client settings

521

for setting, value in settings.iteritems():

522

setattr(self, setting, value)

523

524

if self.enabled:

525

if not hasattr(self, "last_enabled"):

526

self.last_enabled = datetime.datetime.utcnow()

527

if not hasattr(self, "expires"):

528

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

529

+ self.timeout)

530

else:

531

self.last_enabled = None

532

self.expires = None

533

341

534

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

342

535

# Uppercase and remove spaces from fingerprint for later

343

536

# comparison purposes with return value from the fingerprint()

344

537

# function

345

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

346

.replace(" ", ""))

347

538

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

348

if "secret" in config:

349

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

350

elif "secfile" in config:

351

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

352

(config["secfile"])),

353

"rb") as secfile:

354

self.secret = secfile.read()

355

else:

356

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

357

% self.name)

358

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

359

self.created = datetime.datetime.utcnow()

360

self.enabled = False

361

self.last_approval_request = None

362

self.last_enabled = None

363

self.last_checked_ok = None

364

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

365

self.extended_timeout = string_to_delta(config

366

["extended_timeout"])

367

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

368

self.disable_hook = disable_hook

539

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

540

datetime.datetime.utcnow())

541

542

# attributes specific for this server instance

369

543

self.checker = None

370

544

self.checker_initiator_tag = None

371

545

self.disable_initiator_tag = None

372

self.expires = None

373

546

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

375

547

self.current_checker_command = None

376

self.last_connect = None

377

self._approved = None

378

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

379

True)

548

self.approved = None

380

549

self.approvals_pending = 0

381

self.approval_delay = string_to_delta(

382

config["approval_delay"])

383

self.approval_duration = string_to_delta(

384

config["approval_duration"])

385

550

self.changedstate = (multiprocessing_manager

386

551

.Condition(multiprocessing_manager

387

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

555

if not attr.startswith("_")]

556

self.client_structure.append("client_structure")

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

562

if not name.startswith("_"):

563

self.client_structure.append(name)

388

564

565

# Send notice to process children that client state has changed

389

566

def send_changedstate(self):

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

567

with self.changedstate:

568

self.changedstate.notify_all()

393

569

394

570

def enable(self):

395

571

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

397

573

# Already enabled

398

574

return

399

575

self.send_changedstate()

400

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

401

# and every interval from then on.

402

self.checker_initiator_tag = (gobject.timeout_add

403

(self.interval_milliseconds(),

404

self.start_checker))

405

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

406

576

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

410

577

self.enabled = True

411

578

self.last_enabled = datetime.datetime.utcnow()

412

# Also start a new checker *right now*.

413

self.start_checker()

579

self.init_checker()

414

580

415

581

def disable(self, quiet=True):

416

582

"""Disable this client."""

428

594

gobject.source_remove(self.checker_initiator_tag)

429

595

self.checker_initiator_tag = None

430

596

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

433

597

self.enabled = False

434

598

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

435

599

return False

436

600

437

601

def __del__(self):

438

self.disable_hook = None

439

602

self.disable()

440

603

604

def init_checker(self):

605

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

606

# and every interval from then on.

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

610

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

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

614

# Also start a new checker *right now*.

615

self.start_checker()

616

441

617

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

442

618

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

443

619

self.checker_callback_tag = None

444

620

self.checker = None

445

621

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

622

self.last_checker_status = os.WEXITSTATUS(condition)

623

if self.last_checker_status == 0:

448

624

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

449

625

vars(self))

450

626

self.checked_ok()

452

628

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

453

629

vars(self))

454

630

else:

631

self.last_checker_status = -1

455

632

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

456

633

vars(self))

457

634

458

def checked_ok(self, timeout=None):

459

"""Bump up the timeout for this client.

460

461

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

462

alive and well.

463

"""

635

def checked_ok(self):

636

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

637

self.last_checked_ok = datetime.datetime.utcnow()

638

self.last_checker_status = 0

639

self.bump_timeout()

640

641

def bump_timeout(self, timeout=None):

642

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

464

643

if timeout is None:

465

644

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

467

gobject.source_remove(self.disable_initiator_tag)

468

self.disable_initiator_tag = (gobject.timeout_add

469

(_timedelta_to_milliseconds

470

(timeout), self.disable))

471

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

645

if self.disable_initiator_tag is not None:

646

gobject.source_remove(self.disable_initiator_tag)

647

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

651

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

472

652

473

653

def need_approval(self):

474

654

self.last_approval_request = datetime.datetime.utcnow()

479

659

If a checker already exists, leave it running and do

480

660

nothing."""

481

661

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

482

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

483

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

484

# client would inevitably timeout, since no checker would get

485

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

662

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

663

# slowly and taking more than 'interval' time, then the client

664

# would inevitably timeout, since no checker would get a

665

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

486

666

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

487

667

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

488

668

# should be.

518

698

try:

519

699

command = self.checker_command % escaped_attrs

520

700

except TypeError as error:

521

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

522

' %s', self.checker_command, error)

701

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

702

self.checker_command, exc_info=error)

523

703

return True # Try again later

524

704

self.current_checker_command = command

525

705

try:

543

723

gobject.source_remove(self.checker_callback_tag)

544

724

self.checker_callback(pid, status, command)

545

725

except OSError as error:

546

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

547

error)

726

logger.error("Failed to start subprocess",

727

exc_info=error)

548

728

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

549

729

return True

550

730

557

737

return

558

738

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

559

739

try:

560

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

740

self.checker.terminate()

561

741

#time.sleep(0.5)

562

742

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

563

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

743

# self.checker.kill()

564

744

except OSError as error:

565

745

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

566

746

raise

583

763

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

584

764

if byte_arrays and signature != "ay":

585

765

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

586

" signature %r" % signature)

766

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

587

767

def decorator(func):

588

768

func._dbus_is_property = True

589

769

func._dbus_interface = dbus_interface

597

777

return decorator

598

778

599

779

780

def dbus_interface_annotations(dbus_interface):

781

"""Decorator for marking functions returning interface annotations

782

783

Usage:

784

785

@dbus_interface_annotations("org.example.Interface")

786

def _foo(self): # Function name does not matter

787

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

788

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

789

"false"}

790

"""

791

def decorator(func):

792

func._dbus_is_interface = True

793

func._dbus_interface = dbus_interface

794

func._dbus_name = dbus_interface

795

return func

796

return decorator

797

798

799

def dbus_annotations(annotations):

800

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

801

Usage:

802

803

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

804

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

808

def Property_dbus_property(self):

809

return dbus.Boolean(False)

810

"""

811

def decorator(func):

812

func._dbus_annotations = annotations

813

return func

814

return decorator

815

816

600

817

class DBusPropertyException(dbus.exceptions.DBusException):

601

818

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

602

819

"""

625

842

"""

626

843

627

844

@staticmethod

628

def _is_dbus_property(obj):

629

return getattr(obj, "_dbus_is_property", False)

845

def _is_dbus_thing(thing):

846

"""Returns a function testing if an attribute is a D-Bus thing

847

848

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

849

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

850

"""

851

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

852

False)

630

853

631

def _get_all_dbus_properties(self):

854

def _get_all_dbus_things(self, thing):

632

855

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

633

856

"""

634

return ((prop.__get__(self)._dbus_name, prop.__get__(self))

857

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

858

name),

859

athing.__get__(self))

635

860

for cls in self.__class__.__mro__

636

for name, prop in

637

inspect.getmembers(cls, self._is_dbus_property))

861

for name, athing in

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

638

864

639

865

def _get_dbus_property(self, interface_name, property_name):

640

866

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

642

868

"""

643

869

for cls in self.__class__.__mro__:

644

870

for name, value in (inspect.getmembers

645

(cls, self._is_dbus_property)):

871

(cls,

872

self._is_dbus_thing("property"))):

646

873

if (value._dbus_name == property_name

647

874

and value._dbus_interface == interface_name):

648

875

return value.__get__(self)

677

904

# signatures other than "ay".

678

905

if prop._dbus_signature != "ay":

679

906

raise ValueError

680

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

681

for byte in value))

907

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

908

for byte in value))

682

909

prop(value)

683

910

684

911

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

689

916

690

917

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

691

918

"""

692

all = {}

693

for name, prop in self._get_all_dbus_properties():

919

properties = {}

920

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

694

921

if (interface_name

695

922

and interface_name != prop._dbus_interface):

696

923

# Interface non-empty but did not match

700

927

continue

701

928

value = prop()

702

929

if not hasattr(value, "variant_level"):

703

all[name] = value

930

properties[name] = value

704

931

continue

705

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

706

value.variant_level+1)

707

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

932

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

933

value.variant_level+1)

934

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

708

935

709

936

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

710

937

out_signature="s",

711

938

path_keyword='object_path',

712

939

connection_keyword='connection')

713

940

def Introspect(self, object_path, connection):

714

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

941

"""Overloading of standard D-Bus method.

942

943

Inserts property tags and interface annotation tags.

715

944

"""

716

945

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

717

946

connection)

724

953

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

725

954

return e

726

955

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

956

# Add property tags

727

957

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

728

958

for name, prop

729

in self._get_all_dbus_properties()

959

in self._get_all_dbus_things("property")

730

960

if prop._dbus_interface

731

961

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

732

962

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)

733

994

# Add the names to the return values for the

734

995

# "org.freedesktop.DBus.Properties" methods

735

996

if (if_tag.getAttribute("name")

750

1011

except (AttributeError, xml.dom.DOMException,

751

1012

xml.parsers.expat.ExpatError) as error:

752

1013

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

753

error)

1014

exc_info=error)

754

1015

return xmlstring

755

1016

756

1017

761

1022

return dbus.String(dt.isoformat(),

762

1023

variant_level=variant_level)

763

1024

764

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

765

.__metaclass__):

766

"""Applied to an empty subclass of a D-Bus object, this metaclass

767

will add additional D-Bus attributes matching a certain pattern.

1025

1026

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1027

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

1028

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

1029

interface names according to the "alt_interface_names" mapping.

1030

Usage:

1031

1032

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

1033

"net.example.AlternateInterface"})

1034

class SampleDBusObject(dbus.service.Object):

1035

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

1036

def SampleDBusMethod():

1037

pass

1038

1039

The above "SampleDBusMethod" on "SampleDBusObject" will be

1040

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

1041

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

1042

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

1043

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

1044

1045

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

1046

(from DBusObjectWithProperties) and interfaces (from the

1047

dbus_interface_annotations decorator).

768

1048

"""

769

def __new__(mcs, name, bases, attr):

770

# Go through all the base classes which could have D-Bus

771

# methods, signals, or properties in them

772

for base in (b for b in bases

773

if issubclass(b, dbus.service.Object)):

774

# Go though all attributes of the base class

775

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

1049

def wrapper(cls):

1050

for orig_interface_name, alt_interface_name in (

1051

alt_interface_names.iteritems()):

1052

attr = {}

1053

interface_names = set()

1054

# Go though all attributes of the class

1055

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

776

1056

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

777

1057

# with the wrong interface name

778

1058

if (not hasattr(attribute, "_dbus_interface")

779

1059

or not attribute._dbus_interface

780

.startswith("se.recompile.Mandos")):

1060

.startswith(orig_interface_name)):

781

1061

continue

782

1062

# Create an alternate D-Bus interface name based on

783

1063

# the current name

784

1064

alt_interface = (attribute._dbus_interface

785

.replace("se.recompile.Mandos",

786

"se.bsnet.fukt.Mandos"))

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1067

interface_names.add(alt_interface)

787

1068

# Is this a D-Bus signal?

788

1069

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

789

1070

# Extract the original non-method function by

804

1085

nonmethod_func.func_name,

805

1086

nonmethod_func.func_defaults,

806

1087

nonmethod_func.func_closure)))

1088

# Copy annotations, if any

1089

try:

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1092

except AttributeError:

1093

pass

807

1094

# Define a creator of a function to call both the

808

# old and new functions, so both the old and new

809

# signals gets sent when the function is called

1095

# original and alternate functions, so both the

1096

# original and alternate signals gets sent when

1097

# the function is called

810

1098

def fixscope(func1, func2):

811

1099

"""This function is a scope container to pass

812

1100

func1 and func2 to the "call_both" function

819

1107

return call_both

820

1108

# Create the "call_both" function and add it to

821

1109

# the class

822

attr[attrname] = fixscope(attribute,

823

new_function)

1110

attr[attrname] = fixscope(attribute, new_function)

824

1111

# Is this a D-Bus method?

825

1112

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

826

1113

# Create a new, but exactly alike, function

837

1124

attribute.func_name,

838

1125

attribute.func_defaults,

839

1126

attribute.func_closure)))

1127

# Copy annotations, if any

1128

try:

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1131

except AttributeError:

1132

pass

840

1133

# Is this a D-Bus property?

841

1134

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

842

1135

# Create a new, but exactly alike, function

856

1149

attribute.func_name,

857

1150

attribute.func_defaults,

858

1151

attribute.func_closure)))

859

return type.__new__(mcs, name, bases, attr)

860

1152

# Copy annotations, if any

1153

try:

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1156

except AttributeError:

1157

pass

1158

# Is this a D-Bus interface?

1159

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

1160

# Create a new, but exactly alike, function

1161

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

1162

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

1163

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

1172

if deprecate:

1173

# Deprecate all alternate interfaces

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1175

for interface_name in interface_names:

1176

@dbus_interface_annotations(interface_name)

1177

def func(self):

1178

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

1179

"true" }

1180

# Find an unused name

1181

for aname in (iname.format(i)

1182

for i in itertools.count()):

1183

if aname not in attr:

1184

attr[aname] = func

1185

break

1186

if interface_names:

1187

# Replace the class with a new subclass of it with

1188

# methods, signals, etc. as created above.

1189

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

1190

(cls,), attr)

1191

return cls

1192

return wrapper

1193

1194

1195

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

1196

"se.bsnet.fukt.Mandos"})

861

1197

class ClientDBus(Client, DBusObjectWithProperties):

862

1198

"""A Client class using D-Bus

863

1199

872

1208

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

873

1209

874

1210

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

875

self._approvals_pending = 0

876

1211

self.bus = bus

877

1212

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

878

1213

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

884

1219

("/clients/" + client_object_name))

885

1220

DBusObjectWithProperties.__init__(self, self.bus,

886

1221

self.dbus_object_path)

887

1222

888

1223

def notifychangeproperty(transform_func,

889

1224

dbus_name, type_func=lambda x: x,

890

1225

variant_level=1):

891

1226

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

892

1227

its changes to DBus.

893

894

transform_fun: Function that takes a value and transforms it

895

to a D-Bus type.

1228

1229

transform_fun: Function that takes a value and a variant_level

1230

and transforms it to a D-Bus type.

896

1231

dbus_name: D-Bus name of the variable

897

1232

type_func: Function that transform the value before sending it

898

1233

to the D-Bus. Default: no transform

905

1240

type_func(getattr(self, attrname, None))

906

1241

!= type_func(value)):

907

1242

dbus_value = transform_func(type_func(value),

908

variant_level)

1243

variant_level

1244

=variant_level)

909

1245

self.PropertyChanged(dbus.String(dbus_name),

910

1246

dbus_value)

911

1247

setattr(self, attrname, value)

912

1248

913

1249

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

914

1250

915

916

1251

expires = notifychangeproperty(datetime_to_dbus, "Expires")

917

1252

approvals_pending = notifychangeproperty(dbus.Boolean,

918

1253

"ApprovalPending",

925

1260

checker is not None)

926

1261

last_checked_ok = notifychangeproperty(datetime_to_dbus,

927

1262

"LastCheckedOK")

1263

last_checker_status = notifychangeproperty(dbus.Int16,

1264

"LastCheckerStatus")

928

1265

last_approval_request = notifychangeproperty(

929

1266

datetime_to_dbus, "LastApprovalRequest")

930

1267

approved_by_default = notifychangeproperty(dbus.Boolean,

931

1268

"ApprovedByDefault")

932

approval_delay = notifychangeproperty(dbus.UInt16,

1269

approval_delay = notifychangeproperty(dbus.UInt64,

933

1270

"ApprovalDelay",

934

1271

type_func =

935

_timedelta_to_milliseconds)

1272

timedelta_to_milliseconds)

936

1273

approval_duration = notifychangeproperty(

937

dbus.UInt16, "ApprovalDuration",

938

type_func = _timedelta_to_milliseconds)

1274

dbus.UInt64, "ApprovalDuration",

1275

type_func = timedelta_to_milliseconds)

939

1276

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

940

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

1277

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

941

1278

type_func =

942

_timedelta_to_milliseconds)

1279

timedelta_to_milliseconds)

943

1280

extended_timeout = notifychangeproperty(

944

dbus.UInt16, "ExtendedTimeout",

945

type_func = _timedelta_to_milliseconds)

946

interval = notifychangeproperty(dbus.UInt16,

1281

dbus.UInt64, "ExtendedTimeout",

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

947

1284

"Interval",

948

1285

type_func =

949

_timedelta_to_milliseconds)

1286

timedelta_to_milliseconds)

950

1287

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

951

1288

952

1289

del notifychangeproperty

994

1331

return r

995

1332

996

1333

def _reset_approved(self):

997

self._approved = None

1334

self.approved = None

998

1335

return False

999

1336

1000

1337

def approve(self, value=True):

1001

1338

self.send_changedstate()

1002

self._approved = value

1003

gobject.timeout_add(_timedelta_to_milliseconds

1339

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1004

1341

(self.approval_duration),

1005

1342

self._reset_approved)

1006

1343

1007

1008

1344

## D-Bus methods, signals & properties

1009

1345

_interface = "se.recompile.Mandos.Client"

1010

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1011

1354

## Signals

1012

1355

1013

1356

# CheckerCompleted - signal

1112

1455

access="readwrite")

1113

1456

def ApprovalDuration_dbus_property(self, value=None):

1114

1457

if value is None: # get

1115

return dbus.UInt64(_timedelta_to_milliseconds(

1458

return dbus.UInt64(timedelta_to_milliseconds(

1116

1459

self.approval_duration))

1117

1460

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

1118

1461

1132

1475

def Host_dbus_property(self, value=None):

1133

1476

if value is None: # get

1134

1477

return dbus.String(self.host)

1135

self.host = value

1478

self.host = unicode(value)

1136

1479

1137

1480

# Created - property

1138

1481

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

1139

1482

def Created_dbus_property(self):

1140

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

1483

return datetime_to_dbus(self.created)

1141

1484

1142

1485

# LastEnabled - property

1143

1486

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

1164

1507

return

1165

1508

return datetime_to_dbus(self.last_checked_ok)

1166

1509

1510

# LastCheckerStatus - property

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

1513

def LastCheckerStatus_dbus_property(self):

1514

return dbus.Int16(self.last_checker_status)

1515

1167

1516

# Expires - property

1168

1517

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

1169

1518

def Expires_dbus_property(self):

1181

1530

if value is None: # get

1182

1531

return dbus.UInt64(self.timeout_milliseconds())

1183

1532

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

1184

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

1185

return

1186

1533

# Reschedule timeout

1187

gobject.source_remove(self.disable_initiator_tag)

1188

self.disable_initiator_tag = None

1189

self.expires = None

1190

time_to_die = (self.

1191

_timedelta_to_milliseconds((self

1192

.last_checked_ok

1193

+ self.timeout)

1194

- datetime.datetime

1195

.utcnow()))

1196

if time_to_die <= 0:

1197

# The timeout has passed

1198

self.disable()

1199

else:

1200

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

1201

+ datetime.timedelta(milliseconds =

1202

time_to_die))

1203

self.disable_initiator_tag = (gobject.timeout_add

1204

(time_to_die, self.disable))

1534

if self.enabled:

1535

now = datetime.datetime.utcnow()

1536

time_to_die = timedelta_to_milliseconds(

1537

(self.last_checked_ok + self.timeout) - now)

1538

if time_to_die <= 0:

1539

# The timeout has passed

1540

self.disable()

1541

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

1545

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

1546

is None):

1547

return

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1205

1552

1206

1553

# ExtendedTimeout - property

1207

1554

@dbus_service_property(_interface, signature="t",

1220

1567

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

1221

1568

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

1222

1569

return

1223

# Reschedule checker run

1224

gobject.source_remove(self.checker_initiator_tag)

1225

self.checker_initiator_tag = (gobject.timeout_add

1226

(value, self.start_checker))

1227

self.start_checker() # Start one now, too

1570

if self.enabled:

1571

# Reschedule checker run

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1228

1576

1229

1577

# Checker - property

1230

1578

@dbus_service_property(_interface, signature="s",

1232

1580

def Checker_dbus_property(self, value=None):

1233

1581

if value is None: # get

1234

1582

return dbus.String(self.checker_command)

1235

self.checker_command = value

1583

self.checker_command = unicode(value)

1236

1584

1237

1585

# CheckerRunning - property

1238

1586

@dbus_service_property(_interface, signature="b",

1267

1615

raise KeyError()

1268

1616

1269

1617

def __getattribute__(self, name):

1270

if(name == '_pipe'):

1618

if name == '_pipe':

1271

1619

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

1272

1620

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

1273

1621

data = self._pipe.recv()

1280

1628

return func

1281

1629

1282

1630

def __setattr__(self, name, value):

1283

if(name == '_pipe'):

1631

if name == '_pipe':

1284

1632

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

1285

1633

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

1286

1634

1287

class ClientDBusTransitional(ClientDBus):

1288

__metaclass__ = AlternateDBusNamesMetaclass

1289

1635

1290

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

1291

1637

"""A class to handle client connections.

1374

1720

client.Rejected("Disabled")

1375

1721

return

1376

1722

1377

if client._approved or not client.approval_delay:

1723

if client.approved or not client.approval_delay:

1378

1724

#We are approved or approval is disabled

1379

1725

break

1380

elif client._approved is None:

1726

elif client.approved is None:

1381

1727

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

1382

1728

client.name)

1383

1729

if self.server.use_dbus:

1397

1743

time = datetime.datetime.now()

1398

1744

client.changedstate.acquire()

1399

1745

(client.changedstate.wait

1400

(float(client._timedelta_to_milliseconds(delay)

1746

(float(client.timedelta_to_milliseconds(delay)

1401

1747

/ 1000)))

1402

1748

client.changedstate.release()

1403

1749

time2 = datetime.datetime.now()

1420

1766

try:

1421

1767

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

1422

1768

except gnutls.errors.GNUTLSError as error:

1423

logger.warning("gnutls send failed")

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1424

1771

return

1425

1772

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

1426

1773

sent, len(client.secret)

1428

1775

sent_size += sent

1429

1776

1430

1777

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

1431

# bump the timeout as if seen

1432

client.checked_ok(client.extended_timeout)

1778

# bump the timeout using extended_timeout

1779

client.bump_timeout(client.extended_timeout)

1433

1780

if self.server.use_dbus:

1434

1781

# Emit D-Bus signal

1435

1782

client.GotSecret()

1440

1787

try:

1441

1788

session.bye()

1442

1789

except gnutls.errors.GNUTLSError as error:

1443

logger.warning("GnuTLS bye failed")

1790

logger.warning("GnuTLS bye failed",

1791

exc_info=error)

1444

1792

1445

1793

@staticmethod

1446

1794

def peer_certificate(session):

1502

1850

# Convert the buffer to a Python bytestring

1503

1851

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

1504

1852

# Convert the bytestring to hexadecimal notation

1505

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

1853

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

1506

1854

return hex_fpr

1507

1855

1508

1856

1511

1859

def sub_process_main(self, request, address):

1512

1860

try:

1513

1861

self.finish_request(request, address)

1514

except:

1862

except Exception:

1515

1863

self.handle_error(request, address)

1516

1864

self.close_request(request)

1517

1865

1518

1866

def process_request(self, request, address):

1519

1867

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

1520

1868

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

1521

args = (request,

1522

address))

1869

args = (request, address))

1523

1870

proc.start()

1524

1871

return proc

1525

1872

1622

1969

self.enabled = False

1623

1970

self.clients = clients

1624

1971

if self.clients is None:

1625

self.clients = set()

1972

self.clients = {}

1626

1973

self.use_dbus = use_dbus

1627

1974

self.gnutls_priority = gnutls_priority

1628

1975

IPv6_TCPServer.__init__(self, server_address,

1647

1994

1648

1995

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

1649

1996

proc = None, client_object=None):

1650

condition_names = {

1651

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

1652

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

1653

# blocking).

1654

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

1655

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

1656

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

1657

# broken, usually for pipes and

1658

# sockets).

1659

}

1660

conditions_string = ' | '.join(name

1661

for cond, name in

1662

condition_names.iteritems()

1663

if cond & condition)

1664

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

1665

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

1997

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

1998

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

1999

# Wait for other process to exit

1666

2000

proc.join()

1667

2001

return False

1668

2002

1674

2008

fpr = request[1]

1675

2009

address = request[2]

1676

2010

1677

for c in self.clients:

2011

for c in self.clients.itervalues():

1678

2012

if c.fingerprint == fpr:

1679

2013

client = c

1680

2014

break

1757

2091

elif suffix == "w":

1758

2092

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

1759

2093

else:

1760

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

2094

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

2095

.format(suffix))

1761

2096

except (ValueError, IndexError) as e:

1762

2097

raise ValueError(*(e.args))

1763

2098

timevalue += delta

1764

2099

return timevalue

1765

2100

1766

2101

1767

def if_nametoindex(interface):

1768

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

1769

1770

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

1771

global if_nametoindex

1772

try:

1773

if_nametoindex = (ctypes.cdll.LoadLibrary

1774

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

1775

.if_nametoindex)

1776

except (OSError, AttributeError):

1777

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

1778

def if_nametoindex(interface):

1779

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

1780

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

1781

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

1782

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1783

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

1784

interface))

1785

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

1786

ifreq[16:20])[0]

1787

return interface_index

1788

return if_nametoindex(interface)

1789

1790

1791

2102

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

1792

2103

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

1793

2104

1801

2112

sys.exit()

1802

2113

if not noclose:

1803

2114

# Close all standard open file descriptors

1804

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

2115

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

1805

2116

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

1806

2117

raise OSError(errno.ENODEV,

1807

"%s not a character device"

1808

% os.path.devnull)

2118

"{0} not a character device"

2119

.format(os.devnull))

1809

2120

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

1810

2121

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

1811

2122

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

1820

2131

1821

2132

parser = argparse.ArgumentParser()

1822

2133

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

1823

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

2134

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

1824

2135

help="show version number and exit")

1825

2136

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

1826

2137

help="Bind to interface IF")

1848

2159

" system bus interface")

1849

2160

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

1850

2161

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

2162

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

2163

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

2164

" state")

2165

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

2166

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

2167

1851

2168

options = parser.parse_args()

1852

2169

1853

2170

if options.check:

1866

2183

"use_dbus": "True",

1867

2184

"use_ipv6": "True",

1868

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

1869

2188

}

1870

2189

1871

2190

# Parse config file for server-global settings

1888

2207

# options, if set.

1889

2208

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

1890

2209

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

1891

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

2210

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

2211

"statedir"):

1892

2212

value = getattr(options, option)

1893

2213

if value is not None:

1894

2214

server_settings[option] = value

1906

2226

debuglevel = server_settings["debuglevel"]

1907

2227

use_dbus = server_settings["use_dbus"]

1908

2228

use_ipv6 = server_settings["use_ipv6"]

2229

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

2230

stored_state_file)

2231

2232

if debug:

2233

initlogger(debug, logging.DEBUG)

2234

else:

2235

if not debuglevel:

2236

initlogger(debug)

2237

else:

2238

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

2239

initlogger(debug, level)

1909

2240

1910

2241

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

1911

2242

syslogger.setFormatter(logging.Formatter

1912

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

1913

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

1914

% server_settings["servicename"]))

2243

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

2244

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

2245

.format(server_settings

2246

["servicename"])))

1915

2247

1916

2248

# Parse config file with clients

1917

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

1918

"extended_timeout": "15m",

1919

"interval": "2m",

1920

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

1921

"host": "",

1922

"approval_delay": "0s",

1923

"approval_duration": "1s",

1924

}

1925

client_config = configparser.SafeConfigParser(client_defaults)

2249

client_config = configparser.SafeConfigParser(Client

2250

.client_defaults)

1926

2251

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

1927

2252

"clients.conf"))

1928

2253

1942

2267

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

1943

2268

try:

1944

2269

pidfile = open(pidfilename, "w")

1945

except IOError:

1946

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

2270

except IOError as e:

2271

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

2272

exc_info=e)

1947

2273

1948

try:

1949

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

1950

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

1951

except KeyError:

2274

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

1952

2275

try:

1953

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

1954

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

2276

uid = pwd.getpwnam(name).pw_uid

2277

gid = pwd.getpwnam(name).pw_gid

2278

break

1955

2279

except KeyError:

1956

try:

1957

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

1958

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

1959

except KeyError:

1960

uid = 65534

1961

gid = 65534

2280

continue

2281

else:

2282

uid = 65534

2283

gid = 65534

1962

2284

try:

1963

2285

os.setgid(gid)

1964

2286

os.setuid(uid)

1966

2288

if error[0] != errno.EPERM:

1967

2289

raise error

1968

2290

1969

if not debug and not debuglevel:

1970

syslogger.setLevel(logging.WARNING)

1971

console.setLevel(logging.WARNING)

1972

if debuglevel:

1973

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

1974

syslogger.setLevel(level)

1975

console.setLevel(level)

1976

1977

2291

if debug:

1978

2292

# Enable all possible GnuTLS debugging

1979

2293

1989

2303

.gnutls_global_set_log_function(debug_gnutls))

1990

2304

1991

2305

# Redirect stdin so all checkers get /dev/null

1992

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

2306

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

1993

2307

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

1994

2308

if null > 2:

1995

2309

os.close(null)

1996

else:

1997

# No console logging

1998

logger.removeHandler(console)

1999

2310

2000

2311

# Need to fork before connecting to D-Bus

2001

2312

if not debug:

2002

2313

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

2003

2314

daemon()

2004

2315

2316

gobject.threads_init()

2317

2005

2318

global main_loop

2006

2319

# From the Avahi example code

2007

DBusGMainLoop(set_as_default=True )

2320

DBusGMainLoop(set_as_default=True)

2008

2321

main_loop = gobject.MainLoop()

2009

2322

bus = dbus.SystemBus()

2010

2323

# End of Avahi example code

2016

2329

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

2017

2330

do_not_queue=True))

2018

2331

except dbus.exceptions.NameExistsException as e:

2019

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

2332

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

2020

2333

use_dbus = False

2021

2334

server_settings["use_dbus"] = False

2022

2335

tcp_server.use_dbus = False

2023

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2024

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

2025

servicetype = "_mandos._tcp",

2026

protocol = protocol, bus = bus)

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2027

2341

if server_settings["interface"]:

2028

2342

service.interface = (if_nametoindex

2029

2343

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

2033

2347

2034

2348

client_class = Client

2035

2349

if use_dbus:

2036

client_class = functools.partial(ClientDBusTransitional,

2037

bus = bus)

2038

def client_config_items(config, section):

2039

special_settings = {

2040

"approved_by_default":

2041

lambda: config.getboolean(section,

2042

"approved_by_default"),

2043

}

2044

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

2350

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

2351

2352

client_settings = Client.config_parser(client_config)

2353

old_client_settings = {}

2354

clients_data = {}

2355

2356

# Get client data and settings from last running state.

2357

if server_settings["restore"]:

2358

try:

2359

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

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

2362

os.remove(stored_state_path)

2363

except IOError as e:

2364

if e.errno == errno.ENOENT:

2365

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

2366

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

2367

else:

2368

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

2369

exc_info=e)

2370

raise

2371

except EOFError as e:

2372

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

2373

"EOFError:", exc_info=e)

2374

2375

with PGPEngine() as pgp:

2376

for client_name, client in clients_data.iteritems():

2377

# Decide which value to use after restoring saved state.

2378

# We have three different values: Old config file,

2379

# new config file, and saved state.

2380

# New config value takes precedence if it differs from old

2381

# config value, otherwise use saved state.

2382

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

2383

try:

2384

# For each value in new config, check if it

2385

# differs from the old config value (Except for

2386

# the "secret" attribute)

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

2390

client[name] = value

2391

except KeyError:

2392

pass

2393

2394

# Clients who has passed its expire date can still be

2395

# enabled if its last checker was successful. Clients

2396

# whose checker succeeded before we stored its state is

2397

# assumed to have successfully run all checkers during

2398

# downtime.

2399

if client["enabled"]:

2400

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

2401

if not client["last_checked_ok"]:

2402

logger.warning(

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

2406

client["enabled"] = False

2407

elif client["last_checker_status"] != 0:

2408

logger.warning(

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

2413

client["enabled"] = False

2414

else:

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

2418

logger.debug("Last checker succeeded,"

2419

" keeping {0} enabled"

2420

.format(client_name))

2045

2421

try:

2046

yield (name, special_settings[name]())

2047

except KeyError:

2048

yield (name, value)

2049

2050

tcp_server.clients.update(set(

2051

client_class(name = section,

2052

config= dict(client_config_items(

2053

client_config, section)))

2054

for section in client_config.sections()))

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

2426

except PGPError:

2427

# If decryption fails, we use secret from new settings

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

2433

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

2434

for client_name in (set(old_client_settings)

2435

- set(client_settings)):

2436

del clients_data[client_name]

2437

for client_name in (set(client_settings)

2438

- set(old_client_settings)):

2439

clients_data[client_name] = client_settings[client_name]

2440

2441

# Create all client objects

2442

for client_name, client in clients_data.iteritems():

2443

tcp_server.clients[client_name] = client_class(

2444

name = client_name, settings = client)

2445

2055

2446

if not tcp_server.clients:

2056

2447

logger.warning("No clients defined")

2057

2448

2058

2449

if not debug:

2059

2450

try:

2060

2451

with pidfile:

2068

2459

# "pidfile" was never created

2069

2460

pass

2070

2461

del pidfilename

2071

2072

2462

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

2073

2463

2074

2464

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

2075

2465

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

2076

2466

2077

2467

if use_dbus:

2078

class MandosDBusService(dbus.service.Object):

2468

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

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

2079

2471

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

2080

2472

def __init__(self):

2081

2473

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

2082

2474

_interface = "se.recompile.Mandos"

2083

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

2084

2482

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

2085

2483

def ClientAdded(self, objpath):

2086

2484

"D-Bus signal"

2100

2498

def GetAllClients(self):

2101

2499

"D-Bus method"

2102

2500

return dbus.Array(c.dbus_object_path

2103

for c in tcp_server.clients)

2501

for c in

2502

tcp_server.clients.itervalues())

2104

2503

2105

2504

@dbus.service.method(_interface,

2106

2505

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

2108

2507

"D-Bus method"

2109

2508

return dbus.Dictionary(

2110

2509

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

2111

for c in tcp_server.clients),

2510

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

2112

2511

signature="oa{sv}")

2113

2512

2114

2513

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

2115

2514

def RemoveClient(self, object_path):

2116

2515

"D-Bus method"

2117

for c in tcp_server.clients:

2516

for c in tcp_server.clients.itervalues():

2118

2517

if c.dbus_object_path == object_path:

2119

tcp_server.clients.remove(c)

2518

del tcp_server.clients[c.name]

2120

2519

c.remove_from_connection()

2121

2520

# Don't signal anything except ClientRemoved

2122

2521

c.disable(quiet=True)

2127

2526

2128

2527

del _interface

2129

2528

2130

class MandosDBusServiceTransitional(MandosDBusService):

2131

__metaclass__ = AlternateDBusNamesMetaclass

2132

mandos_dbus_service = MandosDBusServiceTransitional()

2529

mandos_dbus_service = MandosDBusService()

2133

2530

2134

2531

def cleanup():

2135

2532

"Cleanup function; run on exit"

2136

2533

service.cleanup()

2137

2534

2138

2535

multiprocessing.active_children()

2536

if not (tcp_server.clients or client_settings):

2537

return

2538

2539

# Store client before exiting. Secrets are encrypted with key

2540

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

2541

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

2542

clients = {}

2543

with PGPEngine() as pgp:

2544

for client in tcp_server.clients.itervalues():

2545

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

2546

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

2547

key)

2548

client_dict = {}

2549

2550

# A list of attributes that can not be pickled

2551

# + secret.

2552

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

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

2556

exclude.add(name)

2557

2558

client_dict["encrypted_secret"] = (client

2559

.encrypted_secret)

2560

for attr in client.client_structure:

2561

if attr not in exclude:

2562

client_dict[attr] = getattr(client, attr)

2563

2564

clients[client.name] = client_dict

2565

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

2566

2567

try:

2568

with (tempfile.NamedTemporaryFile

2569

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

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

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

2573

tempname=stored_state.name

2574

os.rename(tempname, stored_state_path)

2575

except (IOError, OSError) as e:

2576

if not debug:

2577

try:

2578

os.remove(tempname)

2579

except NameError:

2580

pass

2581

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

2582

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

2583

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

2584

else:

2585

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

2586

exc_info=e)

2587

raise e

2588

2589

# Delete all clients, and settings from config

2139

2590

while tcp_server.clients:

2140

client = tcp_server.clients.pop()

2591

name, client = tcp_server.clients.popitem()

2141

2592

if use_dbus:

2142

2593

client.remove_from_connection()

2143

client.disable_hook = None

2144

2594

# Don't signal anything except ClientRemoved

2145

2595

client.disable(quiet=True)

2146

2596

if use_dbus:

2148

2598

mandos_dbus_service.ClientRemoved(client

2149

2599

.dbus_object_path,

2150

2600

client.name)

2601

client_settings.clear()

2151

2602

2152

2603

atexit.register(cleanup)

2153

2604

2154

for client in tcp_server.clients:

2605

for client in tcp_server.clients.itervalues():

2155

2606

if use_dbus:

2156

2607

# Emit D-Bus signal

2157

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2158

client.enable()

2609

# Need to initiate checking of clients

2610

if client.enabled:

2611

client.init_checker()

2159

2612

2160

2613

tcp_server.enable()

2161

2614

tcp_server.server_activate()

2164

2617

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

2165

2618

if use_ipv6:

2166

2619

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

2167

" flowinfo %d, scope_id %d"

2168

% tcp_server.socket.getsockname())

2620

" flowinfo %d, scope_id %d",

2621

*tcp_server.socket.getsockname())

2169

2622

else: # IPv4

2170

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

2171

% tcp_server.socket.getsockname())

2623

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

2624

*tcp_server.socket.getsockname())

2172

2625

2173

2626

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

2174

2627

2177

2630

try:

2178

2631

service.activate()

2179

2632

except dbus.exceptions.DBusException as error:

2180

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

2633

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

2181

2634

cleanup()

2182

2635

sys.exit(1)

2183

2636

# End of Avahi example code

2190

2643

logger.debug("Starting main loop")

2191

2644

main_loop.run()

2192

2645

except AvahiError as error:

2193

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

2646

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

2194

2647

cleanup()

2195

2648

sys.exit(1)

2196

2649

except KeyboardInterrupt:

2201

2654

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

2202

2655

cleanup()

2203

2656

2204

2205

2657

if __name__ == '__main__':

2206

2658

main()