/mandos/trunk : revision 237.4.39

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

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

136

139

class PGPEngine(object):

137

140

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

138

141

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

142

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

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

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

146

148

147

149

def __enter__(self):

148

150

return self

149

151

150

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

152

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

151

153

self._cleanup()

152

154

return False

153

155

170

172

def password_encode(self, password):

171

173

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

172

174

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

173

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

174

182

175

183

def encrypt(self, data, password):

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

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)

190

199

return ciphertext

191

200

192

201

def decrypt(self, data, password):

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

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)

207

218

return decrypted_plaintext

208

219

209

220

210

211

221

class AvahiError(Exception):

212

222

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

213

223

self.value = value

230

240

Used to optionally bind to the specified interface.

231

241

name: string; Example: 'Mandos'

232

242

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

233

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

243

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

234

244

port: integer; what port to announce

235

245

TXT: list of strings; TXT record for the service

236

246

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

242

252

server: D-Bus Server

243

253

bus: dbus.SystemBus()

244

254

"""

255

245

256

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

246

257

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

247

258

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

260

271

self.server = None

261

272

self.bus = bus

262

273

self.entry_group_state_changed_match = None

274

263

275

def rename(self):

264

276

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

265

277

if self.rename_count >= self.max_renames:

275

287

try:

276

288

self.add()

277

289

except dbus.exceptions.DBusException as error:

278

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

290

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

279

291

self.cleanup()

280

292

os._exit(1)

281

293

self.rename_count += 1

294

282

295

def remove(self):

283

296

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

284

297

if self.entry_group_state_changed_match is not None:

286

299

self.entry_group_state_changed_match = None

287

300

if self.group is not None:

288

301

self.group.Reset()

302

289

303

def add(self):

290

304

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

291

305

self.remove()

308

322

dbus.UInt16(self.port),

309

323

avahi.string_array_to_txt_array(self.TXT))

310

324

self.group.Commit()

325

311

326

def entry_group_state_changed(self, state, error):

312

327

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

313

328

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

320

335

elif state == avahi.ENTRY_GROUP_FAILURE:

321

336

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

322

337

unicode(error))

323

raise AvahiGroupError("State changed: %s"

324

% unicode(error))

338

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

339

.format(error))

340

325

341

def cleanup(self):

326

342

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

327

343

if self.group is not None:

332

348

pass

333

349

self.group = None

334

350

self.remove()

351

335

352

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

336

353

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

337

354

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

356

373

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

357

374

else:

358

375

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

376

359

377

def activate(self):

360

378

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

361

379

if self.server is None:

368

386

self.server_state_changed)

369

387

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

370

388

389

371

390

class AvahiServiceToSyslog(AvahiService):

372

391

def rename(self):

373

392

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

374

393

ret = AvahiService.rename(self)

375

394

syslogger.setFormatter(logging.Formatter

376

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

377

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

378

% self.name))

395

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

396

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

397

.format(self.name)))

379

398

return ret

380

399

400

381

401

def timedelta_to_milliseconds(td):

382

402

"Convert a datetime.timedelta() to milliseconds"

383

403

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

384

404

+ (td.seconds * 1000)

385

405

+ (td.microseconds // 1000))

386

406

407

387

408

class Client(object):

388

409

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

389

410

414

435

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

415

436

last_checker_status: integer between 0 and 255 reflecting exit

416

437

status of last checker. -1 reflects crashed

417

checker, or None.

438

checker, -2 means no checker completed yet.

418

439

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

419

440

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

420

441

D-Bus identifiers

421

442

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

422

443

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

423

444

until this client is disabled

424

extended_timeout: extra long timeout when password has been sent

445

extended_timeout: extra long timeout when secret has been sent

425

446

runtime_expansions: Allowed attributes for runtime expansion.

426

447

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

427

448

disabled, or None

449

server_settings: The server_settings dict from main()

428

450

"""

429

451

430

452

runtime_expansions = ("approval_delay", "approval_duration",

431

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

432

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

453

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

454

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

455

"last_approval_request", "last_checked_ok",

433

456

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

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

437

460

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

438

461

"host": "",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

441

464

"approved_by_default": "True",

442

465

"enabled": "True",

443

466

}

456

479

457

480

def approval_delay_milliseconds(self):

458

481

return timedelta_to_milliseconds(self.approval_delay)

459

482

460

483

@staticmethod

461

484

def config_parser(config):

462

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

485

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

463

486

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

464

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

"""

465

491

settings = {}

466

492

for client_name in config.sections():

467

493

section = dict(config.items(client_name))

471

497

# Reformat values from string types to Python types

472

498

client["approved_by_default"] = config.getboolean(

473

499

client_name, "approved_by_default")

474

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

500

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

501

"enabled")

475

502

476

503

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

477

504

.replace(" ", ""))

483

510

"rb") as secfile:

484

511

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

485

512

else:

486

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

487

% section)

513

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

514

.format(section))

488

515

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

489

516

client["extended_timeout"] = string_to_delta(

490

517

section["extended_timeout"])

496

523

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

497

524

client["last_approval_request"] = None

498

525

client["last_checked_ok"] = None

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

526

client["last_checker_status"] = -2

527

508

528

return settings

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

529

530

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

515

531

self.name = name

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

516

535

# adding all client settings

517

536

for setting, value in settings.iteritems():

518

537

setattr(self, setting, value)

519

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

520

549

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

521

550

# Uppercase and remove spaces from fingerprint for later

522

551

# comparison purposes with return value from the fingerprint()

523

552

# function

524

553

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

525

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

526

554

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

555

datetime.datetime.utcnow())

556

527

557

# attributes specific for this server instance

528

558

self.checker = None

529

559

self.checker_initiator_tag = None

557

587

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

558

588

# Already enabled

559

589

return

560

self.send_changedstate()

561

590

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

562

591

self.enabled = True

563

592

self.last_enabled = datetime.datetime.utcnow()

564

593

self.init_checker()

594

self.send_changedstate()

565

595

566

596

def disable(self, quiet=True):

567

597

"""Disable this client."""

568

598

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

569

599

return False

570

600

if not quiet:

571

self.send_changedstate()

572

if not quiet:

573

601

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

574

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

602

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

575

603

gobject.source_remove(self.disable_initiator_tag)

576

604

self.disable_initiator_tag = None

577

605

self.expires = None

578

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

606

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

579

607

gobject.source_remove(self.checker_initiator_tag)

580

608

self.checker_initiator_tag = None

581

609

self.stop_checker()

582

610

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

583

613

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

584

614

return False

585

615

589

619

def init_checker(self):

590

620

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

591

621

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

592

624

self.checker_initiator_tag = (gobject.timeout_add

593

625

(self.interval_milliseconds(),

594

626

self.start_checker))

595

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)

596

630

self.disable_initiator_tag = (gobject.timeout_add

597

631

(self.timeout_milliseconds(),

598

632

self.disable))

617

651

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

618

652

vars(self))

619

653

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

"""

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

626

662

if timeout is None:

627

663

timeout = self.timeout

628

self.last_checked_ok = datetime.datetime.utcnow()

629

664

if self.disable_initiator_tag is not None:

630

665

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

631

667

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

632

668

self.disable_initiator_tag = (gobject.timeout_add

633

669

(timedelta_to_milliseconds

643

679

If a checker already exists, leave it running and do

644

680

nothing."""

645

681

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

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

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

650

686

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

651

687

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

652

688

# should be.

654

690

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

655

691

try:

656

692

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

657

except (AttributeError, OSError) as error:

658

if (isinstance(error, OSError)

659

and error.errno != errno.ECHILD):

660

raise error

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

661

698

else:

662

699

if pid:

663

700

logger.warning("Checker was a zombie")

666

703

self.current_checker_command)

667

704

# Start a new checker if needed

668

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)

669

711

try:

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

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

688

717

self.current_checker_command = command

689

718

try:

690

719

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

693

722

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

694

723

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

695

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

696

733

self.checker = subprocess.Popen(command,

697

734

close_fds=True,

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.

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:

705

748

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)

709

749

except OSError as error:

710

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

711

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)

712

759

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

713

760

return True

714

761

721

768

return

722

769

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

723

770

try:

724

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

771

self.checker.terminate()

725

772

#time.sleep(0.5)

726

773

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

727

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

774

# self.checker.kill()

728

775

except OSError as error:

729

776

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

730

777

raise

747

794

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

748

795

if byte_arrays and signature != "ay":

749

796

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

750

" signature %r" % signature)

797

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

751

798

def decorator(func):

752

799

func._dbus_is_property = True

753

800

func._dbus_interface = dbus_interface

761

808

return decorator

762

809

763

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

764

848

class DBusPropertyException(dbus.exceptions.DBusException):

765

849

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

766

850

"""

789

873

"""

790

874

791

875

@staticmethod

792

def _is_dbus_property(obj):

793

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)

794

884

795

def _get_all_dbus_properties(self):

885

def _get_all_dbus_things(self, thing):

796

886

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

797

887

"""

798

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

888

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

889

name),

890

athing.__get__(self))

799

891

for cls in self.__class__.__mro__

800

for name, prop in

801

inspect.getmembers(cls, self._is_dbus_property))

892

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

802

895

803

896

def _get_dbus_property(self, interface_name, property_name):

804

897

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

806

899

"""

807

900

for cls in self.__class__.__mro__:

808

901

for name, value in (inspect.getmembers

809

(cls, self._is_dbus_property)):

902

(cls,

903

self._is_dbus_thing("property"))):

810

904

if (value._dbus_name == property_name

811

905

and value._dbus_interface == interface_name):

812

906

return value.__get__(self)

840

934

# The byte_arrays option is not supported yet on

841

935

# signatures other than "ay".

842

936

if prop._dbus_signature != "ay":

843

raise ValueError

844

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

845

for byte in value))

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

846

942

prop(value)

847

943

848

944

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

854

950

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

855

951

"""

856

952

properties = {}

857

for name, prop in self._get_all_dbus_properties():

953

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

858

954

if (interface_name

859

955

and interface_name != prop._dbus_interface):

860

956

# Interface non-empty but did not match

875

971

path_keyword='object_path',

876

972

connection_keyword='connection')

877

973

def Introspect(self, object_path, connection):

878

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

974

"""Overloading of standard D-Bus method.

975

976

Inserts property tags and interface annotation tags.

879

977

"""

880

978

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

881

979

connection)

888

986

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

889

987

return e

890

988

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

989

# Add property tags

891

990

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

892

991

for name, prop

893

in self._get_all_dbus_properties()

992

in self._get_all_dbus_things("property")

894

993

if prop._dbus_interface

895

994

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

896

995

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)

897

1027

# Add the names to the return values for the

898

1028

# "org.freedesktop.DBus.Properties" methods

899

1029

if (if_tag.getAttribute("name")

914

1044

except (AttributeError, xml.dom.DOMException,

915

1045

xml.parsers.expat.ExpatError) as error:

916

1046

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

917

error)

1047

exc_info=error)

918

1048

return xmlstring

919

1049

920

1050

921

def datetime_to_dbus (dt, variant_level=0):

1051

def datetime_to_dbus(dt, variant_level=0):

922

1052

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

923

1053

if dt is None:

924

1054

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

926

1056

variant_level=variant_level)

927

1057

928

1058

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.

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

933

1081

"""

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

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

941

1089

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

942

1090

# with the wrong interface name

943

1091

if (not hasattr(attribute, "_dbus_interface")

944

1092

or not attribute._dbus_interface

945

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

1093

.startswith(orig_interface_name)):

946

1094

continue

947

1095

# Create an alternate D-Bus interface name based on

948

1096

# the current name

949

1097

alt_interface = (attribute._dbus_interface

950

.replace("se.recompile.Mandos",

951

"se.bsnet.fukt.Mandos"))

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1100

interface_names.add(alt_interface)

952

1101

# Is this a D-Bus signal?

953

1102

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

954

# Extract the original non-method function by

955

# black magic

1103

# Extract the original non-method undecorated

1104

# function by black magic

956

1105

nonmethod_func = (dict(

957

1106

zip(attribute.func_code.co_freevars,

958

1107

attribute.__closure__))["func"]

969

1118

nonmethod_func.func_name,

970

1119

nonmethod_func.func_defaults,

971

1120

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

972

1127

# Define a creator of a function to call both the

973

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

974

# signals gets sent when the function is called

1128

# original and alternate functions, so both the

1129

# original and alternate signals gets sent when

1130

# the function is called

975

1131

def fixscope(func1, func2):

976

1132

"""This function is a scope container to pass

977

1133

func1 and func2 to the "call_both" function

984

1140

return call_both

985

1141

# Create the "call_both" function and add it to

986

1142

# the class

987

attr[attrname] = fixscope(attribute,

988

new_function)

1143

attr[attrname] = fixscope(attribute, new_function)

989

1144

# Is this a D-Bus method?

990

1145

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

991

1146

# Create a new, but exactly alike, function

1002

1157

attribute.func_name,

1003

1158

attribute.func_defaults,

1004

1159

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

1005

1166

# Is this a D-Bus property?

1006

1167

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

1007

1168

# Create a new, but exactly alike, function

1021

1182

attribute.func_name,

1022

1183

attribute.func_defaults,

1023

1184

attribute.func_closure)))

1024

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

1025

1026

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

1027

1230

class ClientDBus(Client, DBusObjectWithProperties):

1028

1231

"""A Client class using D-Bus

1029

1232

1040

1243

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

1041

1244

self.bus = bus

1042

1245

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

1043

self._approvals_pending = 0

1044

1045

self._approvals_pending = 0

1046

1246

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

1047

1247

# the D-Bus

1048

1248

client_object_name = unicode(self.name).translate(

1052

1252

("/clients/" + client_object_name))

1053

1253

DBusObjectWithProperties.__init__(self, self.bus,

1054

1254

self.dbus_object_path)

1055

1255

1056

1256

def notifychangeproperty(transform_func,

1057

1257

dbus_name, type_func=lambda x: x,

1058

1258

variant_level=1):

1081

1281

1082

1282

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

1083

1283

1084

1085

1284

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1086

1285

approvals_pending = notifychangeproperty(dbus.Boolean,

1087

1286

"ApprovalPending",

1094

1293

checker is not None)

1095

1294

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1096

1295

"LastCheckedOK")

1296

last_checker_status = notifychangeproperty(dbus.Int16,

1297

"LastCheckerStatus")

1097

1298

last_approval_request = notifychangeproperty(

1098

1299

datetime_to_dbus, "LastApprovalRequest")

1099

1300

approved_by_default = notifychangeproperty(dbus.Boolean,

1167

1368

return False

1168

1369

1169

1370

def approve(self, value=True):

1170

self.send_changedstate()

1171

1371

self.approved = value

1172

1372

gobject.timeout_add(timedelta_to_milliseconds

1173

1373

(self.approval_duration),

1174

1374

self._reset_approved)

1175

1375

self.send_changedstate()

1176

1376

1177

1377

## D-Bus methods, signals & properties

1178

1378

_interface = "se.recompile.Mandos.Client"

1179

1379

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1180

1387

## Signals

1181

1388

1182

1389

# CheckerCompleted - signal

1218

1425

"D-Bus signal"

1219

1426

return self.need_approval()

1220

1427

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

1229

1428

## Methods

1230

1429

1231

1430

# Approve - method

1341

1540

return

1342

1541

return datetime_to_dbus(self.last_checked_ok)

1343

1542

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

1344

1549

# Expires - property

1345

1550

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

1346

1551

def Expires_dbus_property(self):

1357

1562

def Timeout_dbus_property(self, value=None):

1358

1563

if value is None: # get

1359

1564

return dbus.UInt64(self.timeout_milliseconds())

1565

old_timeout = self.timeout

1360

1566

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

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

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

1381

1583

1382

1584

# ExtendedTimeout - property

1383

1585

@dbus_service_property(_interface, signature="t",

1462

1664

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

1463

1665

1464

1666

1465

class ClientDBusTransitional(ClientDBus):

1466

__metaclass__ = AlternateDBusNamesMetaclass

1467

1468

1469

1667

class ClientHandler(socketserver.BaseRequestHandler, object):

1470

1668

"""A class to handle client connections.

1471

1669

1507

1705

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

1508

1706

try:

1509

1707

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

1510

raise RuntimeError

1708

raise RuntimeError(line)

1511

1709

except (ValueError, IndexError, RuntimeError) as error:

1512

1710

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

1513

1711

return

1539

1737

except KeyError:

1540

1738

return

1541

1739

1542

if self.server.use_dbus:

1543

# Emit D-Bus signal

1544

client.NewRequest(str(self.client_address))

1545

1546

1740

if client.approval_delay:

1547

1741

delay = client.approval_delay

1548

1742

client.approvals_pending += 1

1579

1773

#wait until timeout or approved

1580

1774

time = datetime.datetime.now()

1581

1775

client.changedstate.acquire()

1582

(client.changedstate.wait

1583

(float(client.timedelta_to_milliseconds(delay)

1584

/ 1000)))

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

1585

1779

client.changedstate.release()

1586

1780

time2 = datetime.datetime.now()

1587

1781

if (time2 - time) >= delay:

1603

1797

try:

1604

1798

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

1605

1799

except gnutls.errors.GNUTLSError as error:

1606

logger.warning("gnutls send failed")

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1607

1802

return

1608

1803

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

1609

1804

sent, len(client.secret)

1612

1807

1613

1808

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

1614

1809

# bump the timeout using extended_timeout

1615

client.checked_ok(client.extended_timeout)

1810

client.bump_timeout(client.extended_timeout)

1616

1811

if self.server.use_dbus:

1617

1812

# Emit D-Bus signal

1618

1813

client.GotSecret()

1623

1818

try:

1624

1819

session.bye()

1625

1820

except gnutls.errors.GNUTLSError as error:

1626

logger.warning("GnuTLS bye failed")

1821

logger.warning("GnuTLS bye failed",

1822

exc_info=error)

1627

1823

1628

1824

@staticmethod

1629

1825

def peer_certificate(session):

1701

1897

def process_request(self, request, address):

1702

1898

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

1703

1899

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

1704

args = (request,

1705

address))

1900

args = (request, address))

1706

1901

proc.start()

1707

1902

return proc

1708

1903

1723

1918

1724

1919

def add_pipe(self, parent_pipe, proc):

1725

1920

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

1726

raise NotImplementedError

1921

raise NotImplementedError()

1727

1922

1728

1923

1729

1924

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1736

1931

use_ipv6: Boolean; to use IPv6 or not

1737

1932

"""

1738

1933

def __init__(self, server_address, RequestHandlerClass,

1739

interface=None, use_ipv6=True):

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

"""

1740

1938

self.interface = interface

1741

1939

if use_ipv6:

1742

1940

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.

1743

1967

socketserver.TCPServer.__init__(self, server_address,

1744

1968

RequestHandlerClass)

1969

1745

1970

def server_bind(self):

1746

1971

"""This overrides the normal server_bind() function

1747

1972

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

1755

1980

try:

1756

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1757

1982

SO_BINDTODEVICE,

1758

str(self.interface

1759

+ '\0'))

1983

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

1760

1984

except socket.error as error:

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:

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:

1766

1989

logger.error("SO_BINDTODEVICE not available;"

1767

1990

" cannot bind to interface %s",

1768

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1769

1995

else:

1770

1996

raise

1771

1997

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

1774

2000

if self.address_family == socket.AF_INET6:

1775

2001

any_address = "::" # in6addr_any

1776

2002

else:

1777

any_address = socket.INADDR_ANY

2003

any_address = "0.0.0.0" # INADDR_ANY

1778

2004

self.server_address = (any_address,

1779

2005

self.server_address[1])

1780

2006

elif not self.server_address[1]:

1801

2027

"""

1802

2028

def __init__(self, server_address, RequestHandlerClass,

1803

2029

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

1804

gnutls_priority=None, use_dbus=True):

2030

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

1805

2031

self.enabled = False

1806

2032

self.clients = clients

1807

2033

if self.clients is None:

1811

2037

IPv6_TCPServer.__init__(self, server_address,

1812

2038

RequestHandlerClass,

1813

2039

interface = interface,

1814

use_ipv6 = use_ipv6)

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

1815

2042

def server_activate(self):

1816

2043

if self.enabled:

1817

2044

return socketserver.TCPServer.server_activate(self)

1830

2057

1831

2058

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

1832

2059

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)

1847

2060

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

1848

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

2061

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

1849

2062

# Wait for other process to exit

1850

2063

proc.join()

1851

2064

return False

1909

2122

return True

1910

2123

1911

2124

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

1912

2224

def string_to_delta(interval):

1913

2225

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

1914

2226

1925

2237

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

1926

2238

datetime.timedelta(0, 330)

1927

2239

"""

2240

2241

try:

2242

return rfc3339_duration_to_delta(interval)

2243

except ValueError:

2244

pass

2245

1928

2246

timevalue = datetime.timedelta(0)

1929

2247

for s in interval.split():

1930

2248

try:

1941

2259

elif suffix == "w":

1942

2260

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

1943

2261

else:

1944

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

1945

except (ValueError, IndexError) as e:

2262

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

2263

.format(suffix))

2264

except IndexError as e:

1946

2265

raise ValueError(*(e.args))

1947

2266

timevalue += delta

1948

2267

return timevalue

1961

2280

sys.exit()

1962

2281

if not noclose:

1963

2282

# Close all standard open file descriptors

1964

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

2283

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

1965

2284

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

1966

2285

raise OSError(errno.ENODEV,

1967

"%s not a character device"

1968

% os.path.devnull)

2286

"{0} not a character device"

2287

.format(os.devnull))

1969

2288

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

1970

2289

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

1971

2290

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

1980

2299

1981

2300

parser = argparse.ArgumentParser()

1982

2301

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

1983

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

2302

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

1984

2303

help="show version number and exit")

1985

2304

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

1986

2305

help="Bind to interface IF")

1992

2311

help="Run self-test")

1993

2312

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

1994

2313

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

1995

" to terminal")

2314

" to terminal", default=None)

1996

2315

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

1997

2316

help="Debug level for stdout output")

1998

2317

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

2005

2324

" files")

2006

2325

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

2007

2326

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

2008

" system bus interface")

2327

" system bus interface", default=None)

2009

2328

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

2010

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

2329

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

2330

default=None)

2011

2331

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

2012

2332

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

2013

" state")

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

2014

2337

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

2015

2338

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

2339

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

2340

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

2016

2341

2017

2342

options = parser.parse_args()

2018

2343

2027

2352

"port": "",

2028

2353

"debug": "False",

2029

2354

"priority":

2030

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

2355

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

2031

2356

"servicename": "Mandos",

2032

2357

"use_dbus": "True",

2033

2358

"use_ipv6": "True",

2034

2359

"debuglevel": "",

2035

2360

"restore": "True",

2036

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

2361

"socket": "",

2362

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

2363

"foreground": "False",

2037

2364

}

2038

2365

2039

2366

# Parse config file for server-global settings

2044

2371

# Convert the SafeConfigParser object to a dict

2045

2372

server_settings = server_config.defaults()

2046

2373

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

2047

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

2374

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

2048

2375

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

2049

2376

option)

2050

2377

if server_settings["port"]:

2051

2378

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

2052

2379

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

2053

2389

del server_config

2054

2390

2055

2391

# Override the settings from the config file with command line

2057

2393

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

2058

2394

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

2059

2395

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

2060

"statedir"):

2396

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

2061

2397

value = getattr(options, option)

2062

2398

if value is not None:

2063

2399

server_settings[option] = value

2066

2402

for option in server_settings.keys():

2067

2403

if type(server_settings[option]) is str:

2068

2404

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

2069

2412

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

2070

2413

2071

2414

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

2077

2420

use_ipv6 = server_settings["use_ipv6"]

2078

2421

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

2079

2422

stored_state_file)

2423

foreground = server_settings["foreground"]

2080

2424

2081

2425

if debug:

2082

2426

initlogger(debug, logging.DEBUG)

2089

2433

2090

2434

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

2091

2435

syslogger.setFormatter(logging.Formatter

2092

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

2093

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

2094

% server_settings["servicename"]))

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2095

2440

2096

2441

# Parse config file with clients

2097

client_config = configparser.SafeConfigParser(Client.client_defaults)

2442

client_config = configparser.SafeConfigParser(Client

2443

.client_defaults)

2098

2444

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

2099

2445

"clients.conf"))

2100

2446

2109

2455

use_ipv6=use_ipv6,

2110

2456

gnutls_priority=

2111

2457

server_settings["priority"],

2112

use_dbus=use_dbus)

2113

if not debug:

2114

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

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

2115

2466

try:

2116

2467

pidfile = open(pidfilename, "w")

2117

except IOError:

2118

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

2468

except IOError as e:

2469

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

2470

exc_info=e)

2119

2471

2120

try:

2121

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

2122

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

2123

except KeyError:

2472

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

2124

2473

try:

2125

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

2126

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

2474

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

2476

break

2127

2477

except KeyError:

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

2478

continue

2479

else:

2480

uid = 65534

2481

gid = 65534

2134

2482

try:

2135

2483

os.setgid(gid)

2136

2484

os.setuid(uid)

2137

2485

except OSError as error:

2138

if error[0] != errno.EPERM:

2139

raise error

2486

if error.errno != errno.EPERM:

2487

raise

2140

2488

2141

2489

if debug:

2142

2490

# Enable all possible GnuTLS debugging

2153

2501

.gnutls_global_set_log_function(debug_gnutls))

2154

2502

2155

2503

# Redirect stdin so all checkers get /dev/null

2156

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

2504

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

2157

2505

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

2158

2506

if null > 2:

2159

2507

os.close(null)

2160

2508

2161

2509

# Need to fork before connecting to D-Bus

2162

if not debug:

2510

if not foreground:

2163

2511

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

2164

2512

daemon()

2165

2513

2514

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

2515

# need to inform gobject that threads will be used.

2166

2516

gobject.threads_init()

2167

2517

2168

2518

global main_loop

2169

2519

# From the Avahi example code

2170

DBusGMainLoop(set_as_default=True )

2520

DBusGMainLoop(set_as_default=True)

2171

2521

main_loop = gobject.MainLoop()

2172

2522

bus = dbus.SystemBus()

2173

2523

# End of Avahi example code

2179

2529

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

2180

2530

do_not_queue=True))

2181

2531

except dbus.exceptions.NameExistsException as e:

2182

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

2532

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

2183

2533

use_dbus = False

2184

2534

server_settings["use_dbus"] = False

2185

2535

tcp_server.use_dbus = False

2197

2547

2198

2548

client_class = Client

2199

2549

if use_dbus:

2200

client_class = functools.partial(ClientDBusTransitional,

2201

bus = bus)

2550

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

2202

2551

2203

2552

client_settings = Client.config_parser(client_config)

2204

2553

old_client_settings = {}

2205

2554

clients_data = {}

2206

2555

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

2207

2564

# Get client data and settings from last running state.

2208

2565

if server_settings["restore"]:

2209

2566

try:

2212

2569

(stored_state))

2213

2570

os.remove(stored_state_path)

2214

2571

except IOError as e:

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

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)

2218

2578

raise

2219

2579

except EOFError as e:

2220

2580

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

2221

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

2581

"EOFError:", exc_info=e)

2222

2582

2223

2583

with PGPEngine() as pgp:

2224

2584

for client_name, client in clients_data.iteritems():

2585

# Skip removed clients

2586

if client_name not in client_settings:

2587

continue

2588

2225

2589

# Decide which value to use after restoring saved state.

2226

2590

# We have three different values: Old config file,

2227

2591

# new config file, and saved state.

2241

2605

2242

2606

# Clients who has passed its expire date can still be

2243

2607

# enabled if its last checker was successful. Clients

2244

# whose checker failed before we stored its state is

2245

# assumed to have failed all checkers during downtime.

2608

# whose checker succeeded before we stored its state is

2609

# assumed to have successfully run all checkers during

2610

# downtime.

2246

2611

if client["enabled"]:

2247

2612

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

2248

2613

if not client["last_checked_ok"]:

2249

2614

logger.warning(

2250

2615

"disabling client {0} - Client never "

2251

"performed a successfull checker"

2252

.format(client["name"]))

2616

"performed a successful checker"

2617

.format(client_name))

2253

2618

client["enabled"] = False

2254

2619

elif client["last_checker_status"] != 0:

2255

2620

logger.warning(

2256

2621

"disabling client {0} - Client "

2257

2622

"last checker failed with error code {1}"

2258

.format(client["name"],

2623

.format(client_name,

2259

2624

client["last_checker_status"]))

2260

2625

client["enabled"] = False

2261

2626

else:

2262

2627

client["expires"] = (datetime.datetime

2263

2628

.utcnow()

2264

2629

+ client["timeout"])

2265

2630

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

2266

2633

try:

2267

2634

client["secret"] = (

2268

2635

pgp.decrypt(client["encrypted_secret"],

2274

2641

.format(client_name))

2275

2642

client["secret"] = (

2276

2643

client_settings[client_name]["secret"])

2277

2278

2644

2279

2645

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

2280

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

2646

for client_name in (set(old_client_settings)

2647

- set(client_settings)):

2281

2648

del clients_data[client_name]

2282

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

2649

for client_name in (set(client_settings)

2650

- set(old_client_settings)):

2283

2651

clients_data[client_name] = client_settings[client_name]

2284

2285

# Create clients all clients

2652

2653

# Create all client objects

2286

2654

for client_name, client in clients_data.iteritems():

2287

2655

tcp_server.clients[client_name] = client_class(

2288

name = client_name, settings = client)

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2289

2658

2290

2659

if not tcp_server.clients:

2291

2660

logger.warning("No clients defined")

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

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

2305

2672

del pidfilename

2306

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

2307

2673

2308

2674

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

2309

2675

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

2310

2676

2311

2677

if use_dbus:

2312

class MandosDBusService(dbus.service.Object):

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

2313

2681

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

2314

2682

def __init__(self):

2315

2683

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

2316

2684

_interface = "se.recompile.Mandos"

2317

2685

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

2318

2692

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

2319

2693

def ClientAdded(self, objpath):

2320

2694

"D-Bus signal"

2362

2736

2363

2737

del _interface

2364

2738

2365

class MandosDBusServiceTransitional(MandosDBusService):

2366

__metaclass__ = AlternateDBusNamesMetaclass

2367

mandos_dbus_service = MandosDBusServiceTransitional()

2739

mandos_dbus_service = MandosDBusService()

2368

2740

2369

2741

def cleanup():

2370

2742

"Cleanup function; run on exit"

2371

2743

service.cleanup()

2372

2744

2373

2745

multiprocessing.active_children()

2746

wnull.close()

2374

2747

if not (tcp_server.clients or client_settings):

2375

2748

return

2376

2749

2388

2761

# A list of attributes that can not be pickled

2389

2762

# + secret.

2390

2763

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

2391

"checker"))

2764

"checker", "server_settings"))

2392

2765

for name, typ in (inspect.getmembers

2393

2766

(dbus.service.Object)):

2394

2767

exclude.add(name)

2403

2776

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

2404

2777

2405

2778

try:

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:

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:

2411

2783

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

2784

tempname=stored_state.name

2412

2785

os.rename(tempname, stored_state_path)

2413

2786

except (IOError, OSError) as e:

2414

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

2415

.format(e))

2416

2787

if not debug:

2417

2788

try:

2418

2789

os.remove(tempname)

2419

2790

except NameError:

2420

2791

pass

2421

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

2422

errno.EEXIST)):

2423

raise e

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

2424

2799

2425

2800

# Delete all clients, and settings from config

2426

2801

while tcp_server.clients:

2453

2828

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

2454

2829

if use_ipv6:

2455

2830

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

2456

" flowinfo %d, scope_id %d"

2457

% tcp_server.socket.getsockname())

2831

" flowinfo %d, scope_id %d",

2832

*tcp_server.socket.getsockname())

2458

2833

else: # IPv4

2459

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

2460

% tcp_server.socket.getsockname())

2834

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

2835

*tcp_server.socket.getsockname())

2461

2836

2462

2837

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

2463

2838

2466

2841

try:

2467

2842

service.activate()

2468

2843

except dbus.exceptions.DBusException as error:

2469

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

2844

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

2470

2845

cleanup()

2471

2846

sys.exit(1)

2472

2847

# End of Avahi example code

2479

2854

logger.debug("Starting main loop")

2480

2855

main_loop.run()

2481

2856

except AvahiError as error:

2482

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

2857

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

2483

2858

cleanup()

2484

2859

sys.exit(1)

2485

2860

except KeyboardInterrupt: