/mandos/trunk : revision 534

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

39

37

import SocketServer as socketserver

40

38

import socket

41

39

import argparse

67

65

import types

68

66

import binascii

69

67

import tempfile

70

import itertools

71

import collections

72

68

73

69

import dbus

74

70

import dbus.service

79

75

import ctypes.util

80

76

import xml.dom.minidom

81

77

import inspect

78

import GnuPGInterface

82

79

83

80

try:

84

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

88

85

except ImportError:

89

86

SO_BINDTODEVICE = None

90

87

91

version = "1.6.2"

88

version = "1.4.1"

92

89

stored_state_file = "clients.pickle"

93

90

94

91

logger = logging.getLogger()

139

136

class PGPEngine(object):

140

137

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

141

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

142

140

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

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet'])

148

146

149

147

def __enter__(self):

150

148

return self

151

149

152

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

150

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

153

151

self._cleanup()

154

152

return False

155

153

172

170

def password_encode(self, password):

173

171

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

174

172

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

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

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

182

174

183

175

def encrypt(self, data, password):

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)

176

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

177

with open(os.devnull) as devnull:

178

try:

179

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

180

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

181

attach_fhs={'stderr': devnull})

182

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

183

f.write(data)

184

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

185

ciphertext = f.read()

186

proc.wait()

187

except IOError as e:

188

raise PGPError(e)

189

self.gnupg.passphrase = None

199

190

return ciphertext

200

191

201

192

def decrypt(self, data, password):

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)

193

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

194

with open(os.devnull) as devnull:

195

try:

196

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

197

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

198

attach_fhs={'stderr': devnull})

199

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

200

f.write(data)

201

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

202

decrypted_plaintext = f.read()

203

proc.wait()

204

except IOError as e:

205

raise PGPError(e)

206

self.gnupg.passphrase = None

218

207

return decrypted_plaintext

219

208

220

209

210

221

211

class AvahiError(Exception):

222

212

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

223

213

self.value = value

240

230

Used to optionally bind to the specified interface.

241

231

name: string; Example: 'Mandos'

242

232

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

243

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

233

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

244

234

port: integer; what port to announce

245

235

TXT: list of strings; TXT record for the service

246

236

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

252

242

server: D-Bus Server

253

243

bus: dbus.SystemBus()

254

244

"""

255

256

245

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

257

246

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

258

247

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

271

260

self.server = None

272

261

self.bus = bus

273

262

self.entry_group_state_changed_match = None

274

275

263

def rename(self):

276

264

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

277

265

if self.rename_count >= self.max_renames:

287

275

try:

288

276

self.add()

289

277

except dbus.exceptions.DBusException as error:

290

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

278

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

291

279

self.cleanup()

292

280

os._exit(1)

293

281

self.rename_count += 1

294

295

282

def remove(self):

296

283

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

297

284

if self.entry_group_state_changed_match is not None:

299

286

self.entry_group_state_changed_match = None

300

287

if self.group is not None:

301

288

self.group.Reset()

302

303

289

def add(self):

304

290

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

305

291

self.remove()

322

308

dbus.UInt16(self.port),

323

309

avahi.string_array_to_txt_array(self.TXT))

324

310

self.group.Commit()

325

326

311

def entry_group_state_changed(self, state, error):

327

312

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

328

313

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

335

320

elif state == avahi.ENTRY_GROUP_FAILURE:

336

321

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

337

322

unicode(error))

338

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

339

.format(error))

340

323

raise AvahiGroupError("State changed: %s"

324

% unicode(error))

341

325

def cleanup(self):

342

326

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

343

327

if self.group is not None:

348

332

pass

349

333

self.group = None

350

334

self.remove()

351

352

335

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

353

336

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

354

337

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

373

356

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

374

357

else:

375

358

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

376

377

359

def activate(self):

378

360

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

379

361

if self.server is None:

386

368

self.server_state_changed)

387

369

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

388

370

389

390

371

class AvahiServiceToSyslog(AvahiService):

391

372

def rename(self):

392

373

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

393

374

ret = AvahiService.rename(self)

394

375

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

376

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

377

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

378

% self.name))

398

379

return ret

399

380

400

401

381

def timedelta_to_milliseconds(td):

402

382

"Convert a datetime.timedelta() to milliseconds"

403

383

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

404

384

+ (td.seconds * 1000)

405

385

+ (td.microseconds // 1000))

406

407

386

408

387

class Client(object):

409

388

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

410

389

435

414

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

436

415

last_checker_status: integer between 0 and 255 reflecting exit

437

416

status of last checker. -1 reflects crashed

438

checker, -2 means no checker completed yet.

417

checker, or None.

439

418

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

440

419

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

441

420

D-Bus identifiers

442

421

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

443

422

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

444

423

until this client is disabled

445

extended_timeout: extra long timeout when secret has been sent

424

extended_timeout: extra long timeout when password has been sent

446

425

runtime_expansions: Allowed attributes for runtime expansion.

447

426

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

448

427

disabled, or None

449

server_settings: The server_settings dict from main()

450

428

"""

451

429

452

430

runtime_expansions = ("approval_delay", "approval_duration",

453

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

454

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

455

"last_approval_request", "last_checked_ok",

431

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

432

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

456

433

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

460

437

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

461

438

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

464

441

"approved_by_default": "True",

465

442

"enabled": "True",

466

443

}

479

456

480

457

def approval_delay_milliseconds(self):

481

458

return timedelta_to_milliseconds(self.approval_delay)

482

459

483

460

@staticmethod

484

461

def config_parser(config):

485

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

462

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

486

463

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

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

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

491

465

settings = {}

492

466

for client_name in config.sections():

493

467

section = dict(config.items(client_name))

497

471

# Reformat values from string types to Python types

498

472

client["approved_by_default"] = config.getboolean(

499

473

client_name, "approved_by_default")

500

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

501

"enabled")

474

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

502

475

503

476

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

504

477

.replace(" ", ""))

510

483

"rb") as secfile:

511

484

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

512

485

else:

513

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

514

.format(section))

486

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

487

% section)

515

488

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

516

489

client["extended_timeout"] = string_to_delta(

517

490

section["extended_timeout"])

523

496

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

524

497

client["last_approval_request"] = None

525

498

client["last_checked_ok"] = None

526

client["last_checker_status"] = -2

527

499

client["last_checker_status"] = None

500

if client["enabled"]:

501

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

502

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

503

+ client["timeout"])

504

else:

505

client["last_enabled"] = None

506

client["expires"] = None

507

528

508

return settings

529

530

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

509

510

511

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

512

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

513

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

514

attribute."""

531

515

self.name = name

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

535

516

# adding all client settings

536

517

for setting, value in settings.iteritems():

537

518

setattr(self, setting, value)

538

519

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

549

520

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

550

521

# Uppercase and remove spaces from fingerprint for later

551

522

# comparison purposes with return value from the fingerprint()

552

523

# function

553

524

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

554

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

555

datetime.datetime.utcnow())

556

525

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

526

557

527

# attributes specific for this server instance

558

528

self.checker = None

559

529

self.checker_initiator_tag = None

587

557

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

588

558

# Already enabled

589

559

return

560

self.send_changedstate()

590

561

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

591

562

self.enabled = True

592

563

self.last_enabled = datetime.datetime.utcnow()

593

564

self.init_checker()

594

self.send_changedstate()

595

565

596

566

def disable(self, quiet=True):

597

567

"""Disable this client."""

598

568

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

599

569

return False

600

570

if not quiet:

571

self.send_changedstate()

572

if not quiet:

601

573

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

602

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

574

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

603

575

gobject.source_remove(self.disable_initiator_tag)

604

576

self.disable_initiator_tag = None

605

577

self.expires = None

606

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

578

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

607

579

gobject.source_remove(self.checker_initiator_tag)

608

580

self.checker_initiator_tag = None

609

581

self.stop_checker()

610

582

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

613

583

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

614

584

return False

615

585

619

589

def init_checker(self):

620

590

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

621

591

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

592

self.checker_initiator_tag = (gobject.timeout_add

625

593

(self.interval_milliseconds(),

626

594

self.start_checker))

627

595

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

628

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

596

self.disable_initiator_tag = (gobject.timeout_add

631

597

(self.timeout_milliseconds(),

632

598

self.disable))

651

617

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

652

618

vars(self))

653

619

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

620

def checked_ok(self, timeout=None):

621

"""Bump up the timeout for this client.

622

623

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

624

alive and well.

625

"""

662

626

if timeout is None:

663

627

timeout = self.timeout

628

self.last_checked_ok = datetime.datetime.utcnow()

664

629

if self.disable_initiator_tag is not None:

665

630

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

667

631

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

668

632

self.disable_initiator_tag = (gobject.timeout_add

669

633

(timedelta_to_milliseconds

679

643

If a checker already exists, leave it running and do

680

644

nothing."""

681

645

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

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

646

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

647

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

648

# client would inevitably timeout, since no checker would get

649

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

686

650

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

687

651

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

688

652

# should be.

690

654

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

691

655

try:

692

656

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

657

except (AttributeError, OSError) as error:

658

if (isinstance(error, OSError)

659

and error.errno != errno.ECHILD):

660

raise error

698

661

else:

699

662

if pid:

700

663

logger.warning("Checker was a zombie")

703

666

self.current_checker_command)

704

667

# Start a new checker if needed

705

668

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)

711

669

try:

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

670

# In case checker_command has exactly one % operator

671

command = self.checker_command % self.host

672

except TypeError:

673

# Escape attributes for the shell

674

escaped_attrs = dict(

675

(attr,

676

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

677

errors=

678

'replace')))

679

for attr in

680

self.runtime_expansions)

681

682

try:

683

command = self.checker_command % escaped_attrs

684

except TypeError as error:

685

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

686

' %s', self.checker_command, error)

687

return True # Try again later

717

688

self.current_checker_command = command

718

689

try:

719

690

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

722

693

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

723

694

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

724

695

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

733

696

self.checker = subprocess.Popen(command,

734

697

close_fds=True,

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:

698

shell=True, cwd="/")

699

self.checker_callback_tag = (gobject.child_watch_add

700

(self.checker.pid,

701

self.checker_callback,

702

data=command))

703

# The checker may have completed before the gobject

704

# watch was added. Check for this.

748

705

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

706

if pid:

707

gobject.source_remove(self.checker_callback_tag)

708

self.checker_callback(pid, status, command)

749

709

except OSError as 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)

710

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

711

error)

759

712

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

760

713

return True

761

714

768

721

return

769

722

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

770

723

try:

771

self.checker.terminate()

724

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

772

725

#time.sleep(0.5)

773

726

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

774

# self.checker.kill()

727

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

775

728

except OSError as error:

776

729

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

777

730

raise

794

747

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

795

748

if byte_arrays and signature != "ay":

796

749

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

797

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

750

" signature %r" % signature)

798

751

def decorator(func):

799

752

func._dbus_is_property = True

800

753

func._dbus_interface = dbus_interface

808

761

return decorator

809

762

810

763

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

848

764

class DBusPropertyException(dbus.exceptions.DBusException):

849

765

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

850

766

"""

873

789

"""

874

790

875

791

@staticmethod

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)

792

def _is_dbus_property(obj):

793

return getattr(obj, "_dbus_is_property", False)

884

794

885

def _get_all_dbus_things(self, thing):

795

def _get_all_dbus_properties(self):

886

796

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

887

797

"""

888

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

889

name),

890

athing.__get__(self))

798

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

891

799

for cls in self.__class__.__mro__

892

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

800

for name, prop in

801

inspect.getmembers(cls, self._is_dbus_property))

895

802

896

803

def _get_dbus_property(self, interface_name, property_name):

897

804

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

899

806

"""

900

807

for cls in self.__class__.__mro__:

901

808

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

809

(cls, self._is_dbus_property)):

904

810

if (value._dbus_name == property_name

905

811

and value._dbus_interface == interface_name):

906

812

return value.__get__(self)

934

840

# The byte_arrays option is not supported yet on

935

841

# signatures other than "ay".

936

842

if prop._dbus_signature != "ay":

937

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

938

"'ay' signature {0!r}"

939

.format(prop._dbus_signature))

940

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

941

for byte in value))

843

raise ValueError

844

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

845

for byte in value))

942

846

prop(value)

943

847

944

848

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

950

854

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

951

855

"""

952

856

properties = {}

953

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

857

for name, prop in self._get_all_dbus_properties():

954

858

if (interface_name

955

859

and interface_name != prop._dbus_interface):

956

860

# Interface non-empty but did not match

971

875

path_keyword='object_path',

972

876

connection_keyword='connection')

973

877

def Introspect(self, object_path, connection):

974

"""Overloading of standard D-Bus method.

975

976

Inserts property tags and interface annotation tags.

878

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

977

879

"""

978

880

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

979

881

connection)

986

888

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

987

889

return e

988

890

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

989

# Add property tags

990

891

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

991

892

for name, prop

992

in self._get_all_dbus_things("property")

893

in self._get_all_dbus_properties()

993

894

if prop._dbus_interface

994

895

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

995

896

if_tag.appendChild(tag)

996

# Add annotation tags

997

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

998

for tag in if_tag.getElementsByTagName(typ):

999

annots = dict()

1000

for name, prop in (self.

1001

_get_all_dbus_things(typ)):

1002

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

1003

and prop._dbus_interface

1004

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

1005

annots.update(getattr

1006

(prop,

1007

"_dbus_annotations",

1008

{}))

1009

for name, value in annots.iteritems():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1027

897

# Add the names to the return values for the

1028

898

# "org.freedesktop.DBus.Properties" methods

1029

899

if (if_tag.getAttribute("name")

1044

914

except (AttributeError, xml.dom.DOMException,

1045

915

xml.parsers.expat.ExpatError) as error:

1046

916

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

1047

exc_info=error)

917

error)

1048

918

return xmlstring

1049

919

1050

920

1051

def datetime_to_dbus(dt, variant_level=0):

921

def datetime_to_dbus (dt, variant_level=0):

1052

922

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

1053

923

if dt is None:

1054

924

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

1056

926

variant_level=variant_level)

1057

927

1058

928

1059

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1060

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

1061

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

1062

interface names according to the "alt_interface_names" mapping.

1063

Usage:

1064

1065

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

1066

"net.example.AlternateInterface"})

1067

class SampleDBusObject(dbus.service.Object):

1068

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

1069

def SampleDBusMethod():

1070

pass

1071

1072

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

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

1074

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

1075

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

1076

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

1077

1078

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

1079

(from DBusObjectWithProperties) and interfaces (from the

1080

dbus_interface_annotations decorator).

929

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

930

.__metaclass__):

931

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

932

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

1081

933

"""

1082

def wrapper(cls):

1083

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1085

attr = {}

1086

interface_names = set()

1087

# Go though all attributes of the class

1088

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

934

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

935

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

936

# methods, signals, or properties in them

937

for base in (b for b in bases

938

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

939

# Go though all attributes of the base class

940

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

1089

941

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

1090

942

# with the wrong interface name

1091

943

if (not hasattr(attribute, "_dbus_interface")

1092

944

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

945

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

1094

946

continue

1095

947

# Create an alternate D-Bus interface name based on

1096

948

# the current name

1097

949

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1100

interface_names.add(alt_interface)

950

.replace("se.recompile.Mandos",

951

"se.bsnet.fukt.Mandos"))

1101

952

# Is this a D-Bus signal?

1102

953

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

1103

# Extract the original non-method undecorated

1104

# function by black magic

954

# Extract the original non-method function by

955

# black magic

1105

956

nonmethod_func = (dict(

1106

957

zip(attribute.func_code.co_freevars,

1107

958

attribute.__closure__))["func"]

1118

969

nonmethod_func.func_name,

1119

970

nonmethod_func.func_defaults,

1120

971

nonmethod_func.func_closure)))

1121

# Copy annotations, if any

1122

try:

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1125

except AttributeError:

1126

pass

1127

972

# Define a creator of a function to call both the

1128

# original and alternate functions, so both the

1129

# original and alternate signals gets sent when

1130

# the function is called

973

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

974

# signals gets sent when the function is called

1131

975

def fixscope(func1, func2):

1132

976

"""This function is a scope container to pass

1133

977

func1 and func2 to the "call_both" function

1140

984

return call_both

1141

985

# Create the "call_both" function and add it to

1142

986

# the class

1143

attr[attrname] = fixscope(attribute, new_function)

987

attr[attrname] = fixscope(attribute,

988

new_function)

1144

989

# Is this a D-Bus method?

1145

990

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

1146

991

# Create a new, but exactly alike, function

1157

1002

attribute.func_name,

1158

1003

attribute.func_defaults,

1159

1004

attribute.func_closure)))

1160

# Copy annotations, if any

1161

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1164

except AttributeError:

1165

pass

1166

1005

# Is this a D-Bus property?

1167

1006

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

1168

1007

# Create a new, but exactly alike, function

1182

1021

attribute.func_name,

1183

1022

attribute.func_defaults,

1184

1023

attribute.func_closure)))

1185

# Copy annotations, if any

1186

try:

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1189

except AttributeError:

1190

pass

1191

# Is this a D-Bus interface?

1192

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

1193

# Create a new, but exactly alike, function

1194

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

1195

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

1196

# to the class.

1197

attr[attrname] = (dbus_interface_annotations

1198

(alt_interface)

1199

(types.FunctionType

1200

(attribute.func_code,

1201

attribute.func_globals,

1202

attribute.func_name,

1203

attribute.func_defaults,

1204

attribute.func_closure)))

1205

if deprecate:

1206

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1208

for interface_name in interface_names:

1209

@dbus_interface_annotations(interface_name)

1210

def func(self):

1211

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

1212

"true" }

1213

# Find an unused name

1214

for aname in (iname.format(i)

1215

for i in itertools.count()):

1216

if aname not in attr:

1217

attr[aname] = func

1218

break

1219

if interface_names:

1220

# Replace the class with a new subclass of it with

1221

# methods, signals, etc. as created above.

1222

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

1223

(cls,), attr)

1224

return cls

1225

return wrapper

1226

1227

1228

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

1229

"se.bsnet.fukt.Mandos"})

1024

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

1025

1026

1230

1027

class ClientDBus(Client, DBusObjectWithProperties):

1231

1028

"""A Client class using D-Bus

1232

1029

1243

1040

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

1244

1041

self.bus = bus

1245

1042

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

1043

self._approvals_pending = 0

1044

1045

self._approvals_pending = 0

1246

1046

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

1247

1047

# the D-Bus

1248

1048

client_object_name = unicode(self.name).translate(

1252

1052

("/clients/" + client_object_name))

1253

1053

DBusObjectWithProperties.__init__(self, self.bus,

1254

1054

self.dbus_object_path)

1255

1055

1256

1056

def notifychangeproperty(transform_func,

1257

1057

dbus_name, type_func=lambda x: x,

1258

1058

variant_level=1):

1281

1081

1282

1082

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

1283

1083

1084

1284

1085

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1086

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1087

"ApprovalPending",

1293

1094

checker is not None)

1294

1095

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1096

"LastCheckedOK")

1296

last_checker_status = notifychangeproperty(dbus.Int16,

1297

"LastCheckerStatus")

1298

1097

last_approval_request = notifychangeproperty(

1299

1098

datetime_to_dbus, "LastApprovalRequest")

1300

1099

approved_by_default = notifychangeproperty(dbus.Boolean,

1368

1167

return False

1369

1168

1370

1169

def approve(self, value=True):

1170

self.send_changedstate()

1371

1171

self.approved = value

1372

1172

gobject.timeout_add(timedelta_to_milliseconds

1373

1173

(self.approval_duration),

1374

1174

self._reset_approved)

1375

self.send_changedstate()

1175

1376

1176

1377

1177

## D-Bus methods, signals & properties

1378

1178

_interface = "se.recompile.Mandos.Client"

1379

1179

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

1180

## Signals

1388

1181

1389

1182

# CheckerCompleted - signal

1425

1218

"D-Bus signal"

1426

1219

return self.need_approval()

1427

1220

1221

# NeRwequest - signal

1222

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

1223

def NewRequest(self, ip):

1224

"""D-Bus signal

1225

Is sent after a client request a password.

1226

"""

1227

pass

1228

1428

1229

## Methods

1429

1230

1430

1231

# Approve - method

1540

1341

return

1541

1342

return datetime_to_dbus(self.last_checked_ok)

1542

1343

1543

# LastCheckerStatus - property

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

1546

def LastCheckerStatus_dbus_property(self):

1547

return dbus.Int16(self.last_checker_status)

1548

1549

1344

# Expires - property

1550

1345

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

1551

1346

def Expires_dbus_property(self):

1562

1357

def Timeout_dbus_property(self, value=None):

1563

1358

if value is None: # get

1564

1359

return dbus.UInt64(self.timeout_milliseconds())

1565

old_timeout = self.timeout

1566

1360

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

1567

# Reschedule disabling

1568

if self.enabled:

1569

now = datetime.datetime.utcnow()

1570

self.expires += self.timeout - old_timeout

1571

if self.expires <= now:

1572

# The timeout has passed

1573

self.disable()

1574

else:

1575

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

1576

is None):

1577

return

1578

gobject.source_remove(self.disable_initiator_tag)

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1361

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

1362

return

1363

# Reschedule timeout

1364

gobject.source_remove(self.disable_initiator_tag)

1365

self.disable_initiator_tag = None

1366

self.expires = None

1367

time_to_die = timedelta_to_milliseconds((self

1368

.last_checked_ok

1369

+ self.timeout)

1370

- datetime.datetime

1371

.utcnow())

1372

if time_to_die <= 0:

1373

# The timeout has passed

1374

self.disable()

1375

else:

1376

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

1377

+ datetime.timedelta(milliseconds =

1378

time_to_die))

1379

self.disable_initiator_tag = (gobject.timeout_add

1380

(time_to_die, self.disable))

1583

1381

1584

1382

# ExtendedTimeout - property

1585

1383

@dbus_service_property(_interface, signature="t",

1664

1462

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

1665

1463

1666

1464

1465

class ClientDBusTransitional(ClientDBus):

1466

__metaclass__ = AlternateDBusNamesMetaclass

1467

1468

1667

1469

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

1470

"""A class to handle client connections.

1669

1471

1705

1507

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

1706

1508

try:

1707

1509

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

1708

raise RuntimeError(line)

1510

raise RuntimeError

1709

1511

except (ValueError, IndexError, RuntimeError) as error:

1710

1512

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

1711

1513

return

1737

1539

except KeyError:

1738

1540

return

1739

1541

1542

if self.server.use_dbus:

1543

# Emit D-Bus signal

1544

client.NewRequest(str(self.client_address))

1545

1740

1546

if client.approval_delay:

1741

1547

delay = client.approval_delay

1742

1548

client.approvals_pending += 1

1773

1579

#wait until timeout or approved

1774

1580

time = datetime.datetime.now()

1775

1581

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

1582

(client.changedstate.wait

1583

(float(client.timedelta_to_milliseconds(delay)

1584

/ 1000)))

1779

1585

client.changedstate.release()

1780

1586

time2 = datetime.datetime.now()

1781

1587

if (time2 - time) >= delay:

1797

1603

try:

1798

1604

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

1799

1605

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1606

logger.warning("gnutls send failed")

1802

1607

return

1803

1608

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

1804

1609

sent, len(client.secret)

1807

1612

1808

1613

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

1809

1614

# bump the timeout using extended_timeout

1810

client.bump_timeout(client.extended_timeout)

1615

client.checked_ok(client.extended_timeout)

1811

1616

if self.server.use_dbus:

1812

1617

# Emit D-Bus signal

1813

1618

client.GotSecret()

1818

1623

try:

1819

1624

session.bye()

1820

1625

except gnutls.errors.GNUTLSError as error:

1821

logger.warning("GnuTLS bye failed",

1822

exc_info=error)

1626

logger.warning("GnuTLS bye failed")

1823

1627

1824

1628

@staticmethod

1825

1629

def peer_certificate(session):

1897

1701

def process_request(self, request, address):

1898

1702

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

1899

1703

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

1900

args = (request, address))

1704

args = (request,

1705

address))

1901

1706

proc.start()

1902

1707

return proc

1903

1708

1918

1723

1919

1724

def add_pipe(self, parent_pipe, proc):

1920

1725

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

1921

raise NotImplementedError()

1726

raise NotImplementedError

1922

1727

1923

1728

1924

1729

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1931

1736

use_ipv6: Boolean; to use IPv6 or not

1932

1737

"""

1933

1738

def __init__(self, server_address, RequestHandlerClass,

1934

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

1935

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

1936

creating a new one with socket.socket().

1937

"""

1739

interface=None, use_ipv6=True):

1938

1740

self.interface = interface

1939

1741

if use_ipv6:

1940

1742

self.address_family = socket.AF_INET6

1941

if socketfd is not None:

1942

# Save the file descriptor

1943

self.socketfd = socketfd

1944

# Save the original socket.socket() function

1945

self.socket_socket = socket.socket

1946

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

1947

#

1948

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

1949

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

1950

# patching socket.socket.)

1951

#

1952

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

1953

@functools.wraps(socket.socket)

1954

def socket_wrapper(*args, **kwargs):

1955

# Restore original function so subsequent calls are

1956

# not affected.

1957

socket.socket = self.socket_socket

1958

del self.socket_socket

1959

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

1960

# saved file descriptor.

1961

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

1962

# Replace socket.socket() function with wrapper

1963

socket.socket = socket_wrapper

1964

# The socketserver.TCPServer.__init__ will call

1965

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

1966

# socket_wrapper(), if socketfd was set.

1967

1743

socketserver.TCPServer.__init__(self, server_address,

1968

1744

RequestHandlerClass)

1969

1970

1745

def server_bind(self):

1971

1746

"""This overrides the normal server_bind() function

1972

1747

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

1980

1755

try:

1981

1756

self.socket.setsockopt(socket.SOL_SOCKET,

1982

1757

SO_BINDTODEVICE,

1983

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

1758

str(self.interface

1759

+ '\0'))

1984

1760

except socket.error as error:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1761

if error[0] == errno.EPERM:

1762

logger.error("No permission to"

1763

" bind to interface %s",

1764

self.interface)

1765

elif error[0] == errno.ENOPROTOOPT:

1989

1766

logger.error("SO_BINDTODEVICE not available;"

1990

1767

" cannot bind to interface %s",

1991

1768

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

1769

else:

1996

1770

raise

1997

1771

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

2000

1774

if self.address_family == socket.AF_INET6:

2001

1775

any_address = "::" # in6addr_any

2002

1776

else:

2003

any_address = "0.0.0.0" # INADDR_ANY

1777

any_address = socket.INADDR_ANY

2004

1778

self.server_address = (any_address,

2005

1779

self.server_address[1])

2006

1780

elif not self.server_address[1]:

2027

1801

"""

2028

1802

def __init__(self, server_address, RequestHandlerClass,

2029

1803

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

2030

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

1804

gnutls_priority=None, use_dbus=True):

2031

1805

self.enabled = False

2032

1806

self.clients = clients

2033

1807

if self.clients is None:

2037

1811

IPv6_TCPServer.__init__(self, server_address,

2038

1812

RequestHandlerClass,

2039

1813

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

1814

use_ipv6 = use_ipv6)

2042

1815

def server_activate(self):

2043

1816

if self.enabled:

2044

1817

return socketserver.TCPServer.server_activate(self)

2057

1830

2058

1831

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

2059

1832

proc = None, client_object=None):

1833

condition_names = {

1834

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

1835

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

1836

# blocking).

1837

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

1838

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

1839

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

1840

# broken, usually for pipes and

1841

# sockets).

1842

}

1843

conditions_string = ' | '.join(name

1844

for cond, name in

1845

condition_names.iteritems()

1846

if cond & condition)

2060

1847

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

2061

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

1848

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

2062

1849

# Wait for other process to exit

2063

1850

proc.join()

2064

1851

return False

2122

1909

return True

2123

1910

2124

1911

2125

def rfc3339_duration_to_delta(duration):

2126

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

2127

2128

>>> rfc3339_duration_to_delta("P7D")

2129

datetime.timedelta(7)

2130

>>> rfc3339_duration_to_delta("PT60S")

2131

datetime.timedelta(0, 60)

2132

>>> rfc3339_duration_to_delta("PT60M")

2133

datetime.timedelta(0, 3600)

2134

>>> rfc3339_duration_to_delta("PT24H")

2135

datetime.timedelta(1)

2136

>>> rfc3339_duration_to_delta("P1W")

2137

datetime.timedelta(7)

2138

>>> rfc3339_duration_to_delta("PT5M30S")

2139

datetime.timedelta(0, 330)

2140

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

datetime.timedelta(1, 200)

2142

"""

2143

2144

# Parsing an RFC 3339 duration with regular expressions is not

2145

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

2146

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

2147

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

2148

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

2149

# avoid excessive use of external libraries.

2150

2151

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

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# this token

2161

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

2162

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

2163

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

2164

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

2165

datetime.timedelta(seconds=1),

2166

frozenset((token_end,)))

2167

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

2168

datetime.timedelta(minutes=1),

2169

frozenset((token_second, token_end)))

2170

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

2171

datetime.timedelta(hours=1),

2172

frozenset((token_minute, token_end)))

2173

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

2174

None,

2175

frozenset((token_hour, token_minute,

2176

token_second)))

2177

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

2178

datetime.timedelta(days=1),

2179

frozenset((token_time, token_end)))

2180

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

2181

datetime.timedelta(weeks=4),

2182

frozenset((token_day, token_end)))

2183

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

2184

datetime.timedelta(weeks=52),

2185

frozenset((token_month, token_end)))

2186

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

2187

datetime.timedelta(weeks=1),

2188

frozenset((token_end,)))

2189

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

2190

frozenset((token_year, token_month,

2191

token_day, token_time,

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2195

found_token = None

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2198

# Loop until end token is found

2199

while found_token is not token_end:

2200

# Search for any currently valid tokens

2201

for token in followers:

2202

match = token.regexp.match(s)

2203

if match is not None:

2204

# Token found

2205

if token.value is not None:

2206

# Value found, parse digits

2207

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

2208

# Add to value so far

2209

value += factor * token.value

2210

# Strip token from string

2211

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

2212

# Go to found token

2213

found_token = token

2214

# Set valid next tokens

2215

followers = found_token.followers

2216

break

2217

else:

2218

# No currently valid tokens were found

2219

raise ValueError("Invalid RFC 3339 duration")

2220

# End token found

2221

return value

2222

2223

2224

1912

def string_to_delta(interval):

2225

1913

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

2226

1914

2237

1925

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

2238

1926

datetime.timedelta(0, 330)

2239

1927

"""

2240

2241

try:

2242

return rfc3339_duration_to_delta(interval)

2243

except ValueError:

2244

pass

2245

2246

1928

timevalue = datetime.timedelta(0)

2247

1929

for s in interval.split():

2248

1930

try:

2259

1941

elif suffix == "w":

2260

1942

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

2261

1943

else:

2262

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

2263

.format(suffix))

2264

except IndexError as e:

1944

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

1945

except (ValueError, IndexError) as e:

2265

1946

raise ValueError(*(e.args))

2266

1947

timevalue += delta

2267

1948

return timevalue

2280

1961

sys.exit()

2281

1962

if not noclose:

2282

1963

# Close all standard open file descriptors

2283

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

1964

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

2284

1965

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

2285

1966

raise OSError(errno.ENODEV,

2286

"{0} not a character device"

2287

.format(os.devnull))

1967

"%s not a character device"

1968

% os.path.devnull)

2288

1969

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

2289

1970

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

2290

1971

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

2299

1980

2300

1981

parser = argparse.ArgumentParser()

2301

1982

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

2302

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

1983

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

2303

1984

help="show version number and exit")

2304

1985

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

2305

1986

help="Bind to interface IF")

2311

1992

help="Run self-test")

2312

1993

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

2313

1994

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

2314

" to terminal", default=None)

1995

" to terminal")

2315

1996

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

2316

1997

help="Debug level for stdout output")

2317

1998

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

2324

2005

" files")

2325

2006

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

2326

2007

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

2327

" system bus interface", default=None)

2008

" system bus interface")

2328

2009

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

2329

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

2330

default=None)

2010

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

2331

2011

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

2332

2012

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

2333

" state", default=None)

2334

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

2335

help="Specify a file descriptor to a network"

2336

" socket to use instead of creating one")

2013

" state")

2337

2014

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

2338

2015

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

2339

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

2340

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

2341

2016

2342

2017

options = parser.parse_args()

2343

2018

2352

2027

"port": "",

2353

2028

"debug": "False",

2354

2029

"priority":

2355

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

2030

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

2356

2031

"servicename": "Mandos",

2357

2032

"use_dbus": "True",

2358

2033

"use_ipv6": "True",

2359

2034

"debuglevel": "",

2360

2035

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2036

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

2364

2037

}

2365

2038

2366

2039

# Parse config file for server-global settings

2371

2044

# Convert the SafeConfigParser object to a dict

2372

2045

server_settings = server_config.defaults()

2373

2046

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

2374

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

2047

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

2375

2048

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

2376

2049

option)

2377

2050

if server_settings["port"]:

2378

2051

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

2379

2052

"port")

2380

if server_settings["socket"]:

2381

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

2382

"socket")

2383

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

2384

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

2385

# happen with a supplied network socket.

2386

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

2387

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

2388

["socket"])

2389

2053

del server_config

2390

2054

2391

2055

# Override the settings from the config file with command line

2393

2057

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

2394

2058

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

2395

2059

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

2396

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

2060

"statedir"):

2397

2061

value = getattr(options, option)

2398

2062

if value is not None:

2399

2063

server_settings[option] = value

2402

2066

for option in server_settings.keys():

2403

2067

if type(server_settings[option]) is str:

2404

2068

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

2405

# Force all boolean options to be boolean

2406

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

2407

"foreground"):

2408

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

2409

# Debug implies foreground

2410

if server_settings["debug"]:

2411

server_settings["foreground"] = True

2412

2069

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

2413

2070

2414

2071

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

2420

2077

use_ipv6 = server_settings["use_ipv6"]

2421

2078

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

2422

2079

stored_state_file)

2423

foreground = server_settings["foreground"]

2424

2080

2425

2081

if debug:

2426

2082

initlogger(debug, logging.DEBUG)

2433

2089

2434

2090

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

2435

2091

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2092

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

2093

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

2094

% server_settings["servicename"]))

2440

2095

2441

2096

# Parse config file with clients

2442

client_config = configparser.SafeConfigParser(Client

2443

.client_defaults)

2097

client_config = configparser.SafeConfigParser(Client.client_defaults)

2444

2098

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

2445

2099

"clients.conf"))

2446

2100

2455

2109

use_ipv6=use_ipv6,

2456

2110

gnutls_priority=

2457

2111

server_settings["priority"],

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

or None))

2461

if not foreground:

2462

pidfilename = "/run/mandos.pid"

2463

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

2464

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

2465

pidfile = None

2112

use_dbus=use_dbus)

2113

if not debug:

2114

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

2466

2115

try:

2467

2116

pidfile = open(pidfilename, "w")

2468

except IOError as e:

2469

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

2470

exc_info=e)

2117

except IOError:

2118

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

2471

2119

2472

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

2120

try:

2121

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

2122

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

2123

except KeyError:

2473

2124

try:

2474

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

2476

break

2125

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

2126

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

2477

2127

except KeyError:

2478

continue

2479

else:

2480

uid = 65534

2481

gid = 65534

2128

try:

2129

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

2130

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

2131

except KeyError:

2132

uid = 65534

2133

gid = 65534

2482

2134

try:

2483

2135

os.setgid(gid)

2484

2136

os.setuid(uid)

2485

2137

except OSError as error:

2486

if error.errno != errno.EPERM:

2487

raise

2138

if error[0] != errno.EPERM:

2139

raise error

2488

2140

2489

2141

if debug:

2490

2142

# Enable all possible GnuTLS debugging

2501

2153

.gnutls_global_set_log_function(debug_gnutls))

2502

2154

2503

2155

# Redirect stdin so all checkers get /dev/null

2504

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

2156

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

2505

2157

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

2506

2158

if null > 2:

2507

2159

os.close(null)

2508

2160

2509

2161

# Need to fork before connecting to D-Bus

2510

if not foreground:

2162

if not debug:

2511

2163

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

2512

2164

daemon()

2513

2165

2514

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

2515

# need to inform gobject that threads will be used.

2516

2166

gobject.threads_init()

2517

2167

2518

2168

global main_loop

2519

2169

# From the Avahi example code

2520

DBusGMainLoop(set_as_default=True)

2170

DBusGMainLoop(set_as_default=True )

2521

2171

main_loop = gobject.MainLoop()

2522

2172

bus = dbus.SystemBus()

2523

2173

# End of Avahi example code

2529

2179

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

2530

2180

do_not_queue=True))

2531

2181

except dbus.exceptions.NameExistsException as e:

2532

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

2182

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

2533

2183

use_dbus = False

2534

2184

server_settings["use_dbus"] = False

2535

2185

tcp_server.use_dbus = False

2547

2197

2548

2198

client_class = Client

2549

2199

if use_dbus:

2550

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

2200

client_class = functools.partial(ClientDBusTransitional,

2201

bus = bus)

2551

2202

2552

2203

client_settings = Client.config_parser(client_config)

2553

2204

old_client_settings = {}

2554

2205

clients_data = {}

2555

2206

2556

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

2557

global wnull

2558

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

2559

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

2560

# mode

2561

if debug or not foreground:

2562

wnull.close()

2563

2564

2207

# Get client data and settings from last running state.

2565

2208

if server_settings["restore"]:

2566

2209

try:

2569

2212

(stored_state))

2570

2213

os.remove(stored_state_path)

2571

2214

except IOError as e:

2572

if e.errno == errno.ENOENT:

2573

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

2574

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

2575

else:

2576

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

2577

exc_info=e)

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

2578

2218

raise

2579

2219

except EOFError as e:

2580

2220

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

2581

"EOFError:", exc_info=e)

2221

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

2582

2222

2583

2223

with PGPEngine() as pgp:

2584

2224

for client_name, client in clients_data.iteritems():

2585

# Skip removed clients

2586

if client_name not in client_settings:

2587

continue

2588

2589

2225

# Decide which value to use after restoring saved state.

2590

2226

# We have three different values: Old config file,

2591

2227

# new config file, and saved state.

2605

2241

2606

2242

# Clients who has passed its expire date can still be

2607

2243

# enabled if its last checker was successful. Clients

2608

# whose checker succeeded before we stored its state is

2609

# assumed to have successfully run all checkers during

2610

# downtime.

2244

# whose checker failed before we stored its state is

2245

# assumed to have failed all checkers during downtime.

2611

2246

if client["enabled"]:

2612

2247

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

2613

2248

if not client["last_checked_ok"]:

2614

2249

logger.warning(

2615

2250

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

2251

"performed a successfull checker"

2252

.format(client["name"]))

2618

2253

client["enabled"] = False

2619

2254

elif client["last_checker_status"] != 0:

2620

2255

logger.warning(

2621

2256

"disabling client {0} - Client "

2622

2257

"last checker failed with error code {1}"

2623

.format(client_name,

2258

.format(client["name"],

2624

2259

client["last_checker_status"]))

2625

2260

client["enabled"] = False

2626

2261

else:

2627

2262

client["expires"] = (datetime.datetime

2628

2263

.utcnow()

2629

2264

+ client["timeout"])

2630

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

2265

2633

2266

try:

2634

2267

client["secret"] = (

2635

2268

pgp.decrypt(client["encrypted_secret"],

2641

2274

.format(client_name))

2642

2275

client["secret"] = (

2643

2276

client_settings[client_name]["secret"])

2277

2644

2278

2645

2279

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

2646

for client_name in (set(old_client_settings)

2647

- set(client_settings)):

2280

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

2648

2281

del clients_data[client_name]

2649

for client_name in (set(client_settings)

2650

- set(old_client_settings)):

2282

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

2651

2283

clients_data[client_name] = client_settings[client_name]

2652

2653

# Create all client objects

2284

2285

# Create clients all clients

2654

2286

for client_name, client in clients_data.iteritems():

2655

2287

tcp_server.clients[client_name] = client_class(

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2288

name = client_name, settings = client)

2658

2289

2659

2290

if not tcp_server.clients:

2660

2291

logger.warning("No clients defined")

2661

2662

if not foreground:

2663

if pidfile is not None:

2664

try:

2665

with pidfile:

2666

pid = os.getpid()

2667

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

2668

except IOError:

2669

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

2670

pidfilename, pid)

2671

del pidfile

2292

2293

if not debug:

2294

try:

2295

with pidfile:

2296

pid = os.getpid()

2297

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

2298

del pidfile

2299

except IOError:

2300

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

2301

pidfilename, pid)

2302

except NameError:

2303

# "pidfile" was never created

2304

pass

2672

2305

del pidfilename

2306

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

2673

2307

2674

2308

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

2675

2309

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

2676

2310

2677

2311

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

2312

class MandosDBusService(dbus.service.Object):

2681

2313

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

2682

2314

def __init__(self):

2683

2315

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

2684

2316

_interface = "se.recompile.Mandos"

2685

2317

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

2692

2318

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

2693

2319

def ClientAdded(self, objpath):

2694

2320

"D-Bus signal"

2736

2362

2737

2363

del _interface

2738

2364

2739

mandos_dbus_service = MandosDBusService()

2365

class MandosDBusServiceTransitional(MandosDBusService):

2366

__metaclass__ = AlternateDBusNamesMetaclass

2367

mandos_dbus_service = MandosDBusServiceTransitional()

2740

2368

2741

2369

def cleanup():

2742

2370

"Cleanup function; run on exit"

2743

2371

service.cleanup()

2744

2372

2745

2373

multiprocessing.active_children()

2746

wnull.close()

2747

2374

if not (tcp_server.clients or client_settings):

2748

2375

return

2749

2376

2761

2388

# A list of attributes that can not be pickled

2762

2389

# + secret.

2763

2390

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

2764

"checker", "server_settings"))

2391

"checker"))

2765

2392

for name, typ in (inspect.getmembers

2766

2393

(dbus.service.Object)):

2767

2394

exclude.add(name)

2776

2403

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

2777

2404

2778

2405

try:

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2406

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

2407

prefix="clients-",

2408

dir=os.path.dirname

2409

(stored_state_path))

2410

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

2783

2411

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

2784

tempname=stored_state.name

2785

2412

os.rename(tempname, stored_state_path)

2786

2413

except (IOError, OSError) as e:

2414

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

2415

.format(e))

2787

2416

if not debug:

2788

2417

try:

2789

2418

os.remove(tempname)

2790

2419

except NameError:

2791

2420

pass

2792

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

2793

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

2794

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

2795

else:

2796

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

2797

exc_info=e)

2798

raise

2421

if e.errno not in set((errno.ENOENT, errno.EACCES,

2422

errno.EEXIST)):

2423

raise e

2799

2424

2800

2425

# Delete all clients, and settings from config

2801

2426

while tcp_server.clients:

2828

2453

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

2829

2454

if use_ipv6:

2830

2455

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

2831

" flowinfo %d, scope_id %d",

2832

*tcp_server.socket.getsockname())

2456

" flowinfo %d, scope_id %d"

2457

% tcp_server.socket.getsockname())

2833

2458

else: # IPv4

2834

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

2835

*tcp_server.socket.getsockname())

2459

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

2460

% tcp_server.socket.getsockname())

2836

2461

2837

2462

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

2838

2463

2841

2466

try:

2842

2467

service.activate()

2843

2468

except dbus.exceptions.DBusException as error:

2844

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

2469

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

2845

2470

cleanup()

2846

2471

sys.exit(1)

2847

2472

# End of Avahi example code

2854

2479

logger.debug("Starting main loop")

2855

2480

main_loop.run()

2856

2481

except AvahiError as error:

2857

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

2482

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

2858

2483

cleanup()

2859

2484

sys.exit(1)

2860

2485

except KeyboardInterrupt: