/mandos/trunk : revision 541

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

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',

146

'--no-use-agent'])

148

147

149

148

def __enter__(self):

150

149

return self

151

150

152

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

151

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

153

152

self._cleanup()

154

153

return False

155

154

172

171

def password_encode(self, password):

173

172

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

174

173

# 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

174

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

182

175

183

176

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)

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

199

191

return ciphertext

200

192

201

193

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)

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

218

208

return decrypted_plaintext

219

209

220

210

211

221

212

class AvahiError(Exception):

222

213

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

223

214

self.value = value

240

231

Used to optionally bind to the specified interface.

241

232

name: string; Example: 'Mandos'

242

233

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

243

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

234

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

244

235

port: integer; what port to announce

245

236

TXT: list of strings; TXT record for the service

246

237

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

252

243

server: D-Bus Server

253

244

bus: dbus.SystemBus()

254

245

"""

255

256

246

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

257

247

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

258

248

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

271

261

self.server = None

272

262

self.bus = bus

273

263

self.entry_group_state_changed_match = None

274

275

264

def rename(self):

276

265

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

277

266

if self.rename_count >= self.max_renames:

287

276

try:

288

277

self.add()

289

278

except dbus.exceptions.DBusException as error:

290

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

279

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

291

280

self.cleanup()

292

281

os._exit(1)

293

282

self.rename_count += 1

294

295

283

def remove(self):

296

284

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

297

285

if self.entry_group_state_changed_match is not None:

299

287

self.entry_group_state_changed_match = None

300

288

if self.group is not None:

301

289

self.group.Reset()

302

303

290

def add(self):

304

291

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

305

292

self.remove()

322

309

dbus.UInt16(self.port),

323

310

avahi.string_array_to_txt_array(self.TXT))

324

311

self.group.Commit()

325

326

312

def entry_group_state_changed(self, state, error):

327

313

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

328

314

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

335

321

elif state == avahi.ENTRY_GROUP_FAILURE:

336

322

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

337

323

unicode(error))

338

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

339

.format(error))

340

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

341

326

def cleanup(self):

342

327

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

343

328

if self.group is not None:

348

333

pass

349

334

self.group = None

350

335

self.remove()

351

352

336

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

353

337

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

354

338

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

373

357

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

374

358

else:

375

359

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

376

377

360

def activate(self):

378

361

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

379

362

if self.server is None:

386

369

self.server_state_changed)

387

370

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

388

371

389

390

372

class AvahiServiceToSyslog(AvahiService):

391

373

def rename(self):

392

374

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

393

375

ret = AvahiService.rename(self)

394

376

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

377

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

378

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

379

% self.name))

398

380

return ret

399

381

400

401

382

def timedelta_to_milliseconds(td):

402

383

"Convert a datetime.timedelta() to milliseconds"

403

384

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

404

385

+ (td.seconds * 1000)

405

386

+ (td.microseconds // 1000))

406

407

387

408

388

class Client(object):

409

389

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

410

390

435

415

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

436

416

last_checker_status: integer between 0 and 255 reflecting exit

437

417

status of last checker. -1 reflects crashed

438

checker, -2 means no checker completed yet.

418

checker, or None.

439

419

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

440

420

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

441

421

D-Bus identifiers

442

422

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

443

423

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

444

424

until this client is disabled

445

extended_timeout: extra long timeout when secret has been sent

425

extended_timeout: extra long timeout when password has been sent

446

426

runtime_expansions: Allowed attributes for runtime expansion.

447

427

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

448

428

disabled, or None

449

server_settings: The server_settings dict from main()

450

429

"""

451

430

452

431

runtime_expansions = ("approval_delay", "approval_duration",

453

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

454

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

455

"last_approval_request", "last_checked_ok",

432

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

433

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

456

434

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

460

438

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

461

439

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

464

442

"approved_by_default": "True",

465

443

"enabled": "True",

466

444

}

479

457

480

458

def approval_delay_milliseconds(self):

481

459

return timedelta_to_milliseconds(self.approval_delay)

482

460

483

461

@staticmethod

484

462

def config_parser(config):

485

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

463

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

486

464

{ 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

"""

465

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

491

466

settings = {}

492

467

for client_name in config.sections():

493

468

section = dict(config.items(client_name))

497

472

# Reformat values from string types to Python types

498

473

client["approved_by_default"] = config.getboolean(

499

474

client_name, "approved_by_default")

500

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

501

"enabled")

475

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

502

476

503

477

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

504

478

.replace(" ", ""))

510

484

"rb") as secfile:

511

485

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

512

486

else:

513

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

514

.format(section))

487

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

488

% section)

515

489

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

516

490

client["extended_timeout"] = string_to_delta(

517

491

section["extended_timeout"])

523

497

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

524

498

client["last_approval_request"] = None

525

499

client["last_checked_ok"] = None

526

client["last_checker_status"] = -2

527

500

client["last_checker_status"] = None

501

if client["enabled"]:

502

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

503

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

504

+ client["timeout"])

505

else:

506

client["last_enabled"] = None

507

client["expires"] = None

508

528

509

return settings

529

530

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

510

511

512

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

513

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

514

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

515

attribute."""

531

516

self.name = name

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

535

517

# adding all client settings

536

518

for setting, value in settings.iteritems():

537

519

setattr(self, setting, value)

538

520

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

521

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

550

522

# Uppercase and remove spaces from fingerprint for later

551

523

# comparison purposes with return value from the fingerprint()

552

524

# function

553

525

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

554

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

555

datetime.datetime.utcnow())

556

526

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

527

557

528

# attributes specific for this server instance

558

529

self.checker = None

559

530

self.checker_initiator_tag = None

587

558

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

588

559

# Already enabled

589

560

return

561

self.send_changedstate()

590

562

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

591

563

self.enabled = True

592

564

self.last_enabled = datetime.datetime.utcnow()

593

565

self.init_checker()

594

self.send_changedstate()

595

566

596

567

def disable(self, quiet=True):

597

568

"""Disable this client."""

598

569

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

599

570

return False

600

571

if not quiet:

572

self.send_changedstate()

573

if not quiet:

601

574

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

602

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

575

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

603

576

gobject.source_remove(self.disable_initiator_tag)

604

577

self.disable_initiator_tag = None

605

578

self.expires = None

606

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

579

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

607

580

gobject.source_remove(self.checker_initiator_tag)

608

581

self.checker_initiator_tag = None

609

582

self.stop_checker()

610

583

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

613

584

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

614

585

return False

615

586

619

590

def init_checker(self):

620

591

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

621

592

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

593

self.checker_initiator_tag = (gobject.timeout_add

625

594

(self.interval_milliseconds(),

626

595

self.start_checker))

627

596

# 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

597

self.disable_initiator_tag = (gobject.timeout_add

631

598

(self.timeout_milliseconds(),

632

599

self.disable))

651

618

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

652

619

vars(self))

653

620

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

621

def checked_ok(self, timeout=None):

622

"""Bump up the timeout for this client.

623

624

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

625

alive and well.

626

"""

662

627

if timeout is None:

663

628

timeout = self.timeout

629

self.last_checked_ok = datetime.datetime.utcnow()

664

630

if self.disable_initiator_tag is not None:

665

631

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

667

632

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

668

633

self.disable_initiator_tag = (gobject.timeout_add

669

634

(timedelta_to_milliseconds

679

644

If a checker already exists, leave it running and do

680

645

nothing."""

681

646

# 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

647

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

648

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

649

# client would inevitably timeout, since no checker would get

650

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

686

651

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

687

652

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

688

653

# should be.

690

655

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

691

656

try:

692

657

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

658

except (AttributeError, OSError) as error:

659

if (isinstance(error, OSError)

660

and error.errno != errno.ECHILD):

661

raise error

698

662

else:

699

663

if pid:

700

664

logger.warning("Checker was a zombie")

703

667

self.current_checker_command)

704

668

# Start a new checker if needed

705

669

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

670

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

671

# In case checker_command has exactly one % operator

672

command = self.checker_command % self.host

673

except TypeError:

674

# Escape attributes for the shell

675

escaped_attrs = dict(

676

(attr,

677

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

678

errors=

679

'replace')))

680

for attr in

681

self.runtime_expansions)

682

683

try:

684

command = self.checker_command % escaped_attrs

685

except TypeError as error:

686

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

687

' %s', self.checker_command, error)

688

return True # Try again later

717

689

self.current_checker_command = command

718

690

try:

719

691

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

722

694

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

723

695

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

724

696

# 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

697

self.checker = subprocess.Popen(command,

734

698

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:

699

shell=True, cwd="/")

700

self.checker_callback_tag = (gobject.child_watch_add

701

(self.checker.pid,

702

self.checker_callback,

703

data=command))

704

# The checker may have completed before the gobject

705

# watch was added. Check for this.

748

706

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

707

if pid:

708

gobject.source_remove(self.checker_callback_tag)

709

self.checker_callback(pid, status, command)

749

710

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)

711

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

712

error)

759

713

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

760

714

return True

761

715

768

722

return

769

723

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

770

724

try:

771

self.checker.terminate()

725

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

772

726

#time.sleep(0.5)

773

727

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

774

# self.checker.kill()

728

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

775

729

except OSError as error:

776

730

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

777

731

raise

794

748

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

795

749

if byte_arrays and signature != "ay":

796

750

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

797

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

751

" signature %r" % signature)

798

752

def decorator(func):

799

753

func._dbus_is_property = True

800

754

func._dbus_interface = dbus_interface

808

762

return decorator

809

763

810

764

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

765

class DBusPropertyException(dbus.exceptions.DBusException):

849

766

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

850

767

"""

873

790

"""

874

791

875

792

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

793

def _is_dbus_property(obj):

794

return getattr(obj, "_dbus_is_property", False)

884

795

885

def _get_all_dbus_things(self, thing):

796

def _get_all_dbus_properties(self):

886

797

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

887

798

"""

888

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

889

name),

890

athing.__get__(self))

799

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

891

800

for cls in self.__class__.__mro__

892

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

801

for name, prop in

802

inspect.getmembers(cls, self._is_dbus_property))

895

803

896

804

def _get_dbus_property(self, interface_name, property_name):

897

805

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

899

807

"""

900

808

for cls in self.__class__.__mro__:

901

809

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

810

(cls, self._is_dbus_property)):

904

811

if (value._dbus_name == property_name

905

812

and value._dbus_interface == interface_name):

906

813

return value.__get__(self)

934

841

# The byte_arrays option is not supported yet on

935

842

# signatures other than "ay".

936

843

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

844

raise ValueError

845

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

846

for byte in value))

942

847

prop(value)

943

848

944

849

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

950

855

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

951

856

"""

952

857

properties = {}

953

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

858

for name, prop in self._get_all_dbus_properties():

954

859

if (interface_name

955

860

and interface_name != prop._dbus_interface):

956

861

# Interface non-empty but did not match

971

876

path_keyword='object_path',

972

877

connection_keyword='connection')

973

878

def Introspect(self, object_path, connection):

974

"""Overloading of standard D-Bus method.

975

976

Inserts property tags and interface annotation tags.

879

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

977

880

"""

978

881

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

979

882

connection)

986

889

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

987

890

return e

988

891

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

989

# Add property tags

990

892

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

991

893

for name, prop

992

in self._get_all_dbus_things("property")

894

in self._get_all_dbus_properties()

993

895

if prop._dbus_interface

994

896

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

995

897

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

898

# Add the names to the return values for the

1028

899

# "org.freedesktop.DBus.Properties" methods

1029

900

if (if_tag.getAttribute("name")

1044

915

except (AttributeError, xml.dom.DOMException,

1045

916

xml.parsers.expat.ExpatError) as error:

1046

917

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

1047

exc_info=error)

918

error)

1048

919

return xmlstring

1049

920

1050

921

1051

def datetime_to_dbus(dt, variant_level=0):

922

def datetime_to_dbus (dt, variant_level=0):

1052

923

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

1053

924

if dt is None:

1054

925

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

1056

927

variant_level=variant_level)

1057

928

1058

929

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

930

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

931

.__metaclass__):

932

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

933

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

1081

934

"""

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

935

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

936

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

937

# methods, signals, or properties in them

938

for base in (b for b in bases

939

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

940

# Go though all attributes of the base class

941

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

1089

942

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

1090

943

# with the wrong interface name

1091

944

if (not hasattr(attribute, "_dbus_interface")

1092

945

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

946

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

1094

947

continue

1095

948

# Create an alternate D-Bus interface name based on

1096

949

# the current name

1097

950

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1100

interface_names.add(alt_interface)

951

.replace("se.recompile.Mandos",

952

"se.bsnet.fukt.Mandos"))

1101

953

# Is this a D-Bus signal?

1102

954

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

1103

# Extract the original non-method undecorated

1104

# function by black magic

955

# Extract the original non-method function by

956

# black magic

1105

957

nonmethod_func = (dict(

1106

958

zip(attribute.func_code.co_freevars,

1107

959

attribute.__closure__))["func"]

1118

970

nonmethod_func.func_name,

1119

971

nonmethod_func.func_defaults,

1120

972

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

973

# 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

974

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

975

# signals gets sent when the function is called

1131

976

def fixscope(func1, func2):

1132

977

"""This function is a scope container to pass

