/mandos/release : revision 237.7.174

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

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

110

113

return interface_index

111

114

112

115

113

def initlogger(level=logging.WARNING):

116

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

114

117

"""init logger and add loglevel"""

115

118

116

119

syslogger.setFormatter(logging.Formatter

118

121

' %(message)s'))

119

122

logger.addHandler(syslogger)

120

123

121

console = logging.StreamHandler()

122

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

123

' [%(process)d]:'

124

' %(levelname)s:'

125

' %(message)s'))

126

logger.addHandler(console)

124

if debug:

125

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

127

131

logger.setLevel(level)

128

132

129

133

135

139

class PGPEngine(object):

136

140

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

137

141

def __init__(self):

138

self.gnupg = GnuPGInterface.GnuPG()

139

142

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

140

self.gnupg = GnuPGInterface.GnuPG()

141

self.gnupg.options.meta_interactive = False

142

self.gnupg.options.homedir = self.tempdir

143

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

144

'--quiet'])

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

145

148

146

149

def __enter__(self):

147

150

return self

148

151

149

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

152

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

150

153

self._cleanup()

151

154

return False

152

155

172

175

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

173

176

174

177

def encrypt(self, data, password):

175

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

176

with open(os.devnull) as devnull:

177

try:

178

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

179

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

180

attach_fhs={'stderr': devnull})

181

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

182

f.write(data)

183

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

184

ciphertext = f.read()

185

proc.wait()

186

except IOError as e:

187

raise PGPError(e)

188

self.gnupg.passphrase = None

178

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

181

passfile.write(passphrase)

182

passfile.flush()

183

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

184

'--passphrase-file',

185

passfile.name]

186

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

191

if proc.returncode != 0:

192

raise PGPError(err)

189

193

return ciphertext

190

194

191

195

def decrypt(self, data, password):

192

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

193

with open(os.devnull) as devnull:

194

try:

195

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

196

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

197

attach_fhs={'stderr': devnull})

198

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

199

f.write(data)

200

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

201

decrypted_plaintext = f.read()

202

proc.wait()

203

except IOError as e:

204

raise PGPError(e)

205

self.gnupg.passphrase = None

196

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

199

passfile.write(passphrase)

200

passfile.flush()

201

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

202

'--passphrase-file',

203

passfile.name]

204

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

210

if proc.returncode != 0:

211

raise PGPError(err)

206

212

return decrypted_plaintext

207

213

208

214

209

210

215

class AvahiError(Exception):

211

216

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

212

217

self.value = value

229

234

Used to optionally bind to the specified interface.

230

235

name: string; Example: 'Mandos'

231

236

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

232

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

237

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

233

238

port: integer; what port to announce

234

239

TXT: list of strings; TXT record for the service

235

240

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

241

246

server: D-Bus Server

242

247

bus: dbus.SystemBus()

243

248

"""

249

244

250

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

245

251

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

246

252

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

259

265

self.server = None

260

266

self.bus = bus

261

267

self.entry_group_state_changed_match = None

268

262

269

def rename(self):

263

270

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

264

271

if self.rename_count >= self.max_renames:

274

281

try:

275

282

self.add()

276

283

except dbus.exceptions.DBusException as error:

277

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

284

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

278

285

self.cleanup()

279

286

os._exit(1)

280

287

self.rename_count += 1

288

281

289

def remove(self):

282

290

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

283

291

if self.entry_group_state_changed_match is not None:

285

293

self.entry_group_state_changed_match = None

286

294

if self.group is not None:

287

295

self.group.Reset()

296

288

297

def add(self):

289

298

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

290

299

self.remove()

307

316

dbus.UInt16(self.port),

308

317

avahi.string_array_to_txt_array(self.TXT))

309

318

self.group.Commit()

319

310

320

def entry_group_state_changed(self, state, error):

311

321

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

312

322

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

319

329

elif state == avahi.ENTRY_GROUP_FAILURE:

320

330

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

321

331

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

332

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

333

.format(error))

334

324

335

def cleanup(self):

325

336

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

326

337

if self.group is not None:

331

342

pass

332

343

self.group = None

333

344

self.remove()

345

334

346

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

335

347

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

336

348

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

355

367

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

356

368

else:

357

369

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

370

358

371

def activate(self):

359

372

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

360

373

if self.server is None:

367

380

self.server_state_changed)

368

381

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

369

382

383

370

384

class AvahiServiceToSyslog(AvahiService):

371

385

def rename(self):

372

386

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

373

387

ret = AvahiService.rename(self)

374

388

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

389

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

390

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

391

.format(self.name)))

378

392

return ret

379

393

394

380

395

def timedelta_to_milliseconds(td):

381

396

"Convert a datetime.timedelta() to milliseconds"

382

397

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

383

398

+ (td.seconds * 1000)

384

399

+ (td.microseconds // 1000))

385

400

401

386

402

class Client(object):

387

403

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

388

404

413

429

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

414

430

last_checker_status: integer between 0 and 255 reflecting exit

415

431

status of last checker. -1 reflects crashed

416

checker, or None.

432

checker, -2 means no checker completed yet.

417

433

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

418

434

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

419

435

D-Bus identifiers

420

436

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

421

437

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

422

438

until this client is disabled

423

extended_timeout: extra long timeout when password has been sent

439

extended_timeout: extra long timeout when secret has been sent

424

440

runtime_expansions: Allowed attributes for runtime expansion.

425

441

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

426

442

disabled, or None

443

server_settings: The server_settings dict from main()

427

444

"""

428

445

429

446

runtime_expansions = ("approval_delay", "approval_duration",

430

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

431

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

447

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

448

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

449

"last_approval_request", "last_checked_ok",

432

450

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

433

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

434

"extended_timeout": "15m",

435

"interval": "2m",

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

436

454

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

437

455

"host": "",

438

"approval_delay": "0s",

439

"approval_duration": "1s",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

440

458

"approved_by_default": "True",

441

459

"enabled": "True",

442

460

}

455

473

456

474

def approval_delay_milliseconds(self):

457

475

return timedelta_to_milliseconds(self.approval_delay)

458

476

459

477

@staticmethod

460

478

def config_parser(config):

461

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

479

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

462

480

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

463

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

481

with exceptions for any special settings as defined above.

482

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

483

value given the same arguments.

484

"""

464

485

settings = {}

465

486

for client_name in config.sections():

466

487

section = dict(config.items(client_name))

470

491

# Reformat values from string types to Python types

471

492

client["approved_by_default"] = config.getboolean(

472

493

client_name, "approved_by_default")

473

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

494

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

495

"enabled")

474

496

475

497

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

476

498

.replace(" ", ""))

482

504

"rb") as secfile:

483

505

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

484

506

else:

485

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

486

% section)

507

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

508

.format(section))

487

509

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

488

510

client["extended_timeout"] = string_to_delta(

489

511

section["extended_timeout"])

495

517

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

496

518

client["last_approval_request"] = None

497

519

client["last_checked_ok"] = None

498

client["last_checker_status"] = None

499

if client["enabled"]:

500

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

501

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

502

+ client["timeout"])

503

else:

504

client["last_enabled"] = None

505

client["expires"] = None

506

520

client["last_checker_status"] = -2

521

507

522

return settings

508

509

510

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

511

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

512

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

513

attribute."""

523

524

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

514

525

self.name = name

526

if server_settings is None:

527

server_settings = {}

528

self.server_settings = server_settings

515

529

# adding all client settings

516

530

for setting, value in settings.iteritems():

517

531

setattr(self, setting, value)

518

532

533

if self.enabled:

534

if not hasattr(self, "last_enabled"):

535

self.last_enabled = datetime.datetime.utcnow()

536

if not hasattr(self, "expires"):

537

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

538

+ self.timeout)

539

else:

540

self.last_enabled = None

541

self.expires = None

542

519

543

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

520

544

# Uppercase and remove spaces from fingerprint for later

521

545

# comparison purposes with return value from the fingerprint()

522

546

# function

523

547

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

524

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

525

548

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

549

datetime.datetime.utcnow())

550

526

551

# attributes specific for this server instance

527

552

self.checker = None

528

553

self.checker_initiator_tag = None

556

581

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

557

582

# Already enabled

558

583

return

559

self.send_changedstate()

560

584

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

561

585

self.enabled = True

562

586

self.last_enabled = datetime.datetime.utcnow()

563

587

self.init_checker()

588

self.send_changedstate()

564

589

565

590

def disable(self, quiet=True):

566

591

"""Disable this client."""

567

592

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

568

593

return False

569

594

if not quiet:

570

self.send_changedstate()

571

if not quiet:

572

595

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

573

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

596

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

574

597

gobject.source_remove(self.disable_initiator_tag)

575

598

self.disable_initiator_tag = None

576

599

self.expires = None

577

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

600

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

578

601

gobject.source_remove(self.checker_initiator_tag)

579

602

self.checker_initiator_tag = None

580

603

self.stop_checker()

581

604

self.enabled = False

605

if not quiet:

606

self.send_changedstate()

582

607

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

583

608

return False

584

609

588

613

def init_checker(self):

589

614

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

590

615

# and every interval from then on.

616

if self.checker_initiator_tag is not None:

617

gobject.source_remove(self.checker_initiator_tag)

591

618

self.checker_initiator_tag = (gobject.timeout_add

592

619

(self.interval_milliseconds(),

593

620

self.start_checker))

594

621

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

622

if self.disable_initiator_tag is not None:

623

gobject.source_remove(self.disable_initiator_tag)

595

624

self.disable_initiator_tag = (gobject.timeout_add

596

625

(self.timeout_milliseconds(),

597

626

self.disable))

616

645

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

617

646

vars(self))

618

647

619

def checked_ok(self, timeout=None):

620

"""Bump up the timeout for this client.

621

622

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

623

alive and well.

624

"""

648

def checked_ok(self):

649

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

650

self.last_checked_ok = datetime.datetime.utcnow()

651

self.last_checker_status = 0

652

self.bump_timeout()

653

654

def bump_timeout(self, timeout=None):

655

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

625

656

if timeout is None:

626

657

timeout = self.timeout

627

self.last_checked_ok = datetime.datetime.utcnow()

628

658

if self.disable_initiator_tag is not None:

629

659

gobject.source_remove(self.disable_initiator_tag)

660

self.disable_initiator_tag = None

630

661

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

631

662

self.disable_initiator_tag = (gobject.timeout_add

632

663

(timedelta_to_milliseconds

642

673

If a checker already exists, leave it running and do

643

674

nothing."""

644

675

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

645

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

646

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

647

# client would inevitably timeout, since no checker would get

648

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

676

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

677

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

678

# would inevitably timeout, since no checker would get a

679

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

649

680

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

650

681

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

651

682

# should be.

665

696

self.current_checker_command)

666

697

# Start a new checker if needed

667

698

if self.checker is None:

699

# Escape attributes for the shell

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

668

704

try:

669

# In case checker_command has exactly one % operator

670

command = self.checker_command % self.host

671

except TypeError:

672

# Escape attributes for the shell

673

escaped_attrs = dict(

674

(attr,

675

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

676

errors=

677

'replace')))

678

for attr in

679

self.runtime_expansions)

680

681

try:

682

command = self.checker_command % escaped_attrs

683

except TypeError as error:

684

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

685

' %s', self.checker_command, error)

686

return True # Try again later

705

command = self.checker_command % escaped_attrs

706

except TypeError as error:

707

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

687

710

self.current_checker_command = command

688

711

try:

689

712

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

692

715

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

693

716

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

694

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

695

726

self.checker = subprocess.Popen(command,

696

727

close_fds=True,

697

shell=True, cwd="/")

698

self.checker_callback_tag = (gobject.child_watch_add

699

(self.checker.pid,

700

self.checker_callback,

701

data=command))

702

# The checker may have completed before the gobject

703

# watch was added. Check for this.

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

704

741

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

705

if pid:

706

gobject.source_remove(self.checker_callback_tag)

707

self.checker_callback(pid, status, command)

708

742

except OSError as error:

709

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

710

error)

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

711

752

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

712

753

return True

713

754

720

761

return

721

762

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

722

763

try:

723

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

764

self.checker.terminate()

724

765

#time.sleep(0.5)

725

766

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

726

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

767

# self.checker.kill()

727

768

except OSError as error:

728

769

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

729

770

raise

746

787

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

747

788

if byte_arrays and signature != "ay":

748

789

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

749

" signature %r" % signature)

790

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

750

791

def decorator(func):

751

792

func._dbus_is_property = True

752

793

func._dbus_interface = dbus_interface

760

801

return decorator

761

802

762

803

804

def dbus_interface_annotations(dbus_interface):

805

"""Decorator for marking functions returning interface annotations

806

807

Usage:

808

809

@dbus_interface_annotations("org.example.Interface")

810

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

811

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

812

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

813

"false"}

814

"""

815

def decorator(func):

816

func._dbus_is_interface = True

817

func._dbus_interface = dbus_interface

818

func._dbus_name = dbus_interface

819

return func

820

return decorator

821

822

823

def dbus_annotations(annotations):

824

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

825

Usage:

826

827

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

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

def Property_dbus_property(self):

833

return dbus.Boolean(False)

834

"""

835

def decorator(func):

836

func._dbus_annotations = annotations

837

return func

838

return decorator

839

840

763

841

class DBusPropertyException(dbus.exceptions.DBusException):

764

842

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

765

843

"""

788

866

"""

789

867

790

868

@staticmethod

791

def _is_dbus_property(obj):

792

return getattr(obj, "_dbus_is_property", False)

869

def _is_dbus_thing(thing):

870

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

871

872

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

873

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

874

"""

875

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

876

False)

793

877

794

def _get_all_dbus_properties(self):

878

def _get_all_dbus_things(self, thing):

795

879

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

796

880

"""

797

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

881

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

882

name),

883

athing.__get__(self))

798

884

for cls in self.__class__.__mro__

799

for name, prop in

800

inspect.getmembers(cls, self._is_dbus_property))

885

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

801

888

802

889

def _get_dbus_property(self, interface_name, property_name):

803

890

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

805

892

"""

806

893

for cls in self.__class__.__mro__:

807

894

for name, value in (inspect.getmembers

808

(cls, self._is_dbus_property)):

895

(cls,

896

self._is_dbus_thing("property"))):

809

897

if (value._dbus_name == property_name

810

898

and value._dbus_interface == interface_name):

811

899

return value.__get__(self)

840

928

# signatures other than "ay".

841

929

if prop._dbus_signature != "ay":

842

930

raise ValueError

843

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

844

for byte in value))

931

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

932

for byte in value))

845

933

prop(value)

846

934

847

935

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

853

941

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

854

942

"""

855

943

properties = {}

856

for name, prop in self._get_all_dbus_properties():

944

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

857

945

if (interface_name

858

946

and interface_name != prop._dbus_interface):

859

947

# Interface non-empty but did not match

874

962

path_keyword='object_path',

875

963

connection_keyword='connection')

876

964

def Introspect(self, object_path, connection):

877

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

965

"""Overloading of standard D-Bus method.

966

967

Inserts property tags and interface annotation tags.

878

968

"""

879

969

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

880

970

connection)

887

977

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

888

978

return e

889

979

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

980

# Add property tags

890

981

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

891

982

for name, prop

892

in self._get_all_dbus_properties()

983

in self._get_all_dbus_things("property")

893

984

if prop._dbus_interface

894

985

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

895

986

if_tag.appendChild(tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

896

1018

# Add the names to the return values for the

897

1019

# "org.freedesktop.DBus.Properties" methods

898

1020

if (if_tag.getAttribute("name")

913

1035

except (AttributeError, xml.dom.DOMException,

914

1036

xml.parsers.expat.ExpatError) as error:

915

1037

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

916

error)

1038

exc_info=error)

917

1039

return xmlstring

918

1040

919

1041

920

def datetime_to_dbus (dt, variant_level=0):

1042

def datetime_to_dbus(dt, variant_level=0):

921

1043

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

922

1044

if dt is None:

923

1045

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

925

1047

variant_level=variant_level)

926

1048

927

1049

928

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

929

.__metaclass__):

930

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

931

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

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1051

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

1052

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

1053

interface names according to the "alt_interface_names" mapping.

1054

Usage:

1055

1056

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

1057

"net.example.AlternateInterface"})

1058

class SampleDBusObject(dbus.service.Object):

1059

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

1060

def SampleDBusMethod():

1061

pass

1062

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

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

1065

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

1066

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

1067

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

1068

1069

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

1070

(from DBusObjectWithProperties) and interfaces (from the

1071

dbus_interface_annotations decorator).

932

1072

"""

933

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

934

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

935

# methods, signals, or properties in them

936

for base in (b for b in bases

937

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

938

# Go though all attributes of the base class

939

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

1073

def wrapper(cls):

1074

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1076

attr = {}

1077

interface_names = set()

1078

# Go though all attributes of the class

1079

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

940

1080

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

941

1081

# with the wrong interface name

942

1082

if (not hasattr(attribute, "_dbus_interface")

943

1083

or not attribute._dbus_interface

944

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

1084

.startswith(orig_interface_name)):

945

1085

continue

946

1086

# Create an alternate D-Bus interface name based on

947

1087

# the current name

948

1088

alt_interface = (attribute._dbus_interface

949

.replace("se.recompile.Mandos",

950

"se.bsnet.fukt.Mandos"))

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1091

interface_names.add(alt_interface)

951

1092

# Is this a D-Bus signal?

952

1093

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

953

# Extract the original non-method function by

954

# black magic

1094

# Extract the original non-method undecorated

1095

# function by black magic

955

1096

nonmethod_func = (dict(

956

1097

zip(attribute.func_code.co_freevars,

957

1098

attribute.__closure__))["func"]

968

1109

nonmethod_func.func_name,

969

1110

nonmethod_func.func_defaults,

970

1111

nonmethod_func.func_closure)))

1112

# Copy annotations, if any

1113

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1116

except AttributeError:

1117

pass

971

1118

# Define a creator of a function to call both the

972

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

973

# signals gets sent when the function is called

1119

# original and alternate functions, so both the

1120

# original and alternate signals gets sent when

1121

# the function is called

974

1122

def fixscope(func1, func2):

975

1123

"""This function is a scope container to pass

976

1124

func1 and func2 to the "call_both" function

983

1131

return call_both

984

1132

# Create the "call_both" function and add it to

985

1133

# the class

986

attr[attrname] = fixscope(attribute,

987

new_function)

1134

attr[attrname] = fixscope(attribute, new_function)

988

1135

# Is this a D-Bus method?

989

1136

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

990

1137

# Create a new, but exactly alike, function

1001

1148

attribute.func_name,

1002

1149

attribute.func_defaults,

1003

1150

attribute.func_closure)))

1151

# Copy annotations, if any

1152

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1155

except AttributeError:

1156

pass

1004

1157

# Is this a D-Bus property?

1005

1158

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

1006

1159

# Create a new, but exactly alike, function

1020

1173

attribute.func_name,

1021

1174

attribute.func_defaults,

1022

1175

attribute.func_closure)))

1023

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

1024

1025

1176

# Copy annotations, if any

1177

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1180

except AttributeError:

1181

pass

1182

# Is this a D-Bus interface?

1183

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

1184

# Create a new, but exactly alike, function

1185

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

1186

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

1187

# to the class.

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1196

if deprecate:

1197

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1199

for interface_name in interface_names:

1200

@dbus_interface_annotations(interface_name)

1201

def func(self):

1202

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

1203

"true" }

1204

# Find an unused name

1205

for aname in (iname.format(i)

1206

for i in itertools.count()):

1207

if aname not in attr:

1208

attr[aname] = func

1209

break

1210

if interface_names:

1211

# Replace the class with a new subclass of it with

1212

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1215

return cls

1216

return wrapper

1217

1218

1219

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

1220

"se.bsnet.fukt.Mandos"})

1026

1221

class ClientDBus(Client, DBusObjectWithProperties):

1027

1222

"""A Client class using D-Bus

1028

1223

1039

1234

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

1040

1235

self.bus = bus

1041

1236

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

1042

self._approvals_pending = 0

1043

1044

self._approvals_pending = 0

1045

1237

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

1046

1238

# the D-Bus

1047

1239

client_object_name = unicode(self.name).translate(

1051

1243

("/clients/" + client_object_name))

1052

1244

DBusObjectWithProperties.__init__(self, self.bus,

1053

1245

self.dbus_object_path)

1054

1246

1055

1247

def notifychangeproperty(transform_func,

1056

1248

dbus_name, type_func=lambda x: x,

1057

1249

variant_level=1):

1080

1272

1081

1273

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

1082

1274

1083

1084

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1085

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1086

1277

"ApprovalPending",

1093

1284

checker is not None)

1094

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1095

1286

"LastCheckedOK")

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1288

"LastCheckerStatus")

1096

1289

last_approval_request = notifychangeproperty(

1097

1290

datetime_to_dbus, "LastApprovalRequest")

1098

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1166

1359

return False

1167

1360

1168

1361

def approve(self, value=True):

1169

self.send_changedstate()

1170

1362

self.approved = value

1171

1363

gobject.timeout_add(timedelta_to_milliseconds

1172

1364

(self.approval_duration),

1173

1365

self._reset_approved)

1174

1366

self.send_changedstate()

1175

1367

1176

1368

## D-Bus methods, signals & properties

1177

1369

_interface = "se.recompile.Mandos.Client"

1178

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1179

1378

## Signals

1180

1379

1181

1380

# CheckerCompleted - signal

1217

1416

"D-Bus signal"

1218

1417

return self.need_approval()

1219

1418

1220

# NeRwequest - signal

1221

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

1222

def NewRequest(self, ip):

1223

"""D-Bus signal

1224

Is sent after a client request a password.

1225

"""

1226

pass

1227

1228

1419

## Methods

1229

1420

1230

1421

# Approve - method

1340

1531

return

1341

1532

return datetime_to_dbus(self.last_checked_ok)

1342

1533

1534

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

1537

def LastCheckerStatus_dbus_property(self):

1538

return dbus.Int16(self.last_checker_status)

1539

1343

1540

# Expires - property

1344

1541

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

1345

1542

def Expires_dbus_property(self):

1356

1553

def Timeout_dbus_property(self, value=None):

1357

1554

if value is None: # get

1358

1555

return dbus.UInt64(self.timeout_milliseconds())

1556

old_timeout = self.timeout

1359

1557

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

1360

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

1361

return

1362

# Reschedule timeout

1363

gobject.source_remove(self.disable_initiator_tag)

1364

self.disable_initiator_tag = None

1365

self.expires = None

1366

time_to_die = timedelta_to_milliseconds((self

1367

.last_checked_ok

1368

+ self.timeout)

1369

- datetime.datetime

1370

.utcnow())

1371

if time_to_die <= 0:

1372

# The timeout has passed

1373

self.disable()

1374

else:

1375

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

1376

+ datetime.timedelta(milliseconds =

1377

time_to_die))

1378

self.disable_initiator_tag = (gobject.timeout_add

1379

(time_to_die, self.disable))

1558

# Reschedule disabling

1559

if self.enabled:

1560

now = datetime.datetime.utcnow()

1561

self.expires += self.timeout - old_timeout

1562

if self.expires <= now:

1563

# The timeout has passed

1564

self.disable()

1565

else:

1566

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

1567

is None):

1568

return

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1380

1574

1381

1575

# ExtendedTimeout - property

1382

1576

@dbus_service_property(_interface, signature="t",

1461

1655

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

1462

1656

1463

1657

1464

class ClientDBusTransitional(ClientDBus):

1465

__metaclass__ = AlternateDBusNamesMetaclass

1466

1467

1468

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

1469

1659

"""A class to handle client connections.

1470

1660

1538

1728

except KeyError:

1539

1729

return

1540

1730

1541

if self.server.use_dbus:

1542

# Emit D-Bus signal

1543

client.NewRequest(str(self.client_address))

1544

1545

1731

if client.approval_delay:

1546

1732

delay = client.approval_delay

1547

1733

client.approvals_pending += 1

1578

1764

#wait until timeout or approved

1579

1765

time = datetime.datetime.now()

1580

1766

client.changedstate.acquire()

1581

(client.changedstate.wait

1582

(float(client.timedelta_to_milliseconds(delay)

1583

/ 1000)))

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

1584

1770

client.changedstate.release()

1585

1771

time2 = datetime.datetime.now()

1586

1772

if (time2 - time) >= delay:

1602

1788

try:

1603

1789

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

1604

1790

except gnutls.errors.GNUTLSError as error:

1605

logger.warning("gnutls send failed")

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1606

1793

return

1607

1794

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

1608

1795

sent, len(client.secret)

1611

1798

1612

1799

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

1613

1800

# bump the timeout using extended_timeout

1614

client.checked_ok(client.extended_timeout)

1801

client.bump_timeout(client.extended_timeout)

1615

1802

if self.server.use_dbus:

1616

1803

# Emit D-Bus signal

1617

1804

client.GotSecret()

1622

1809

try:

1623

1810

session.bye()

1624

1811

except gnutls.errors.GNUTLSError as error:

1625

logger.warning("GnuTLS bye failed")

1812

logger.warning("GnuTLS bye failed",

1813

exc_info=error)

1626

1814

1627

1815

@staticmethod

1628

1816

def peer_certificate(session):

1700

1888

def process_request(self, request, address):

1701

1889

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

1702

1890

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

1703

args = (request,

1704

address))

1891

args = (request, address))

1705

1892

proc.start()

1706

1893

return proc

1707

1894

1735

1922

use_ipv6: Boolean; to use IPv6 or not

1736

1923

"""

1737

1924

def __init__(self, server_address, RequestHandlerClass,

1738

interface=None, use_ipv6=True):

1925

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

1926

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

1927

creating a new one with socket.socket().

1928

"""

1739

1929

self.interface = interface

1740

1930

if use_ipv6:

1741

1931

self.address_family = socket.AF_INET6

1932

if socketfd is not None:

1933

# Save the file descriptor

1934

self.socketfd = socketfd

1935

# Save the original socket.socket() function

1936

self.socket_socket = socket.socket

1937

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

1938

#

1939

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

1940

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

1941

# patching socket.socket.)

1942

#

1943

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

1944

@functools.wraps(socket.socket)

1945

def socket_wrapper(*args, **kwargs):

1946

# Restore original function so subsequent calls are

1947

# not affected.

1948

socket.socket = self.socket_socket

1949

del self.socket_socket

1950

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

1951

# saved file descriptor.

1952

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

1953

# Replace socket.socket() function with wrapper

1954

socket.socket = socket_wrapper

1955

# The socketserver.TCPServer.__init__ will call

1956

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

1957

# socket_wrapper(), if socketfd was set.

1742

1958

socketserver.TCPServer.__init__(self, server_address,

1743

1959

RequestHandlerClass)

1960

1744

1961

def server_bind(self):

1745

1962

"""This overrides the normal server_bind() function

1746

1963

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

1754

1971

try:

1755

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1756

1973

SO_BINDTODEVICE,

1757

str(self.interface

1758

+ '\0'))

1974

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

1759

1975

except socket.error as error:

1760

if error[0] == errno.EPERM:

1761

logger.error("No permission to"

1762

" bind to interface %s",

1763

self.interface)

1764

elif error[0] == errno.ENOPROTOOPT:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1765

1980

logger.error("SO_BINDTODEVICE not available;"

1766

1981

" cannot bind to interface %s",

1767

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1768

1986

else:

1769

1987

raise

1770

1988

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

1773

1991

if self.address_family == socket.AF_INET6:

1774

1992

any_address = "::" # in6addr_any

1775

1993

else:

1776

any_address = socket.INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

1777

1995

self.server_address = (any_address,

1778

1996

self.server_address[1])

1779

1997

elif not self.server_address[1]:

1800

2018

"""

1801

2019

def __init__(self, server_address, RequestHandlerClass,

1802

2020

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

1803

gnutls_priority=None, use_dbus=True):

2021

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

1804

2022

self.enabled = False

1805

2023

self.clients = clients

1806

2024

if self.clients is None:

1810

2028

IPv6_TCPServer.__init__(self, server_address,

1811

2029

RequestHandlerClass,

1812

2030

interface = interface,

1813

use_ipv6 = use_ipv6)

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

1814

2033

def server_activate(self):

1815

2034

if self.enabled:

1816

2035

return socketserver.TCPServer.server_activate(self)

1829

2048

1830

2049

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

1831

2050

proc = None, client_object=None):

1832

condition_names = {

1833

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

1834

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

1835

# blocking).

1836

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

1837

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

1838

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

1839

# broken, usually for pipes and

1840

# sockets).

1841

}

1842

conditions_string = ' | '.join(name

1843

for cond, name in

1844

condition_names.iteritems()

1845

if cond & condition)

1846

2051

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

1847

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

2052

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

1848

2053

# Wait for other process to exit

1849

2054

proc.join()

1850

2055

return False

1908

2113

return True

1909

2114

1910

2115

2116

def rfc3339_duration_to_delta(duration):

2117

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

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2133

"""

2134

2135

# Parsing an RFC 3339 duration with regular expressions is not

2136

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

2137

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

2138

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

2139

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

2140

# avoid excessive use of external libraries.

2141

2142

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

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2152

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

2153

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

2154

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

2155

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

2156

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2158

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

2159

datetime.timedelta(minutes=1),

2160

frozenset((token_second, token_end)))

2161

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

2162

datetime.timedelta(hours=1),

2163

frozenset((token_minute, token_end)))

2164

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

2165

None,

2166

frozenset((token_hour, token_minute,

2167

token_second)))

2168

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

2169

datetime.timedelta(days=1),

2170

frozenset((token_time, token_end)))

2171

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

2172

datetime.timedelta(weeks=4),

2173

frozenset((token_day, token_end)))

2174

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

2175

datetime.timedelta(weeks=52),

2176

frozenset((token_month, token_end)))

2177

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

2178

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2180

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

2181

frozenset((token_year, token_month,

2182

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2186

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2189

# Loop until end token is found

2190

while found_token is not token_end:

2191

# Search for any currently valid tokens

2192

for token in followers:

2193

match = token.regexp.match(s)

2194

if match is not None:

2195

# Token found

2196

if token.value is not None:

2197

# Value found, parse digits

2198

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

2199

# Add to value so far

2200

value += factor * token.value

2201

# Strip token from string

2202

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

2203

# Go to found token

2204

found_token = token

2205

# Set valid next tokens

2206

followers = found_token.followers

2207

break

2208

else:

2209

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2211

# End token found

2212

return value

2213

2214

1911

2215

def string_to_delta(interval):

1912

2216

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

1913

2217

1924

2228

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

1925

2229

datetime.timedelta(0, 330)

1926

2230

"""

2231

2232

try:

2233

return rfc3339_duration_to_delta(interval)

2234

except ValueError:

2235

pass

2236

1927

2237

timevalue = datetime.timedelta(0)

1928

2238

for s in interval.split():

1929

2239

try:

1940

2250

elif suffix == "w":

1941

2251

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

1942

2252

else:

1943

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

2253

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

2254

.format(suffix))

1944

2255

except (ValueError, IndexError) as e:

1945

2256

raise ValueError(*(e.args))

1946

2257

timevalue += delta

1960

2271

sys.exit()

1961

2272

if not noclose:

1962

2273

# Close all standard open file descriptors

1963

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

2274

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

1964

2275

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

1965

2276

raise OSError(errno.ENODEV,

1966

"%s not a character device"

1967

% os.path.devnull)

2277

"{0} not a character device"

2278

.format(os.devnull))

1968

2279

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

1969

2280

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

1970

2281

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

1979

2290

1980

2291

parser = argparse.ArgumentParser()

1981

2292

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

1982

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

2293

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

1983

2294

help="show version number and exit")

1984

2295

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

1985

2296

help="Bind to interface IF")

1991

2302

help="Run self-test")

1992

2303

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

1993

2304

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

1994

" to terminal")

2305

" to terminal", default=None)

1995

2306

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

1996

2307

help="Debug level for stdout output")

1997

2308

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

2004

2315

" files")

2005

2316

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

2006

2317

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

2007

" system bus interface")

2318

" system bus interface", default=None)

2008

2319

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

2009

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

2320

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

2321

default=None)

2010

2322

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

2011

2323

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

2012

" state")

2324

" state", default=None)

2325

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

2326

help="Specify a file descriptor to a network"

2327

" socket to use instead of creating one")

2013

2328

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

2014

2329

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

2330

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

2331

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

2015

2332

2016

2333

options = parser.parse_args()

2017

2334

2026

2343

"port": "",

2027

2344

"debug": "False",

2028

2345

"priority":

2029

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

2346

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

2030

2347

"servicename": "Mandos",

2031

2348

"use_dbus": "True",

2032

2349

"use_ipv6": "True",

2033

2350

"debuglevel": "",

2034

2351

"restore": "True",

2035

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

2352

"socket": "",

2353

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

2354

"foreground": "False",

2036

2355

}

2037

2356

2038

2357

# Parse config file for server-global settings

2043

2362

# Convert the SafeConfigParser object to a dict

2044

2363

server_settings = server_config.defaults()

2045

2364

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

2046

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

2365

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

2047

2366

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

2048

2367

option)

2049

2368

if server_settings["port"]:

2050

2369

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

2051

2370

"port")

2371

if server_settings["socket"]:

2372

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

2373

"socket")

2374

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

2375

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

2376

# happen with a supplied network socket.

2377

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

2378

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

2379

["socket"])

2052

2380

del server_config

2053

2381

2054

2382

# Override the settings from the config file with command line

2056

2384

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

2057

2385

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

2058

2386

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

2059

"statedir"):

2387

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

2060

2388

value = getattr(options, option)

2061

2389

if value is not None:

2062

2390

server_settings[option] = value

2065

2393

for option in server_settings.keys():

2066

2394

if type(server_settings[option]) is str:

2067

2395

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

2396

# Force all boolean options to be boolean

2397

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

2398

"foreground"):

2399

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

2400

# Debug implies foreground

2401

if server_settings["debug"]:

2402

server_settings["foreground"] = True

2068

2403

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

2069

2404

2070

2405

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

2076

2411

use_ipv6 = server_settings["use_ipv6"]

2077

2412

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

2078

2413

stored_state_file)

2414

foreground = server_settings["foreground"]

2079

2415

2080

2416

if debug:

2081

initlogger(logging.DEBUG)

2417

initlogger(debug, logging.DEBUG)

2082

2418

else:

2083

2419

if not debuglevel:

2084

initlogger()

2420

initlogger(debug)

2085

2421

else:

2086

2422

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

2087

initlogger(level)

2423

initlogger(debug, level)

2088

2424

2089

2425

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

2090

2426

syslogger.setFormatter(logging.Formatter

2091

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

2092

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

2093

% server_settings["servicename"]))

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2094

2431

2095

2432

# Parse config file with clients

2096

client_config = configparser.SafeConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

2097

2435

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

2098

2436

"clients.conf"))

2099

2437

2108

2446

use_ipv6=use_ipv6,

2109

2447

gnutls_priority=

2110

2448

server_settings["priority"],

2111

use_dbus=use_dbus)

2112

if not debug:

2113

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

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

2452

if not foreground:

2453

pidfilename = "/run/mandos.pid"

2454

pidfile = None

2114

2455

try:

2115

2456

pidfile = open(pidfilename, "w")

2116

except IOError:

2117

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

2457

except IOError as e:

2458

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

2459

exc_info=e)

2118

2460

2119

try:

2120

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

2121

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

2122

except KeyError:

2461

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

2123

2462

try:

2124

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

2125

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

2463

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

2465

break

2126

2466

except KeyError:

2127

try:

2128

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

2129

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

2130

except KeyError:

2131

uid = 65534

2132

gid = 65534

2467

continue

2468

else:

2469

uid = 65534

2470

gid = 65534

2133

2471

try:

2134

2472

os.setgid(gid)

2135

2473

os.setuid(uid)

2136

2474

except OSError as error:

2137

if error[0] != errno.EPERM:

2475

if error.errno != errno.EPERM:

2138

2476

raise error

2139

2477

2140

2478

if debug:

2152

2490

.gnutls_global_set_log_function(debug_gnutls))

2153

2491

2154

2492

# Redirect stdin so all checkers get /dev/null

2155

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

2493

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

2156

2494

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

2157

2495

if null > 2:

2158

2496

os.close(null)

2159

else:

2160

# No console logging

2161

logger.removeHandler(console)

2162

2497

2163

2498

# Need to fork before connecting to D-Bus

2164

if not debug:

2499

if not foreground:

2165

2500

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

2166

2501

daemon()

2167

2502

2503

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

2504

# need to inform gobject that threads will be used.

2168

2505

gobject.threads_init()

2169

2506

2170

2507

global main_loop

2171

2508

# From the Avahi example code

2172

DBusGMainLoop(set_as_default=True )

2509

DBusGMainLoop(set_as_default=True)

2173

2510

main_loop = gobject.MainLoop()

2174

2511

bus = dbus.SystemBus()

2175

2512

# End of Avahi example code

2181

2518

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

2182

2519

do_not_queue=True))

2183

2520

except dbus.exceptions.NameExistsException as e:

2184

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

2521

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

2185

2522

use_dbus = False

2186

2523

server_settings["use_dbus"] = False

2187

2524

tcp_server.use_dbus = False

2199

2536

2200

2537

client_class = Client

2201

2538

if use_dbus:

2202

client_class = functools.partial(ClientDBusTransitional,

2203

bus = bus)

2539

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

2204

2540

2205

2541

client_settings = Client.config_parser(client_config)

2206

2542

old_client_settings = {}

2207

2543

clients_data = {}

2208

2544

2545

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

2546

global wnull

2547

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

2548

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

2549

# mode

2550

if debug or not foreground:

2551

wnull.close()

2552

2209

2553

# Get client data and settings from last running state.

2210

2554

if server_settings["restore"]:

2211

2555

try:

2214

2558

(stored_state))

2215

2559

os.remove(stored_state_path)

2216

2560

except IOError as e:

2217

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

2218

.format(e))

2219

if e.errno != errno.ENOENT:

2561

if e.errno == errno.ENOENT:

2562

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

2563

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

2564

else:

2565

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

2566

exc_info=e)

2220

2567

raise

2568

except EOFError as e:

2569

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

2570

"EOFError:", exc_info=e)

2221

2571

2222

2572

with PGPEngine() as pgp:

2223

2573

for client_name, client in clients_data.iteritems():

2574

# Skip removed clients

2575

if client_name not in client_settings:

2576

continue

2577

2224

2578

# Decide which value to use after restoring saved state.

2225

2579

# We have three different values: Old config file,

2226

2580

# new config file, and saved state.

2240

2594

2241

2595

# Clients who has passed its expire date can still be

2242

2596

# enabled if its last checker was successful. Clients

2243

# whose checker failed before we stored its state is

2244

# assumed to have failed all checkers during downtime.

2597

# whose checker succeeded before we stored its state is

2598

# assumed to have successfully run all checkers during

2599

# downtime.

2245

2600

if client["enabled"]:

2246

2601

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

2247

2602

if not client["last_checked_ok"]:

2248

2603

logger.warning(

2249

2604

"disabling client {0} - Client never "

2250

"performed a successfull checker"

2251

.format(client["name"]))

2605

"performed a successful checker"

2606

.format(client_name))

2252

2607

client["enabled"] = False

2253

2608

elif client["last_checker_status"] != 0:

2254

2609

logger.warning(

2255

2610

"disabling client {0} - Client "

2256

2611

"last checker failed with error code {1}"

2257

.format(client["name"],

2612

.format(client_name,

2258

2613

client["last_checker_status"]))

2259

2614

client["enabled"] = False

2260

2615

else:

2261

2616

client["expires"] = (datetime.datetime

2262

2617

.utcnow()

2263

2618

+ client["timeout"])

2264

2619

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

2265

2622

try:

2266

2623

client["secret"] = (

2267

2624

pgp.decrypt(client["encrypted_secret"],

2273

2630

.format(client_name))

2274

2631

client["secret"] = (

2275

2632

client_settings[client_name]["secret"])

2276

2277

2633

2278

2634

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

2279

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

2635

for client_name in (set(old_client_settings)

2636

- set(client_settings)):

2280

2637

del clients_data[client_name]

2281

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

2638

for client_name in (set(client_settings)

2639

- set(old_client_settings)):

2282

2640

clients_data[client_name] = client_settings[client_name]

2283

2284

# Create clients all clients

2641

2642

# Create all client objects

2285

2643

for client_name, client in clients_data.iteritems():

2286

2644

tcp_server.clients[client_name] = client_class(

2287

name = client_name, settings = client)

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2288

2647

2289

2648

if not tcp_server.clients:

2290

2649

logger.warning("No clients defined")

2291

2292

if not debug:

2293

try:

2294

with pidfile:

2295

pid = os.getpid()

2296

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

2297

del pidfile

2298

except IOError:

2299

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

2300

pidfilename, pid)

2301

except NameError:

2302

# "pidfile" was never created

2303

pass

2650

2651

if not foreground:

2652

if pidfile is not None:

2653

try:

2654

with pidfile:

2655

pid = os.getpid()

2656

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

2657

except IOError:

2658

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

2659

pidfilename, pid)

2660

del pidfile

2304

2661

del pidfilename

2305

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

2306

2662

2307

2663

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

2308

2664

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

2309

2665

2310

2666

if use_dbus:

2311

class MandosDBusService(dbus.service.Object):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

2312

2670

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

2313

2671

def __init__(self):

2314

2672

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

2315

2673

_interface = "se.recompile.Mandos"

2316

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

2317

2681

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

2318

2682

def ClientAdded(self, objpath):

2319

2683

"D-Bus signal"

2361

2725

2362

2726

del _interface

2363

2727

2364

class MandosDBusServiceTransitional(MandosDBusService):

2365

__metaclass__ = AlternateDBusNamesMetaclass

2366

mandos_dbus_service = MandosDBusServiceTransitional()

2728

mandos_dbus_service = MandosDBusService()

2367

2729

2368

2730

def cleanup():

2369

2731

"Cleanup function; run on exit"

2370

2732

service.cleanup()

2371

2733

2372

2734

multiprocessing.active_children()

2735

wnull.close()

2373

2736

if not (tcp_server.clients or client_settings):

2374

2737

return

2375

2738

2387

2750

# A list of attributes that can not be pickled

2388

2751

# + secret.

2389

2752

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

2390

"checker"))

2753

"checker", "server_settings"))

2391

2754

for name, typ in (inspect.getmembers

2392

2755

(dbus.service.Object)):

2393

2756

exclude.add(name)

2402

2765

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

2403

2766

2404

2767

try:

2405

with os.fdopen(os.open(stored_state_path,

2406

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

2407

0600), "wb") as stored_state:

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2408

2772

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

2773

tempname=stored_state.name

2774

os.rename(tempname, stored_state_path)

2409

2775

except (IOError, OSError) as e:

2410

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

2411

.format(e))

2412

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

2413

raise

2776

if not debug:

2777

try:

2778

os.remove(tempname)

2779

except NameError:

2780

pass

2781

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

2782

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

2783

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

2784

else:

2785

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

2786

exc_info=e)

2787

raise e

2414

2788

2415

2789

# Delete all clients, and settings from config

2416

2790

while tcp_server.clients:

2443

2817

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

2444

2818

if use_ipv6:

2445

2819

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

2446

" flowinfo %d, scope_id %d"

2447

% tcp_server.socket.getsockname())

2820

" flowinfo %d, scope_id %d",

2821

*tcp_server.socket.getsockname())

2448

2822

else: # IPv4

2449

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

2450

% tcp_server.socket.getsockname())

2823

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

2824

*tcp_server.socket.getsockname())

2451

2825

2452

2826

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

2453

2827

2456

2830

try:

2457

2831

service.activate()

2458

2832

except dbus.exceptions.DBusException as error:

2459

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

2833

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

2460

2834

cleanup()

2461

2835

sys.exit(1)

2462

2836

# End of Avahi example code

2469

2843

logger.debug("Starting main loop")

2470

2844

main_loop.run()

2471

2845

except AvahiError as error:

2472

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

2846

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

2473

2847

cleanup()

2474

2848

sys.exit(1)

2475

2849

except KeyboardInterrupt: