/mandos/release : revision 237.7.195

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

71

import collections

68

72

69

73

import dbus

70

74

import dbus.service

75

79

import ctypes.util

76

80

import xml.dom.minidom

77

81

import inspect

78

import GnuPGInterface

79

82

80

83

try:

81

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

88

except ImportError:

86

89

SO_BINDTODEVICE = None

87

90

88

version = "1.4.1"

91

version = "1.6.2"

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

110

113

return interface_index

111

114

112

115

113

def initlogger(level=logging.WARNING):

116

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

114

117

"""init logger and add loglevel"""

115

118

116

119

syslogger.setFormatter(logging.Formatter

118

121

' %(message)s'))

119

122

logger.addHandler(syslogger)

120

123

121

console = logging.StreamHandler()

122

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

123

' [%(process)d]:'

124

' %(levelname)s:'

125

' %(message)s'))

126

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)

127

131

logger.setLevel(level)

128

132

129

133

135

139

class PGPEngine(object):

136

140

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

137

141

def __init__(self):

138

self.gnupg = GnuPGInterface.GnuPG()

139

142

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

140

self.gnupg = GnuPGInterface.GnuPG()

141

self.gnupg.options.meta_interactive = False

142

self.gnupg.options.homedir = self.tempdir

143

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

144

'--quiet'])

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

145

148

146

149

def __enter__(self):

147

150

return self

148

151

149

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

152

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

150

153

self._cleanup()

151

154

return False

152

155

169

172

def password_encode(self, password):

170

173

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

171

174

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

172

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

175

encoded = b"mandos" + binascii.hexlify(password)

176

if len(encoded) > 2048:

177

# GnuPG can't handle long passwords, so encode differently

178

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

179

.replace(b"\n", b"\\n")

180

.replace(b"\0", b"\\x00"))

181

return encoded

173

182

174

183

def encrypt(self, data, password):

175

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

176

with open(os.devnull) as devnull:

177

try:

178

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

179

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

180

attach_fhs={'stderr': devnull})

181

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

182

f.write(data)

183

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

184

ciphertext = f.read()

185

proc.wait()

186

except IOError as e:

187

raise PGPError(e)

188

self.gnupg.passphrase = None

184

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

187

passfile.write(passphrase)

188

passfile.flush()

189

proc = subprocess.Popen(['gpg', '--symmetric',

190

'--passphrase-file',

191

passfile.name]

192

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

ciphertext, err = proc.communicate(input = data)

197

if proc.returncode != 0:

198

raise PGPError(err)

189

199

return ciphertext

190

200

191

201

def decrypt(self, data, password):

192

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

193

with open(os.devnull) as devnull:

194

try:

195

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

196

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

197

attach_fhs={'stderr': devnull})

198

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

199

f.write(data)

200

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

201

decrypted_plaintext = f.read()

202

proc.wait()

203

except IOError as e:

204

raise PGPError(e)

205

self.gnupg.passphrase = None

202

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

205

passfile.write(passphrase)

206

passfile.flush()

207

proc = subprocess.Popen(['gpg', '--decrypt',

208

'--passphrase-file',

209

passfile.name]

210

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

216

if proc.returncode != 0:

217

raise PGPError(err)

206

218

return decrypted_plaintext

207

219

208

220

209

210

221

class AvahiError(Exception):

211

222

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

212

223

self.value = value

229

240

Used to optionally bind to the specified interface.

230

241

name: string; Example: 'Mandos'

231

242

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

232

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

243

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

233

244

port: integer; what port to announce

234

245

TXT: list of strings; TXT record for the service

235

246

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

241

252

server: D-Bus Server

242

253

bus: dbus.SystemBus()

243

254

"""

255

244

256

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

245

257

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

246

258

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

259

271

self.server = None

260

272

self.bus = bus

261

273

self.entry_group_state_changed_match = None

274

262

275

def rename(self):

263

276

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

264

277

if self.rename_count >= self.max_renames:

274

287

try:

275

288

self.add()

276

289

except dbus.exceptions.DBusException as error:

277

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

290

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

278

291

self.cleanup()

279

292

os._exit(1)

280

293

self.rename_count += 1

294

281

295

def remove(self):

282

296

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

283

297

if self.entry_group_state_changed_match is not None:

285

299

self.entry_group_state_changed_match = None

286

300

if self.group is not None:

287

301

self.group.Reset()

302

288

303

def add(self):

289

304

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

290

305

self.remove()

307

322

dbus.UInt16(self.port),

308

323

avahi.string_array_to_txt_array(self.TXT))

309

324

self.group.Commit()

325

310

326

def entry_group_state_changed(self, state, error):

311

327

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

312

328

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

319

335

elif state == avahi.ENTRY_GROUP_FAILURE:

320

336

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

321

337

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

338

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

339

.format(error))

340

324

341

def cleanup(self):

325

342

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

326

343

if self.group is not None:

331

348

pass

332

349

self.group = None

333

350

self.remove()

351

334

352

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

335

353

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

336

354

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

355

373

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

356

374

else:

357

375

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

376

358

377

def activate(self):

359

378

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

360

379

if self.server is None:

367

386

self.server_state_changed)

368

387

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

369

388

389

370

390

class AvahiServiceToSyslog(AvahiService):

371

391

def rename(self):

372

392

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

373

393

ret = AvahiService.rename(self)

374

394

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

395

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

396

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

397

.format(self.name)))

378

398

return ret

379

399

400

380

401

def timedelta_to_milliseconds(td):

381

402

"Convert a datetime.timedelta() to milliseconds"

382

403

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

383

404

+ (td.seconds * 1000)

384

405

+ (td.microseconds // 1000))

385

406

407

386

408

class Client(object):

387

409

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

388

410

413

435

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

414

436

last_checker_status: integer between 0 and 255 reflecting exit

415

437

status of last checker. -1 reflects crashed

416

checker, or None.

438

checker, -2 means no checker completed yet.

417

439

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

418

440

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

419

441

D-Bus identifiers

420

442

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

421

443

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

422

444

until this client is disabled

423

extended_timeout: extra long timeout when password has been sent

445

extended_timeout: extra long timeout when secret has been sent

424

446

runtime_expansions: Allowed attributes for runtime expansion.

425

447

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

426

448

disabled, or None

449

server_settings: The server_settings dict from main()

427

450

"""

428

451

429

452

runtime_expansions = ("approval_delay", "approval_duration",

430

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

431

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

453

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

454

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

455

"last_approval_request", "last_checked_ok",

432

456

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

433

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

434

"extended_timeout": "15m",

435

"interval": "2m",

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

436

460

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

437

461

"host": "",

438

"approval_delay": "0s",

439

"approval_duration": "1s",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

440

464

"approved_by_default": "True",

441

465

"enabled": "True",

442

466

}

455

479

456

480

def approval_delay_milliseconds(self):

457

481

return timedelta_to_milliseconds(self.approval_delay)

458

482

459

483

@staticmethod

460

484

def config_parser(config):

461

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

485

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

462

486

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

463

with exceptions for any special settings as defined above"""

487

with exceptions for any special settings as defined above.

488

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

489

value given the same arguments.

490

"""

464

491

settings = {}

465

492

for client_name in config.sections():

466

493

section = dict(config.items(client_name))

470

497

# Reformat values from string types to Python types

471

498

client["approved_by_default"] = config.getboolean(

472

499

client_name, "approved_by_default")

473

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

500

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

501

"enabled")

474

502

475

503

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

476

504

.replace(" ", ""))

482

510

"rb") as secfile:

483

511

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

484

512

else:

485

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

486

% section)

513

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

514

.format(section))

487

515

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

488

516

client["extended_timeout"] = string_to_delta(

489

517

section["extended_timeout"])

495

523

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

496

524

client["last_approval_request"] = None

497

525

client["last_checked_ok"] = None

498

client["last_checker_status"] = None

499

if client["enabled"]:

500

client["last_enabled"] = datetime.datetime.utcnow()

501

client["expires"] = (datetime.datetime.utcnow()

502

+ client["timeout"])

503

else:

504

client["last_enabled"] = None

505

client["expires"] = None

506

526

client["last_checker_status"] = -2

527

507

528

return settings

508

509

510

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

511

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

512

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

513

attribute."""

529

530

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

514

531

self.name = name

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

515

535

# adding all client settings

516

536

for setting, value in settings.iteritems():

517

537

setattr(self, setting, value)

518

538

539

if self.enabled:

540

if not hasattr(self, "last_enabled"):

541

self.last_enabled = datetime.datetime.utcnow()

542

if not hasattr(self, "expires"):

543

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

544

+ self.timeout)

545

else:

546

self.last_enabled = None

547

self.expires = None

548

519

549

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

520

550

# Uppercase and remove spaces from fingerprint for later

521

551

# comparison purposes with return value from the fingerprint()

522

552

# function

523

553

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

524

self.created = settings.get("created", datetime.datetime.utcnow())

525

554

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

555

datetime.datetime.utcnow())

556

526

557

# attributes specific for this server instance

527

558

self.checker = None

528

559

self.checker_initiator_tag = None

556

587

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

557

588

# Already enabled

558

589

return

559

self.send_changedstate()

560

590

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

561

591

self.enabled = True

562

592

self.last_enabled = datetime.datetime.utcnow()

563

593

self.init_checker()

594

self.send_changedstate()

564

595

565

596

def disable(self, quiet=True):

566

597

"""Disable this client."""

567

598

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

568

599

return False

569

600

if not quiet:

570

self.send_changedstate()

571

if not quiet:

572

601

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

573

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

602

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

574

603

gobject.source_remove(self.disable_initiator_tag)

575

604

self.disable_initiator_tag = None

576

605

self.expires = None

577

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

606

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

578

607

gobject.source_remove(self.checker_initiator_tag)

579

608

self.checker_initiator_tag = None

580

609

self.stop_checker()

581

610

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

582

613

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

583

614

return False

584

615

588

619

def init_checker(self):

589

620

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

590

621

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

591

624

self.checker_initiator_tag = (gobject.timeout_add

592

625

(self.interval_milliseconds(),

593

626

self.start_checker))

594

627

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

628

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

595

630

self.disable_initiator_tag = (gobject.timeout_add

596

631

(self.timeout_milliseconds(),

597

632

self.disable))

616

651

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

617

652

vars(self))

618

653

619

def checked_ok(self, timeout=None):

620

"""Bump up the timeout for this client.

621

622

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

623

alive and well.

624

"""

654

def checked_ok(self):

655

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

656

self.last_checked_ok = datetime.datetime.utcnow()

657

self.last_checker_status = 0

658

self.bump_timeout()

659

660

def bump_timeout(self, timeout=None):

661

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

625

662

if timeout is None:

626

663

timeout = self.timeout

627

self.last_checked_ok = datetime.datetime.utcnow()

628

664

if self.disable_initiator_tag is not None:

629

665

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

630

667

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

631

668

self.disable_initiator_tag = (gobject.timeout_add

632

669

(timedelta_to_milliseconds

642

679

If a checker already exists, leave it running and do

643

680

nothing."""

644

681

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

645

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

646

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

647

# client would inevitably timeout, since no checker would get

648

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

682

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

683

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

684

# would inevitably timeout, since no checker would get a

685

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

649

686

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

650

687

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

651

688

# should be.

653

690

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

654

691

try:

655

692

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

656

except (AttributeError, OSError) as error:

657

if (isinstance(error, OSError)

658

and error.errno != errno.ECHILD):

659

raise error

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

660

698

else:

661

699

if pid:

662

700

logger.warning("Checker was a zombie")

665

703

self.current_checker_command)

666

704

# Start a new checker if needed

667

705

if self.checker is None:

706

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

668

711

try:

669

# In case checker_command has exactly one % operator

670

command = self.checker_command % self.host

671

except TypeError:

672

# Escape attributes for the shell

673

escaped_attrs = dict(

674

(attr,

675

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

676

errors=

677

'replace')))

678

for attr in

679

self.runtime_expansions)

680

681

try:

682

command = self.checker_command % escaped_attrs

683

except TypeError as error:

684

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

685

' %s', self.checker_command, error)

686

return True # Try again later

712

command = self.checker_command % escaped_attrs

713

except TypeError as error:

714

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

687

717

self.current_checker_command = command

688

718

try:

689

719

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

692

722

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

693

723

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

694

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

695

733

self.checker = subprocess.Popen(command,

696

734

close_fds=True,

697

shell=True, cwd="/")

698

self.checker_callback_tag = (gobject.child_watch_add

699

(self.checker.pid,

700

self.checker_callback,

701

data=command))

702

# The checker may have completed before the gobject

703

# watch was added. Check for this.

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

704

748

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

705

if pid:

706

gobject.source_remove(self.checker_callback_tag)

707

self.checker_callback(pid, status, command)

708

749

except OSError as error:

709

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

710

error)

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

711

759

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

712

760

return True

713

761

720

768

return

721

769

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

722

770

try:

723

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

771

self.checker.terminate()

724

772

#time.sleep(0.5)

725

773

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

726

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

774

# self.checker.kill()

727

775

except OSError as error:

728

776

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

729

777

raise

746

794

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

747

795

if byte_arrays and signature != "ay":

748

796

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

749

" signature %r" % signature)

797

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

750

798

def decorator(func):

751

799

func._dbus_is_property = True

752

800

func._dbus_interface = dbus_interface

760

808

return decorator

761

809

762

810

811

def dbus_interface_annotations(dbus_interface):

812

"""Decorator for marking functions returning interface annotations

813

814

Usage:

815

816

@dbus_interface_annotations("org.example.Interface")

817

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

818

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

819

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

820

"false"}

821

"""

822

def decorator(func):

823

func._dbus_is_interface = True

824

func._dbus_interface = dbus_interface

825

func._dbus_name = dbus_interface

826

return func

827

return decorator

828

829

830

def dbus_annotations(annotations):

831

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

832

Usage:

833

834

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

835

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

def Property_dbus_property(self):

840

return dbus.Boolean(False)

841

"""

842

def decorator(func):

843

func._dbus_annotations = annotations

844

return func

845

return decorator

846

847

763

848

class DBusPropertyException(dbus.exceptions.DBusException):

764

849

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

765

850

"""

788

873

"""

789

874

790

875

@staticmethod

791

def _is_dbus_property(obj):

792

return getattr(obj, "_dbus_is_property", False)

876

def _is_dbus_thing(thing):

877

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

878

879

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

880

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

881

"""

882

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

883

False)

793

884

794

def _get_all_dbus_properties(self):

885

def _get_all_dbus_things(self, thing):

795

886

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

796

887

"""

797

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

888

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

889

name),

890

athing.__get__(self))

798

891

for cls in self.__class__.__mro__

799

for name, prop in

800

inspect.getmembers(cls, self._is_dbus_property))

892

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

801

895

802

896

def _get_dbus_property(self, interface_name, property_name):

803

897

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

805

899

"""

806

900

for cls in self.__class__.__mro__:

807

901

for name, value in (inspect.getmembers

808

(cls, self._is_dbus_property)):

902

(cls,

903

self._is_dbus_thing("property"))):

809

904

if (value._dbus_name == property_name

810

905

and value._dbus_interface == interface_name):

811

906

return value.__get__(self)

840

935

# signatures other than "ay".

841

936

if prop._dbus_signature != "ay":

842

937

raise ValueError

843

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

844

for byte in value))

938

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

939

for byte in value))

845

940

prop(value)

846

941

847

942

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

853

948

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

854

949

"""

855

950

properties = {}

856

for name, prop in self._get_all_dbus_properties():

951

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

857

952

if (interface_name

858

953

and interface_name != prop._dbus_interface):

859

954

# Interface non-empty but did not match

874

969

path_keyword='object_path',

875

970

connection_keyword='connection')

876

971

def Introspect(self, object_path, connection):

877

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

972

"""Overloading of standard D-Bus method.

973

974

Inserts property tags and interface annotation tags.

878

975

"""

879

976

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

880

977

connection)

887

984

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

888

985

return e

889

986

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

987

# Add property tags

890

988

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

891

989

for name, prop

892

in self._get_all_dbus_properties()

990

in self._get_all_dbus_things("property")

893

991

if prop._dbus_interface

894

992

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

895

993

if_tag.appendChild(tag)

994

# Add annotation tags

995

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

996

for tag in if_tag.getElementsByTagName(typ):

997

annots = dict()

998

for name, prop in (self.

999

_get_all_dbus_things(typ)):

1000

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

1001

and prop._dbus_interface

1002

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

1003

annots.update(getattr

1004

(prop,

1005

"_dbus_annotations",

1006

{}))

1007

for name, value in annots.iteritems():

1008

ann_tag = document.createElement(

1009

"annotation")

1010

ann_tag.setAttribute("name", name)

1011

ann_tag.setAttribute("value", value)

1012

tag.appendChild(ann_tag)

1013

# Add interface annotation tags

1014

for annotation, value in dict(

1015

itertools.chain.from_iterable(

1016

annotations().iteritems()

1017

for name, annotations in

1018

self._get_all_dbus_things("interface")

1019

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

1020

)).iteritems():

1021

ann_tag = document.createElement("annotation")

1022

ann_tag.setAttribute("name", annotation)

1023

ann_tag.setAttribute("value", value)

1024

if_tag.appendChild(ann_tag)

896

1025

# Add the names to the return values for the

897

1026

# "org.freedesktop.DBus.Properties" methods

898

1027

if (if_tag.getAttribute("name")

913

1042

except (AttributeError, xml.dom.DOMException,

914

1043

xml.parsers.expat.ExpatError) as error:

915

1044

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

916

error)

1045

exc_info=error)

917

1046

return xmlstring

918

1047

919

1048

920

def datetime_to_dbus (dt, variant_level=0):

1049

def datetime_to_dbus(dt, variant_level=0):

921

1050

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

922

1051

if dt is None:

923

1052

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

925

1054

variant_level=variant_level)

926

1055

927

1056

928

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

929

.__metaclass__):

930

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

931

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

1057

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1058

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

1059

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

1060

interface names according to the "alt_interface_names" mapping.

1061

Usage:

1062

1063

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

1064

"net.example.AlternateInterface"})

1065

class SampleDBusObject(dbus.service.Object):

1066

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

1067

def SampleDBusMethod():

1068

pass

1069

1070

The above "SampleDBusMethod" on "SampleDBusObject" will be

1071

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

1072

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

1073

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

1074

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

1075

1076

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

1077

(from DBusObjectWithProperties) and interfaces (from the

1078

dbus_interface_annotations decorator).

932

1079

"""

933

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

934

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

935

# methods, signals, or properties in them

936

for base in (b for b in bases

937

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

938

# Go though all attributes of the base class

939

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

1080

def wrapper(cls):

1081

for orig_interface_name, alt_interface_name in (

1082

alt_interface_names.iteritems()):

1083

attr = {}

1084

interface_names = set()

1085

# Go though all attributes of the class

1086

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

940

1087

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

941

1088

# with the wrong interface name

942

1089

if (not hasattr(attribute, "_dbus_interface")

943

1090

or not attribute._dbus_interface

944

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

1091

.startswith(orig_interface_name)):

945

1092

continue

946

1093

# Create an alternate D-Bus interface name based on

947

1094

# the current name

948

1095

alt_interface = (attribute._dbus_interface

949

.replace("se.recompile.Mandos",

950

"se.bsnet.fukt.Mandos"))

1096

.replace(orig_interface_name,

1097

alt_interface_name))

1098

interface_names.add(alt_interface)

951

1099

# Is this a D-Bus signal?

952

1100

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

953

# Extract the original non-method function by

954

# black magic

1101

# Extract the original non-method undecorated

1102

# function by black magic

955

1103

nonmethod_func = (dict(

956

1104

zip(attribute.func_code.co_freevars,

957

1105

attribute.__closure__))["func"]

968

1116

nonmethod_func.func_name,

969

1117

nonmethod_func.func_defaults,

970

1118

nonmethod_func.func_closure)))

1119

# Copy annotations, if any

1120

try:

1121

new_function._dbus_annotations = (

1122

dict(attribute._dbus_annotations))

1123

except AttributeError:

1124

pass

971

1125

# Define a creator of a function to call both the

972

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

973

# signals gets sent when the function is called

1126

# original and alternate functions, so both the

1127

# original and alternate signals gets sent when

1128

# the function is called

974

1129

def fixscope(func1, func2):

975

1130

"""This function is a scope container to pass

976

1131

func1 and func2 to the "call_both" function

983

1138

return call_both

984

1139

# Create the "call_both" function and add it to

985

1140

# the class

986

attr[attrname] = fixscope(attribute,

987

new_function)

1141

attr[attrname] = fixscope(attribute, new_function)

988

1142

# Is this a D-Bus method?

989

1143

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

990

1144

# Create a new, but exactly alike, function

1001

1155

attribute.func_name,

1002

1156

attribute.func_defaults,

1003

1157

attribute.func_closure)))

1158

# Copy annotations, if any

1159

try:

1160

attr[attrname]._dbus_annotations = (

1161

dict(attribute._dbus_annotations))

1162

except AttributeError:

1163

pass

1004

1164

# Is this a D-Bus property?

1005

1165

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

1006

1166

# Create a new, but exactly alike, function

1020

1180

attribute.func_name,

1021

1181

attribute.func_defaults,

1022

1182

attribute.func_closure)))

1023

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

1024

1025

1183

# Copy annotations, if any

1184

try:

1185

attr[attrname]._dbus_annotations = (

1186

dict(attribute._dbus_annotations))

1187

except AttributeError:

1188

pass

1189

# Is this a D-Bus interface?

1190

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

1191

# Create a new, but exactly alike, function

1192

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

1193

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

1194

# to the class.

1195

attr[attrname] = (dbus_interface_annotations

1196

(alt_interface)

1197

(types.FunctionType

1198

(attribute.func_code,

1199

attribute.func_globals,

1200

attribute.func_name,

1201

attribute.func_defaults,

1202

attribute.func_closure)))

1203

if deprecate:

1204

# Deprecate all alternate interfaces

1205

iname="_AlternateDBusNames_interface_annotation{0}"

1206

for interface_name in interface_names:

1207

@dbus_interface_annotations(interface_name)

1208

def func(self):

1209

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

1210

"true" }

1211

# Find an unused name

1212

for aname in (iname.format(i)

1213

for i in itertools.count()):

1214

if aname not in attr:

1215

attr[aname] = func

1216

break

1217

if interface_names:

1218

# Replace the class with a new subclass of it with

1219

# methods, signals, etc. as created above.

1220

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

1221

(cls,), attr)

1222

return cls

1223

return wrapper

1224

1225

1226

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

1227

"se.bsnet.fukt.Mandos"})

1026

1228

class ClientDBus(Client, DBusObjectWithProperties):

1027

1229

"""A Client class using D-Bus

1028

1230

1039

1241

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

1040

1242

self.bus = bus

1041

1243

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

1042

self._approvals_pending = 0

1043

1044

self._approvals_pending = 0

1045

1244

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

1046

1245

# the D-Bus

1047

1246

client_object_name = unicode(self.name).translate(

1051

1250

("/clients/" + client_object_name))

1052

1251

DBusObjectWithProperties.__init__(self, self.bus,

1053

1252

self.dbus_object_path)

1054

1253

1055

1254

def notifychangeproperty(transform_func,

1056

1255

dbus_name, type_func=lambda x: x,

1057

1256

variant_level=1):

1080

1279

1081

1280

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

1082

1281

1083

1084

1282

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1085

1283

approvals_pending = notifychangeproperty(dbus.Boolean,

1086

1284

"ApprovalPending",

1093

1291

checker is not None)

1094

1292

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1095

1293

"LastCheckedOK")

1294

last_checker_status = notifychangeproperty(dbus.Int16,

1295

"LastCheckerStatus")

1096

1296

last_approval_request = notifychangeproperty(

1097

1297

datetime_to_dbus, "LastApprovalRequest")

1098

1298

approved_by_default = notifychangeproperty(dbus.Boolean,

1166

1366

return False

1167

1367

1168

1368

def approve(self, value=True):

1169

self.send_changedstate()

1170

1369

self.approved = value

1171

1370

gobject.timeout_add(timedelta_to_milliseconds

1172

1371

(self.approval_duration),

1173

1372

self._reset_approved)

1174

1373

self.send_changedstate()

1175

1374

1176

1375

## D-Bus methods, signals & properties

1177

1376

_interface = "se.recompile.Mandos.Client"

1178

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1179

1385

## Signals

1180

1386

1181

1387

# CheckerCompleted - signal

1217

1423

"D-Bus signal"

1218

1424

return self.need_approval()

1219

1425

1220

# NeRwequest - signal

1221

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

1222

def NewRequest(self, ip):

1223

"""D-Bus signal

1224

Is sent after a client request a password.

1225

"""

1226

pass

1227

1228

1426

## Methods

1229

1427

1230

1428

# Approve - method

1340

1538

return

1341

1539

return datetime_to_dbus(self.last_checked_ok)

1342

1540

1541

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

1544

def LastCheckerStatus_dbus_property(self):

1545

return dbus.Int16(self.last_checker_status)

1546

1343

1547

# Expires - property

1344

1548

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

1345

1549

def Expires_dbus_property(self):

1356

1560

def Timeout_dbus_property(self, value=None):

1357

1561

if value is None: # get

1358

1562

return dbus.UInt64(self.timeout_milliseconds())

1563

old_timeout = self.timeout

1359

1564

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

1360

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

1361

return

1362

# Reschedule timeout

1363

gobject.source_remove(self.disable_initiator_tag)

1364

self.disable_initiator_tag = None

1365

self.expires = None

1366

time_to_die = timedelta_to_milliseconds((self

1367

.last_checked_ok

1368

+ self.timeout)

1369

- datetime.datetime

1370

.utcnow())

1371

if time_to_die <= 0:

1372

# The timeout has passed

1373

self.disable()

1374

else:

1375

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

1376

+ datetime.timedelta(milliseconds =

1377

time_to_die))

1378

self.disable_initiator_tag = (gobject.timeout_add

1379

(time_to_die, self.disable))

1565

# Reschedule disabling

1566

if self.enabled:

1567

now = datetime.datetime.utcnow()

1568

self.expires += self.timeout - old_timeout

1569

if self.expires <= now:

1570

# The timeout has passed

1571

self.disable()

1572

else:

1573

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

1574

is None):

1575

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1380

1581

1381

1582

# ExtendedTimeout - property

1382

1583

@dbus_service_property(_interface, signature="t",

1461

1662

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

1462

1663

1463

1664

1464

class ClientDBusTransitional(ClientDBus):

1465

__metaclass__ = AlternateDBusNamesMetaclass

1466

1467

1468

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

1469

1666

"""A class to handle client connections.

1470

1667

1506

1703

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

1507

1704

try:

1508

1705

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

1509

raise RuntimeError

1706

raise RuntimeError(line)

1510

1707

except (ValueError, IndexError, RuntimeError) as error:

1511

1708

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

1512

1709

return

1538

1735

except KeyError:

1539

1736

return

1540

1737

1541

if self.server.use_dbus:

1542

# Emit D-Bus signal

1543

client.NewRequest(str(self.client_address))

1544

1545

1738

if client.approval_delay:

1546

1739

delay = client.approval_delay

1547

1740

client.approvals_pending += 1

1578

1771

#wait until timeout or approved

1579

1772

time = datetime.datetime.now()

1580

1773

client.changedstate.acquire()

1581

(client.changedstate.wait

1582

(float(client.timedelta_to_milliseconds(delay)

1583

/ 1000)))

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

1584

1777

client.changedstate.release()

1585

1778

time2 = datetime.datetime.now()

1586

1779

if (time2 - time) >= delay:

1602

1795

try:

1603

1796

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

1604

1797

except gnutls.errors.GNUTLSError as error:

1605

logger.warning("gnutls send failed")

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1606

1800

return

1607

1801

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

1608

1802

sent, len(client.secret)

1611

1805

1612

1806

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

1613

1807

# bump the timeout using extended_timeout

1614

client.checked_ok(client.extended_timeout)

1808

client.bump_timeout(client.extended_timeout)

1615

1809

if self.server.use_dbus:

1616

1810

# Emit D-Bus signal

1617

1811

client.GotSecret()

1622

1816

try:

1623

1817

session.bye()

1624

1818

except gnutls.errors.GNUTLSError as error:

1625

logger.warning("GnuTLS bye failed")

1819

logger.warning("GnuTLS bye failed",

1820

exc_info=error)

1626

1821

1627

1822

@staticmethod

1628

1823

def peer_certificate(session):

1700

1895

def process_request(self, request, address):

1701

1896

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

1702

1897

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

1703

args = (request,

1704

address))

1898

args = (request, address))

1705

1899

proc.start()

1706

1900

return proc

1707

1901

1722

1916

1723

1917

def add_pipe(self, parent_pipe, proc):

1724

1918

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

1725

raise NotImplementedError

1919

raise NotImplementedError()

1726

1920

1727

1921

1728

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1735

1929

use_ipv6: Boolean; to use IPv6 or not

1736

1930

"""

1737

1931

def __init__(self, server_address, RequestHandlerClass,

1738

interface=None, use_ipv6=True):

1932

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

1933

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

1934

creating a new one with socket.socket().

1935

"""

1739

1936

self.interface = interface

1740

1937

if use_ipv6:

1741

1938

self.address_family = socket.AF_INET6

1939

if socketfd is not None:

1940

# Save the file descriptor

1941

self.socketfd = socketfd

1942

# Save the original socket.socket() function

1943

self.socket_socket = socket.socket

1944

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

1945

#

1946

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

1947

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

1948

# patching socket.socket.)

1949

#

1950

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

1951

@functools.wraps(socket.socket)

1952

def socket_wrapper(*args, **kwargs):

1953

# Restore original function so subsequent calls are

1954

# not affected.

1955

socket.socket = self.socket_socket

1956

del self.socket_socket

1957

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

1958

# saved file descriptor.

1959

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

1960

# Replace socket.socket() function with wrapper

1961

socket.socket = socket_wrapper

1962

# The socketserver.TCPServer.__init__ will call

1963

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

1964

# socket_wrapper(), if socketfd was set.

1742

1965

socketserver.TCPServer.__init__(self, server_address,

1743

1966

RequestHandlerClass)

1967

1744

1968

def server_bind(self):

1745

1969

"""This overrides the normal server_bind() function

1746

1970

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

1754

1978

try:

1755

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1756

1980

SO_BINDTODEVICE,

1757

str(self.interface

1758

+ '\0'))

1981

str(self.interface + '\0'))

1759

1982

except socket.error as error:

1760

if error[0] == errno.EPERM:

1761

logger.error("No permission to"

1762

" bind to interface %s",

1763

self.interface)

1764

elif error[0] == errno.ENOPROTOOPT:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1765

1987

logger.error("SO_BINDTODEVICE not available;"

1766

1988

" cannot bind to interface %s",

1767

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1768

1993

else:

1769

1994

raise

1770

1995

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

1773

1998

if self.address_family == socket.AF_INET6:

1774

1999

any_address = "::" # in6addr_any

1775

2000

else:

1776

any_address = socket.INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

1777

2002

self.server_address = (any_address,

1778

2003

self.server_address[1])

1779

2004

elif not self.server_address[1]:

1800

2025

"""

1801

2026

def __init__(self, server_address, RequestHandlerClass,

1802

2027

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

1803

gnutls_priority=None, use_dbus=True):

2028

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

1804

2029

self.enabled = False

1805

2030

self.clients = clients

1806

2031

if self.clients is None:

1810

2035

IPv6_TCPServer.__init__(self, server_address,

1811

2036

RequestHandlerClass,

1812

2037

interface = interface,

1813

use_ipv6 = use_ipv6)

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

1814

2040

def server_activate(self):

1815

2041

if self.enabled:

1816

2042

return socketserver.TCPServer.server_activate(self)

1829

2055

1830

2056

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

1831

2057

proc = None, client_object=None):

1832

condition_names = {

1833

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

1834

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

1835

# blocking).

1836

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

1837

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

1838

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

1839

# broken, usually for pipes and

1840

# sockets).

1841

}

1842

conditions_string = ' | '.join(name

1843

for cond, name in

1844

condition_names.iteritems()

1845

if cond & condition)

1846

2058

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

1847

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

2059

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

1848

2060

# Wait for other process to exit

1849

2061

proc.join()

1850

2062

return False

1908

2120

return True

1909

2121

1910

2122

2123

def rfc3339_duration_to_delta(duration):

2124

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

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2140

"""

2141

2142

# Parsing an RFC 3339 duration with regular expressions is not

2143

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

2144

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

2145

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

2146

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

2147

# avoid excessive use of external libraries.

2148

2149

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2159

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

2160

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

2161

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

2162

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

2163

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2165

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

2166

datetime.timedelta(minutes=1),

2167

frozenset((token_second, token_end)))

2168

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

2169

datetime.timedelta(hours=1),

2170

frozenset((token_minute, token_end)))

2171

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

2172

None,

2173

frozenset((token_hour, token_minute,

2174

token_second)))

2175

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

2176

datetime.timedelta(days=1),

2177

frozenset((token_time, token_end)))

2178

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

2179

datetime.timedelta(weeks=4),

2180

frozenset((token_day, token_end)))

2181

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

2182

datetime.timedelta(weeks=52),

2183

frozenset((token_month, token_end)))

2184

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

2185

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2187

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

2188

frozenset((token_year, token_month,

2189

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2193

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2196

# Loop until end token is found

2197

while found_token is not token_end:

2198

# Search for any currently valid tokens

2199

for token in followers:

2200

match = token.regexp.match(s)

2201

if match is not None:

2202

# Token found

2203

if token.value is not None:

2204

# Value found, parse digits

2205

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

2206

# Add to value so far

2207

value += factor * token.value

2208

# Strip token from string

2209

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

2210

# Go to found token

2211

found_token = token

2212

# Set valid next tokens

2213

followers = found_token.followers

2214

break

2215

else:

2216

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2218

# End token found

2219

return value

2220

2221

1911

2222

def string_to_delta(interval):

1912

2223

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

1913

2224

1924

2235

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

1925

2236

datetime.timedelta(0, 330)

1926

2237

"""

2238

2239

try:

2240

return rfc3339_duration_to_delta(interval)

2241

except ValueError:

2242

pass

2243

1927

2244

timevalue = datetime.timedelta(0)

1928

2245

for s in interval.split():

1929

2246

try:

1940

2257

elif suffix == "w":

1941

2258

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

1942

2259

else:

1943

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

1944

except (ValueError, IndexError) as e:

2260

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

2261

.format(suffix))

2262

except IndexError as e:

1945

2263

raise ValueError(*(e.args))

1946

2264

timevalue += delta

1947

2265

return timevalue

1960

2278

sys.exit()

1961

2279

if not noclose:

1962

2280

# Close all standard open file descriptors

1963

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

2281

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

1964

2282

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

1965

2283

raise OSError(errno.ENODEV,

1966

"%s not a character device"

1967

% os.path.devnull)

2284

"{0} not a character device"

2285

.format(os.devnull))

1968

2286

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

1969

2287

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

1970

2288

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

1979

2297

1980

2298

parser = argparse.ArgumentParser()

1981

2299

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

1982

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

2300

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

1983

2301

help="show version number and exit")

1984

2302

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

1985

2303

help="Bind to interface IF")

1991

2309

help="Run self-test")

1992

2310

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

1993

2311

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

1994

" to terminal")

2312

" to terminal", default=None)

1995

2313

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

1996

2314

help="Debug level for stdout output")

1997

2315

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

2004

2322

" files")

2005

2323

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

2006

2324

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

2007

" system bus interface")

2325

" system bus interface", default=None)

2008

2326

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

2009

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

2327

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

2328

default=None)

2010

2329

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

2011

2330

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

2012

" state")

2331

" state", default=None)

2332

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

2333

help="Specify a file descriptor to a network"

2334

" socket to use instead of creating one")

2013

2335

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

2014

2336

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

2337

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

2338

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

2015

2339

2016

2340

options = parser.parse_args()

2017

2341

2026

2350

"port": "",

2027

2351

"debug": "False",

2028

2352

"priority":

2029

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

2353

"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2030

2354

"servicename": "Mandos",

2031

2355

"use_dbus": "True",

2032

2356

"use_ipv6": "True",

2033

2357

"debuglevel": "",

2034

2358

"restore": "True",

2035

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

2359

"socket": "",

2360

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

2361

"foreground": "False",

2036

2362

}

2037

2363

2038

2364

# Parse config file for server-global settings

2043

2369

# Convert the SafeConfigParser object to a dict

2044

2370

server_settings = server_config.defaults()

2045

2371

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

2046

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

2372

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

2047

2373

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

2048

2374

option)

2049

2375

if server_settings["port"]:

2050

2376

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

2051

2377

"port")

2378

if server_settings["socket"]:

2379

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

2380

"socket")

2381

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

2382

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

2383

# happen with a supplied network socket.

2384

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

2385

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

2386

["socket"])

2052

2387

del server_config

2053

2388

2054

2389

# Override the settings from the config file with command line

2056

2391

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

2057

2392

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

2058

2393

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

2059

"statedir"):

2394

"statedir", "socket", "foreground"):

2060

2395

value = getattr(options, option)

2061

2396

if value is not None:

2062

2397

server_settings[option] = value

2065

2400

for option in server_settings.keys():

2066

2401

if type(server_settings[option]) is str:

2067

2402

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

2403

# Force all boolean options to be boolean

2404

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

2405

"foreground"):

2406

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

2407

# Debug implies foreground

2408

if server_settings["debug"]:

2409

server_settings["foreground"] = True

2068

2410

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

2069

2411

2070

2412

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

2076

2418

use_ipv6 = server_settings["use_ipv6"]

2077

2419

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

2078

2420

stored_state_file)

2421

foreground = server_settings["foreground"]

2079

2422

2080

2423

if debug:

2081

initlogger(logging.DEBUG)

2424

initlogger(debug, logging.DEBUG)

2082

2425

else:

2083

2426

if not debuglevel:

2084

initlogger()

2427

initlogger(debug)

2085

2428

else:

2086

2429

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

2087

initlogger(level)

2430

initlogger(debug, level)

2088

2431

2089

2432

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

2090

2433

syslogger.setFormatter(logging.Formatter

2091

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

2092

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

2093

% server_settings["servicename"]))

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2094

2438

2095

2439

# Parse config file with clients

2096

client_config = configparser.SafeConfigParser(Client.client_defaults)

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

2097

2442

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

2098

2443

"clients.conf"))

2099

2444

2108

2453

use_ipv6=use_ipv6,

2109

2454

gnutls_priority=

2110

2455

server_settings["priority"],

2111

use_dbus=use_dbus)

2112

if not debug:

2113

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

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

2459

if not foreground:

2460

pidfilename = "/run/mandos.pid"

2461

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

2462

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

2463

pidfile = None

2114

2464

try:

2115

2465

pidfile = open(pidfilename, "w")

2116

except IOError:

2117

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

2466

except IOError as e:

2467

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

2468

exc_info=e)

2118

2469

2119

try:

2120

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

2121

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

2122

except KeyError:

2470

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

2123

2471

try:

2124

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

2125

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

2472

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

2474

break

2126

2475

except KeyError:

2127

try:

2128

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

2129

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

2130

except KeyError:

2131

uid = 65534

2132

gid = 65534

2476

continue

2477

else:

2478

uid = 65534

2479

gid = 65534

2133

2480

try:

2134

2481

os.setgid(gid)

2135

2482

os.setuid(uid)

2136

2483

except OSError as error:

2137

if error[0] != errno.EPERM:

2138

raise error

2484

if error.errno != errno.EPERM:

2485

raise

2139

2486

2140

2487

if debug:

2141

2488

# Enable all possible GnuTLS debugging

2152

2499

.gnutls_global_set_log_function(debug_gnutls))

2153

2500

2154

2501

# Redirect stdin so all checkers get /dev/null

2155

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

2502

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

2156

2503

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

2157

2504

if null > 2:

2158

2505

os.close(null)

2159

else:

2160

# No console logging

2161

logger.removeHandler(console)

2162

2506

2163

2507

# Need to fork before connecting to D-Bus

2164

if not debug:

2508

if not foreground:

2165

2509

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

2166

2510

daemon()

2167

2511

2512

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

2513

# need to inform gobject that threads will be used.

2168

2514

gobject.threads_init()

2169

2515

2170

2516

global main_loop

2171

2517

# From the Avahi example code

2172

DBusGMainLoop(set_as_default=True )

2518

DBusGMainLoop(set_as_default=True)

2173

2519

main_loop = gobject.MainLoop()

2174

2520

bus = dbus.SystemBus()

2175

2521

# End of Avahi example code

2181

2527

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

2182

2528

do_not_queue=True))

2183

2529

except dbus.exceptions.NameExistsException as e:

2184

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

2530

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

2185

2531

use_dbus = False

2186

2532

server_settings["use_dbus"] = False

2187

2533

tcp_server.use_dbus = False

2199

2545

2200

2546

client_class = Client

2201

2547

if use_dbus:

2202

client_class = functools.partial(ClientDBusTransitional,

2203

bus = bus)

2548

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

2204

2549

2205

2550

client_settings = Client.config_parser(client_config)

2206

2551

old_client_settings = {}

2207

2552

clients_data = {}

2208

2553

2554

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

2555

global wnull

2556

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

2557

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

2558

# mode

2559

if debug or not foreground:

2560

wnull.close()

2561

2209

2562

# Get client data and settings from last running state.

2210

2563

if server_settings["restore"]:

2211

2564

try:

2214

2567

(stored_state))

2215

2568

os.remove(stored_state_path)

2216

2569

except IOError as e:

2217

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

2218

.format(e))

2219

if e.errno != errno.ENOENT:

2570

if e.errno == errno.ENOENT:

2571

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

2572

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

2573

else:

2574

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

2575

exc_info=e)

2220

2576

raise

2221

2577

except EOFError as e:

2222

2578

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

2223

"EOFError: {0}".format(e))

2579

"EOFError:", exc_info=e)

2224

2580

2225

2581

with PGPEngine() as pgp:

2226

2582

for client_name, client in clients_data.iteritems():

2583

# Skip removed clients

2584

if client_name not in client_settings:

2585

continue

2586

2227

2587

# Decide which value to use after restoring saved state.

2228

2588

# We have three different values: Old config file,

2229

2589

# new config file, and saved state.

2243

2603

2244

2604

# Clients who has passed its expire date can still be

2245

2605

# enabled if its last checker was successful. Clients

2246

# whose checker failed before we stored its state is

2247

# assumed to have failed all checkers during downtime.

2606

# whose checker succeeded before we stored its state is

2607

# assumed to have successfully run all checkers during

2608

# downtime.

2248

2609

if client["enabled"]:

2249

2610

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

2250

2611

if not client["last_checked_ok"]:

2251

2612

logger.warning(

2252

2613

"disabling client {0} - Client never "

2253

"performed a successfull checker"

2254

.format(client["name"]))

2614

"performed a successful checker"

2615

.format(client_name))

2255

2616

client["enabled"] = False

2256

2617

elif client["last_checker_status"] != 0:

2257

2618

logger.warning(

2258

2619

"disabling client {0} - Client "

2259

2620

"last checker failed with error code {1}"

2260

.format(client["name"],

2621

.format(client_name,

2261

2622

client["last_checker_status"]))

2262

2623

client["enabled"] = False

2263

2624

else:

2264

2625

client["expires"] = (datetime.datetime

2265

2626

.utcnow()

2266

2627

+ client["timeout"])

2267

2628

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

2268

2631

try:

2269

2632

client["secret"] = (

2270

2633

pgp.decrypt(client["encrypted_secret"],

2276

2639

.format(client_name))

2277

2640

client["secret"] = (

2278

2641

client_settings[client_name]["secret"])

2279

2280

2642

2281

2643

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

2282

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

2644

for client_name in (set(old_client_settings)

2645

- set(client_settings)):

2283

2646

del clients_data[client_name]

2284

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

2647

for client_name in (set(client_settings)

2648

- set(old_client_settings)):

2285

2649

clients_data[client_name] = client_settings[client_name]

2286

2287

# Create clients all clients

2650

2651

# Create all client objects

2288

2652

for client_name, client in clients_data.iteritems():

2289

2653

tcp_server.clients[client_name] = client_class(

2290

name = client_name, settings = client)

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2291

2656

2292

2657

if not tcp_server.clients:

2293

2658

logger.warning("No clients defined")

2294

2295

if not debug:

2296

try:

2297

with pidfile:

2298

pid = os.getpid()

2299

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

2300

del pidfile

2301

except IOError:

2302

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

2303

pidfilename, pid)

2304

except NameError:

2305

# "pidfile" was never created

2306

pass

2659

2660

if not foreground:

2661

if pidfile is not None:

2662

try:

2663

with pidfile:

2664

pid = os.getpid()

2665

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

2666

except IOError:

2667

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

2668

pidfilename, pid)

2669

del pidfile

2307

2670

del pidfilename

2308

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

2309

2671

2310

2672

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

2311

2673

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

2312

2674

2313

2675

if use_dbus:

2314

class MandosDBusService(dbus.service.Object):

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

2315

2679

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

2316

2680

def __init__(self):

2317

2681

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

2318

2682

_interface = "se.recompile.Mandos"

2319

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

2320

2690

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

2321

2691

def ClientAdded(self, objpath):

2322

2692

"D-Bus signal"

2364

2734

2365

2735

del _interface

2366

2736

2367

class MandosDBusServiceTransitional(MandosDBusService):

2368

__metaclass__ = AlternateDBusNamesMetaclass

2369

mandos_dbus_service = MandosDBusServiceTransitional()

2737

mandos_dbus_service = MandosDBusService()

2370

2738

2371

2739

def cleanup():

2372

2740

"Cleanup function; run on exit"

2373

2741

service.cleanup()

2374

2742

2375

2743

multiprocessing.active_children()

2744

wnull.close()

2376

2745

if not (tcp_server.clients or client_settings):

2377

2746

return

2378

2747

2390

2759

# A list of attributes that can not be pickled

2391

2760

# + secret.

2392

2761

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

2393

"checker"))

2762

"checker", "server_settings"))

2394

2763

for name, typ in (inspect.getmembers

2395

2764

(dbus.service.Object)):

2396

2765

exclude.add(name)

2405

2774

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

2406

2775

2407

2776

try:

2408

with os.fdopen(os.open(stored_state_path,

2409

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

2410

0600), "wb") as stored_state:

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2411

2781

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

2782

tempname=stored_state.name

2783

os.rename(tempname, stored_state_path)

2412

2784

except (IOError, OSError) as e:

2413

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

2414

.format(e))

2415

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

2785

if not debug:

2786

try:

2787

os.remove(tempname)

2788

except NameError:

2789

pass

2790

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

2791

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

2792

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

2793

else:

2794

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

2795

exc_info=e)

2416

2796

raise

2417

2797

2418

2798

# Delete all clients, and settings from config

2446

2826

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

2447

2827

if use_ipv6:

2448

2828

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

2449

" flowinfo %d, scope_id %d"

2450

% tcp_server.socket.getsockname())

2829

" flowinfo %d, scope_id %d",

2830

*tcp_server.socket.getsockname())

2451

2831

else: # IPv4

2452

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

2453

% tcp_server.socket.getsockname())

2832

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

2833

*tcp_server.socket.getsockname())

2454

2834

2455

2835

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

2456

2836

2459

2839

try:

2460

2840

service.activate()

2461

2841

except dbus.exceptions.DBusException as error:

2462

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

2842

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

2463

2843

cleanup()

2464

2844

sys.exit(1)

2465

2845

# End of Avahi example code

2472

2852

logger.debug("Starting main loop")

2473

2853

main_loop.run()

2474

2854

except AvahiError as error:

2475

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

2855

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

2476

2856

cleanup()

2477

2857

sys.exit(1)

2478

2858

except KeyboardInterrupt: