/mandos/trunk : revision 594.1.4

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

65

67

import types

66

68

import binascii

67

69

import tempfile

70

import itertools

68

71

69

72

import dbus

70

73

import dbus.service

85

88

except ImportError:

86

89

SO_BINDTODEVICE = None

87

90

88

89

version = "1.4.1"

91

version = "1.5.5"

90

92

stored_state_file = "clients.pickle"

91

93

92

94

logger = logging.getLogger()

111

113

return interface_index

112

114

113

115

114

def initlogger(level=logging.WARNING):

116

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

115

117

"""init logger and add loglevel"""

116

118

117

119

syslogger.setFormatter(logging.Formatter

119

121

' %(message)s'))

120

122

logger.addHandler(syslogger)

121

123

122

console = logging.StreamHandler()

123

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

124

' [%(process)d]:'

125

' %(levelname)s:'

126

' %(message)s'))

127

logger.addHandler(console)

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)

128

131

logger.setLevel(level)

129

132

130

133

131

class CryptoError(Exception):

134

class PGPError(Exception):

135

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

132

136

pass

133

137

134

138

135

class Crypto(object):

139

class PGPEngine(object):

136

140

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

137

141

def __init__(self):

138

142

self.gnupg = GnuPGInterface.GnuPG()

141

145

self.gnupg.options.meta_interactive = False

142

146

self.gnupg.options.homedir = self.tempdir

143

147

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

144

'--quiet'])

148

'--quiet',

149

'--no-use-agent'])

145

150

146

151

def __enter__(self):

147

152

return self

148

153

149

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

154

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

150

155

self._cleanup()

151

156

return False

152

157

173

178

174

179

def encrypt(self, data, password):

175

180

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

176

with open(os.devnull) as devnull:

181

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

177

182

try:

178

183

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

179

184

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

184

189

ciphertext = f.read()

185

190

proc.wait()

186

191

except IOError as e:

187

raise CryptoError(e)

192

raise PGPError(e)

188

193

self.gnupg.passphrase = None

189

194

return ciphertext

190

195

191

196

def decrypt(self, data, password):

192

197

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

193

with open(os.devnull) as devnull:

198

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

194

199

try:

195

200

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

196

201

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

197

202

attach_fhs={'stderr': devnull})

198

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

203

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

199

204

f.write(data)

200

205

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

201

206

decrypted_plaintext = f.read()

202

207

proc.wait()

203

208

except IOError as e:

204

raise CryptoError(e)

209

raise PGPError(e)

205

210

self.gnupg.passphrase = None

206

211

return decrypted_plaintext

207

212

208

213

209

210

214

class AvahiError(Exception):

211

215

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

212

216

self.value = value

241

245

server: D-Bus Server

242

246

bus: dbus.SystemBus()

243

247

"""

248

244

249

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

245

250

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

246

251

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

259

264

self.server = None

260

265

self.bus = bus

261

266

self.entry_group_state_changed_match = None

267

262

268

def rename(self):

263

269

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

264

270

if self.rename_count >= self.max_renames:

274

280

try:

275

281

self.add()

276

282

except dbus.exceptions.DBusException as error:

277

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

283

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

278

284

self.cleanup()

279

285

os._exit(1)

280

286

self.rename_count += 1

287

281

288

def remove(self):

282

289

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

283

290

if self.entry_group_state_changed_match is not None:

285

292

self.entry_group_state_changed_match = None

286

293

if self.group is not None:

287

294

self.group.Reset()

295

288

296

def add(self):

289

297

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

290

298

self.remove()

307

315

dbus.UInt16(self.port),

308

316

avahi.string_array_to_txt_array(self.TXT))

309

317

self.group.Commit()

318

310

319

def entry_group_state_changed(self, state, error):

311

320

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

312

321

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

319

328

elif state == avahi.ENTRY_GROUP_FAILURE:

320

329

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

321

330

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

331

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

332

.format(error))

333

324

334

def cleanup(self):

325

335

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

326

336

if self.group is not None:

331

341

pass

332

342

self.group = None

333

343

self.remove()

344

334

345

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

335

346

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

336

347

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

355

366

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

356

367

else:

357

368

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

369

358

370

def activate(self):

359

371

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

360

372

if self.server is None:

367

379

self.server_state_changed)

368

380

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

369

381

382

370

383

class AvahiServiceToSyslog(AvahiService):

371

384

def rename(self):

372

385

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

373

386

ret = AvahiService.rename(self)

374

387

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

388

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

389

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

390

.format(self.name)))

378

391

return ret

379

392

380

def _timedelta_to_milliseconds(td):

393

394

def timedelta_to_milliseconds(td):

381

395

"Convert a datetime.timedelta() to milliseconds"

382

396

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

383

397

+ (td.seconds * 1000)

384

398

+ (td.microseconds // 1000))

385

399

400

386

401

class Client(object):

387

402

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

388

403

389

404

Attributes:

390

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

405

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

391

406

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

392

407

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

393

408

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

411

426

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

412

427

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

413

428

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

414

415

429

last_checker_status: integer between 0 and 255 reflecting exit

416

430

status of last checker. -1 reflects crashed

417

checker, or None.

418

last_enabled: datetime.datetime(); (UTC)

431

checker, -2 means no checker completed yet.

432

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

419

433

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

420

434

D-Bus identifiers

421

435

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

422

436

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

423

437

until this client is disabled

424

extended_timeout: extra long timeout when password has been sent

438

extended_timeout: extra long timeout when secret has been sent

425

439

runtime_expansions: Allowed attributes for runtime expansion.

426

440

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

427

441

disabled, or None

428

442

"""

429

443

430

444

runtime_expansions = ("approval_delay", "approval_duration",

431

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

432

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

445

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

446

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

447

"last_approval_request", "last_checked_ok",

433

448

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

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

434

459

435

460

def timeout_milliseconds(self):

436

461

"Return the 'timeout' attribute in milliseconds"

437

return _timedelta_to_milliseconds(self.timeout)

462

return timedelta_to_milliseconds(self.timeout)

438

463

439

464

def extended_timeout_milliseconds(self):

440

465

"Return the 'extended_timeout' attribute in milliseconds"

441

return _timedelta_to_milliseconds(self.extended_timeout)

466

return timedelta_to_milliseconds(self.extended_timeout)

442

467

443

468

def interval_milliseconds(self):

444

469

"Return the 'interval' attribute in milliseconds"

445

return _timedelta_to_milliseconds(self.interval)

470

return timedelta_to_milliseconds(self.interval)

446

471

447

472

def approval_delay_milliseconds(self):

448

return _timedelta_to_milliseconds(self.approval_delay)

449

450

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

451

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

452

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

453

attribute."""

473

return timedelta_to_milliseconds(self.approval_delay)

474

475

@staticmethod

476

def config_parser(config):

477

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

478

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

479

with exceptions for any special settings as defined above.

480

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

481

value given the same arguments.

482

"""

483

settings = {}

484

for client_name in config.sections():

485

section = dict(config.items(client_name))

486

client = settings[client_name] = {}

487

488

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

489

# Reformat values from string types to Python types

490

client["approved_by_default"] = config.getboolean(

491

client_name, "approved_by_default")

492

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

493

"enabled")

494

495

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

496

.replace(" ", ""))

497

if "secret" in section:

498

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

499

elif "secfile" in section:

500

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

501

(section["secfile"])),

502

"rb") as secfile:

503

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

504

else:

505

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

506

.format(section))

507

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

508

client["extended_timeout"] = string_to_delta(

509

section["extended_timeout"])

510

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

511

client["approval_delay"] = string_to_delta(

512

section["approval_delay"])

513

client["approval_duration"] = string_to_delta(

514

section["approval_duration"])

515

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

516

client["last_approval_request"] = None

517

client["last_checked_ok"] = None

518

client["last_checker_status"] = -2

519

520

return settings

521

522

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

454

523

self.name = name

455

if config is None:

456

config = {}

524

# adding all client settings

525

for setting, value in settings.iteritems():

526

setattr(self, setting, value)

527

528

if self.enabled:

529

if not hasattr(self, "last_enabled"):

530

self.last_enabled = datetime.datetime.utcnow()

531

if not hasattr(self, "expires"):

532

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

533

+ self.timeout)

534

else:

535

self.last_enabled = None

536

self.expires = None

537

457

538

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

458

539

# Uppercase and remove spaces from fingerprint for later

459

540

# comparison purposes with return value from the fingerprint()

460

541

# function

461

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

462

.replace(" ", ""))

463

542

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

464

if "secret" in config:

465

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

466

elif "secfile" in config:

467

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

468

(config["secfile"])),

469

"rb") as secfile:

470

self.secret = secfile.read()

471

else:

472

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

473

% self.name)

474

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

475

self.created = datetime.datetime.utcnow()

476

self.enabled = True

477

self.last_approval_request = None

478

self.last_enabled = datetime.datetime.utcnow()

479

self.last_checked_ok = None

480

self.last_checker_status = None

481

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

482

self.extended_timeout = string_to_delta(config

483

["extended_timeout"])

484

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

543

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

544

datetime.datetime.utcnow())

545

546

# attributes specific for this server instance

485

547

self.checker = None

486

548

self.checker_initiator_tag = None

487

549

self.disable_initiator_tag = None

488

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

489

550

self.checker_callback_tag = None

490

self.checker_command = config["checker"]

491

551

self.current_checker_command = None

492

self._approved = None

493

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

494

True)

552

self.approved = None

495

553

self.approvals_pending = 0

496

self.approval_delay = string_to_delta(

497

config["approval_delay"])

498

self.approval_duration = string_to_delta(

499

config["approval_duration"])

500

554

self.changedstate = (multiprocessing_manager

501

555

.Condition(multiprocessing_manager

502

556

.Lock()))

522

576

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

523

577

# Already enabled

524

578

return

525

self.send_changedstate()

526

579

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

527

580

self.enabled = True

528

581

self.last_enabled = datetime.datetime.utcnow()

529

582

self.init_checker()

583

self.send_changedstate()

530

584

531

585

def disable(self, quiet=True):

532

586

"""Disable this client."""

533

587

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

534

588

return False

535

589

if not quiet:

536

self.send_changedstate()

537

if not quiet:

538

590

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

539

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

591

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

540

592

gobject.source_remove(self.disable_initiator_tag)

541

593

self.disable_initiator_tag = None

542

594

self.expires = None

543

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

595

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

544

596

gobject.source_remove(self.checker_initiator_tag)

545

597

self.checker_initiator_tag = None

546

598

self.stop_checker()

547

599

self.enabled = False

600

if not quiet:

601

self.send_changedstate()

548

602

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

549

603

return False

550

604

554

608

def init_checker(self):

555

609

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

556

610

# and every interval from then on.

611

if self.checker_initiator_tag is not None:

612

gobject.source_remove(self.checker_initiator_tag)

557

613

self.checker_initiator_tag = (gobject.timeout_add

558

614

(self.interval_milliseconds(),

559

615

self.start_checker))

560

616

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

617

if self.disable_initiator_tag is not None:

618

gobject.source_remove(self.disable_initiator_tag)

561

619

self.disable_initiator_tag = (gobject.timeout_add

562

620

(self.timeout_milliseconds(),

563

621

self.disable))

569

627

self.checker_callback_tag = None

570

628

self.checker = None

571

629

if os.WIFEXITED(condition):

572

self.last_checker_status = os.WEXITSTATUS(condition)

630

self.last_checker_status = os.WEXITSTATUS(condition)

573

631

if self.last_checker_status == 0:

574

632

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

575

633

vars(self))

582

640

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

583

641

vars(self))

584

642

585

def checked_ok(self, timeout=None):

586

"""Bump up the timeout for this client.

587

588

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

589

alive and well.

590

"""

643

def checked_ok(self):

644

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

645

self.last_checked_ok = datetime.datetime.utcnow()

646

self.last_checker_status = 0

647

self.bump_timeout()

648

649

def bump_timeout(self, timeout=None):

650

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

591

651

if timeout is None:

592

652

timeout = self.timeout

593

self.last_checked_ok = datetime.datetime.utcnow()

594

653

if self.disable_initiator_tag is not None:

595

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = None

596

656

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

597

657

self.disable_initiator_tag = (gobject.timeout_add

598

(_timedelta_to_milliseconds

658

(timedelta_to_milliseconds

599

659

(timeout), self.disable))

600

660

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

601

661

608

668

If a checker already exists, leave it running and do

609

669

nothing."""

610

670

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

611

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

612

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

613

# client would inevitably timeout, since no checker would get

614

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

671

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

672

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

673

# would inevitably timeout, since no checker would get a

674

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

615

675

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

616

676

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

617

677

# should be.

631

691

self.current_checker_command)

632

692

# Start a new checker if needed

633

693

if self.checker is None:

694

# Escape attributes for the shell

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

634

699

try:

635

# In case checker_command has exactly one % operator

636

command = self.checker_command % self.host

637

except TypeError:

638

# Escape attributes for the shell

639

escaped_attrs = dict(

640

(attr,

641

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

642

errors=

643

'replace')))

644

for attr in

645

self.runtime_expansions)

646

647

try:

648

command = self.checker_command % escaped_attrs

649

except TypeError as error:

650

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

651

' %s', self.checker_command, error)

652

return True # Try again later

700

command = self.checker_command % escaped_attrs

701

except TypeError as error:

702

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

653

705

self.current_checker_command = command

654

706

try:

655

707

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

661

713

self.checker = subprocess.Popen(command,

662

714

close_fds=True,

663

715

shell=True, cwd="/")

664

self.checker_callback_tag = (gobject.child_watch_add

665

(self.checker.pid,

666

self.checker_callback,

667

data=command))

668

# The checker may have completed before the gobject

669

# watch was added. Check for this.

670

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

671

if pid:

672

gobject.source_remove(self.checker_callback_tag)

673

self.checker_callback(pid, status, command)

674

716

except OSError as error:

675

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

676

error)

717

logger.error("Failed to start subprocess",

718

exc_info=error)

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

677

729

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

678

730

return True

679

731

686

738

return

687

739

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

688

740

try:

689

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

741

self.checker.terminate()

690

742

#time.sleep(0.5)

691

743

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

692

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

744

# self.checker.kill()

693

745

except OSError as error:

694

746

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

695

747

raise

712

764

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

713

765

if byte_arrays and signature != "ay":

714

766

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

715

" signature %r" % signature)

767

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

716

768

def decorator(func):

717

769

func._dbus_is_property = True

718

770

func._dbus_interface = dbus_interface

726

778

return decorator

727

779

728

780

781

def dbus_interface_annotations(dbus_interface):

782

"""Decorator for marking functions returning interface annotations

783

784

Usage:

785

786

@dbus_interface_annotations("org.example.Interface")

787

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

788

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

789

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

790

"false"}

791

"""

792

def decorator(func):

793

func._dbus_is_interface = True

794

func._dbus_interface = dbus_interface

795

func._dbus_name = dbus_interface

796

return func

797

return decorator

798

799

800

def dbus_annotations(annotations):

801

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

802

Usage:

803

804

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

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

809

def Property_dbus_property(self):

810

return dbus.Boolean(False)

811

"""

812

def decorator(func):

813

func._dbus_annotations = annotations

814

return func

815

return decorator

816

817

729

818

class DBusPropertyException(dbus.exceptions.DBusException):

730

819

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

731

820

"""

754

843

"""

755

844

756

845

@staticmethod

757

def _is_dbus_property(obj):

758

return getattr(obj, "_dbus_is_property", False)

846

def _is_dbus_thing(thing):

847

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

848

849

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

850

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

851

"""

852

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

853

False)

759

854

760

def _get_all_dbus_properties(self):

855

def _get_all_dbus_things(self, thing):

761

856

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

762

857

"""

763

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

858

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

859

name),

860

athing.__get__(self))

764

861

for cls in self.__class__.__mro__

765

for name, prop in

766

inspect.getmembers(cls, self._is_dbus_property))

862

for name, athing in

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

767

865

768

866

def _get_dbus_property(self, interface_name, property_name):

769

867

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

771

869

"""

772

870

for cls in self.__class__.__mro__:

773

871

for name, value in (inspect.getmembers

774

(cls, self._is_dbus_property)):

872

(cls,

873

self._is_dbus_thing("property"))):

775

874

if (value._dbus_name == property_name

776

875

and value._dbus_interface == interface_name):

777

876

return value.__get__(self)

806

905

# signatures other than "ay".

807

906

if prop._dbus_signature != "ay":

808

907

raise ValueError

809

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

810

for byte in value))

908

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

909

for byte in value))

811

910

prop(value)

812

911

813

912

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

819

918

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

820

919

"""

821

920

properties = {}

822

for name, prop in self._get_all_dbus_properties():

921

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

823

922

if (interface_name

824

923

and interface_name != prop._dbus_interface):

825

924

# Interface non-empty but did not match

840

939

path_keyword='object_path',

841

940

connection_keyword='connection')

842

941

def Introspect(self, object_path, connection):

843

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

942

"""Overloading of standard D-Bus method.

943

944

Inserts property tags and interface annotation tags.

844

945

"""

845

946

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

846

947

connection)

853

954

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

854

955

return e

855

956

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

957

# Add property tags

856

958

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

857

959

for name, prop

858

in self._get_all_dbus_properties()

960

in self._get_all_dbus_things("property")

859

961

if prop._dbus_interface

860

962

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

861

963

if_tag.appendChild(tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

862

995

# Add the names to the return values for the

863

996

# "org.freedesktop.DBus.Properties" methods

864

997

if (if_tag.getAttribute("name")

879

1012

except (AttributeError, xml.dom.DOMException,

880

1013

xml.parsers.expat.ExpatError) as error:

881

1014

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

882

error)

1015

exc_info=error)

883

1016

return xmlstring

884

1017

885

1018

886

def datetime_to_dbus (dt, variant_level=0):

1019

def datetime_to_dbus(dt, variant_level=0):

887

1020

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

888

1021

if dt is None:

889

1022

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

891

1024

variant_level=variant_level)

892

1025

893

1026

894

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

895

.__metaclass__):

896

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

897

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

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1028

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

1029

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

1030

interface names according to the "alt_interface_names" mapping.

1031

Usage:

1032

1033

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

1034

"net.example.AlternateInterface"})

1035

class SampleDBusObject(dbus.service.Object):

1036

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

1037

def SampleDBusMethod():

1038

pass

1039

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1041

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

1042

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

1043

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

1044

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

1045

1046

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

1047

(from DBusObjectWithProperties) and interfaces (from the

1048

dbus_interface_annotations decorator).

898

1049

"""

899

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

900

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

901

# methods, signals, or properties in them

902

for base in (b for b in bases

903

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

904

# Go though all attributes of the base class

905

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

1050

def wrapper(cls):

1051

for orig_interface_name, alt_interface_name in (

1052

alt_interface_names.iteritems()):

1053

attr = {}

1054

interface_names = set()

1055

# Go though all attributes of the class

1056

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

906

1057

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

907

1058

# with the wrong interface name

908

1059

if (not hasattr(attribute, "_dbus_interface")

909

1060

or not attribute._dbus_interface

910

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

1061

.startswith(orig_interface_name)):

911

1062

continue

912

1063

# Create an alternate D-Bus interface name based on

913

1064

# the current name

914

1065

alt_interface = (attribute._dbus_interface

915

.replace("se.recompile.Mandos",

916

"se.bsnet.fukt.Mandos"))

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1068

interface_names.add(alt_interface)

917

1069

# Is this a D-Bus signal?

918

1070

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

919

1071

# Extract the original non-method function by

934

1086

nonmethod_func.func_name,

935

1087

nonmethod_func.func_defaults,

936

1088

nonmethod_func.func_closure)))

1089

# Copy annotations, if any

1090

try:

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1093

except AttributeError:

1094

pass

937

1095

# Define a creator of a function to call both the

938

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

939

# signals gets sent when the function is called

1096

# original and alternate functions, so both the

1097

# original and alternate signals gets sent when

1098

# the function is called

940

1099

def fixscope(func1, func2):

941

1100

"""This function is a scope container to pass

942

1101

func1 and func2 to the "call_both" function

949

1108

return call_both

950

1109

# Create the "call_both" function and add it to

951

1110

# the class

952

attr[attrname] = fixscope(attribute,

953

new_function)

1111

attr[attrname] = fixscope(attribute, new_function)

954

1112

# Is this a D-Bus method?

955

1113

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

956

1114

# Create a new, but exactly alike, function

967

1125

attribute.func_name,

968

1126

attribute.func_defaults,

969

1127

attribute.func_closure)))

1128

# Copy annotations, if any

1129

try:

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1132

except AttributeError:

1133

pass

970

1134

# Is this a D-Bus property?

971

1135

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

972

1136

# Create a new, but exactly alike, function

986

1150

attribute.func_name,

987

1151

attribute.func_defaults,

988

1152

attribute.func_closure)))

989

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

990

991

1153

# Copy annotations, if any

1154

try:

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1157

except AttributeError:

1158

pass

1159

# Is this a D-Bus interface?

1160

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

1161

# Create a new, but exactly alike, function

1162

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

1163

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

1164

# to the class.

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1173

if deprecate:

1174

# Deprecate all alternate interfaces

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1176

for interface_name in interface_names:

1177

@dbus_interface_annotations(interface_name)

1178

def func(self):

1179

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

1180

"true" }

1181

# Find an unused name

1182

for aname in (iname.format(i)

1183

for i in itertools.count()):

1184

if aname not in attr:

1185

attr[aname] = func

1186

break

1187

if interface_names:

1188

# Replace the class with a new subclass of it with

1189

# methods, signals, etc. as created above.

1190

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

1191

(cls,), attr)

1192

return cls

1193

return wrapper

1194

1195

1196

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

1197

"se.bsnet.fukt.Mandos"})

992

1198

class ClientDBus(Client, DBusObjectWithProperties):

993

1199

"""A Client class using D-Bus

994

1200

1005

1211

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

1006

1212

self.bus = bus

1007

1213

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

1008

1009

self._approvals_pending = 0

1010

1214

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

1011

1215

# the D-Bus

1012

1216

client_object_name = unicode(self.name).translate(

1016

1220

("/clients/" + client_object_name))

1017

1221

DBusObjectWithProperties.__init__(self, self.bus,

1018

1222

self.dbus_object_path)

1019

1223

1020

1224

def notifychangeproperty(transform_func,

1021

1225

dbus_name, type_func=lambda x: x,

1022

1226

variant_level=1):

1045

1249

1046

1250

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

1047

1251

1048

1049

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1050

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1051

1254

"ApprovalPending",

1058

1261

checker is not None)

1059

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1060

1263

"LastCheckedOK")

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1265

"LastCheckerStatus")

1061

1266

last_approval_request = notifychangeproperty(

1062

1267

datetime_to_dbus, "LastApprovalRequest")

1063

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1064

1269

"ApprovedByDefault")

1065

approval_delay = notifychangeproperty(dbus.UInt16,

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1066

1271

"ApprovalDelay",

1067

1272

type_func =

1068

_timedelta_to_milliseconds)

1273

timedelta_to_milliseconds)

1069

1274

approval_duration = notifychangeproperty(

1070

dbus.UInt16, "ApprovalDuration",

1071

type_func = _timedelta_to_milliseconds)

1275

dbus.UInt64, "ApprovalDuration",

1276

type_func = timedelta_to_milliseconds)

1072

1277

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

1073

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

1278

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

1074

1279

type_func =

1075

_timedelta_to_milliseconds)

1280

timedelta_to_milliseconds)

1076

1281

extended_timeout = notifychangeproperty(

1077

dbus.UInt16, "ExtendedTimeout",

1078

type_func = _timedelta_to_milliseconds)

1079

interval = notifychangeproperty(dbus.UInt16,

1282

dbus.UInt64, "ExtendedTimeout",

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1080

1285

"Interval",

1081

1286

type_func =

1082

_timedelta_to_milliseconds)

1287

timedelta_to_milliseconds)

1083

1288

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

1084

1289

1085

1290

del notifychangeproperty

1127

1332

return r

1128

1333

1129

1334

def _reset_approved(self):

1130

self._approved = None

1335

self.approved = None

1131

1336

return False

1132

1337

1133

1338

def approve(self, value=True):

1134

self.send_changedstate()

1135

self._approved = value

1136

gobject.timeout_add(_timedelta_to_milliseconds

1339

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1137

1341

(self.approval_duration),

1138

1342

self._reset_approved)

1139

1343

self.send_changedstate()

1140

1344

1141

1345

## D-Bus methods, signals & properties

1142

1346

_interface = "se.recompile.Mandos.Client"

1143

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1144

1355

## Signals

1145

1356

1146

1357

# CheckerCompleted - signal

1182

1393

"D-Bus signal"

1183

1394

return self.need_approval()

1184

1395

1185

# NeRwequest - signal

1186

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

1187

def NewRequest(self, ip):

1188

"""D-Bus signal

1189

Is sent after a client request a password.

1190

"""

1191

pass

1192

1193

1396

## Methods

1194

1397

1195

1398

# Approve - method

1253

1456

access="readwrite")

1254

1457

def ApprovalDuration_dbus_property(self, value=None):

1255

1458

if value is None: # get

1256

return dbus.UInt64(_timedelta_to_milliseconds(

1459

return dbus.UInt64(timedelta_to_milliseconds(

1257

1460

self.approval_duration))

1258

1461

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

1259

1462

1273

1476

def Host_dbus_property(self, value=None):

1274

1477

if value is None: # get

1275

1478

return dbus.String(self.host)

1276

self.host = value

1479

self.host = unicode(value)

1277

1480

1278

1481

# Created - property

1279

1482

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

1280

1483

def Created_dbus_property(self):

1281

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

1484

return datetime_to_dbus(self.created)

1282

1485

1283

1486

# LastEnabled - property

1284

1487

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

1305

1508

return

1306

1509

return datetime_to_dbus(self.last_checked_ok)

1307

1510

1511

# LastCheckerStatus - property

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

1514

def LastCheckerStatus_dbus_property(self):

1515

return dbus.Int16(self.last_checker_status)

1516

1308

1517

# Expires - property

1309

1518

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

1310

1519

def Expires_dbus_property(self):

1321

1530

def Timeout_dbus_property(self, value=None):

1322

1531

if value is None: # get

1323

1532

return dbus.UInt64(self.timeout_milliseconds())

1533

old_timeout = self.timeout

1324

1534

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

1325

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

1326

return

1327

# Reschedule timeout

1328

gobject.source_remove(self.disable_initiator_tag)

1329

self.disable_initiator_tag = None

1330

self.expires = None

1331

time_to_die = _timedelta_to_milliseconds((self

1332

.last_checked_ok

1333

+ self.timeout)

1334

- datetime.datetime

1335

.utcnow())

1336

if time_to_die <= 0:

1337

# The timeout has passed

1338

self.disable()

1339

else:

1340

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

1341

+ datetime.timedelta(milliseconds =

1342

time_to_die))

1343

self.disable_initiator_tag = (gobject.timeout_add

1344

(time_to_die, self.disable))

1535

# Reschedule disabling

1536

if self.enabled:

1537

now = datetime.datetime.utcnow()

1538

self.expires += self.timeout - old_timeout

1539

if self.expires <= now:

1540

# The timeout has passed

1541

self.disable()

1542

else:

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

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1345

1551

1346

1552

# ExtendedTimeout - property

1347

1553

@dbus_service_property(_interface, signature="t",

1360

1566

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

1361

1567

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

1362

1568

return

1363

# Reschedule checker run

1364

gobject.source_remove(self.checker_initiator_tag)

1365

self.checker_initiator_tag = (gobject.timeout_add

1366

(value, self.start_checker))

1367

self.start_checker() # Start one now, too

1569

if self.enabled:

1570

# Reschedule checker run

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1368

1575

1369

1576

# Checker - property

1370

1577

@dbus_service_property(_interface, signature="s",

1372

1579

def Checker_dbus_property(self, value=None):

1373

1580

if value is None: # get

1374

1581

return dbus.String(self.checker_command)

1375

self.checker_command = value

1582

self.checker_command = unicode(value)

1376

1583

1377

1584

# CheckerRunning - property

1378

1585

@dbus_service_property(_interface, signature="b",

1407

1614

raise KeyError()

1408

1615

1409

1616

def __getattribute__(self, name):

1410

if(name == '_pipe'):

1617

if name == '_pipe':

1411

1618

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

1412

1619

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

1413

1620

data = self._pipe.recv()

1420

1627

return func

1421

1628

1422

1629

def __setattr__(self, name, value):

1423

if(name == '_pipe'):

1630

if name == '_pipe':

1424

1631

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

1425

1632

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

1426

1633

1427

1634

1428

class ClientDBusTransitional(ClientDBus):

1429

__metaclass__ = AlternateDBusNamesMetaclass

1430

1431

1432

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

1433

1636

"""A class to handle client connections.

1434

1637

1495

1698

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

1496

1699

return

1497

1700

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

1498

if self.server.use_dbus:

1499

# Emit D-Bus signal

1500

client.NewRequest(str(self.client_address))

1501

1701

1502

1702

try:

1503

1703

client = ProxyClient(child_pipe, fpr,

1519

1719

client.Rejected("Disabled")

1520

1720

return

1521

1721

1522

if client._approved or not client.approval_delay:

1722

if client.approved or not client.approval_delay:

1523

1723

#We are approved or approval is disabled

1524

1724

break

1525

elif client._approved is None:

1725

elif client.approved is None:

1526

1726

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

1527

1727

client.name)

1528

1728

if self.server.use_dbus:

1541

1741

#wait until timeout or approved

1542

1742

time = datetime.datetime.now()

1543

1743

client.changedstate.acquire()

1544

(client.changedstate.wait

1545

(float(client._timedelta_to_milliseconds(delay)

1546

/ 1000)))

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

1547

1747

client.changedstate.release()

1548

1748

time2 = datetime.datetime.now()

1549

1749

if (time2 - time) >= delay:

1565

1765

try:

1566

1766

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

1567

1767

except gnutls.errors.GNUTLSError as error:

1568

logger.warning("gnutls send failed")

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1569

1770

return

1570

1771

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

1571

1772

sent, len(client.secret)

1574

1775

1575

1776

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

1576

1777

# bump the timeout using extended_timeout

1577

client.checked_ok(client.extended_timeout)

1778

client.bump_timeout(client.extended_timeout)

1578

1779

if self.server.use_dbus:

1579

1780

# Emit D-Bus signal

1580

1781

client.GotSecret()

1585

1786

try:

1586

1787

session.bye()

1587

1788

except gnutls.errors.GNUTLSError as error:

1588

logger.warning("GnuTLS bye failed")

1789

logger.warning("GnuTLS bye failed",

1790

exc_info=error)

1589

1791

1590

1792

@staticmethod

1591

1793

def peer_certificate(session):

1656

1858

def sub_process_main(self, request, address):

1657

1859

try:

1658

1860

self.finish_request(request, address)

1659

except:

1861

except Exception:

1660

1862

self.handle_error(request, address)

1661

1863

self.close_request(request)

1662

1864

1663

1865

def process_request(self, request, address):

1664

1866

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

1665

1867

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

1666

args = (request,

1667

address))

1868

args = (request, address))

1668

1869

proc.start()

1669

1870

return proc

1670

1871

1698

1899

use_ipv6: Boolean; to use IPv6 or not

1699

1900

"""

1700

1901

def __init__(self, server_address, RequestHandlerClass,

1701

interface=None, use_ipv6=True):

1902

interface=None, use_ipv6=True, socketfd=None):

1903

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

1904

creating a new one with socket.socket().

1905

"""

1702

1906

self.interface = interface

1703

1907

if use_ipv6:

1704

1908

self.address_family = socket.AF_INET6

1909

if socketfd is not None:

1910

# Save the file descriptor

1911

self.socketfd = socketfd

1912

# Save the original socket.socket() function

1913

self.socket_socket = socket.socket

1914

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

1915

#

1916

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

1917

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

1918

# patching socket.socket.)

1919

#

1920

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

1921

@functools.wraps(socket.socket)

1922

def socket_wrapper(*args, **kwargs):

1923

# Restore original function so subsequent calls are

1924

# not affected.

1925

socket.socket = self.socket_socket

1926

del self.socket_socket

1927

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

1928

# saved file descriptor.

1929

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

1930

# Replace socket.socket() function with wrapper

1931

socket.socket = socket_wrapper

1932

# The socketserver.TCPServer.__init__ will call

1933

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

1934

# socket_wrapper(), if socketfd was set.

1705

1935

socketserver.TCPServer.__init__(self, server_address,

1706

1936

RequestHandlerClass)

1937

1707

1938

def server_bind(self):

1708

1939

"""This overrides the normal server_bind() function

1709

1940

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

1720

1951

str(self.interface

1721

1952

+ '\0'))

1722

1953

except socket.error as error:

1723

if error[0] == errno.EPERM:

1954

if error.errno == errno.EPERM:

1724

1955

logger.error("No permission to"

1725

1956

" bind to interface %s",

1726

1957

self.interface)

1727

elif error[0] == errno.ENOPROTOOPT:

1958

elif error.errno == errno.ENOPROTOOPT:

1728

1959

logger.error("SO_BINDTODEVICE not available;"

1729

1960

" cannot bind to interface %s",

1730

1961

self.interface)

1962

elif error.errno == errno.ENODEV:

1963

logger.error("Interface %s does not"

1964

" exist, cannot bind",

1965

self.interface)

1731

1966

else:

1732

1967

raise

1733

1968

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

1763

1998

"""

1764

1999

def __init__(self, server_address, RequestHandlerClass,

1765

2000

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

1766

gnutls_priority=None, use_dbus=True):

2001

gnutls_priority=None, use_dbus=True, socketfd=None):

1767

2002

self.enabled = False

1768

2003

self.clients = clients

1769

2004

if self.clients is None:

1773

2008

IPv6_TCPServer.__init__(self, server_address,

1774

2009

RequestHandlerClass,

1775

2010

interface = interface,

1776

use_ipv6 = use_ipv6)

2011

use_ipv6 = use_ipv6,

2012

socketfd = socketfd)

1777

2013

def server_activate(self):

1778

2014

if self.enabled:

1779

2015

return socketserver.TCPServer.server_activate(self)

1792

2028

1793

2029

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

1794

2030

proc = None, client_object=None):

1795

condition_names = {

1796

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

1797

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

1798

# blocking).

1799

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

1800

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

1801

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

1802

# broken, usually for pipes and

1803

# sockets).

1804

}

1805

conditions_string = ' | '.join(name

1806

for cond, name in

1807

condition_names.iteritems()

1808

if cond & condition)

1809

2031

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

1810

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

2032

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

1811

2033

# Wait for other process to exit

1812

2034

proc.join()

1813

2035

return False

1903

2125

elif suffix == "w":

1904

2126

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

1905

2127

else:

1906

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

2128

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

2129

.format(suffix))

1907

2130

except (ValueError, IndexError) as e:

1908

2131

raise ValueError(*(e.args))

1909

2132

timevalue += delta

1923

2146

sys.exit()

1924

2147

if not noclose:

1925

2148

# Close all standard open file descriptors

1926

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

2149

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

1927

2150

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

1928

2151

raise OSError(errno.ENODEV,

1929

"%s not a character device"

1930

% os.path.devnull)

2152

"{0} not a character device"

2153

.format(os.devnull))

1931

2154

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

1932

2155

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

1933

2156

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

1942

2165

1943

2166

parser = argparse.ArgumentParser()

1944

2167

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

1945

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

2168

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

1946

2169

help="show version number and exit")

1947

2170

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

1948

2171

help="Bind to interface IF")

1973

2196

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

1974

2197

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

1975

2198

" state")

2199

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

2200

help="Specify a file descriptor to a network"

2201

" socket to use instead of creating one")

1976

2202

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

1977

2203

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

1978

2204

1995

2221

"use_ipv6": "True",

1996

2222

"debuglevel": "",

1997

2223

"restore": "True",

2224

"socket": "",

1998

2225

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

1999

2226

}

2000

2227

2012

2239

if server_settings["port"]:

2013

2240

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

2014

2241

"port")

2242

if server_settings["socket"]:

2243

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

2244

"socket")

2245

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

2246

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

2247

# happen with a supplied network socket.

2248

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

2249

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

2250

["socket"])

2015

2251

del server_config

2016

2252

2017

2253

# Override the settings from the config file with command line

2019

2255

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

2020

2256

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

2021

2257

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

2022

"statedir"):

2258

"statedir", "socket"):

2023

2259

value = getattr(options, option)

2024

2260

if value is not None:

2025

2261

server_settings[option] = value

2041

2277

stored_state_file)

2042

2278

2043

2279

if debug:

2044

initlogger(logging.DEBUG)

2280

initlogger(debug, logging.DEBUG)

2045

2281

else:

2046

2282

if not debuglevel:

2047

initlogger()

2283

initlogger(debug)

2048

2284

else:

2049

2285

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

2050

initlogger(level)

2286

initlogger(debug, level)

2051

2287

2052

2288

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

2053

2289

syslogger.setFormatter(logging.Formatter

2054

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

2055

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

2056

% server_settings["servicename"]))

2290

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

2291

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

2292

.format(server_settings

2293

["servicename"])))

2057

2294

2058

2295

# Parse config file with clients

2059

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

2060

"extended_timeout": "15m",

2061

"interval": "2m",

2062

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

2063

"host": "",

2064

"approval_delay": "0s",

2065

"approval_duration": "1s",

2066

}

2067

client_config = configparser.SafeConfigParser(client_defaults)

2296

client_config = configparser.SafeConfigParser(Client

2297

.client_defaults)

2068

2298

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

2069

2299

"clients.conf"))

2070

2300

2079

2309

use_ipv6=use_ipv6,

2080

2310

gnutls_priority=

2081

2311

server_settings["priority"],

2082

use_dbus=use_dbus)

2312

use_dbus=use_dbus,

2313

socketfd=(server_settings["socket"]

2314

or None))

2083

2315

if not debug:

2084

2316

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

2085

2317

try:

2086

2318

pidfile = open(pidfilename, "w")

2087

except IOError:

2088

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

2319

except IOError as e:

2320

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

2321

exc_info=e)

2089

2322

2090

try:

2091

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

2092

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

2093

except KeyError:

2323

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

2094

2324

try:

2095

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

2096

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

2325

uid = pwd.getpwnam(name).pw_uid

2326

gid = pwd.getpwnam(name).pw_gid

2327

break

2097

2328

except KeyError:

2098

try:

2099

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

2100

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

2101

except KeyError:

2102

uid = 65534

2103

gid = 65534

2329

continue

2330

else:

2331

uid = 65534

2332

gid = 65534

2104

2333

try:

2105

2334

os.setgid(gid)

2106

2335

os.setuid(uid)

2107

2336

except OSError as error:

2108

if error[0] != errno.EPERM:

2337

if error.errno != errno.EPERM:

2109

2338

raise error

2110

2339

2111

2340

if debug:

2123

2352

.gnutls_global_set_log_function(debug_gnutls))

2124

2353

2125

2354

# Redirect stdin so all checkers get /dev/null

2126

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

2355

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

2127

2356

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

2128

2357

if null > 2:

2129

2358

os.close(null)

2130

else:

2131

# No console logging

2132

logger.removeHandler(console)

2133

2359

2134

2360

# Need to fork before connecting to D-Bus

2135

2361

if not debug:

2136

2362

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

2137

2363

daemon()

2138

2364

2365

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

2366

# need to inform gobject that threads will be used.

2367

gobject.threads_init()

2368

2139

2369

global main_loop

2140

2370

# From the Avahi example code

2141

DBusGMainLoop(set_as_default=True )

2371

DBusGMainLoop(set_as_default=True)

2142

2372

main_loop = gobject.MainLoop()

2143

2373

bus = dbus.SystemBus()

2144

2374

# End of Avahi example code

2150

2380

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

2151

2381

do_not_queue=True))

2152

2382

except dbus.exceptions.NameExistsException as e:

2153

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

2383

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

2154

2384

use_dbus = False

2155

2385

server_settings["use_dbus"] = False

2156

2386

tcp_server.use_dbus = False

2168

2398

2169

2399

client_class = Client

2170

2400

if use_dbus:

2171

client_class = functools.partial(ClientDBusTransitional,

2172

bus = bus)

2173

2174

special_settings = {

2175

# Some settings need to be accessd by special methods;

2176

# booleans need .getboolean(), etc. Here is a list of them:

2177

"approved_by_default":

2178

lambda section:

2179

client_config.getboolean(section, "approved_by_default"),

2180

}

2181

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

2182

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

2183

# with exceptions for any special settings as defined above

2184

client_settings = dict((clientname,

2185

dict((setting,

2186

(value

2187

if setting not in special_settings

2188

else special_settings[setting]

2189

(clientname)))

2190

for setting, value in

2191

client_config.items(clientname)))

2192

for clientname in client_config.sections())

2193

2401

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

2402

2403

client_settings = Client.config_parser(client_config)

2194

2404

old_client_settings = {}

2195

clients_data = []

2405

clients_data = {}

2196

2406

2197

2407

# Get client data and settings from last running state.

2198

2408

if server_settings["restore"]:

2202

2412

(stored_state))

2203

2413

os.remove(stored_state_path)

2204

2414

except IOError as e:

2205

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

2206

.format(e))

2207

if e.errno != errno.ENOENT:

2415

if e.errno == errno.ENOENT:

2416

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

2417

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

2418

else:

2419

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

2420

exc_info=e)

2208

2421

raise

2422

except EOFError as e:

2423

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

2424

"EOFError:", exc_info=e)

2209

2425

2210

with Crypto() as crypt:

2211

for client in clients_data:

2212

client_name = client["name"]

2213

2426

with PGPEngine() as pgp:

2427

for client_name, client in clients_data.iteritems():

2214

2428

# Decide which value to use after restoring saved state.

2215

2429

# We have three different values: Old config file,

2216

2430

# new config file, and saved state.

2224

2438

if (name != "secret" and

2225

2439

value != old_client_settings[client_name]

2226

2440

[name]):

2227

setattr(client, name, value)

2441

client[name] = value

2228

2442

except KeyError:

2229

2443

pass

2230

2444

2231

2445

# Clients who has passed its expire date can still be

2232

# enabled if its last checker was sucessful. Clients

2233

# whose checker failed before we stored its state is

2234

# assumed to have failed all checkers during downtime.

2235

if client["enabled"] and client["last_checked_ok"]:

2236

if ((datetime.datetime.utcnow()

2237

- client["last_checked_ok"])

2238

> client["interval"]):

2239

if client["last_checker_status"] != 0:

2446

# enabled if its last checker was successful. Clients

2447

# whose checker succeeded before we stored its state is

2448

# assumed to have successfully run all checkers during

2449

# downtime.

2450

if client["enabled"]:

2451

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

2452

if not client["last_checked_ok"]:

2453

logger.warning(

2454

"disabling client {0} - Client never "

2455

"performed a successful checker"

2456

.format(client_name))

2457

client["enabled"] = False

2458

elif client["last_checker_status"] != 0:

2459

logger.warning(

2460

"disabling client {0} - Client "

2461

"last checker failed with error code {1}"

2462

.format(client_name,

2463

client["last_checker_status"]))

2240

2464

client["enabled"] = False

2241

2465

else:

2242

2466

client["expires"] = (datetime.datetime

2243

2467

.utcnow()

2244

2468

+ client["timeout"])

2245

2246

client["changedstate"] = (multiprocessing_manager

2247

.Condition

2248

(multiprocessing_manager

2249

.Lock()))

2250

if use_dbus:

2251

new_client = (ClientDBusTransitional.__new__

2252

(ClientDBusTransitional))

2253

tcp_server.clients[client_name] = new_client

2254

new_client.bus = bus

2255

for name, value in client.iteritems():

2256

setattr(new_client, name, value)

2257

client_object_name = unicode(client_name).translate(

2258

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

2259

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

2260

new_client.dbus_object_path = (dbus.ObjectPath

2261

("/clients/"

2262

+ client_object_name))

2263

DBusObjectWithProperties.__init__(new_client,

2264

new_client.bus,

2265

new_client

2266

.dbus_object_path)

2267

else:

2268

tcp_server.clients[client_name] = (Client.__new__

2269

(Client))

2270

for name, value in client.iteritems():

2271

setattr(tcp_server.clients[client_name],

2272

name, value)

2273

2469

logger.debug("Last checker succeeded,"

2470

" keeping {0} enabled"

2471

.format(client_name))

2274

2472

try:

2275

tcp_server.clients[client_name].secret = (

2276

crypt.decrypt(tcp_server.clients[client_name]

2277

.encrypted_secret,

2278

client_settings[client_name]

2279

["secret"]))

2280

except CryptoError:

2473

client["secret"] = (

2474

pgp.decrypt(client["encrypted_secret"],

2475

client_settings[client_name]

2476

["secret"]))

2477

except PGPError:

2281

2478

# If decryption fails, we use secret from new settings

2282

tcp_server.clients[client_name].secret = (

2479

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

2480

.format(client_name))

2481

client["secret"] = (

2283

2482

client_settings[client_name]["secret"])

2284

2483

2285

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

2286

for clientname in set(old_client_settings) - set(client_settings):

2287

del tcp_server.clients[clientname]

2288

for clientname in set(client_settings) - set(old_client_settings):

2289

tcp_server.clients[clientname] = (client_class(name

2290

= clientname,

2291

config =

2292

client_settings

2293

[clientname]))

2484

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

2485

for client_name in (set(old_client_settings)

2486

- set(client_settings)):

2487

del clients_data[client_name]

2488

for client_name in (set(client_settings)

2489

- set(old_client_settings)):

2490

clients_data[client_name] = client_settings[client_name]

2491

2492

# Create all client objects

2493

for client_name, client in clients_data.iteritems():

2494

tcp_server.clients[client_name] = client_class(

2495

name = client_name, settings = client)

2294

2496

2295

2497

if not tcp_server.clients:

2296

2498

logger.warning("No clients defined")

2297

2499

2298

2500

if not debug:

2299

2501

try:

2300

2502

with pidfile:

2308

2510

# "pidfile" was never created

2309

2511

pass

2310

2512

del pidfilename

2311

2312

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

2313

2513

2314

2514

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

2315

2515

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

2316

2516

2317

2517

if use_dbus:

2318

class MandosDBusService(dbus.service.Object):

2518

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

2519

"se.bsnet.fukt.Mandos"})

2520

class MandosDBusService(DBusObjectWithProperties):

2319

2521

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

2320

2522

def __init__(self):

2321

2523

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

2322

2524

_interface = "se.recompile.Mandos"

2323

2525

2526

@dbus_interface_annotations(_interface)

2527

def _foo(self):

2528

return { "org.freedesktop.DBus.Property"

2529

".EmitsChangedSignal":

2530

"false"}

2531

2324

2532

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

2325

2533

def ClientAdded(self, objpath):

2326

2534

"D-Bus signal"

2368

2576

2369

2577

del _interface

2370

2578

2371

class MandosDBusServiceTransitional(MandosDBusService):

2372

__metaclass__ = AlternateDBusNamesMetaclass

2373

mandos_dbus_service = MandosDBusServiceTransitional()

2579

mandos_dbus_service = MandosDBusService()

2374

2580

2375

2581

def cleanup():

2376

2582

"Cleanup function; run on exit"

2383

2589

# Store client before exiting. Secrets are encrypted with key

2384

2590

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

2385

2591

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

2386

clients = []

2387

with Crypto() as crypt:

2592

clients = {}

2593

with PGPEngine() as pgp:

2388

2594

for client in tcp_server.clients.itervalues():

2389

2595

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

2390

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

2391

key)

2596

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

2597

key)

2392

2598

client_dict = {}

2393

2599

2394

# A list of attributes that will not be stored when

2395

# shutting down.

2396

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

2600

# A list of attributes that can not be pickled

2601

# + secret.

2602

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

2603

"checker"))

2397

2604

for name, typ in (inspect.getmembers

2398

2605

(dbus.service.Object)):

2399

2606

exclude.add(name)

2404

2611

if attr not in exclude:

2405

2612

client_dict[attr] = getattr(client, attr)

2406

2613

2407

clients.append(client_dict)

2614

clients[client.name] = client_dict

2408

2615

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

2409

2616

2410

2617

try:

2411

with os.fdopen(os.open(stored_state_path,

2412

os.O_CREAT|os.O_WRONLY|os.O_TRUNC,

2413

0600), "wb") as stored_state:

2618

with (tempfile.NamedTemporaryFile

2619

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

2620

dir=os.path.dirname(stored_state_path),

2621

delete=False)) as stored_state:

2414

2622

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

2623

tempname=stored_state.name

2624

os.rename(tempname, stored_state_path)

2415

2625

except (IOError, OSError) as e:

2416

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

2417

.format(e))

2418

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

2419

raise

2626

if not debug:

2627

try:

2628

os.remove(tempname)

2629

except NameError:

2630

pass

2631

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

2632

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

2633

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

2634

else:

2635

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

2636

exc_info=e)

2637

raise e

2420

2638

2421

2639

# Delete all clients, and settings from config

2422

2640

while tcp_server.clients:

2449

2667

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

2450

2668

if use_ipv6:

2451

2669

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

2452

" flowinfo %d, scope_id %d"

2453

% tcp_server.socket.getsockname())

2670

" flowinfo %d, scope_id %d",

2671

*tcp_server.socket.getsockname())

2454

2672

else: # IPv4

2455

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

2456

% tcp_server.socket.getsockname())

2673

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

2674

*tcp_server.socket.getsockname())

2457

2675

2458

2676

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

2459

2677

2462

2680

try:

2463

2681

service.activate()

2464

2682

except dbus.exceptions.DBusException as error:

2465

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

2683

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

2466

2684

cleanup()

2467

2685

sys.exit(1)

2468

2686

# End of Avahi example code

2475

2693

logger.debug("Starting main loop")

2476

2694

main_loop.run()

2477

2695

except AvahiError as error:

2478

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

2696

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

2479

2697

cleanup()

2480

2698

sys.exit(1)

2481

2699

except KeyboardInterrupt:

2486

2704

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

2487

2705

cleanup()

2488

2706

2489

2490

2707

if __name__ == '__main__':

2491

2708

main()