/mandos/trunk : revision 636

11

# "AvahiService" class, and some lines in "main".

12

#

13

# Everything else is

14

15

14

15

16

#

17

# This program is free software: you can redistribute it and/or modify

18

# it under the terms of the GNU General Public License as published by

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

65

67

import types

66

68

import binascii

67

69

import tempfile

70

import itertools

71

import collections

68

72

69

73

import dbus

70

74

import dbus.service

75

79

import ctypes.util

76

80

import xml.dom.minidom

77

81

import inspect

78

import GnuPGInterface

79

82

80

83

try:

81

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

88

except ImportError:

86

89

SO_BINDTODEVICE = None

87

90

88

version = "1.4.1"

91

version = "1.6.2"

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

110

113

return interface_index

111

114

112

115

113

def initlogger(level=logging.WARNING):

116

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

114

117

"""init logger and add loglevel"""

115

118

116

119

syslogger.setFormatter(logging.Formatter

118

121

' %(message)s'))

119

122

logger.addHandler(syslogger)

120

123

121

console = logging.StreamHandler()

122

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

123

' [%(process)d]:'

124

' %(levelname)s:'

125

' %(message)s'))

126

logger.addHandler(console)

124

if debug:

125

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

127

131

logger.setLevel(level)

128

132

129

133

135

139

class PGPEngine(object):

136

140

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

137

141

def __init__(self):

138

self.gnupg = GnuPGInterface.GnuPG()

139

142

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

140

self.gnupg = GnuPGInterface.GnuPG()

141

self.gnupg.options.meta_interactive = False

142

self.gnupg.options.homedir = self.tempdir

143

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

144

'--quiet'])

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

145

148

146

149

def __enter__(self):

147

150

return self

148

151

149

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

152

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

150

153

self._cleanup()

151

154

return False

152

155

169

172

def password_encode(self, password):

170

173

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

171

174

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

172

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

175

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

176

if len(encoded) > 2048:

177

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

178

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

179

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

180

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

181

return encoded

173

182

174

183

def encrypt(self, data, password):

175

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

176

with open(os.devnull) as devnull:

177

try:

178

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

179

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

180

attach_fhs={'stderr': devnull})

181

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

182

f.write(data)

183

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

184

ciphertext = f.read()

185

proc.wait()

186

except IOError as e:

187

raise PGPError(e)

188

self.gnupg.passphrase = None

184

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

187

passfile.write(passphrase)

188

passfile.flush()

189

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

190

'--passphrase-file',

191

passfile.name]

192

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

197

if proc.returncode != 0:

198

raise PGPError(err)

189

199

return ciphertext

190

200

191

201

def decrypt(self, data, password):

192

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

193

with open(os.devnull) as devnull:

194

try:

195

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

196

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

197

attach_fhs={'stderr': devnull})

198

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

199

f.write(data)

200

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

201

decrypted_plaintext = f.read()

202

proc.wait()

203

except IOError as e:

204

raise PGPError(e)

205

self.gnupg.passphrase = None

202

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

205

passfile.write(passphrase)

206

passfile.flush()

207

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

208

'--passphrase-file',

209

passfile.name]

210

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

216

if proc.returncode != 0:

217

raise PGPError(err)

206

218

return decrypted_plaintext

207

219

208

220

209

210

221

class AvahiError(Exception):

211

222

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

212

223

self.value = value

229

240

Used to optionally bind to the specified interface.

230

241

name: string; Example: 'Mandos'

231

242

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

232

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

243

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

233

244

port: integer; what port to announce

234

245

TXT: list of strings; TXT record for the service

235

246

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

241

252

server: D-Bus Server

242

253

bus: dbus.SystemBus()

243

254

"""

255

244

256

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

245

257

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

246

258

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

259

271

self.server = None

260

272

self.bus = bus

261

273

self.entry_group_state_changed_match = None

274

262

275

def rename(self):

263

276

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

264

277

if self.rename_count >= self.max_renames:

274

287

try:

275

288

self.add()

276

289

except dbus.exceptions.DBusException as error:

277

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

290

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

278

291

self.cleanup()

279

292

os._exit(1)

280

293

self.rename_count += 1

294

281

295

def remove(self):

282

296

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

283

297

if self.entry_group_state_changed_match is not None:

285

299

self.entry_group_state_changed_match = None

286

300

if self.group is not None:

287

301

self.group.Reset()

302

288

303

def add(self):

289

304

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

290

305

self.remove()

307

322

dbus.UInt16(self.port),

308

323

avahi.string_array_to_txt_array(self.TXT))

309

324

self.group.Commit()

325

310

326

def entry_group_state_changed(self, state, error):

311

327

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

312

328

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

319

335

elif state == avahi.ENTRY_GROUP_FAILURE:

320

336

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

321

337

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

338

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

339

.format(error))

340

324

341

def cleanup(self):

325

342

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

326

343

if self.group is not None:

331

348

pass

332

349

self.group = None

333

350

self.remove()

351

334

352

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

335

353

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

336

354

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

355

373

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

356

374

else:

357

375

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

376

358

377

def activate(self):

359

378

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

360

379

if self.server is None:

367

386

self.server_state_changed)

368

387

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

369

388

389

370

390

class AvahiServiceToSyslog(AvahiService):

371

391

def rename(self):

372

392

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

373

393

ret = AvahiService.rename(self)

374

394

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

395

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

396

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

397

.format(self.name)))

378

398

return ret

379

399

400

380

401

def timedelta_to_milliseconds(td):

381

402

"Convert a datetime.timedelta() to milliseconds"

382

403

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

383

404

+ (td.seconds * 1000)

384

405

+ (td.microseconds // 1000))

385

406

407

386

408

class Client(object):

387

409

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

388

410

413

435

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

414

436

last_checker_status: integer between 0 and 255 reflecting exit

415

437

status of last checker. -1 reflects crashed

416

checker, or None.

438

checker, -2 means no checker completed yet.

417

439

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

418

440

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

419

441

D-Bus identifiers

420

442

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

421

443

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

422

444

until this client is disabled

423

extended_timeout: extra long timeout when password has been sent

445

extended_timeout: extra long timeout when secret has been sent

424

446

runtime_expansions: Allowed attributes for runtime expansion.

425

447

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

426

448

disabled, or None

449

server_settings: The server_settings dict from main()

427

450

"""

428

451

429

452

runtime_expansions = ("approval_delay", "approval_duration",

430

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

431

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

453

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

454

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

455

"last_approval_request", "last_checked_ok",

432

456

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

433

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

434

"extended_timeout": "15m",

435

"interval": "2m",

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

436

460

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

437

461

"host": "",

438

"approval_delay": "0s",

439

"approval_duration": "1s",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

440

464

"approved_by_default": "True",

441

465

"enabled": "True",

442

466

}

455

479

456

480

def approval_delay_milliseconds(self):

457

481

return timedelta_to_milliseconds(self.approval_delay)

458

482

459

483

@staticmethod

460

484

def config_parser(config):

461

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

485

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

462

486

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

463

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

487

with exceptions for any special settings as defined above.

488

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

489

value given the same arguments.

490

"""

464

491

settings = {}

465

492

for client_name in config.sections():

466

493

section = dict(config.items(client_name))

470

497

# Reformat values from string types to Python types

471

498

client["approved_by_default"] = config.getboolean(

472

499

client_name, "approved_by_default")

473

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

500

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

501

"enabled")

474

502

475

503

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

476

504

.replace(" ", ""))

482

510

"rb") as secfile:

483

511

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

484

512

else:

485

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

486

% section)

513

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

514

.format(section))

487

515

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

488

516

client["extended_timeout"] = string_to_delta(

489

517

section["extended_timeout"])

495

523

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

496

524

client["last_approval_request"] = None

497

525

client["last_checked_ok"] = None

498

client["last_checker_status"] = None

499

if client["enabled"]:

500

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

501

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

502

+ client["timeout"])

503

else:

504

client["last_enabled"] = None

505

client["expires"] = None

506

526

client["last_checker_status"] = -2

527

507

528

return settings

508

509

510

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

511

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

512

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

513

attribute."""

529

530

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

514

531

self.name = name

532

if server_settings is None:

533

server_settings = {}

534

self.server_settings = server_settings

515

535

# adding all client settings

516

536

for setting, value in settings.iteritems():

517

537

setattr(self, setting, value)

518

538

539

if self.enabled:

540

if not hasattr(self, "last_enabled"):

541

self.last_enabled = datetime.datetime.utcnow()

542

if not hasattr(self, "expires"):

543

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

544

+ self.timeout)

545

else:

546

self.last_enabled = None

547

self.expires = None

548

519

549

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

520

550

# Uppercase and remove spaces from fingerprint for later

521

551

# comparison purposes with return value from the fingerprint()

522

552

# function

523

553

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

524

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

525

554

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

555

datetime.datetime.utcnow())

556

526

557

# attributes specific for this server instance

527

558

self.checker = None

528

559

self.checker_initiator_tag = None

556

587

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

557

588

# Already enabled

558

589

return

559

self.send_changedstate()

560

590

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

561

591

self.enabled = True

562

592

self.last_enabled = datetime.datetime.utcnow()

563

593

self.init_checker()

594

self.send_changedstate()

564

595

565

596

def disable(self, quiet=True):

566

597

"""Disable this client."""

567

598

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

568

599

return False

569

600

if not quiet:

570

self.send_changedstate()

571

if not quiet:

572

601

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

573

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

602

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

574

603

gobject.source_remove(self.disable_initiator_tag)

575

604

self.disable_initiator_tag = None

576

605

self.expires = None

577

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

606

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

578

607

gobject.source_remove(self.checker_initiator_tag)

579

608

self.checker_initiator_tag = None

580

609

self.stop_checker()

581

610

self.enabled = False

611

if not quiet:

612

self.send_changedstate()

582

613

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

583

614

return False

584

615

588

619

def init_checker(self):

589

620

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

590

621

# and every interval from then on.

622

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

591

624

self.checker_initiator_tag = (gobject.timeout_add

592

625

(self.interval_milliseconds(),

593

626

self.start_checker))

594

627

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

628

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

595

630

self.disable_initiator_tag = (gobject.timeout_add

596

631

(self.timeout_milliseconds(),

597

632

self.disable))

616

651

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

617

652

vars(self))

618

653

619

def checked_ok(self, timeout=None):

620

"""Bump up the timeout for this client.

621

622

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

623

alive and well.

624

"""

654

def checked_ok(self):

655

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

656

self.last_checked_ok = datetime.datetime.utcnow()

657

self.last_checker_status = 0

658

self.bump_timeout()

659

660

def bump_timeout(self, timeout=None):

661

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

625

662

if timeout is None:

626

663

timeout = self.timeout

627

self.last_checked_ok = datetime.datetime.utcnow()

628

664

if self.disable_initiator_tag is not None:

629

665

gobject.source_remove(self.disable_initiator_tag)

666

self.disable_initiator_tag = None

630

667

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

631

668

self.disable_initiator_tag = (gobject.timeout_add

632

669

(timedelta_to_milliseconds

642

679

If a checker already exists, leave it running and do

643

680

nothing."""

644

681

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

645

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

646

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

647

# client would inevitably timeout, since no checker would get

648

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

682

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

683

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

684

# would inevitably timeout, since no checker would get a

685

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

649

686

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

650

687

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

651

688

# should be.

665

702

self.current_checker_command)

666

703

# Start a new checker if needed

667

704

if self.checker is None:

705

# Escape attributes for the shell

706

escaped_attrs = dict(

707

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

708

for attr in

709

self.runtime_expansions)

668

710

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

711

command = self.checker_command % escaped_attrs

712

except TypeError as error:

713

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

714

self.checker_command, exc_info=error)

715

return True # Try again later

687

716

self.current_checker_command = command

688

717

try:

689

718

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

692

721

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

693

722

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

694

723

# always replaced by /dev/null.)

724

# The exception is when not debugging but nevertheless

725

# running in the foreground; use the previously

726

# created wnull.

727

popen_args = {}

728

if (not self.server_settings["debug"]

729

and self.server_settings["foreground"]):

730

popen_args.update({"stdout": wnull,

731

"stderr": wnull })

695

732

self.checker = subprocess.Popen(command,

696

733

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.

734

shell=True, cwd="/",

735

**popen_args)

736

except OSError as error:

737

logger.error("Failed to start subprocess",

738

exc_info=error)

739

return True

740

self.checker_callback_tag = (gobject.child_watch_add

741

(self.checker.pid,

742

self.checker_callback,

743

data=command))

744

# The checker may have completed before the gobject

745

# watch was added. Check for this.

746

try:

704

747

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

748

except OSError as error:

709

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

710

error)

749

if error.errno == errno.ECHILD:

750

# This should never happen

751

logger.error("Child process vanished",

752

exc_info=error)

753

return True

754

raise

755

if pid:

756

gobject.source_remove(self.checker_callback_tag)

757

self.checker_callback(pid, status, command)

711

758

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

712

759

return True

713

760

720

767

return

721

768

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

722

769

try:

723

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

770

self.checker.terminate()

724

771

#time.sleep(0.5)

725

772

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

726

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

773

# self.checker.kill()

727

774

except OSError as error:

728

775

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

729

776

raise

746

793

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

747

794

if byte_arrays and signature != "ay":

748

795

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

749

" signature %r" % signature)

796

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

750

797

def decorator(func):

751

798

func._dbus_is_property = True

752

799

func._dbus_interface = dbus_interface

760

807

return decorator

761

808

762

809

810

def dbus_interface_annotations(dbus_interface):

811

"""Decorator for marking functions returning interface annotations

812

813

Usage:

814

815

@dbus_interface_annotations("org.example.Interface")

816

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

817

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

818

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

819

"false"}

820

"""

821

def decorator(func):

822

func._dbus_is_interface = True

823

func._dbus_interface = dbus_interface

824

func._dbus_name = dbus_interface

825

return func

826

return decorator

827

828

829

def dbus_annotations(annotations):

830

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

831

Usage:

832

833

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

834

access="r")

835

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

836

"org.freedesktop.DBus.Property."

837

"EmitsChangedSignal": "false"})

838

def Property_dbus_property(self):

839

return dbus.Boolean(False)

840

"""

841

def decorator(func):

842

func._dbus_annotations = annotations

843

return func

844

return decorator

845

846

763

847

class DBusPropertyException(dbus.exceptions.DBusException):

764

848

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

765

849

"""

788

872

"""

789

873

790

874

@staticmethod

791

def _is_dbus_property(obj):

792

return getattr(obj, "_dbus_is_property", False)

875

def _is_dbus_thing(thing):

876

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

877

878

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

879

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

880

"""

881

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

882

False)

793

883

794

def _get_all_dbus_properties(self):

884

def _get_all_dbus_things(self, thing):

795

885

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

796

886

"""

797

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

887

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

888

name),

889

athing.__get__(self))

798

890

for cls in self.__class__.__mro__

799

for name, prop in

800

inspect.getmembers(cls, self._is_dbus_property))

891

for name, athing in

892

inspect.getmembers(cls,

893

self._is_dbus_thing(thing)))

801

894

802

895

def _get_dbus_property(self, interface_name, property_name):

803

896

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

805

898

"""

806

899

for cls in self.__class__.__mro__:

807

900

for name, value in (inspect.getmembers

808

(cls, self._is_dbus_property)):

901

(cls,

902

self._is_dbus_thing("property"))):

809

903

if (value._dbus_name == property_name

810

904

and value._dbus_interface == interface_name):

811

905

return value.__get__(self)

840

934

# signatures other than "ay".

841

935

if prop._dbus_signature != "ay":

842

936

raise ValueError

843

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

844

for byte in value))

937

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

938

for byte in value))

845

939

prop(value)

846

940

847

941

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

853

947

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

854

948

"""

855

949

properties = {}

856

for name, prop in self._get_all_dbus_properties():

950

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

857

951

if (interface_name

858

952

and interface_name != prop._dbus_interface):

859

953

# Interface non-empty but did not match

874

968

path_keyword='object_path',

875

969

connection_keyword='connection')

876

970

def Introspect(self, object_path, connection):

877

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

971

"""Overloading of standard D-Bus method.

972

973

Inserts property tags and interface annotation tags.

878

974

"""

879

975

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

880

976

connection)

887

983

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

888

984

return e

889

985

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

986

# Add property tags

890

987

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

891

988

for name, prop

892

in self._get_all_dbus_properties()

989

in self._get_all_dbus_things("property")

893

990

if prop._dbus_interface

894

991

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

895

992

if_tag.appendChild(tag)

993

# Add annotation tags

994

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

995

for tag in if_tag.getElementsByTagName(typ):

996

annots = dict()

997

for name, prop in (self.

998

_get_all_dbus_things(typ)):

999

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

1000

and prop._dbus_interface

1001

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

1002

annots.update(getattr

1003

(prop,

1004

"_dbus_annotations",

1005

{}))

1006

for name, value in annots.iteritems():

1007

ann_tag = document.createElement(

1008

"annotation")

1009

ann_tag.setAttribute("name", name)

1010

ann_tag.setAttribute("value", value)

1011

tag.appendChild(ann_tag)

1012

# Add interface annotation tags

1013

for annotation, value in dict(

1014

itertools.chain.from_iterable(

1015

annotations().iteritems()

1016

for name, annotations in

1017

self._get_all_dbus_things("interface")

1018

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

1019

)).iteritems():

1020

ann_tag = document.createElement("annotation")

1021

ann_tag.setAttribute("name", annotation)

1022

ann_tag.setAttribute("value", value)

1023

if_tag.appendChild(ann_tag)

896

1024

# Add the names to the return values for the

897

1025

# "org.freedesktop.DBus.Properties" methods

898

1026

if (if_tag.getAttribute("name")

913

1041

except (AttributeError, xml.dom.DOMException,

914

1042

xml.parsers.expat.ExpatError) as error:

915

1043

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

916

error)

1044

exc_info=error)

917

1045

return xmlstring

918

1046

919

1047

920

def datetime_to_dbus (dt, variant_level=0):

1048

def datetime_to_dbus(dt, variant_level=0):

921

1049

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

922

1050

if dt is None:

923

1051

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

925

1053

variant_level=variant_level)

926

1054

927

1055

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.

1056

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1057

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

1058

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

1059

interface names according to the "alt_interface_names" mapping.

1060

Usage:

1061

1062

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

1063

"net.example.AlternateInterface"})

1064

class SampleDBusObject(dbus.service.Object):

1065

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

1066

def SampleDBusMethod():

1067

pass

1068

1069

The above "SampleDBusMethod" on "SampleDBusObject" will be

1070

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

1071

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

1072

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

1073

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

1074

1075

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

1076

(from DBusObjectWithProperties) and interfaces (from the

1077

dbus_interface_annotations decorator).

932

1078

"""

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

1079

def wrapper(cls):

1080

for orig_interface_name, alt_interface_name in (

1081

alt_interface_names.iteritems()):

1082

attr = {}

1083

interface_names = set()

1084

# Go though all attributes of the class

1085

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

940

1086

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

941

1087

# with the wrong interface name

942

1088

if (not hasattr(attribute, "_dbus_interface")

943

1089

or not attribute._dbus_interface

944

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

1090

.startswith(orig_interface_name)):

945

1091

continue

946

1092

# Create an alternate D-Bus interface name based on

947

1093

# the current name

948

1094

alt_interface = (attribute._dbus_interface

949

.replace("se.recompile.Mandos",

950

"se.bsnet.fukt.Mandos"))

1095

.replace(orig_interface_name,

1096

alt_interface_name))

1097

interface_names.add(alt_interface)

951

1098

# Is this a D-Bus signal?

952

1099

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

953

# Extract the original non-method function by

954

# black magic

1100

# Extract the original non-method undecorated

1101

# function by black magic

955

1102

nonmethod_func = (dict(

956

1103

zip(attribute.func_code.co_freevars,

957

1104

attribute.__closure__))["func"]

968

1115

nonmethod_func.func_name,

969

1116

nonmethod_func.func_defaults,

970

1117

nonmethod_func.func_closure)))

1118

# Copy annotations, if any

1119

try:

1120

new_function._dbus_annotations = (

1121

dict(attribute._dbus_annotations))

1122

except AttributeError:

1123

pass

971

1124

# 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

1125

# original and alternate functions, so both the

1126

# original and alternate signals gets sent when

1127

# the function is called

974

1128

def fixscope(func1, func2):

975

1129

"""This function is a scope container to pass

976

1130

func1 and func2 to the "call_both" function

983

1137

return call_both

984

1138

# Create the "call_both" function and add it to

985

1139

# the class

986

attr[attrname] = fixscope(attribute,

987

new_function)

1140

attr[attrname] = fixscope(attribute, new_function)

988

1141

# Is this a D-Bus method?

989

1142

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

990

1143

# Create a new, but exactly alike, function

1001

1154

attribute.func_name,

1002

1155

attribute.func_defaults,

1003

1156

attribute.func_closure)))

1157

# Copy annotations, if any

1158

try:

1159

attr[attrname]._dbus_annotations = (

1160

dict(attribute._dbus_annotations))

1161

except AttributeError:

1162

pass

1004

1163

# Is this a D-Bus property?

1005

1164

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

1006

1165

# Create a new, but exactly alike, function

1020

1179

attribute.func_name,

1021

1180

attribute.func_defaults,

1022

1181

attribute.func_closure)))

1023

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

1024

1025

1182

# Copy annotations, if any

1183

try:

1184

attr[attrname]._dbus_annotations = (

1185

dict(attribute._dbus_annotations))

1186

except AttributeError:

1187

pass

1188

# Is this a D-Bus interface?

1189

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

1190

# Create a new, but exactly alike, function

1191

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

1192

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

1193

# to the class.

1194

attr[attrname] = (dbus_interface_annotations

1195

(alt_interface)

1196

(types.FunctionType

1197

(attribute.func_code,

1198

attribute.func_globals,

1199

attribute.func_name,

1200

attribute.func_defaults,

1201

attribute.func_closure)))

1202

if deprecate:

1203

# Deprecate all alternate interfaces

1204

iname="_AlternateDBusNames_interface_annotation{0}"

1205

for interface_name in interface_names:

1206

@dbus_interface_annotations(interface_name)

1207

def func(self):

1208

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

1209

"true" }

1210

# Find an unused name

1211

for aname in (iname.format(i)

1212

for i in itertools.count()):

1213

if aname not in attr:

1214

attr[aname] = func

1215

break

1216

if interface_names:

1217

# Replace the class with a new subclass of it with

1218

# methods, signals, etc. as created above.

1219

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

1220

(cls,), attr)

1221

return cls

1222

return wrapper

1223

1224

1225

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

1226

"se.bsnet.fukt.Mandos"})

1026

1227

class ClientDBus(Client, DBusObjectWithProperties):

1027

1228

"""A Client class using D-Bus

1028

1229

1039

1240

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

1040

1241

self.bus = bus

1041

1242

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

1042

self._approvals_pending = 0

1043

1044

self._approvals_pending = 0

1045

1243

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

1046

1244

# the D-Bus

1047

1245

client_object_name = unicode(self.name).translate(

1051

1249

("/clients/" + client_object_name))

1052

1250

DBusObjectWithProperties.__init__(self, self.bus,

1053

1251

self.dbus_object_path)

1054

1252

1055

1253

def notifychangeproperty(transform_func,

1056

1254

dbus_name, type_func=lambda x: x,

1057

1255

variant_level=1):

1080

1278

1081

1279

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

1082

1280

1083

1084

1281

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1085

1282

approvals_pending = notifychangeproperty(dbus.Boolean,

1086

1283

"ApprovalPending",

1093

1290

checker is not None)

1094

1291

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1095

1292

"LastCheckedOK")

1293

last_checker_status = notifychangeproperty(dbus.Int16,

1294

"LastCheckerStatus")

1096

1295

last_approval_request = notifychangeproperty(

1097

1296

datetime_to_dbus, "LastApprovalRequest")

1098

1297

approved_by_default = notifychangeproperty(dbus.Boolean,

1166

1365

return False

1167

1366

1168

1367

def approve(self, value=True):

1169

self.send_changedstate()

1170

1368

self.approved = value

1171

1369

gobject.timeout_add(timedelta_to_milliseconds

1172

1370

(self.approval_duration),

1173

1371

self._reset_approved)

1174

1372

self.send_changedstate()

1175

1373

1176

1374

## D-Bus methods, signals & properties

1177

1375

_interface = "se.recompile.Mandos.Client"

1178

1376

1377

## Interfaces

1378

1379

@dbus_interface_annotations(_interface)

1380

def _foo(self):

1381

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

1382

"false"}

1383

1179

1384

## Signals

1180

1385

1181

1386

# CheckerCompleted - signal

1217

1422

"D-Bus signal"

1218

1423

return self.need_approval()

1219

1424

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

1425

## Methods

1229

1426

1230

1427

# Approve - method

1340

1537

return

1341

1538

return datetime_to_dbus(self.last_checked_ok)

1342

1539

1540

# LastCheckerStatus - property

1541

@dbus_service_property(_interface, signature="n",

1542

access="read")

1543

def LastCheckerStatus_dbus_property(self):

1544

return dbus.Int16(self.last_checker_status)

1545

1343

1546

# Expires - property

1344

1547

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

1345

1548

def Expires_dbus_property(self):

1356

1559

def Timeout_dbus_property(self, value=None):

1357

1560

if value is None: # get

1358

1561

return dbus.UInt64(self.timeout_milliseconds())

1562

old_timeout = self.timeout

1359

1563

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

1564

# Reschedule disabling

1565

if self.enabled:

1566

now = datetime.datetime.utcnow()

1567

self.expires += self.timeout - old_timeout

1568

if self.expires <= now:

1569

# The timeout has passed

1570

self.disable()

1571

else:

1572

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

1573

is None):

1574

return

1575

gobject.source_remove(self.disable_initiator_tag)

1576

self.disable_initiator_tag = (

1577

gobject.timeout_add(

1578

timedelta_to_milliseconds(self.expires - now),

1579

self.disable))

1380

1580

1381

1581

# ExtendedTimeout - property

1382

1582

@dbus_service_property(_interface, signature="t",

1461

1661

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

1462

1662

1463

1663

1464

class ClientDBusTransitional(ClientDBus):

1465

__metaclass__ = AlternateDBusNamesMetaclass

1466

1467

1468

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

1469

1665

"""A class to handle client connections.

1470

1666

1538

1734

except KeyError:

1539

1735

return

1540

1736

1541

if self.server.use_dbus:

1542

# Emit D-Bus signal

1543

client.NewRequest(str(self.client_address))

1544

1545

1737

if client.approval_delay:

1546

1738

delay = client.approval_delay

1547

1739

client.approvals_pending += 1

1578

1770

#wait until timeout or approved

1579

1771

time = datetime.datetime.now()

1580

1772

client.changedstate.acquire()

1581

(client.changedstate.wait

1582

(float(client.timedelta_to_milliseconds(delay)

1583

/ 1000)))

1773

client.changedstate.wait(

1774

float(timedelta_to_milliseconds(delay)

1775

/ 1000))

1584

1776

client.changedstate.release()

1585

1777

time2 = datetime.datetime.now()

1586

1778

if (time2 - time) >= delay:

1602

1794

try:

1603

1795

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

1604

1796

except gnutls.errors.GNUTLSError as error:

1605

logger.warning("gnutls send failed")

1797

logger.warning("gnutls send failed",

1798

exc_info=error)

1606

1799

return

1607

1800

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

1608

1801

sent, len(client.secret)

1611

1804

1612

1805

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

1613

1806

# bump the timeout using extended_timeout

1614

client.checked_ok(client.extended_timeout)

1807

client.bump_timeout(client.extended_timeout)

1615

1808

if self.server.use_dbus:

1616

1809

# Emit D-Bus signal

1617

1810

client.GotSecret()

1622

1815

try:

1623

1816

session.bye()

1624

1817

except gnutls.errors.GNUTLSError as error:

1625

logger.warning("GnuTLS bye failed")

1818

logger.warning("GnuTLS bye failed",

1819

exc_info=error)

1626

1820

1627

1821

@staticmethod

1628

1822

def peer_certificate(session):

1700

1894

def process_request(self, request, address):

1701

1895

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

1702

1896

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

1703

args = (request,

1704

address))

1897

args = (request, address))

1705

1898

proc.start()

1706

1899

return proc

1707

1900

1735

1928

use_ipv6: Boolean; to use IPv6 or not

1736

1929

"""

1737

1930

def __init__(self, server_address, RequestHandlerClass,

1738

interface=None, use_ipv6=True):

1931

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

1932

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

1933

creating a new one with socket.socket().

1934

"""

1739

1935

self.interface = interface

1740

1936

if use_ipv6:

1741

1937

self.address_family = socket.AF_INET6

1938

if socketfd is not None:

1939

# Save the file descriptor

1940

self.socketfd = socketfd

1941

# Save the original socket.socket() function

1942

self.socket_socket = socket.socket

1943

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

1944

#

1945

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

1946

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

1947

# patching socket.socket.)

1948

#

1949

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

1950

@functools.wraps(socket.socket)

1951

def socket_wrapper(*args, **kwargs):

1952

# Restore original function so subsequent calls are

1953

# not affected.

1954

socket.socket = self.socket_socket

1955

del self.socket_socket

1956

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

1957

# saved file descriptor.

1958

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

1959

# Replace socket.socket() function with wrapper

1960

socket.socket = socket_wrapper

1961

# The socketserver.TCPServer.__init__ will call

1962

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

1963

# socket_wrapper(), if socketfd was set.

1742

1964

socketserver.TCPServer.__init__(self, server_address,

1743

1965

RequestHandlerClass)

1966

1744

1967

def server_bind(self):

1745

1968

"""This overrides the normal server_bind() function

1746

1969

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

1754

1977

try:

1755

1978

self.socket.setsockopt(socket.SOL_SOCKET,

1756

1979

SO_BINDTODEVICE,

1757

str(self.interface

1758

+ '\0'))

1980

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

1759

1981

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:

1982

if error.errno == errno.EPERM:

1983

logger.error("No permission to bind to"

1984

" interface %s", self.interface)

1985

elif error.errno == errno.ENOPROTOOPT:

1765

1986

logger.error("SO_BINDTODEVICE not available;"

1766

1987

" cannot bind to interface %s",

1767

1988

self.interface)

1989

elif error.errno == errno.ENODEV:

1990

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

1991

" cannot bind", self.interface)

1768

1992

else:

1769

1993

raise

1770

1994

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

1773

1997

if self.address_family == socket.AF_INET6:

1774

1998

any_address = "::" # in6addr_any

1775

1999

else:

1776

any_address = socket.INADDR_ANY

2000

any_address = "0.0.0.0" # INADDR_ANY

1777

2001

self.server_address = (any_address,

1778

2002

self.server_address[1])

1779

2003

elif not self.server_address[1]:

1800

2024

"""

1801

2025

def __init__(self, server_address, RequestHandlerClass,

1802

2026

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

1803

gnutls_priority=None, use_dbus=True):

2027

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

1804

2028

self.enabled = False

1805

2029

self.clients = clients

1806

2030

if self.clients is None:

1810

2034

IPv6_TCPServer.__init__(self, server_address,

1811

2035

RequestHandlerClass,

1812

2036

interface = interface,

1813

use_ipv6 = use_ipv6)

2037

use_ipv6 = use_ipv6,

2038

socketfd = socketfd)

1814

2039

def server_activate(self):

1815

2040

if self.enabled:

1816

2041

return socketserver.TCPServer.server_activate(self)

1829

2054

1830

2055

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

1831

2056

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

2057

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

1847

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

2058

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

1848

2059

# Wait for other process to exit

1849

2060

proc.join()

1850

2061

return False

1908

2119

return True

1909

2120

1910

2121

2122

def rfc3339_duration_to_delta(duration):

2123

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

2124

2125

>>> rfc3339_duration_to_delta("P7D")

2126

datetime.timedelta(7)

2127

>>> rfc3339_duration_to_delta("PT60S")

2128

datetime.timedelta(0, 60)

2129

>>> rfc3339_duration_to_delta("PT60M")

2130

datetime.timedelta(0, 3600)

2131

>>> rfc3339_duration_to_delta("PT24H")

2132

datetime.timedelta(1)

2133

>>> rfc3339_duration_to_delta("P1W")

2134

datetime.timedelta(7)

2135

>>> rfc3339_duration_to_delta("PT5M30S")

2136

datetime.timedelta(0, 330)

2137

>>> rfc3339_duration_to_delta("P1DT3M20S")

2138

datetime.timedelta(1, 200)

2139

"""

2140

2141

# Parsing an RFC 3339 duration with regular expressions is not

2142

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

2143

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

2144

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

2145

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

2146

# avoid excessive use of external libraries.

2147

2148

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

2149

Token = collections.namedtuple("Token",

2150

("regexp", # To match token; if

2151

# "value" is not None,

2152

# must have a "group"

2153

# containing digits

2154

"value", # datetime.timedelta or

2155

# None

2156

"followers")) # Tokens valid after

2157

# this token

2158

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

2159

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

2160

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

2161

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

2162

datetime.timedelta(seconds=1),

2163

frozenset((token_end,)))

2164

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

2165

datetime.timedelta(minutes=1),

2166

frozenset((token_second, token_end)))

2167

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

2168

datetime.timedelta(hours=1),

2169

frozenset((token_minute, token_end)))

2170

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

2171

None,

2172

frozenset((token_hour, token_minute,

2173

token_second)))

2174

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

2175

datetime.timedelta(days=1),

2176

frozenset((token_time, token_end)))

2177

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

2178

datetime.timedelta(weeks=4),

2179

frozenset((token_day, token_end)))

2180

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

2181

datetime.timedelta(weeks=52),

2182

frozenset((token_month, token_end)))

2183

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

2184

datetime.timedelta(weeks=1),

2185

frozenset((token_end,)))

2186

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

2187

frozenset((token_year, token_month,

2188

token_day, token_time,

2189

token_week))),

2190

# Define starting values

2191

value = datetime.timedelta() # Value so far

2192

found_token = None

2193

followers = frozenset(token_duration,) # Following valid tokens

2194

s = duration # String left to parse

2195

# Loop until end token is found

2196

while found_token is not token_end:

2197

# Search for any currently valid tokens

2198

for token in followers:

2199

match = token.regexp.match(s)

2200

if match is not None:

2201

# Token found

2202

if token.value is not None:

2203

# Value found, parse digits

2204

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

2205

# Add to value so far

2206

value += factor * token.value

2207

# Strip token from string

2208

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

2209

# Go to found token

2210

found_token = token

2211

# Set valid next tokens

2212

followers = found_token.followers

2213

break

2214

else:

2215

# No currently valid tokens were found

2216

raise ValueError("Invalid RFC 3339 duration")

2217

# End token found

2218

return value

2219

2220

1911

2221

def string_to_delta(interval):

1912

2222

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

1913

2223

1924

2234

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

1925

2235

datetime.timedelta(0, 330)

1926

2236

"""

2237

2238

try:

2239

return rfc3339_duration_to_delta(interval)

2240

except ValueError:

2241

pass

2242

1927

2243

timevalue = datetime.timedelta(0)

1928

2244

for s in interval.split():

1929

2245

try:

1940

2256

elif suffix == "w":

1941

2257

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

1942

2258

else:

1943

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

2259

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

2260

.format(suffix))

1944

2261

except (ValueError, IndexError) as e:

1945

2262

raise ValueError(*(e.args))

1946

2263

timevalue += delta

1960

2277

sys.exit()

1961

2278

if not noclose:

1962

2279

# Close all standard open file descriptors

1963

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

2280

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

1964

2281

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

1965

2282

raise OSError(errno.ENODEV,

1966

"%s not a character device"

1967

% os.path.devnull)

2283

"{0} not a character device"

2284

.format(os.devnull))

1968

2285

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

1969

2286

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

1970

2287

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

1979

2296

1980

2297

parser = argparse.ArgumentParser()

1981

2298

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

1982

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

2299

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

1983

2300

help="show version number and exit")

1984

2301

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

1985

2302

help="Bind to interface IF")

1991

2308

help="Run self-test")

1992

2309

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

1993

2310

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

1994

" to terminal")

2311

" to terminal", default=None)

1995

2312

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

1996

2313

help="Debug level for stdout output")

1997

2314

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

2004

2321

" files")

2005

2322

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

2006

2323

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

2007

" system bus interface")

2324

" system bus interface", default=None)

2008

2325

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

2009

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

2326

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

2327

default=None)

2010

2328

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

2011

2329

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

2012

" state")

2330

" state", default=None)

2331

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

2332

help="Specify a file descriptor to a network"

2333

" socket to use instead of creating one")

2013

2334

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

2014

2335

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

2336

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

2337

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

2015

2338

2016

2339

options = parser.parse_args()

2017

2340

2026

2349

"port": "",

2027

2350

"debug": "False",

2028

2351

"priority":

2029

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

2352

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

2030

2353

"servicename": "Mandos",

2031

2354

"use_dbus": "True",

2032

2355

"use_ipv6": "True",

2033

2356

"debuglevel": "",

2034

2357

"restore": "True",

2035

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

2358

"socket": "",

2359

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

2360

"foreground": "False",

2036

2361

}

2037

2362

2038

2363

# Parse config file for server-global settings

2043

2368

# Convert the SafeConfigParser object to a dict

2044

2369

server_settings = server_config.defaults()

2045

2370

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

2046

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

2371

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

2047

2372

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

2048

2373

option)

2049

2374

if server_settings["port"]:

2050

2375

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

2051

2376

"port")

2377

if server_settings["socket"]:

2378

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

2379

"socket")

2380

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

2381

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

2382

# happen with a supplied network socket.

2383

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

2384

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

2385

["socket"])

2052

2386

del server_config

2053

2387

2054

2388

# Override the settings from the config file with command line

2056

2390

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

2057

2391

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

2058

2392

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

2059

"statedir"):

2393

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

2060

2394

value = getattr(options, option)

2061

2395

if value is not None:

2062

2396

server_settings[option] = value

2065

2399

for option in server_settings.keys():

2066

2400

if type(server_settings[option]) is str:

2067

2401

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

2402

# Force all boolean options to be boolean

2403

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

2404

"foreground"):

2405

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

2406

# Debug implies foreground

2407

if server_settings["debug"]:

2408

server_settings["foreground"] = True

2068

2409

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

2069

2410

2070

2411

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

2076

2417

use_ipv6 = server_settings["use_ipv6"]

2077

2418

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

2078

2419

stored_state_file)

2420

foreground = server_settings["foreground"]

2079

2421

2080

2422

if debug:

2081

initlogger(logging.DEBUG)

2423

initlogger(debug, logging.DEBUG)

2082

2424

else:

2083

2425

if not debuglevel:

2084

initlogger()

2426

initlogger(debug)

2085

2427

else:

2086

2428

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

2087

initlogger(level)

2429

initlogger(debug, level)

2088

2430

2089

2431

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

2090

2432

syslogger.setFormatter(logging.Formatter

2091

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

2092

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

2093

% server_settings["servicename"]))

2433

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

2434

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

2435

.format(server_settings

2436

["servicename"])))

2094

2437

2095

2438

# Parse config file with clients

2096

client_config = configparser.SafeConfigParser(Client.client_defaults)

2439

client_config = configparser.SafeConfigParser(Client

2440

.client_defaults)

2097

2441

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

2098

2442

"clients.conf"))

2099

2443

2108

2452

use_ipv6=use_ipv6,

2109

2453

gnutls_priority=

2110

2454

server_settings["priority"],

2111

use_dbus=use_dbus)

2112

if not debug:

2113

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

2455

use_dbus=use_dbus,

2456

socketfd=(server_settings["socket"]

2457

or None))

2458

if not foreground:

2459

pidfilename = "/run/mandos.pid"

2460

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

2461

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

2462

pidfile = None

2114

2463

try:

2115

2464

pidfile = open(pidfilename, "w")

2116

except IOError:

2117

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

2465

except IOError as e:

2466

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

2467

exc_info=e)

2118

2468

2119

try:

2120

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

2121

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

2122

except KeyError:

2469

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

2123

2470

try:

2124

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

2125

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

2471

uid = pwd.getpwnam(name).pw_uid

2472

gid = pwd.getpwnam(name).pw_gid

2473

break

2126

2474

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

2475

continue

2476

else:

2477

uid = 65534

2478

gid = 65534

2133

2479

try:

2134

2480

os.setgid(gid)

2135

2481

os.setuid(uid)

2136

2482

except OSError as error:

2137

if error[0] != errno.EPERM:

2483

if error.errno != errno.EPERM:

2138

2484

raise error

2139

2485

2140

2486

if debug:

2152

2498

.gnutls_global_set_log_function(debug_gnutls))

2153

2499

2154

2500

# Redirect stdin so all checkers get /dev/null

2155

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

2501

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

2156

2502

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

2157

2503

if null > 2:

2158

2504

os.close(null)

2159

else:

2160

# No console logging

2161

logger.removeHandler(console)

2162

2505

2163

2506

# Need to fork before connecting to D-Bus

2164

if not debug:

2507

if not foreground:

2165

2508

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

2166

2509

daemon()

2167

2510

2511

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

2512

# need to inform gobject that threads will be used.

2168

2513

gobject.threads_init()

2169

2514

2170

2515

global main_loop

2171

2516

# From the Avahi example code

2172

DBusGMainLoop(set_as_default=True )

2517

DBusGMainLoop(set_as_default=True)

2173

2518

main_loop = gobject.MainLoop()

2174

2519

bus = dbus.SystemBus()

2175

2520

# End of Avahi example code

2181

2526

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

2182

2527

do_not_queue=True))

2183

2528

except dbus.exceptions.NameExistsException as e:

2184

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

2529

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

2185

2530

use_dbus = False

2186

2531

server_settings["use_dbus"] = False

2187

2532

tcp_server.use_dbus = False

2199

2544

2200

2545

client_class = Client

2201

2546

if use_dbus:

2202

client_class = functools.partial(ClientDBusTransitional,

2203

bus = bus)

2547

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

2204

2548

2205

2549

client_settings = Client.config_parser(client_config)

2206

2550

old_client_settings = {}

2207

2551

clients_data = {}

2208

2552

2553

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

2554

global wnull

2555

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

2556

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

2557

# mode

2558

if debug or not foreground:

2559

wnull.close()

2560

2209

2561

# Get client data and settings from last running state.

2210

2562

if server_settings["restore"]:

2211

2563

try:

2214

2566

(stored_state))

2215

2567

os.remove(stored_state_path)

2216

2568

except IOError as e:

2217

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

2218

.format(e))

2219

if e.errno != errno.ENOENT:

2569

if e.errno == errno.ENOENT:

2570

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

2571

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

2572

else:

2573

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

2574

exc_info=e)

2220

2575

raise

2221

2576

except EOFError as e:

2222

2577

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

2223

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

2578

"EOFError:", exc_info=e)

2224

2579

2225

2580

with PGPEngine() as pgp:

2226

2581

for client_name, client in clients_data.iteritems():

2582

# Skip removed clients

2583

if client_name not in client_settings:

2584

continue

2585

2227

2586

# Decide which value to use after restoring saved state.

2228

2587

# We have three different values: Old config file,

2229

2588

# new config file, and saved state.

2243

2602

2244

2603

# Clients who has passed its expire date can still be

2245

2604

# enabled if its last checker was successful. Clients

2246

# whose checker failed before we stored its state is

2247

# assumed to have failed all checkers during downtime.

2605

# whose checker succeeded before we stored its state is

2606

# assumed to have successfully run all checkers during

2607

# downtime.

2248

2608

if client["enabled"]:

2249

2609

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

2250

2610

if not client["last_checked_ok"]:

2251

2611

logger.warning(

2252

2612

"disabling client {0} - Client never "

2253

"performed a successfull checker"

2254

.format(client["name"]))

2613

"performed a successful checker"

2614

.format(client_name))

2255

2615

client["enabled"] = False

2256

2616

elif client["last_checker_status"] != 0:

2257

2617

logger.warning(

2258

2618

"disabling client {0} - Client "

2259

2619

"last checker failed with error code {1}"

2260

.format(client["name"],

2620

.format(client_name,

2261

2621

client["last_checker_status"]))

2262

2622

client["enabled"] = False

2263

2623

else:

2264

2624

client["expires"] = (datetime.datetime

2265

2625

.utcnow()

2266

2626

+ client["timeout"])

2267

2627

logger.debug("Last checker succeeded,"

2628

" keeping {0} enabled"

2629

.format(client_name))

2268

2630

try:

2269

2631

client["secret"] = (

2270

2632

pgp.decrypt(client["encrypted_secret"],

2276

2638

.format(client_name))

2277

2639

client["secret"] = (

2278

2640

client_settings[client_name]["secret"])

2279

2280

2641

2281

2642

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

2282

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

2643

for client_name in (set(old_client_settings)

2644

- set(client_settings)):

2283

2645

del clients_data[client_name]

2284

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

2646

for client_name in (set(client_settings)

2647

- set(old_client_settings)):

2285

2648

clients_data[client_name] = client_settings[client_name]

2286

2287

# Create clients all clients

2649

2650

# Create all client objects

2288

2651

for client_name, client in clients_data.iteritems():

2289

2652

tcp_server.clients[client_name] = client_class(

2290

name = client_name, settings = client)

2653

name = client_name, settings = client,

2654

server_settings = server_settings)

2291

2655

2292

2656

if not tcp_server.clients:

2293

2657

logger.warning("No clients defined")

2294

2295

if not debug:

2296

try:

2297

with pidfile:

2298

pid = os.getpid()

2299

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

2300

del pidfile

2301

except IOError:

2302

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

2303

pidfilename, pid)

2304

except NameError:

2305

# "pidfile" was never created

2306

pass

2658

2659

if not foreground:

2660

if pidfile is not None:

2661

try:

2662

with pidfile:

2663

pid = os.getpid()

2664

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

2665

except IOError:

2666

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

2667

pidfilename, pid)

2668

del pidfile

2307

2669

del pidfilename

2308

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

2309

2670

2310

2671

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

2311

2672

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

2312

2673

2313

2674

if use_dbus:

2314

class MandosDBusService(dbus.service.Object):

2675

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

2676

"se.bsnet.fukt.Mandos"})

2677

class MandosDBusService(DBusObjectWithProperties):

2315

2678

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

2316

2679

def __init__(self):

2317

2680

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

2318

2681

_interface = "se.recompile.Mandos"

2319

2682

2683

@dbus_interface_annotations(_interface)

2684

def _foo(self):

2685

return { "org.freedesktop.DBus.Property"

2686

".EmitsChangedSignal":

2687

"false"}

2688

2320

2689

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

2321

2690

def ClientAdded(self, objpath):

2322

2691

"D-Bus signal"

2364

2733

2365

2734

del _interface

2366

2735

2367

class MandosDBusServiceTransitional(MandosDBusService):

2368

__metaclass__ = AlternateDBusNamesMetaclass

2369

mandos_dbus_service = MandosDBusServiceTransitional()

2736

mandos_dbus_service = MandosDBusService()

2370

2737

2371

2738

def cleanup():

2372

2739

"Cleanup function; run on exit"

2373

2740

service.cleanup()

2374

2741

2375

2742

multiprocessing.active_children()

2743

wnull.close()

2376

2744

if not (tcp_server.clients or client_settings):

2377

2745

return

2378

2746

2390

2758

# A list of attributes that can not be pickled

2391

2759

# + secret.

2392

2760

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

2393

"checker"))

2761

"checker", "server_settings"))

2394

2762

for name, typ in (inspect.getmembers

2395

2763

(dbus.service.Object)):

2396

2764

exclude.add(name)

2405

2773

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

2406

2774

2407

2775

try:

2408

with os.fdopen(os.open(stored_state_path,

2409

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

2410

0600), "wb") as stored_state:

2776

with (tempfile.NamedTemporaryFile

2777

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

2778

dir=os.path.dirname(stored_state_path),

2779

delete=False)) as stored_state:

2411

2780

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

2781

tempname=stored_state.name

2782

os.rename(tempname, stored_state_path)

2412

2783

except (IOError, OSError) as e:

2413

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

2414

.format(e))

2415

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

2416

raise

2784

if not debug:

2785

try:

2786

os.remove(tempname)

2787

except NameError:

2788

pass

2789

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

2790

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

2791

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

2792

else:

2793

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

2794

exc_info=e)

2795

raise e

2417

2796

2418

2797

# Delete all clients, and settings from config

2419

2798

while tcp_server.clients:

2446

2825

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

2447

2826

if use_ipv6:

2448

2827

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

2449

" flowinfo %d, scope_id %d"

2450

% tcp_server.socket.getsockname())

2828

" flowinfo %d, scope_id %d",

2829

*tcp_server.socket.getsockname())

2451

2830

else: # IPv4

2452

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

2453

% tcp_server.socket.getsockname())

2831

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

2832

*tcp_server.socket.getsockname())

2454

2833

2455

2834

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

2456

2835

2459

2838

try:

2460

2839

service.activate()

2461

2840

except dbus.exceptions.DBusException as error:

2462

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

2841

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

2463

2842

cleanup()

2464

2843

sys.exit(1)

2465

2844

# End of Avahi example code

2472

2851

logger.debug("Starting main loop")

2473

2852

main_loop.run()

2474

2853

except AvahiError as error:

2475

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

2854

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

2476

2855

cleanup()

2477

2856

sys.exit(1)

2478

2857

except KeyboardInterrupt: