/mandos/release : revision 237.7.123

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

63

import cPickle as pickle

64

import multiprocessing

65

import types

66

import binascii

67

import tempfile

68

import itertools

66

69

67

70

import dbus

68

71

import dbus.service

73

76

import ctypes.util

74

77

import xml.dom.minidom

75

78

import inspect

79

import GnuPGInterface

76

80

77

81

try:

78

82

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

82

86

except ImportError:

83

87

SO_BINDTODEVICE = None

84

88

85

86

version = "1.3.1"

87

88

#logger = logging.getLogger('mandos')

89

logger = logging.Logger('mandos')

89

version = "1.5.3"

90

stored_state_file = "clients.pickle"

91

92

logger = logging.getLogger()

90

93

syslogger = (logging.handlers.SysLogHandler

91

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

92

95

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)

96

97

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

101

except (OSError, AttributeError):

102

def if_nametoindex(interface):

103

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

104

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

105

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

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

111

return interface_index

112

113

114

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

115

"""init logger and add loglevel"""

116

117

syslogger.setFormatter(logging.Formatter

118

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

119

' %(message)s'))

120

logger.addHandler(syslogger)

121

122

if debug:

123

console = logging.StreamHandler()

124

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

125

' [%(process)d]:'

126

' %(levelname)s:'

127

' %(message)s'))

128

logger.addHandler(console)

129

logger.setLevel(level)

130

131

132

class PGPError(Exception):

133

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

134

pass

135

136

137

class PGPEngine(object):

138

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

139

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

148

149

def __enter__(self):

150

return self

151

152

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

153

self._cleanup()

154

return False

155

156

def __del__(self):

157

self._cleanup()

158

159

def _cleanup(self):

160

if self.tempdir is not None:

161

# Delete contents of tempdir

162

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

163

topdown = False):

164

for filename in files:

165

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

166

for dirname in dirs:

167

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

168

# Remove tempdir

169

os.rmdir(self.tempdir)

170

self.tempdir = None

171

172

def password_encode(self, password):

173

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

174

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

175

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

176

177

def encrypt(self, data, password):

178

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

179

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

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

192

return ciphertext

193

194

def decrypt(self, data, password):

195

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

196

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

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

209

return decrypted_plaintext

210

103

211

104

212

class AvahiError(Exception):

105

213

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

135

243

server: D-Bus Server

136

244

bus: dbus.SystemBus()

137

245

"""

246

138

247

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

139

248

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

140

249

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

153

262

self.server = None

154

263

self.bus = bus

155

264

self.entry_group_state_changed_match = None

265

156

266

def rename(self):

157

267

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

158

268

if self.rename_count >= self.max_renames:

164

274

.GetAlternativeServiceName(self.name))

165

275

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

166

276

self.name)

167

syslogger.setFormatter(logging.Formatter

168

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

169

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

170

% self.name))

171

277

self.remove()

172

278

try:

173

279

self.add()

174

280

except dbus.exceptions.DBusException as error:

175

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

281

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

176

282

self.cleanup()

177

283

os._exit(1)

178

284

self.rename_count += 1

285

179

286

def remove(self):

180

287

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

181

288

if self.entry_group_state_changed_match is not None:

183

290

self.entry_group_state_changed_match = None

184

291

if self.group is not None:

185

292

self.group.Reset()

293

186

294

def add(self):

187

295

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

188

296

self.remove()

193

301

avahi.DBUS_INTERFACE_ENTRY_GROUP)

194

302

self.entry_group_state_changed_match = (

195

303

self.group.connect_to_signal(

196

'StateChanged', self .entry_group_state_changed))

304

'StateChanged', self.entry_group_state_changed))

197

305

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

198

306

self.name, self.type)

199

307

self.group.AddService(

205

313

dbus.UInt16(self.port),

206

314

avahi.string_array_to_txt_array(self.TXT))

207

315

self.group.Commit()

316

208

317

def entry_group_state_changed(self, state, error):

209

318

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

210

319

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

217

326

elif state == avahi.ENTRY_GROUP_FAILURE:

218

327

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

219

328

unicode(error))

220

raise AvahiGroupError("State changed: %s"

221

% unicode(error))

329

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

330

.format(error))

331

222

332

def cleanup(self):

223

333

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

224

334

if self.group is not None:

225

335

try:

226

336

self.group.Free()

227

337

except (dbus.exceptions.UnknownMethodException,

228

dbus.exceptions.DBusException) as e:

338

dbus.exceptions.DBusException):

229

339

pass

230

340

self.group = None

231

341

self.remove()

342

232

343

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

233

344

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

234

345

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

253

364

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

254

365

else:

255

366

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

367

256

368

def activate(self):

257

369

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

258

370

if self.server is None:

265

377

self.server_state_changed)

266

378

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

267

379

380

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

382

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

383

ret = AvahiService.rename(self)

384

syslogger.setFormatter(logging.Formatter

385

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

386

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

387

.format(self.name)))

388

return ret

268

389

269

def _timedelta_to_milliseconds(td):

390

def timedelta_to_milliseconds(td):

270

391

"Convert a datetime.timedelta() to milliseconds"

271

392

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

272

393

+ (td.seconds * 1000)

273

394

+ (td.microseconds // 1000))

274

395

275

396

class Client(object):

276

397

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

277

398

278

399

Attributes:

279

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

400

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

280

401

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

281

402

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

282

403

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

289

410

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

290

411

checker_initiator_tag: a gobject event source tag, or None

291

412

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

413

client_structure: Object describing what attributes a client has

414

and is used for storing the client at exit

292

415

current_checker_command: string; current running checker_command

293

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

294

416

disable_initiator_tag: a gobject event source tag, or None

295

417

enabled: bool()

296

418

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

299

421

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

300

422

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

301

423

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

302

last_enabled: datetime.datetime(); (UTC)

424

last_checker_status: integer between 0 and 255 reflecting exit

425

status of last checker. -1 reflects crashed

426

checker, -2 means no checker completed yet.

427

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

303

428

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

304

429

D-Bus identifiers

305

430

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

306

431

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

307

432

until this client is disabled

308

extended_timeout: extra long timeout when password has been sent

433

extended_timeout: extra long timeout when secret has been sent

309

434

runtime_expansions: Allowed attributes for runtime expansion.

310

435

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

311

436

disabled, or None

315

440

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

316

441

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

317

442

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

443

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

444

"extended_timeout": "15m",

445

"interval": "2m",

446

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

447

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

450

"approved_by_default": "True",

451

"enabled": "True",

452

}

318

453

319

454

def timeout_milliseconds(self):

320

455

"Return the 'timeout' attribute in milliseconds"

321

return _timedelta_to_milliseconds(self.timeout)

456

return timedelta_to_milliseconds(self.timeout)

322

457

323

458

def extended_timeout_milliseconds(self):

324

459

"Return the 'extended_timeout' attribute in milliseconds"

325

return _timedelta_to_milliseconds(self.extended_timeout)

460

return timedelta_to_milliseconds(self.extended_timeout)

326

461

327

462

def interval_milliseconds(self):

328

463

"Return the 'interval' attribute in milliseconds"

329

return _timedelta_to_milliseconds(self.interval)

464

return timedelta_to_milliseconds(self.interval)

330

465

331

466

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

467

return timedelta_to_milliseconds(self.approval_delay)

468

469

@staticmethod

470

def config_parser(config):

471

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

472

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

473

with exceptions for any special settings as defined above.

474

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

475

value given the same arguments.

476

"""

477

settings = {}

478

for client_name in config.sections():

479

section = dict(config.items(client_name))

480

client = settings[client_name] = {}

481

482

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

483

# Reformat values from string types to Python types

484

client["approved_by_default"] = config.getboolean(

485

client_name, "approved_by_default")

486

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

487

"enabled")

488

489

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

490

.replace(" ", ""))

491

if "secret" in section:

492

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

493

elif "secfile" in section:

494

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

495

(section["secfile"])),

496

"rb") as secfile:

497

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

498

else:

499

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

500

.format(section))

501

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

502

client["extended_timeout"] = string_to_delta(

503

section["extended_timeout"])

504

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

505

client["approval_delay"] = string_to_delta(

506

section["approval_delay"])

507

client["approval_duration"] = string_to_delta(

508

section["approval_duration"])

509

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

510

client["last_approval_request"] = None

511

client["last_checked_ok"] = None

512

client["last_checker_status"] = -2

513

514

return settings

515

516

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

338

517

self.name = name

339

if config is None:

340

config = {}

518

# adding all client settings

519

for setting, value in settings.iteritems():

520

setattr(self, setting, value)

521

522

if self.enabled:

523

if not hasattr(self, "last_enabled"):

524

self.last_enabled = datetime.datetime.utcnow()

525

if not hasattr(self, "expires"):

526

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

527

+ self.timeout)

528

else:

529

self.last_enabled = None

530

self.expires = None

531

341

532

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

342

533

# Uppercase and remove spaces from fingerprint for later

343

534

# comparison purposes with return value from the fingerprint()

344

535

# function

345

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

346

.replace(" ", ""))

347

536

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

537

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

538

datetime.datetime.utcnow())

539

540

# attributes specific for this server instance

369

541

self.checker = None

370

542

self.checker_initiator_tag = None

371

543

self.disable_initiator_tag = None

372

self.expires = None

373

544

self.checker_callback_tag = None

374

self.checker_command = config["checker"]

375

545

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)

546

self.approved = None

380

547

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

548

self.changedstate = (multiprocessing_manager

386

549

.Condition(multiprocessing_manager

387

550

.Lock()))

551

self.client_structure = [attr for attr in

552

self.__dict__.iterkeys()

553

if not attr.startswith("_")]

554

self.client_structure.append("client_structure")

555

556

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

557

lambda obj:

558

isinstance(obj,

559

property)):

560

if not name.startswith("_"):

561

self.client_structure.append(name)

388

562

563

# Send notice to process children that client state has changed

389

564

def send_changedstate(self):

390

self.changedstate.acquire()

391

self.changedstate.notify_all()

392

self.changedstate.release()

565

with self.changedstate:

566

self.changedstate.notify_all()

393

567

394

568

def enable(self):

395

569

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

397

571

# Already enabled

398

572

return

399

573

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

574

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

407

self.disable_initiator_tag = (gobject.timeout_add

408

(self.timeout_milliseconds(),

409

self.disable))

410

575

self.enabled = True

411

576

self.last_enabled = datetime.datetime.utcnow()

412

# Also start a new checker *right now*.

413

self.start_checker()

577

self.init_checker()

414

578

415

579

def disable(self, quiet=True):

416

580

"""Disable this client."""

428

592

gobject.source_remove(self.checker_initiator_tag)

429

593

self.checker_initiator_tag = None

430

594

self.stop_checker()

431

if self.disable_hook:

432

self.disable_hook(self)

433

595

self.enabled = False

434

596

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

435

597

return False

436

598

437

599

def __del__(self):

438

self.disable_hook = None

439

600

self.disable()

440

601

602

def init_checker(self):

603

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

604

# and every interval from then on.

605

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

607

self.start_checker))

608

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

609

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

612

# Also start a new checker *right now*.

613

self.start_checker()

614

441

615

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

442

616

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

443

617

self.checker_callback_tag = None

444

618

self.checker = None

445

619

if os.WIFEXITED(condition):

446

exitstatus = os.WEXITSTATUS(condition)

447

if exitstatus == 0:

620

self.last_checker_status = os.WEXITSTATUS(condition)

621

if self.last_checker_status == 0:

448

622

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

449

623

vars(self))

450

624

self.checked_ok()

452

626

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

453

627

vars(self))

454

628

else:

629

self.last_checker_status = -1

455

630

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

456

631

vars(self))

457

632

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

"""

633

def checked_ok(self):

634

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

635

self.last_checked_ok = datetime.datetime.utcnow()

636

self.last_checker_status = 0

637

self.bump_timeout()

638

639

def bump_timeout(self, timeout=None):

640

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

464

641

if timeout is None:

465

642

timeout = self.timeout

466

self.last_checked_ok = datetime.datetime.utcnow()

467

gobject.source_remove(self.disable_initiator_tag)

468

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

469

self.disable_initiator_tag = (gobject.timeout_add

470

(_timedelta_to_milliseconds

471

(timeout), self.disable))

643

if self.disable_initiator_tag is not None:

644

gobject.source_remove(self.disable_initiator_tag)

645

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

646

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

649

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

472

650

473

651

def need_approval(self):

474

652

self.last_approval_request = datetime.datetime.utcnow()

518

696

try:

519

697

command = self.checker_command % escaped_attrs

520

698

except TypeError as error:

521

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

522

' %s', self.checker_command, error)

699

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

700

self.checker_command, exc_info=error)

523

701

return True # Try again later

524

702

self.current_checker_command = command

525

703

try:

543

721

gobject.source_remove(self.checker_callback_tag)

544

722

self.checker_callback(pid, status, command)

545

723

except OSError as error:

546

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

547

error)

724

logger.error("Failed to start subprocess",

725

exc_info=error)

548

726

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

549

727

return True

550

728

557

735

return

558

736

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

559

737

try:

560

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

738

self.checker.terminate()

561

739

#time.sleep(0.5)

562

740

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

563

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

741

# self.checker.kill()

564

742

except OSError as error:

565

743

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

566

744

raise

583

761

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

584

762

if byte_arrays and signature != "ay":

585

763

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

586

" signature %r" % signature)

764

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

587

765

def decorator(func):

588

766

func._dbus_is_property = True

589

767

func._dbus_interface = dbus_interface

597

775

return decorator

598

776

599

777

778

def dbus_interface_annotations(dbus_interface):

779

"""Decorator for marking functions returning interface annotations

780

781

Usage:

782

783

@dbus_interface_annotations("org.example.Interface")

784

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

785

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

786

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

787

"false"}

788

"""

789

def decorator(func):

790

func._dbus_is_interface = True

791

func._dbus_interface = dbus_interface

792

func._dbus_name = dbus_interface

793

return func

794

return decorator

795

796

797

def dbus_annotations(annotations):

798

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

799

Usage:

800

801

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

802

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

def Property_dbus_property(self):

807

return dbus.Boolean(False)

808

"""

809

def decorator(func):

810

func._dbus_annotations = annotations

811

return func

812

return decorator

813

814

600

815

class DBusPropertyException(dbus.exceptions.DBusException):

601

816

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

602

817

"""

625

840

"""

626

841

627

842

@staticmethod

628

def _is_dbus_property(obj):

629

return getattr(obj, "_dbus_is_property", False)

843

def _is_dbus_thing(thing):

844

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

845

846

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

847

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

848

"""

849

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

850

False)

630

851

631

def _get_all_dbus_properties(self):

852

def _get_all_dbus_things(self, thing):

632

853

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

633

854

"""

634

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

855

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

856

name),

857

athing.__get__(self))

635

858

for cls in self.__class__.__mro__

636

for name, prop in

637

inspect.getmembers(cls, self._is_dbus_property))

859

for name, athing in

860

inspect.getmembers(cls,

861

self._is_dbus_thing(thing)))

638

862

639

863

def _get_dbus_property(self, interface_name, property_name):

640

864

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

642

866

"""

643

867

for cls in self.__class__.__mro__:

644

868

for name, value in (inspect.getmembers

645

(cls, self._is_dbus_property)):

869

(cls,

870

self._is_dbus_thing("property"))):

646

871

if (value._dbus_name == property_name

647

872

and value._dbus_interface == interface_name):

648

873

return value.__get__(self)

677

902

# signatures other than "ay".

678

903

if prop._dbus_signature != "ay":

679

904

raise ValueError

680

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

681

for byte in value))

905

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

906

for byte in value))

682

907

prop(value)

683

908

684

909

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

689

914

690

915

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

691

916

"""

692

all = {}

693

for name, prop in self._get_all_dbus_properties():

917

properties = {}

918

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

694

919

if (interface_name

695

920

and interface_name != prop._dbus_interface):

696

921

# Interface non-empty but did not match

700

925

continue

701

926

value = prop()

702

927

if not hasattr(value, "variant_level"):

703

all[name] = value

928

properties[name] = value

704

929

continue

705

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

706

value.variant_level+1)

707

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

930

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

931

value.variant_level+1)

932

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

708

933

709

934

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

710

935

out_signature="s",

711

936

path_keyword='object_path',

712

937

connection_keyword='connection')

713

938

def Introspect(self, object_path, connection):

714

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

939

"""Overloading of standard D-Bus method.

940

941

Inserts property tags and interface annotation tags.

715

942

"""

716

943

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

717

944

connection)

724

951

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

725

952

return e

726

953

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

954

# Add property tags

727

955

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

728

956

for name, prop

729

in self._get_all_dbus_properties()

957

in self._get_all_dbus_things("property")

730

958

if prop._dbus_interface

731

959

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

732

960

if_tag.appendChild(tag)

961

# Add annotation tags

962

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

963

for tag in if_tag.getElementsByTagName(typ):

964

annots = dict()

965

for name, prop in (self.

966

_get_all_dbus_things(typ)):

967

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

968

and prop._dbus_interface

969

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

970

annots.update(getattr

971

(prop,

972

"_dbus_annotations",

973

{}))

974

for name, value in annots.iteritems():

975

ann_tag = document.createElement(

976

"annotation")

977

ann_tag.setAttribute("name", name)

978

ann_tag.setAttribute("value", value)

979

tag.appendChild(ann_tag)

980

# Add interface annotation tags

981

for annotation, value in dict(

982

itertools.chain(

983

*(annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

))).iteritems():

988

ann_tag = document.createElement("annotation")

989

ann_tag.setAttribute("name", annotation)

990

ann_tag.setAttribute("value", value)

991

if_tag.appendChild(ann_tag)

733

992

# Add the names to the return values for the

734

993

# "org.freedesktop.DBus.Properties" methods

735

994

if (if_tag.getAttribute("name")

750

1009

except (AttributeError, xml.dom.DOMException,

751

1010

xml.parsers.expat.ExpatError) as error:

752

1011

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

753

error)

1012

exc_info=error)

754

1013

return xmlstring

755

1014

756

1015

761

1020

return dbus.String(dt.isoformat(),

762

1021

variant_level=variant_level)

763

1022

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.

1023

1024

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1025

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

1026

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

1027

interface names according to the "alt_interface_names" mapping.

1028

Usage:

1029

1030

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

1031

"net.example.AlternateInterface"})

1032

class SampleDBusObject(dbus.service.Object):

1033

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

1034

def SampleDBusMethod():

1035

pass

1036

1037

The above "SampleDBusMethod" on "SampleDBusObject" will be

1038

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

1039

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

1040

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

1041

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

1042

1043

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

1044

(from DBusObjectWithProperties) and interfaces (from the

1045

dbus_interface_annotations decorator).

768

1046

"""

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

1047

def wrapper(cls):

1048

for orig_interface_name, alt_interface_name in (

1049

alt_interface_names.iteritems()):

1050

attr = {}

1051

interface_names = set()

1052

# Go though all attributes of the class

1053

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

776

1054

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

777

1055

# with the wrong interface name

778

1056

if (not hasattr(attribute, "_dbus_interface")

779

1057

or not attribute._dbus_interface

780

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

1058

.startswith(orig_interface_name)):

781

1059

continue

782

1060

# Create an alternate D-Bus interface name based on

783

1061

# the current name

784

1062

alt_interface = (attribute._dbus_interface

785

.replace("se.recompile.Mandos",

786

"se.bsnet.fukt.Mandos"))

1063

.replace(orig_interface_name,

1064

alt_interface_name))

1065

interface_names.add(alt_interface)

787

1066

# Is this a D-Bus signal?

788

1067

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

789

1068

# Extract the original non-method function by

804

1083

nonmethod_func.func_name,

805

1084

nonmethod_func.func_defaults,

806

1085

nonmethod_func.func_closure)))

1086

# Copy annotations, if any

1087

try:

1088

new_function._dbus_annotations = (

1089

dict(attribute._dbus_annotations))

1090

except AttributeError:

1091

pass

807

1092

# 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

1093

# original and alternate functions, so both the

1094

# original and alternate signals gets sent when

1095

# the function is called

810

1096

def fixscope(func1, func2):

811

1097

"""This function is a scope container to pass

812

1098

func1 and func2 to the "call_both" function

819

1105

return call_both

820

1106

# Create the "call_both" function and add it to

821

1107

# the class

822

attr[attrname] = fixscope(attribute,

823

new_function)

1108

attr[attrname] = fixscope(attribute, new_function)

824

1109

# Is this a D-Bus method?

825

1110

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

826

1111

# Create a new, but exactly alike, function

837

1122

attribute.func_name,

838

1123

attribute.func_defaults,

839

1124

attribute.func_closure)))

1125

# Copy annotations, if any

1126

try:

1127

attr[attrname]._dbus_annotations = (

1128

dict(attribute._dbus_annotations))

1129

except AttributeError:

1130

pass

840

1131

# Is this a D-Bus property?

841

1132

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

842

1133

# Create a new, but exactly alike, function

856

1147

attribute.func_name,

857

1148

attribute.func_defaults,

858

1149

attribute.func_closure)))

859

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

860

1150

# Copy annotations, if any

1151

try:

1152

attr[attrname]._dbus_annotations = (

1153

dict(attribute._dbus_annotations))

1154

except AttributeError:

1155

pass

1156

# Is this a D-Bus interface?

1157

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

1158

# Create a new, but exactly alike, function

1159

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

1160

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

1161

# to the class.

1162

attr[attrname] = (dbus_interface_annotations

1163

(alt_interface)

1164

(types.FunctionType

1165

(attribute.func_code,

1166

attribute.func_globals,

1167

attribute.func_name,

1168

attribute.func_defaults,

1169

attribute.func_closure)))

1170

if deprecate:

1171

# Deprecate all alternate interfaces

1172

iname="_AlternateDBusNames_interface_annotation{0}"

1173

for interface_name in interface_names:

1174

@dbus_interface_annotations(interface_name)

1175

def func(self):

1176

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

1177

"true" }

1178

# Find an unused name

1179

for aname in (iname.format(i)

1180

for i in itertools.count()):

1181

if aname not in attr:

1182

attr[aname] = func

1183

break

1184

if interface_names:

1185

# Replace the class with a new subclass of it with

1186

# methods, signals, etc. as created above.

1187

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

1188

(cls,), attr)

1189

return cls

1190

return wrapper

1191

1192

1193

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

1194

"se.bsnet.fukt.Mandos"})

861

1195

class ClientDBus(Client, DBusObjectWithProperties):

862

1196

"""A Client class using D-Bus

863

1197

872

1206

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

873

1207

874

1208

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

875

self._approvals_pending = 0

876

1209

self.bus = bus

877

1210

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

878

1211

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

884

1217

("/clients/" + client_object_name))

885

1218

DBusObjectWithProperties.__init__(self, self.bus,

886

1219

self.dbus_object_path)

887

1220

888

1221

def notifychangeproperty(transform_func,

889

1222

dbus_name, type_func=lambda x: x,

890

1223

variant_level=1):

891

1224

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

892

1225

its changes to DBus.

893

894

transform_fun: Function that takes a value and transforms it

895

to a D-Bus type.

1226

1227

transform_fun: Function that takes a value and a variant_level

1228

and transforms it to a D-Bus type.

896

1229

dbus_name: D-Bus name of the variable

897

1230

type_func: Function that transform the value before sending it

898

1231

to the D-Bus. Default: no transform

905

1238

type_func(getattr(self, attrname, None))

906

1239

!= type_func(value)):

907

1240

dbus_value = transform_func(type_func(value),

908

variant_level)

1241

variant_level

1242

=variant_level)

909

1243

self.PropertyChanged(dbus.String(dbus_name),

910

1244

dbus_value)

911

1245

setattr(self, attrname, value)

912

1246

913

1247

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

914

1248

915

916

1249

expires = notifychangeproperty(datetime_to_dbus, "Expires")

917

1250

approvals_pending = notifychangeproperty(dbus.Boolean,

918

1251

"ApprovalPending",

925

1258

checker is not None)

926

1259

last_checked_ok = notifychangeproperty(datetime_to_dbus,

927

1260

"LastCheckedOK")

1261

last_checker_status = notifychangeproperty(dbus.Int16,

1262

"LastCheckerStatus")

928

1263

last_approval_request = notifychangeproperty(

929

1264

datetime_to_dbus, "LastApprovalRequest")

930

1265

approved_by_default = notifychangeproperty(dbus.Boolean,

931

1266

"ApprovedByDefault")

932

approval_delay = notifychangeproperty(dbus.UInt16,

1267

approval_delay = notifychangeproperty(dbus.UInt64,

933

1268

"ApprovalDelay",

934

1269

type_func =

935

_timedelta_to_milliseconds)

1270

timedelta_to_milliseconds)

936

1271

approval_duration = notifychangeproperty(

937

dbus.UInt16, "ApprovalDuration",

938

type_func = _timedelta_to_milliseconds)

1272

dbus.UInt64, "ApprovalDuration",

1273

type_func = timedelta_to_milliseconds)

939

1274

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

940

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

1275

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

941

1276

type_func =

942

_timedelta_to_milliseconds)

1277

timedelta_to_milliseconds)

943

1278

extended_timeout = notifychangeproperty(

944

dbus.UInt16, "ExtendedTimeout",

945

type_func = _timedelta_to_milliseconds)

946

interval = notifychangeproperty(dbus.UInt16,

1279

dbus.UInt64, "ExtendedTimeout",

1280

type_func = timedelta_to_milliseconds)

1281

interval = notifychangeproperty(dbus.UInt64,

947

1282

"Interval",

948

1283

type_func =

949

_timedelta_to_milliseconds)

1284

timedelta_to_milliseconds)

950

1285

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

951

1286

952

1287

del notifychangeproperty

994

1329

return r

995

1330

996

1331

def _reset_approved(self):

997

self._approved = None

1332

self.approved = None

998

1333

return False

999

1334

1000

1335

def approve(self, value=True):

1001

1336

self.send_changedstate()

1002

self._approved = value

1003

gobject.timeout_add(_timedelta_to_milliseconds

1337

self.approved = value

1338

gobject.timeout_add(timedelta_to_milliseconds

1004

1339

(self.approval_duration),

1005

1340

self._reset_approved)

1006

1341

1007

1008

1342

## D-Bus methods, signals & properties

1009

1343

_interface = "se.recompile.Mandos.Client"

1010

1344

1345

## Interfaces

1346

1347

@dbus_interface_annotations(_interface)

1348

def _foo(self):

1349

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

1350

"false"}

1351

1011

1352

## Signals

1012

1353

1013

1354

# CheckerCompleted - signal

1112

1453

access="readwrite")

1113

1454

def ApprovalDuration_dbus_property(self, value=None):

1114

1455

if value is None: # get

1115

return dbus.UInt64(_timedelta_to_milliseconds(

1456

return dbus.UInt64(timedelta_to_milliseconds(

1116

1457

self.approval_duration))

1117

1458

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

1118

1459

1132

1473

def Host_dbus_property(self, value=None):

1133

1474

if value is None: # get

1134

1475

return dbus.String(self.host)

1135

self.host = value

1476

self.host = unicode(value)

1136

1477

1137

1478

# Created - property

1138

1479

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

1139

1480

def Created_dbus_property(self):

1140

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

1481

return datetime_to_dbus(self.created)

1141

1482

1142

1483

# LastEnabled - property

1143

1484

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

1164

1505

return

1165

1506

return datetime_to_dbus(self.last_checked_ok)

1166

1507

1508

# LastCheckerStatus - property

1509

@dbus_service_property(_interface, signature="n",

1510

access="read")

1511

def LastCheckerStatus_dbus_property(self):

1512

return dbus.Int16(self.last_checker_status)

1513

1167

1514

# Expires - property

1168

1515

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

1169

1516

def Expires_dbus_property(self):

1181

1528

if value is None: # get

1182

1529

return dbus.UInt64(self.timeout_milliseconds())

1183

1530

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

1184

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

1185

return

1186

1531

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

1532

if self.enabled:

1533

now = datetime.datetime.utcnow()

1534

time_to_die = timedelta_to_milliseconds(

1535

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

1536

if time_to_die <= 0:

1537

# The timeout has passed

1538

self.disable()

1539

else:

1540

self.expires = (now +

1541

datetime.timedelta(milliseconds =

1542

time_to_die))

1543

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

1544

is None):

1545

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (gobject.timeout_add

1548

(time_to_die,

1549

self.disable))

1205

1550

1206

1551

# ExtendedTimeout - property

1207

1552

@dbus_service_property(_interface, signature="t",

1220

1565

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

1221

1566

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

1222

1567

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

1568

if self.enabled:

1569

# Reschedule checker run

1570

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

1228

1574

1229

1575

# Checker - property

1230

1576

@dbus_service_property(_interface, signature="s",

1232

1578

def Checker_dbus_property(self, value=None):

1233

1579

if value is None: # get

1234

1580

return dbus.String(self.checker_command)

1235

self.checker_command = value

1581

self.checker_command = unicode(value)

1236

1582

1237

1583

# CheckerRunning - property

1238

1584

@dbus_service_property(_interface, signature="b",

1267

1613

raise KeyError()

1268

1614

1269

1615

def __getattribute__(self, name):

1270

if(name == '_pipe'):

1616

if name == '_pipe':

1271

1617

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

1272

1618

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

1273

1619

data = self._pipe.recv()

1280

1626

return func

1281

1627

1282

1628

def __setattr__(self, name, value):

1283

if(name == '_pipe'):

1629

if name == '_pipe':

1284

1630

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

1285

1631

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

1286

1632

1287

class ClientDBusTransitional(ClientDBus):

1288

__metaclass__ = AlternateDBusNamesMetaclass

1289

1633

1290

1634

class ClientHandler(socketserver.BaseRequestHandler, object):

1291

1635

"""A class to handle client connections.

1374

1718

client.Rejected("Disabled")

1375

1719

return

1376

1720

1377

if client._approved or not client.approval_delay:

1721

if client.approved or not client.approval_delay:

1378

1722

#We are approved or approval is disabled

1379

1723

break

1380

elif client._approved is None:

1724

elif client.approved is None:

1381

1725

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

1382

1726

client.name)

1383

1727

if self.server.use_dbus:

1394

1738

return

1395

1739

1396

1740

#wait until timeout or approved

1397

#x = float(client

1398

# ._timedelta_to_milliseconds(delay))

1399

1741

time = datetime.datetime.now()

1400

1742

client.changedstate.acquire()

1401

1743

(client.changedstate.wait

1402

(float(client._timedelta_to_milliseconds(delay)

1744

(float(client.timedelta_to_milliseconds(delay)

1403

1745

/ 1000)))

1404

1746

client.changedstate.release()

1405

1747

time2 = datetime.datetime.now()

1422

1764

try:

1423

1765

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

1424

1766

except gnutls.errors.GNUTLSError as error:

1425

logger.warning("gnutls send failed")

1767

logger.warning("gnutls send failed",

1768

exc_info=error)

1426

1769

return

1427

1770

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

1428

1771

sent, len(client.secret)

1430

1773

sent_size += sent

1431

1774

1432

1775

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

1433

# bump the timeout as if seen

1434

client.checked_ok(client.extended_timeout)

1776

# bump the timeout using extended_timeout

1777

client.bump_timeout(client.extended_timeout)

1435

1778

if self.server.use_dbus:

1436

1779

# Emit D-Bus signal

1437

1780

client.GotSecret()

1442

1785

try:

1443

1786

session.bye()

1444

1787

except gnutls.errors.GNUTLSError as error:

1445

logger.warning("GnuTLS bye failed")

1788

logger.warning("GnuTLS bye failed",

1789

exc_info=error)

1446

1790

1447

1791

@staticmethod

1448

1792

def peer_certificate(session):

1504

1848

# Convert the buffer to a Python bytestring

1505

1849

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

1506

1850

# Convert the bytestring to hexadecimal notation

1507

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

1851

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

1508

1852

return hex_fpr

1509

1853

1510

1854

1513

1857

def sub_process_main(self, request, address):

1514

1858

try:

1515

1859

self.finish_request(request, address)

1516

except:

1860

except Exception:

1517

1861

self.handle_error(request, address)

1518

1862

self.close_request(request)

1519

1863

1520

1864

def process_request(self, request, address):

1521

1865

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

1522

multiprocessing.Process(target = self.sub_process_main,

1523

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

1866

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

1867

args = (request,

1868

address))

1869

proc.start()

1870

return proc

1524

1871

1525

1872

1526

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1532

1879

"""

1533

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1534

1881

1535

super(MultiprocessingMixInWithPipe,

1536

self).process_request(request, client_address)

1882

proc = MultiprocessingMixIn.process_request(self, request,

1883

client_address)

1537

1884

self.child_pipe.close()

1538

self.add_pipe(parent_pipe)

1885

self.add_pipe(parent_pipe, proc)

1539

1886

1540

def add_pipe(self, parent_pipe):

1887

def add_pipe(self, parent_pipe, proc):

1541

1888

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

1542

1889

raise NotImplementedError

1543

1890

1621

1968

self.enabled = False

1622

1969

self.clients = clients

1623

1970

if self.clients is None:

1624

self.clients = set()

1971

self.clients = {}

1625

1972

self.use_dbus = use_dbus

1626

1973

self.gnutls_priority = gnutls_priority

1627

1974

IPv6_TCPServer.__init__(self, server_address,

1631

1978

def server_activate(self):

1632

1979

if self.enabled:

1633

1980

return socketserver.TCPServer.server_activate(self)

1981

1634

1982

def enable(self):

1635

1983

self.enabled = True

1636

def add_pipe(self, parent_pipe):

1984

1985

def add_pipe(self, parent_pipe, proc):

1637

1986

# Call "handle_ipc" for both data and EOF events

1638

1987

gobject.io_add_watch(parent_pipe.fileno(),

1639

1988

gobject.IO_IN | gobject.IO_HUP,

1640

1989

functools.partial(self.handle_ipc,

1641

1990

parent_pipe =

1642

parent_pipe))

1991

parent_pipe,

1992

proc = proc))

1643

1993

1644

1994

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

1645

client_object=None):

1995

proc = None, client_object=None):

1646

1996

condition_names = {

1647

1997

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

1648

1998

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

1657

2007

for cond, name in

1658

2008

condition_names.iteritems()

1659

2009

if cond & condition)

1660

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

2010

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

1661

2011

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

2012

# Wait for other process to exit

2013

proc.join()

1662

2014

return False

1663

2015

1664

2016

# Read a request from the child

1669

2021

fpr = request[1]

1670

2022

address = request[2]

1671

2023

1672

for c in self.clients:

2024

for c in self.clients.itervalues():

1673

2025

if c.fingerprint == fpr:

1674

2026

client = c

1675

2027

break

1688

2040

functools.partial(self.handle_ipc,

1689

2041

parent_pipe =

1690

2042

parent_pipe,

2043

proc = proc,

1691

2044

client_object =

1692

2045

client))

1693

2046

parent_pipe.send(True)

1751

2104

elif suffix == "w":

1752

2105

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

1753

2106

else:

1754

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

2107

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

2108

.format(suffix))

1755

2109

except (ValueError, IndexError) as e:

1756

2110

raise ValueError(*(e.args))

1757

2111

timevalue += delta

1758

2112

return timevalue

1759

2113

1760

2114

1761

def if_nametoindex(interface):

1762

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

1763

1764

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

1765

global if_nametoindex

1766

try:

1767

if_nametoindex = (ctypes.cdll.LoadLibrary

1768

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

1769

.if_nametoindex)

1770

except (OSError, AttributeError):

1771

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

1772

def if_nametoindex(interface):

1773

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

1774

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

1775

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

1776

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

1777

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

1778

interface))

1779

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

1780

ifreq[16:20])[0]

1781

return interface_index

1782

return if_nametoindex(interface)

1783

1784

1785

2115

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

1786

2116

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

1787

2117

1795

2125

sys.exit()

1796

2126

if not noclose:

1797

2127

# Close all standard open file descriptors

1798

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

2128

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

1799

2129

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

1800

2130

raise OSError(errno.ENODEV,

1801

"%s not a character device"

1802

% os.path.devnull)

2131

"{0} not a character device"

2132

.format(os.devnull))

1803

2133

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

1804

2134

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

1805

2135

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

1814

2144

1815

2145

parser = argparse.ArgumentParser()

1816

2146

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

1817

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

2147

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

1818

2148

help="show version number and exit")

1819

2149

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

1820

2150

help="Bind to interface IF")

1842

2172

" system bus interface")

1843

2173

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

1844

2174

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

2175

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

2176

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

2177

" state")

2178

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

2179

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

2180

1845

2181

options = parser.parse_args()

1846

2182

1847

2183

if options.check:

1860

2196

"use_dbus": "True",

1861

2197

"use_ipv6": "True",

1862

2198

"debuglevel": "",

2199

"restore": "True",

2200

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

1863

2201

}

1864

2202

1865

2203

# Parse config file for server-global settings

1882

2220

# options, if set.

1883

2221

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

1884

2222

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

1885

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

2223

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

2224

"statedir"):

1886

2225

value = getattr(options, option)

1887

2226

if value is not None:

1888

2227

server_settings[option] = value

1900

2239

debuglevel = server_settings["debuglevel"]

1901

2240

use_dbus = server_settings["use_dbus"]

1902

2241

use_ipv6 = server_settings["use_ipv6"]

2242

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

2243

stored_state_file)

2244

2245

if debug:

2246

initlogger(debug, logging.DEBUG)

2247

else:

2248

if not debuglevel:

2249

initlogger(debug)

2250

else:

2251

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

2252

initlogger(debug, level)

1903

2253

1904

2254

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

1905

2255

syslogger.setFormatter(logging.Formatter

1906

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

1907

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

1908

% server_settings["servicename"]))

2256

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

2257

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

2258

.format(server_settings

2259

["servicename"])))

1909

2260

1910

2261

# Parse config file with clients

1911

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

1912

"extended_timeout": "15m",

1913

"interval": "2m",

1914

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

1915

"host": "",

1916

"approval_delay": "0s",

1917

"approval_duration": "1s",

1918

}

1919

client_config = configparser.SafeConfigParser(client_defaults)

2262

client_config = configparser.SafeConfigParser(Client

2263

.client_defaults)

1920

2264

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

1921

2265

"clients.conf"))

1922

2266

1936

2280

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

1937

2281

try:

1938

2282

pidfile = open(pidfilename, "w")

1939

except IOError:

1940

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

2283

except IOError as e:

2284

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

2285

exc_info=e)

1941

2286

1942

try:

1943

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

1944

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

1945

except KeyError:

2287

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

1946

2288

try:

1947

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

1948

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

2289

uid = pwd.getpwnam(name).pw_uid

2290

gid = pwd.getpwnam(name).pw_gid

2291

break

1949

2292

except KeyError:

1950

try:

1951

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

1952

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

1953

except KeyError:

1954

uid = 65534

1955

gid = 65534

2293

continue

2294

else:

2295

uid = 65534

2296

gid = 65534

1956

2297

try:

1957

2298

os.setgid(gid)

1958

2299

os.setuid(uid)

1960

2301

if error[0] != errno.EPERM:

1961

2302

raise error

1962

2303

1963

if not debug and not debuglevel:

1964

syslogger.setLevel(logging.WARNING)

1965

console.setLevel(logging.WARNING)

1966

if debuglevel:

1967

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

1968

syslogger.setLevel(level)

1969

console.setLevel(level)

1970

1971

2304

if debug:

1972

2305

# Enable all possible GnuTLS debugging

1973

2306

1983

2316

.gnutls_global_set_log_function(debug_gnutls))

1984

2317

1985

2318

# Redirect stdin so all checkers get /dev/null

1986

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

2319

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

1987

2320

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

1988

2321

if null > 2:

1989

2322

os.close(null)

1990

else:

1991

# No console logging

1992

logger.removeHandler(console)

1993

2323

1994

2324

# Need to fork before connecting to D-Bus

1995

2325

if not debug:

1996

2326

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

1997

2327

daemon()

1998

2328

2329

gobject.threads_init()

2330

1999

2331

global main_loop

2000

2332

# From the Avahi example code

2001

DBusGMainLoop(set_as_default=True )

2333

DBusGMainLoop(set_as_default=True)

2002

2334

main_loop = gobject.MainLoop()

2003

2335

bus = dbus.SystemBus()

2004

2336

# End of Avahi example code

2010

2342

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

2011

2343

do_not_queue=True))

2012

2344

except dbus.exceptions.NameExistsException as e:

2013

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

2345

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

2014

2346

use_dbus = False

2015

2347

server_settings["use_dbus"] = False

2016

2348

tcp_server.use_dbus = False

2017

2349

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2018

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

2019

servicetype = "_mandos._tcp",

2020

protocol = protocol, bus = bus)

2350

service = AvahiServiceToSyslog(name =

2351

server_settings["servicename"],

2352

servicetype = "_mandos._tcp",

2353

protocol = protocol, bus = bus)

2021

2354

if server_settings["interface"]:

2022

2355

service.interface = (if_nametoindex

2023

2356

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

2027

2360

2028

2361

client_class = Client

2029

2362

if use_dbus:

2030

client_class = functools.partial(ClientDBusTransitional,

2031

bus = bus)

2032

def client_config_items(config, section):

2033

special_settings = {

2034

"approved_by_default":

2035

lambda: config.getboolean(section,

2036

"approved_by_default"),

2037

}

2038

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

2363

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

2364

2365

client_settings = Client.config_parser(client_config)

2366

old_client_settings = {}

2367

clients_data = {}

2368

2369

# Get client data and settings from last running state.

2370

if server_settings["restore"]:

2371

try:

2372

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

2373

clients_data, old_client_settings = (pickle.load

2374

(stored_state))

2375

os.remove(stored_state_path)

2376

except IOError as e:

2377

if e.errno == errno.ENOENT:

2378

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

2379

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

2380

else:

2381

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

2382

exc_info=e)

2383

raise

2384

except EOFError as e:

2385

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

2386

"EOFError:", exc_info=e)

2387

2388

with PGPEngine() as pgp:

2389

for client_name, client in clients_data.iteritems():

2390

# Decide which value to use after restoring saved state.

2391

# We have three different values: Old config file,

2392

# new config file, and saved state.

2393

# New config value takes precedence if it differs from old

2394

# config value, otherwise use saved state.

2395

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

2396

try:

2397

# For each value in new config, check if it

2398

# differs from the old config value (Except for

2399

# the "secret" attribute)

2400

if (name != "secret" and

2401

value != old_client_settings[client_name]

2402

[name]):

2403

client[name] = value

2404

except KeyError:

2405

pass

2406

2407

# Clients who has passed its expire date can still be

2408

# enabled if its last checker was successful. Clients

2409

# whose checker succeeded before we stored its state is

2410

# assumed to have successfully run all checkers during

2411

# downtime.

2412

if client["enabled"]:

2413

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

2414

if not client["last_checked_ok"]:

2415

logger.warning(

2416

"disabling client {0} - Client never "

2417

"performed a successful checker"

2418

.format(client_name))

2419

client["enabled"] = False

2420

elif client["last_checker_status"] != 0:

2421

logger.warning(

2422

"disabling client {0} - Client "

2423

"last checker failed with error code {1}"

2424

.format(client_name,

2425

client["last_checker_status"]))

2426

client["enabled"] = False

2427

else:

2428

client["expires"] = (datetime.datetime

2429

.utcnow()

2430

+ client["timeout"])

2431

logger.debug("Last checker succeeded,"

2432

" keeping {0} enabled"

2433

.format(client_name))

2039

2434

try:

2040

yield (name, special_settings[name]())

2041

except KeyError:

2042

yield (name, value)

2043

2044

tcp_server.clients.update(set(

2045

client_class(name = section,

2046

config= dict(client_config_items(

2047

client_config, section)))

2048

for section in client_config.sections()))

2435

client["secret"] = (

2436

pgp.decrypt(client["encrypted_secret"],

2437

client_settings[client_name]

2438

["secret"]))

2439

except PGPError:

2440

# If decryption fails, we use secret from new settings

2441

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

2442

.format(client_name))

2443

client["secret"] = (

2444

client_settings[client_name]["secret"])

2445

2446

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

2447

for client_name in (set(old_client_settings)

2448

- set(client_settings)):

2449

del clients_data[client_name]

2450

for client_name in (set(client_settings)

2451

- set(old_client_settings)):

2452

clients_data[client_name] = client_settings[client_name]

2453

2454

# Create all client objects

2455

for client_name, client in clients_data.iteritems():

2456

tcp_server.clients[client_name] = client_class(

2457

name = client_name, settings = client)

2458

2049

2459

if not tcp_server.clients:

2050

2460

logger.warning("No clients defined")

2051

2461

2052

2462

if not debug:

2053

2463

try:

2054

2464

with pidfile:

2062

2472

# "pidfile" was never created

2063

2473

pass

2064

2474

del pidfilename

2065

2066

2475

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

2067

2476

2068

2477

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

2069

2478

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

2070

2479

2071

2480

if use_dbus:

2072

class MandosDBusService(dbus.service.Object):

2481

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

2482

"se.bsnet.fukt.Mandos"})

2483

class MandosDBusService(DBusObjectWithProperties):

2073

2484

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

2074

2485

def __init__(self):

2075

2486

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

2076

2487

_interface = "se.recompile.Mandos"

2077

2488

2489

@dbus_interface_annotations(_interface)

2490

def _foo(self):

2491

return { "org.freedesktop.DBus.Property"

2492

".EmitsChangedSignal":

2493

"false"}

2494

2078

2495

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

2079

2496

def ClientAdded(self, objpath):

2080

2497

"D-Bus signal"

2094

2511

def GetAllClients(self):

2095

2512

"D-Bus method"

2096

2513

return dbus.Array(c.dbus_object_path

2097

for c in tcp_server.clients)

2514

for c in

2515

tcp_server.clients.itervalues())

2098

2516

2099

2517

@dbus.service.method(_interface,

2100

2518

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

2102

2520

"D-Bus method"

2103

2521

return dbus.Dictionary(

2104

2522

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

2105

for c in tcp_server.clients),

2523

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

2106

2524

signature="oa{sv}")

2107

2525

2108

2526

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

2109

2527

def RemoveClient(self, object_path):

2110

2528

"D-Bus method"

2111

for c in tcp_server.clients:

2529

for c in tcp_server.clients.itervalues():

2112

2530

if c.dbus_object_path == object_path:

2113

tcp_server.clients.remove(c)

2531

del tcp_server.clients[c.name]

2114

2532

c.remove_from_connection()

2115

2533

# Don't signal anything except ClientRemoved

2116

2534

c.disable(quiet=True)

2121

2539

2122

2540

del _interface

2123

2541

2124

class MandosDBusServiceTransitional(MandosDBusService):

2125

__metaclass__ = AlternateDBusNamesMetaclass

2126

mandos_dbus_service = MandosDBusServiceTransitional()

2542

mandos_dbus_service = MandosDBusService()

2127

2543

2128

2544

def cleanup():

2129

2545

"Cleanup function; run on exit"

2130

2546

service.cleanup()

2131

2547

2548

multiprocessing.active_children()

2549

if not (tcp_server.clients or client_settings):

2550

return

2551

2552

# Store client before exiting. Secrets are encrypted with key

2553

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

2554

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

2555

clients = {}

2556

with PGPEngine() as pgp:

2557

for client in tcp_server.clients.itervalues():

2558

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

2559

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

2560

key)

2561

client_dict = {}

2562

2563

# A list of attributes that can not be pickled

2564

# + secret.

2565

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

2566

"checker"))

2567

for name, typ in (inspect.getmembers

2568

(dbus.service.Object)):

2569

exclude.add(name)

2570

2571

client_dict["encrypted_secret"] = (client

2572

.encrypted_secret)

2573

for attr in client.client_structure:

2574

if attr not in exclude:

2575

client_dict[attr] = getattr(client, attr)

2576

2577

clients[client.name] = client_dict

2578

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

2579

2580

try:

2581

tempfd, tempname = tempfile.mkstemp(suffix=".pickle",

2582

prefix="clients-",

2583

dir=os.path.dirname

2584

(stored_state_path))

2585

with os.fdopen(tempfd, "wb") as stored_state:

2586

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

2587

os.rename(tempname, stored_state_path)

2588

except (IOError, OSError) as e:

2589

if not debug:

2590

try:

2591

os.remove(tempname)

2592

except NameError:

2593

pass

2594

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

2595

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

2596

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

2597

else:

2598

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

2599

exc_info=e)

2600

raise e

2601

2602

# Delete all clients, and settings from config

2132

2603

while tcp_server.clients:

2133

client = tcp_server.clients.pop()

2604

name, client = tcp_server.clients.popitem()

2134

2605

if use_dbus:

2135

2606

client.remove_from_connection()

2136

client.disable_hook = None

2137

2607

# Don't signal anything except ClientRemoved

2138

2608

client.disable(quiet=True)

2139

2609

if use_dbus:

2141

2611

mandos_dbus_service.ClientRemoved(client

2142

2612

.dbus_object_path,

2143

2613

client.name)

2614

client_settings.clear()

2144

2615

2145

2616

atexit.register(cleanup)

2146

2617

2147

for client in tcp_server.clients:

2618

for client in tcp_server.clients.itervalues():

2148

2619

if use_dbus:

2149

2620

# Emit D-Bus signal

2150

2621

mandos_dbus_service.ClientAdded(client.dbus_object_path)

2151

client.enable()

2622

# Need to initiate checking of clients

2623

if client.enabled:

2624

client.init_checker()

2152

2625

2153

2626

tcp_server.enable()

2154

2627

tcp_server.server_activate()

2157

2630

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

2158

2631

if use_ipv6:

2159

2632

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

2160

" flowinfo %d, scope_id %d"

2161

% tcp_server.socket.getsockname())

2633

" flowinfo %d, scope_id %d",

2634

*tcp_server.socket.getsockname())

2162

2635

else: # IPv4

2163

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

2164

% tcp_server.socket.getsockname())

2636

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

2637

*tcp_server.socket.getsockname())

2165

2638

2166

2639

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

2167

2640

2170

2643

try:

2171

2644

service.activate()

2172

2645

except dbus.exceptions.DBusException as error:

2173

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

2646

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

2174

2647

cleanup()

2175

2648

sys.exit(1)

2176

2649

# End of Avahi example code

2183

2656

logger.debug("Starting main loop")

2184

2657

main_loop.run()

2185

2658

except AvahiError as error:

2186

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

2659

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

2187

2660

cleanup()

2188

2661

sys.exit(1)

2189

2662

except KeyboardInterrupt:

2194

2667

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

2195

2668

cleanup()

2196

2669

2197

2198

2670

if __name__ == '__main__':

2199

2671

main()