1133

978

func1 and func2 to the "call_both" function

1140

985

return call_both

1141

986

# Create the "call_both" function and add it to

1142

987

# the class

1143

attr[attrname] = fixscope(attribute, new_function)

988

attr[attrname] = fixscope(attribute,

989

new_function)

1144

990

# Is this a D-Bus method?

1145

991

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

1146

992

# Create a new, but exactly alike, function

1157

1003

attribute.func_name,

1158

1004

attribute.func_defaults,

1159

1005

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

1006

# Is this a D-Bus property?

1167

1007

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

1168

1008

# Create a new, but exactly alike, function

1182

1022

attribute.func_name,

1183

1023

attribute.func_defaults,

1184

1024

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

1025

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

1026

1027

1230

1028

class ClientDBus(Client, DBusObjectWithProperties):

1231

1029

"""A Client class using D-Bus

1232

1030

1243

1041

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

1244

1042

self.bus = bus

1245

1043

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

1044

self._approvals_pending = 0

1045

1046

self._approvals_pending = 0

1246

1047

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

1247

1048

# the D-Bus

1248

1049

client_object_name = unicode(self.name).translate(

1252

1053

("/clients/" + client_object_name))

1253

1054

DBusObjectWithProperties.__init__(self, self.bus,

1254

1055

self.dbus_object_path)

1255

1056

1256

1057

def notifychangeproperty(transform_func,

1257

1058

dbus_name, type_func=lambda x: x,

1258

1059

variant_level=1):

1281

1082

1282

1083

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

1283

1084

1085

1284

1086

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1087

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1088

"ApprovalPending",

1293

1095

checker is not None)

1294

1096

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1097

"LastCheckedOK")

1296

last_checker_status = notifychangeproperty(dbus.Int16,

1297

"LastCheckerStatus")

1298

1098

last_approval_request = notifychangeproperty(

1299

1099

datetime_to_dbus, "LastApprovalRequest")

1300

1100

approved_by_default = notifychangeproperty(dbus.Boolean,

1368

1168

return False

1369

1169

1370

1170

def approve(self, value=True):

1171

self.send_changedstate()

1371

1172

self.approved = value

1372

1173

gobject.timeout_add(timedelta_to_milliseconds

1373

1174

(self.approval_duration),

1374

1175

self._reset_approved)

1375

self.send_changedstate()

1176

1376

1177

1377

1178

## D-Bus methods, signals & properties

1378

1179

_interface = "se.recompile.Mandos.Client"

1379

1180

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

1181

## Signals

1388

1182

1389

1183

# CheckerCompleted - signal

1425

1219

"D-Bus signal"

1426

1220

return self.need_approval()

1427

1221

1222

# NeRwequest - signal

1223

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

1224

def NewRequest(self, ip):

1225

"""D-Bus signal

1226

Is sent after a client request a password.

1227

"""

1228

pass

1229

1428

1230

## Methods

1429

1231

1430

1232

# Approve - method

1540

1342

return

1541

1343

return datetime_to_dbus(self.last_checked_ok)

1542

1344

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

1345

# Expires - property

1550

1346

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

1551

1347

def Expires_dbus_property(self):

1562

1358

def Timeout_dbus_property(self, value=None):

1563

1359

if value is None: # get

1564

1360

return dbus.UInt64(self.timeout_milliseconds())

1565

old_timeout = self.timeout

1566

1361

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

1362

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

1363

return

1364

# Reschedule timeout

1365

gobject.source_remove(self.disable_initiator_tag)

1366

self.disable_initiator_tag = None

1367

self.expires = None

1368

time_to_die = timedelta_to_milliseconds((self

1369

.last_checked_ok

1370

+ self.timeout)

1371

- datetime.datetime

1372

.utcnow())

1373

if time_to_die <= 0:

1374

# The timeout has passed

1375

self.disable()

1376

else:

1377

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

1378

+ datetime.timedelta(milliseconds =

1379

time_to_die))

1380

self.disable_initiator_tag = (gobject.timeout_add

1381

(time_to_die, self.disable))

1583

1382

1584

1383

# ExtendedTimeout - property

1585

1384

@dbus_service_property(_interface, signature="t",

1664

1463

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

1665

1464

1666

1465

1466

class ClientDBusTransitional(ClientDBus):

1467

__metaclass__ = AlternateDBusNamesMetaclass

1468

1469

1667

1470

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

1471

"""A class to handle client connections.

1669

1472

1705

1508

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

1706

1509

try:

1707

1510

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

1708

raise RuntimeError(line)

1511

raise RuntimeError

1709

1512

except (ValueError, IndexError, RuntimeError) as error:

1710

1513

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

1711

1514

return

1737

1540

except KeyError:

1738

1541

return

1739

1542

1543

if self.server.use_dbus:

1544

# Emit D-Bus signal

1545

client.NewRequest(str(self.client_address))

1546

1740

1547

if client.approval_delay:

1741

1548

delay = client.approval_delay

1742

1549

client.approvals_pending += 1

1773

1580

#wait until timeout or approved

1774

1581

time = datetime.datetime.now()

1775

1582

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

1583

(client.changedstate.wait

1584

(float(client.timedelta_to_milliseconds(delay)

1585

/ 1000)))

1779

1586

client.changedstate.release()

1780

1587

time2 = datetime.datetime.now()

1781

1588

if (time2 - time) >= delay:

1797

1604

try:

1798

1605

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

1799

1606

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1607

logger.warning("gnutls send failed")

1802

1608

return

1803

1609

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

1804

1610

sent, len(client.secret)

1807

1613

1808

1614

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

1809

1615

# bump the timeout using extended_timeout

1810

client.bump_timeout(client.extended_timeout)

1616

client.checked_ok(client.extended_timeout)

1811

1617

if self.server.use_dbus:

1812

1618

# Emit D-Bus signal

1813

1619

client.GotSecret()

1818

1624

try:

1819

1625

session.bye()

1820

1626

except gnutls.errors.GNUTLSError as error:

1821

logger.warning("GnuTLS bye failed",

1822

exc_info=error)

1627

logger.warning("GnuTLS bye failed")

1823

1628

1824

1629

@staticmethod

1825

1630

def peer_certificate(session):

1897

1702

def process_request(self, request, address):

1898

1703

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

1899

1704

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

1900

args = (request, address))

1705

args = (request,

1706

address))

1901

1707

proc.start()

1902

1708

return proc

1903

1709

1918

1724

1919

1725

def add_pipe(self, parent_pipe, proc):

1920

1726

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

1921

raise NotImplementedError()

1727

raise NotImplementedError

1922

1728

1923

1729

1924

1730

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1931

1737

use_ipv6: Boolean; to use IPv6 or not

1932

1738

"""

1933

1739

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

"""

1740

interface=None, use_ipv6=True):

1938

1741

self.interface = interface

1939

1742

if use_ipv6:

1940

1743

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

1744

socketserver.TCPServer.__init__(self, server_address,

1968

1745

RequestHandlerClass)

1969

1970

1746

def server_bind(self):

1971

1747

"""This overrides the normal server_bind() function

1972

1748

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

1980

1756

try:

1981

1757

self.socket.setsockopt(socket.SOL_SOCKET,

1982

1758

SO_BINDTODEVICE,

1983

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

1759

str(self.interface

1760

+ '\0'))

1984

1761

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:

1762

if error[0] == errno.EPERM:

1763

logger.error("No permission to"

1764

" bind to interface %s",

1765

self.interface)

1766

elif error[0] == errno.ENOPROTOOPT:

1989

1767

logger.error("SO_BINDTODEVICE not available;"

1990

1768

" cannot bind to interface %s",

1991

1769

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

1770

else:

1996

1771

raise

1997

1772

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

2000

1775

if self.address_family == socket.AF_INET6:

2001

1776

any_address = "::" # in6addr_any

2002

1777

else:

2003

any_address = "0.0.0.0" # INADDR_ANY

1778

any_address = socket.INADDR_ANY

2004

1779

self.server_address = (any_address,

2005

1780

self.server_address[1])

2006

1781

elif not self.server_address[1]:

2027

1802

"""

2028

1803

def __init__(self, server_address, RequestHandlerClass,

2029

1804

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

2030

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

1805

gnutls_priority=None, use_dbus=True):

2031

1806

self.enabled = False

2032

1807

self.clients = clients

2033

1808

if self.clients is None:

2037

1812

IPv6_TCPServer.__init__(self, server_address,

2038

1813

RequestHandlerClass,

2039

1814

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

1815

use_ipv6 = use_ipv6)

2042

1816

def server_activate(self):

2043

1817

if self.enabled:

2044

1818

return socketserver.TCPServer.server_activate(self)

2057

1831

2058

1832

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

2059

1833

proc = None, client_object=None):

1834

condition_names = {

1835

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

1836

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

1837

# blocking).

1838

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

1839

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

1840

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

1841

# broken, usually for pipes and

1842

# sockets).

1843

}

1844

conditions_string = ' | '.join(name

1845

for cond, name in

1846

condition_names.iteritems()

1847

if cond & condition)

2060

1848

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

2061

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

1849

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

2062

1850

# Wait for other process to exit

2063

1851

proc.join()

2064

1852

return False

2122

1910

return True

2123

1911

2124

1912

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

1913

def string_to_delta(interval):

2225

1914

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

2226

1915

2237

1926

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

2238

1927

datetime.timedelta(0, 330)

2239

1928

"""

2240

2241

try:

2242

return rfc3339_duration_to_delta(interval)

2243

except ValueError:

2244

pass

2245

2246

1929

timevalue = datetime.timedelta(0)

2247

1930

for s in interval.split():

2248

1931

try:

2259

1942

elif suffix == "w":

2260

1943

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

2261

1944

else:

2262

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

2263

.format(suffix))

2264

except IndexError as e:

1945

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

1946

except (ValueError, IndexError) as e:

2265

1947

raise ValueError(*(e.args))

2266

1948

timevalue += delta

2267

1949

return timevalue

2280

1962

sys.exit()

2281

1963

if not noclose:

2282

1964

# Close all standard open file descriptors

2283

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

1965

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

2284

1966

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

2285

1967

raise OSError(errno.ENODEV,

2286

"{0} not a character device"

2287

.format(os.devnull))

1968

"%s not a character device"

1969

% os.path.devnull)

2288

1970

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

2289

1971

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

2290

1972

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

2299

1981

2300

1982

parser = argparse.ArgumentParser()

2301

1983

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

2302

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

1984

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

2303

1985

help="show version number and exit")

2304

1986

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

2305

1987

help="Bind to interface IF")

2311

1993

help="Run self-test")

2312

1994

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

2313

1995

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

2314

" to terminal", default=None)

1996

" to terminal")

2315

1997

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

2316

1998

help="Debug level for stdout output")

2317

1999

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

2324

2006

" files")

2325

2007

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

2326

2008

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

2327

" system bus interface", default=None)

2009

" system bus interface")

2328

2010

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

2329

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

2330

default=None)

2011

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

2331

2012

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

2332

2013

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

2014

" state")

2337

2015

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

2338

2016

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

2339

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

2340

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

2341

2017

2342

2018

options = parser.parse_args()

2343

2019

2344

2020

if options.check:

2345

2021

import doctest

2346

fail_count, test_count = doctest.testmod()

2347

sys.exit(os.EX_OK if fail_count == 0 else 1)

2022

doctest.testmod()

2023

sys.exit()

2348

2024

2349

2025

# Default values for config file for server-global settings

2350

2026

server_defaults = { "interface": "",

2352

2028

"port": "",

2353

2029

"debug": "False",

2354

2030

"priority":

2355

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

2031

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

2356

2032

"servicename": "Mandos",

2357

2033

"use_dbus": "True",

2358

2034

"use_ipv6": "True",

2359

2035

"debuglevel": "",

2360

2036

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2037

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

2364

2038

}

2365

2039

2366

2040

# Parse config file for server-global settings

2371

2045

# Convert the SafeConfigParser object to a dict

2372

2046

server_settings = server_config.defaults()

2373

2047

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

2374

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

2048

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

2375

2049

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

2376

2050

option)

2377

2051

if server_settings["port"]:

2378

2052

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

2379

2053

"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

2054

del server_config

2390

2055

2391

2056

# Override the settings from the config file with command line

2393

2058

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

2394

2059

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

2395

2060

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

2396

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

2061

"statedir"):

2397

2062

value = getattr(options, option)

2398

2063

if value is not None:

2399

2064

server_settings[option] = value

2402

2067

for option in server_settings.keys():

2403

2068

if type(server_settings[option]) is str:

2404

2069

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

2070

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

2413

2071

2414

2072

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

2420

2078

use_ipv6 = server_settings["use_ipv6"]

2421

2079

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

2422

2080

stored_state_file)

2423

foreground = server_settings["foreground"]

2424

2081

2425

2082

if debug:

2426

2083

initlogger(debug, logging.DEBUG)

2433

2090

2434

2091

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

2435

2092

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2093

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

2094

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

2095

% server_settings["servicename"]))

2440

2096

2441

2097

# Parse config file with clients

2442

client_config = configparser.SafeConfigParser(Client

2443

.client_defaults)

2098

client_config = configparser.SafeConfigParser(Client.client_defaults)

2444

2099

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

2445

2100

"clients.conf"))

2446

2101

2455

2110

use_ipv6=use_ipv6,

2456

2111

gnutls_priority=

2457

2112

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

2113

use_dbus=use_dbus)

2114

if not debug:

2115

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

2466

2116

try:

2467

2117

pidfile = open(pidfilename, "w")

2468

except IOError as e:

2469

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

2470

exc_info=e)

2118

except IOError:

2119

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

2471

2120

2472

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

2121

try:

2122

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

2123

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

2124

except KeyError:

2473

2125

try:

2474

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

2476

break

2126

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

2127

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

2477

2128

except KeyError:

2478

continue

2479

else:

2480

uid = 65534

2481

gid = 65534

2129

try:

2130

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

2131

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

2132

except KeyError:

2133

uid = 65534

2134

gid = 65534

2482

2135

try:

2483

2136

os.setgid(gid)

2484

2137

os.setuid(uid)

2485

2138

except OSError as error:

2486

if error.errno != errno.EPERM:

2487

raise

2139

if error[0] != errno.EPERM:

2140

raise error

2488

2141

2489

2142

if debug:

2490

2143

# Enable all possible GnuTLS debugging

2501

2154

.gnutls_global_set_log_function(debug_gnutls))

2502

2155

2503

2156

# Redirect stdin so all checkers get /dev/null

2504

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

2157

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

2505

2158

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

2506

2159

if null > 2:

2507

2160

os.close(null)

2508

2161

2509

2162

# Need to fork before connecting to D-Bus

2510

if not foreground:

2163

if not debug:

2511

2164

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

2512

2165

daemon()

2513

2166

2514

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

2515

# need to inform gobject that threads will be used.

2516

2167

gobject.threads_init()

2517

2168

2518

2169

global main_loop

2519

2170

# From the Avahi example code

2520

DBusGMainLoop(set_as_default=True)

2171

DBusGMainLoop(set_as_default=True )

2521

2172

main_loop = gobject.MainLoop()

2522

2173

bus = dbus.SystemBus()

2523

2174

# End of Avahi example code

2529

2180

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

2530

2181

do_not_queue=True))

2531

2182

except dbus.exceptions.NameExistsException as e:

2532

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

2183

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

2533

2184

use_dbus = False

2534

2185

server_settings["use_dbus"] = False

2535

2186

tcp_server.use_dbus = False

2547

2198

2548

2199

client_class = Client

2549

2200

if use_dbus:

2550

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

2201

client_class = functools.partial(ClientDBusTransitional,

2202

bus = bus)

2551

2203

2552

2204

client_settings = Client.config_parser(client_config)

2553

2205

old_client_settings = {}

2554

2206

clients_data = {}

2555

2207

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

2208

# Get client data and settings from last running state.

2565

2209

if server_settings["restore"]:

2566

2210

try:

2569

2213

(stored_state))

2570

2214

os.remove(stored_state_path)

2571

2215

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)

2216

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

2217

.format(e))

2218

if e.errno != errno.ENOENT:

2578

2219

raise

2579

2220

except EOFError as e:

2580

2221

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

2581

"EOFError:", exc_info=e)

2222

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

2582

2223

2583

2224

with PGPEngine() as pgp:

2584

2225

for client_name, client in clients_data.iteritems():

2585

# Skip removed clients

2586

if client_name not in client_settings:

2587

continue

2588

2589

2226

# Decide which value to use after restoring saved state.

2590

2227

# We have three different values: Old config file,

2591

2228

# new config file, and saved state.

2605

2242

2606

2243

# Clients who has passed its expire date can still be

2607

2244

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

2245

# whose checker failed before we stored its state is

2246

# assumed to have failed all checkers during downtime.

2611

2247

if client["enabled"]:

2612

2248

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

2613

2249

if not client["last_checked_ok"]:

2614

2250

logger.warning(

2615

2251

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

2252

"performed a successfull checker"

2253

.format(client["name"]))

2618

2254

client["enabled"] = False

2619

2255

elif client["last_checker_status"] != 0:

2620

2256

logger.warning(

2621

2257

"disabling client {0} - Client "

2622

2258

"last checker failed with error code {1}"

2623

.format(client_name,

2259

.format(client["name"],

2624

2260

client["last_checker_status"]))

2625

2261

client["enabled"] = False

2626

2262

else:

2627

2263

client["expires"] = (datetime.datetime

2628

2264

.utcnow()

2629

2265

+ client["timeout"])

2630

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

2266

2633

2267

try:

2634

2268

client["secret"] = (

2635

2269

pgp.decrypt(client["encrypted_secret"],

2641

2275

.format(client_name))

2642

2276

client["secret"] = (

2643

2277

client_settings[client_name]["secret"])

2278

2644

2279

2645

2280

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

2646

for client_name in (set(old_client_settings)

2647

- set(client_settings)):

2281

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

2648

2282

del clients_data[client_name]

2649

for client_name in (set(client_settings)

2650

- set(old_client_settings)):

2283

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

2651

2284

clients_data[client_name] = client_settings[client_name]

2652

2653

# Create all client objects

2285

2286

# Create clients all clients

2654

2287

for client_name, client in clients_data.iteritems():

2655

2288

tcp_server.clients[client_name] = client_class(

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2289

name = client_name, settings = client)

2658

2290

2659

2291

if not tcp_server.clients:

2660

2292

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

2293

2294

if not debug:

2295

try:

2296

with pidfile:

2297

pid = os.getpid()

2298

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

2299

del pidfile

2300

except IOError:

2301

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

2302

pidfilename, pid)

2303

except NameError:

2304

# "pidfile" was never created

2305

pass

2672

2306

del pidfilename

2307

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

2673

2308

2674

2309

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

2675

2310

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

2676

2311

2677

2312

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

2313

class MandosDBusService(dbus.service.Object):

2681

2314

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

2682

2315

def __init__(self):

2683

2316

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

2684

2317

_interface = "se.recompile.Mandos"

2685

2318

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

2692

2319

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

2693

2320

def ClientAdded(self, objpath):

2694

2321

"D-Bus signal"

2736

2363

2737

2364

del _interface

2738

2365

2739

mandos_dbus_service = MandosDBusService()

2366

class MandosDBusServiceTransitional(MandosDBusService):

2367

__metaclass__ = AlternateDBusNamesMetaclass

2368

mandos_dbus_service = MandosDBusServiceTransitional()

2740

2369

2741

2370

def cleanup():

2742

2371

"Cleanup function; run on exit"

2743

2372

service.cleanup()

2744

2373

2745

2374

multiprocessing.active_children()

2746

wnull.close()

2747

2375

if not (tcp_server.clients or client_settings):

2748

2376

return

2749

2377

2761

2389

# A list of attributes that can not be pickled

2762

2390

# + secret.

2763

2391

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

2764

"checker", "server_settings"))

2392

"checker"))

2765

2393

for name, typ in (inspect.getmembers

2766

2394

(dbus.service.Object)):

2767

2395

exclude.add(name)

2776

2404

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

2777

2405

2778

2406

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:

2407

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

2408

prefix="clients-",

2409

dir=os.path.dirname

2410

(stored_state_path))

2411

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

2783

2412

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

2784

tempname=stored_state.name

2785

2413

os.rename(tempname, stored_state_path)

2786

2414

except (IOError, OSError) as e:

2415

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

2416

.format(e))

2787

2417

if not debug:

2788

2418

try:

2789

2419

os.remove(tempname)

2790

2420

except NameError:

2791

2421

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

2422

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

2423

errno.EEXIST)):

2424

raise e

2799

2425

2800

2426

# Delete all clients, and settings from config

2801

2427

while tcp_server.clients:

2828

2454

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

2829

2455

if use_ipv6:

2830

2456

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

2831

" flowinfo %d, scope_id %d",

2832

*tcp_server.socket.getsockname())

2457

" flowinfo %d, scope_id %d"

2458

% tcp_server.socket.getsockname())

2833

2459

else: # IPv4

2834

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

2835

*tcp_server.socket.getsockname())

2460

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

2461

% tcp_server.socket.getsockname())

2836

2462

2837

2463

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

2838

2464

2841

2467

try:

2842

2468

service.activate()

2843

2469

except dbus.exceptions.DBusException as error:

2844

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

2470

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

2845

2471

cleanup()

2846

2472

sys.exit(1)

2847

2473

# End of Avahi example code

2854

2480

logger.debug("Starting main loop")

2855

2481

main_loop.run()

2856

2482

except AvahiError as error:

2857

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

2483

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

2858

2484

cleanup()

2859

2485

sys.exit(1)

2860

2486

except KeyboardInterrupt: