/mandos/release : revision 237.17.6

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

39

37

import SocketServer as socketserver

40

38

import socket

41

39

import argparse

67

65

import types

68

66

import binascii

69

67

import tempfile

70

import itertools

71

import collections

72

68

73

69

import dbus

74

70

import dbus.service

79

75

import ctypes.util

80

76

import xml.dom.minidom

81

77

import inspect

78

import GnuPGInterface

82

79

83

80

try:

84

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

88

85

except ImportError:

89

86

SO_BINDTODEVICE = None

90

87

91

version = "1.6.4"

88

version = "1.4.1"

92

89

stored_state_file = "clients.pickle"

93

90

94

91

logger = logging.getLogger()

95

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

address = str("/dev/log")))

96

95

97

96

try:

98

97

if_nametoindex = (ctypes.cdll.LoadLibrary

114

113

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

115

114

"""init logger and add loglevel"""

116

115

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

address = str("/dev/log")))

121

116

syslogger.setFormatter(logging.Formatter

122

117

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

123

118

' %(message)s'))

141

136

class PGPEngine(object):

142

137

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

143

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

144

140

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

145

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

147

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet'])

150

146

151

147

def __enter__(self):

152

148

return self

153

149

154

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

150

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

155

151

self._cleanup()

156

152

return False

157

153

174

170

def password_encode(self, password):

175

171

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

176

172

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

177

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

178

if len(encoded) > 2048:

179

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

180

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

181

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

182

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

183

return encoded

173

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

184

174

185

175

def encrypt(self, data, password):

186

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

189

passfile.write(passphrase)

190

passfile.flush()

191

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

192

'--passphrase-file',

193

passfile.name]

194

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

199

if proc.returncode != 0:

200

raise PGPError(err)

176

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

177

with open(os.devnull) as devnull:

178

try:

179

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

180

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

181

attach_fhs={'stderr': devnull})

182

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

183

f.write(data)

184

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

185

ciphertext = f.read()

186

proc.wait()

187

except IOError as e:

188

raise PGPError(e)

189

self.gnupg.passphrase = None

201

190

return ciphertext

202

191

203

192

def decrypt(self, data, password):

204

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

207

passfile.write(passphrase)

208

passfile.flush()

209

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

210

'--passphrase-file',

211

passfile.name]

212

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

218

if proc.returncode != 0:

219

raise PGPError(err)

193

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

194

with open(os.devnull) as devnull:

195

try:

196

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

197

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

198

attach_fhs={'stderr': devnull})

199

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

200

f.write(data)

201

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

202

decrypted_plaintext = f.read()

203

proc.wait()

204

except IOError as e:

205

raise PGPError(e)

206

self.gnupg.passphrase = None

220

207

return decrypted_plaintext

221

208

222

209

210

223

211

class AvahiError(Exception):

224

212

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

225

213

self.value = value

242

230

Used to optionally bind to the specified interface.

243

231

name: string; Example: 'Mandos'

244

232

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

245

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

233

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

246

234

port: integer; what port to announce

247

235

TXT: list of strings; TXT record for the service

248

236

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

254

242

server: D-Bus Server

255

243

bus: dbus.SystemBus()

256

244

"""

257

258

245

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

259

246

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

260

247

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

273

260

self.server = None

274

261

self.bus = bus

275

262

self.entry_group_state_changed_match = None

276

277

263

def rename(self):

278

264

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

279

265

if self.rename_count >= self.max_renames:

289

275

try:

290

276

self.add()

291

277

except dbus.exceptions.DBusException as error:

292

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

278

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

293

279

self.cleanup()

294

280

os._exit(1)

295

281

self.rename_count += 1

296

297

282

def remove(self):

298

283

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

299

284

if self.entry_group_state_changed_match is not None:

301

286

self.entry_group_state_changed_match = None

302

287

if self.group is not None:

303

288

self.group.Reset()

304

305

289

def add(self):

306

290

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

307

291

self.remove()

324

308

dbus.UInt16(self.port),

325

309

avahi.string_array_to_txt_array(self.TXT))

326

310

self.group.Commit()

327

328

311

def entry_group_state_changed(self, state, error):

329

312

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

330

313

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

337

320

elif state == avahi.ENTRY_GROUP_FAILURE:

338

321

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

339

322

unicode(error))

340

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

341

.format(error))

342

323

raise AvahiGroupError("State changed: %s"

324

% unicode(error))

343

325

def cleanup(self):

344

326

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

345

327

if self.group is not None:

350

332

pass

351

333

self.group = None

352

334

self.remove()

353

354

335

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

355

336

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

356

337

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

375

356

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

376

357

else:

377

358

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

378

379

359

def activate(self):

380

360

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

381

361

if self.server is None:

388

368

self.server_state_changed)

389

369

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

390

370

391

392

371

class AvahiServiceToSyslog(AvahiService):

393

372

def rename(self):

394

373

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

395

374

ret = AvahiService.rename(self)

396

375

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

376

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

377

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

378

% self.name))

400

379

return ret

401

380

402

403

381

def timedelta_to_milliseconds(td):

404

382

"Convert a datetime.timedelta() to milliseconds"

405

383

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

406

384

+ (td.seconds * 1000)

407

385

+ (td.microseconds // 1000))

408

409

386

410

387

class Client(object):

411

388

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

412

389

437

414

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

438

415

last_checker_status: integer between 0 and 255 reflecting exit

439

416

status of last checker. -1 reflects crashed

440

checker, -2 means no checker completed yet.

417

checker, or None.

441

418

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

442

419

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

443

420

D-Bus identifiers

444

421

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

445

422

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

446

423

until this client is disabled

447

extended_timeout: extra long timeout when secret has been sent

424

extended_timeout: extra long timeout when password has been sent

448

425

runtime_expansions: Allowed attributes for runtime expansion.

449

426

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

450

427

disabled, or None

451

server_settings: The server_settings dict from main()

452

428

"""

453

429

454

430

runtime_expansions = ("approval_delay", "approval_duration",

455

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

456

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

457

"last_approval_request", "last_checked_ok",

431

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

432

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

458

433

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

462

437

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

463

438

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

466

441

"approved_by_default": "True",

467

442

"enabled": "True",

468

443

}

481

456

482

457

def approval_delay_milliseconds(self):

483

458

return timedelta_to_milliseconds(self.approval_delay)

484

459

485

460

@staticmethod

486

461

def config_parser(config):

487

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

462

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

488

463

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

489

with exceptions for any special settings as defined above.

490

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

491

value given the same arguments.

492

"""

464

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

493

465

settings = {}

494

466

for client_name in config.sections():

495

467

section = dict(config.items(client_name))

499

471

# Reformat values from string types to Python types

500

472

client["approved_by_default"] = config.getboolean(

501

473

client_name, "approved_by_default")

502

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

503

"enabled")

474

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

504

475

505

476

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

506

477

.replace(" ", ""))

512

483

"rb") as secfile:

513

484

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

514

485

else:

515

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

516

.format(section))

486

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

487

% section)

517

488

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

518

489

client["extended_timeout"] = string_to_delta(

519

490

section["extended_timeout"])

525

496

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

526

497

client["last_approval_request"] = None

527

498

client["last_checked_ok"] = None

528

client["last_checker_status"] = -2

529

499

client["last_checker_status"] = None

500

if client["enabled"]:

501

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

502

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

503

+ client["timeout"])

504

else:

505

client["last_enabled"] = None

506

client["expires"] = None

507

530

508

return settings

531

532

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

509

510

511

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

512

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

513

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

514

attribute."""

533

515

self.name = name

534

if server_settings is None:

535

server_settings = {}

536

self.server_settings = server_settings

537

516

# adding all client settings

538

517

for setting, value in settings.iteritems():

539

518

setattr(self, setting, value)

540

519

541

if self.enabled:

542

if not hasattr(self, "last_enabled"):

543

self.last_enabled = datetime.datetime.utcnow()

544

if not hasattr(self, "expires"):

545

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

546

+ self.timeout)

547

else:

548

self.last_enabled = None

549

self.expires = None

550

551

520

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

552

521

# Uppercase and remove spaces from fingerprint for later

553

522

# comparison purposes with return value from the fingerprint()

554

523

# function

555

524

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

556

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

557

datetime.datetime.utcnow())

558

525

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

526

559

527

# attributes specific for this server instance

560

528

self.checker = None

561

529

self.checker_initiator_tag = None

589

557

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

590

558

# Already enabled

591

559

return

560

self.send_changedstate()

592

561

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

593

562

self.enabled = True

594

563

self.last_enabled = datetime.datetime.utcnow()

595

564

self.init_checker()

596

self.send_changedstate()

597

565

598

566

def disable(self, quiet=True):

599

567

"""Disable this client."""

600

568

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

601

569

return False

602

570

if not quiet:

571

self.send_changedstate()

572

if not quiet:

603

573

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

604

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

574

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

605

575

gobject.source_remove(self.disable_initiator_tag)

606

576

self.disable_initiator_tag = None

607

577

self.expires = None

608

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

578

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

609

579

gobject.source_remove(self.checker_initiator_tag)

610

580

self.checker_initiator_tag = None

611

581

self.stop_checker()

612

582

self.enabled = False

613

if not quiet:

614

self.send_changedstate()

615

583

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

616

584

return False

617

585

621

589

def init_checker(self):

622

590

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

623

591

# and every interval from then on.

624

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

626

592

self.checker_initiator_tag = (gobject.timeout_add

627

593

(self.interval_milliseconds(),

628

594

self.start_checker))

629

595

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

630

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

632

596

self.disable_initiator_tag = (gobject.timeout_add

633

597

(self.timeout_milliseconds(),

634

598

self.disable))

653

617

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

654

618

vars(self))

655

619

656

def checked_ok(self):

657

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

658

self.last_checked_ok = datetime.datetime.utcnow()

659

self.last_checker_status = 0

660

self.bump_timeout()

661

662

def bump_timeout(self, timeout=None):

663

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

620

def checked_ok(self, timeout=None):

621

"""Bump up the timeout for this client.

622

623

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

624

alive and well.

625

"""

664

626

if timeout is None:

665

627

timeout = self.timeout

628

self.last_checked_ok = datetime.datetime.utcnow()

666

629

if self.disable_initiator_tag is not None:

667

630

gobject.source_remove(self.disable_initiator_tag)

668

self.disable_initiator_tag = None

669

631

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

670

632

self.disable_initiator_tag = (gobject.timeout_add

671

633

(timedelta_to_milliseconds

681

643

If a checker already exists, leave it running and do

682

644

nothing."""

683

645

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

684

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

685

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

686

# would inevitably timeout, since no checker would get a

687

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

646

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

647

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

648

# client would inevitably timeout, since no checker would get

649

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

688

650

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

689

651

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

690

652

# should be.

692

654

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

693

655

try:

694

656

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

657

except (AttributeError, OSError) as error:

658

if (isinstance(error, OSError)

659

and error.errno != errno.ECHILD):

660

raise error

700

661

else:

701

662

if pid:

702

663

logger.warning("Checker was a zombie")

705

666

self.current_checker_command)

706

667

# Start a new checker if needed

707

668

if self.checker is None:

708

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

713

669

try:

714

command = self.checker_command % escaped_attrs

715

except TypeError as error:

716

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

670

# In case checker_command has exactly one % operator

671

command = self.checker_command % self.host

672

except TypeError:

673

# Escape attributes for the shell

674

escaped_attrs = dict(

675

(attr,

676

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

677

errors=

678

'replace')))

679

for attr in

680

self.runtime_expansions)

681

682

try:

683

command = self.checker_command % escaped_attrs

684

except TypeError as error:

685

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

686

' %s', self.checker_command, error)

687

return True # Try again later

719

688

self.current_checker_command = command

720

689

try:

721

690

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

724

693

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

725

694

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

726

695

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

696

self.checker = subprocess.Popen(command,

736

697

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

698

shell=True, cwd="/")

699

self.checker_callback_tag = (gobject.child_watch_add

700

(self.checker.pid,

701

self.checker_callback,

702

data=command))

703

# The checker may have completed before the gobject

704

# watch was added. Check for this.

750

705

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

706

if pid:

707

gobject.source_remove(self.checker_callback_tag)

708

self.checker_callback(pid, status, command)

751

709

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

710

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

711

error)

761

712

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

762

713

return True

763

714

770

721

return

771

722

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

772

723

try:

773

self.checker.terminate()

724

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

774

725

#time.sleep(0.5)

775

726

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

776

# self.checker.kill()

727

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

777

728

except OSError as error:

778

729

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

779

730

raise

796

747

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

797

748

if byte_arrays and signature != "ay":

798

749

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

799

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

750

" signature %r" % signature)

800

751

def decorator(func):

801

752

func._dbus_is_property = True

802

753

func._dbus_interface = dbus_interface

810

761

return decorator

811

762

812

763

813

def dbus_interface_annotations(dbus_interface):

814

"""Decorator for marking functions returning interface annotations

815

816

Usage:

817

818

@dbus_interface_annotations("org.example.Interface")

819

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

820

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

821

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

822

"false"}

823

"""

824

def decorator(func):

825

func._dbus_is_interface = True

826

func._dbus_interface = dbus_interface

827

func._dbus_name = dbus_interface

828

return func

829

return decorator

830

831

832

def dbus_annotations(annotations):

833

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

834

Usage:

835

836

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

837

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

def Property_dbus_property(self):

842

return dbus.Boolean(False)

843

"""

844

def decorator(func):

845

func._dbus_annotations = annotations

846

return func

847

return decorator

848

849

850

764

class DBusPropertyException(dbus.exceptions.DBusException):

851

765

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

852

766

"""

875

789

"""

876

790

877

791

@staticmethod

878

def _is_dbus_thing(thing):

879

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

880

881

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

882

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

883

"""

884

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

885

False)

792

def _is_dbus_property(obj):

793

return getattr(obj, "_dbus_is_property", False)

886

794

887

def _get_all_dbus_things(self, thing):

795

def _get_all_dbus_properties(self):

888

796

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

889

797

"""

890

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

891

name),

892

athing.__get__(self))

798

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

893

799

for cls in self.__class__.__mro__

894

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

800

for name, prop in

801

inspect.getmembers(cls, self._is_dbus_property))

897

802

898

803

def _get_dbus_property(self, interface_name, property_name):

899

804

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

901

806

"""

902

807

for cls in self.__class__.__mro__:

903

808

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

809

(cls, self._is_dbus_property)):

906

810

if (value._dbus_name == property_name

907

811

and value._dbus_interface == interface_name):

908

812

return value.__get__(self)

936

840

# The byte_arrays option is not supported yet on

937

841

# signatures other than "ay".

938

842

if prop._dbus_signature != "ay":

939

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

940

"'ay' signature {0!r}"

941

.format(prop._dbus_signature))

942

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

943

for byte in value))

843

raise ValueError

844

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

845

for byte in value))

944

846

prop(value)

945

847

946

848

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

952

854

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

953

855

"""

954

856

properties = {}

955

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

857

for name, prop in self._get_all_dbus_properties():

956

858

if (interface_name

957

859

and interface_name != prop._dbus_interface):

958

860

# Interface non-empty but did not match

973

875

path_keyword='object_path',

974

876

connection_keyword='connection')

975

877

def Introspect(self, object_path, connection):

976

"""Overloading of standard D-Bus method.

977

978

Inserts property tags and interface annotation tags.

878

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

979

879

"""

980

880

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

981

881

connection)

988

888

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

989

889

return e

990

890

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

991

# Add property tags

992

891

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

993

892

for name, prop

994

in self._get_all_dbus_things("property")

893

in self._get_all_dbus_properties()

995

894

if prop._dbus_interface

996

895

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

997

896

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1029

897

# Add the names to the return values for the

1030

898

# "org.freedesktop.DBus.Properties" methods

1031

899

if (if_tag.getAttribute("name")

1046

914

except (AttributeError, xml.dom.DOMException,

1047

915

xml.parsers.expat.ExpatError) as error:

1048

916

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

1049

exc_info=error)

917

error)

1050

918

return xmlstring

1051

919

1052

920

1053

def datetime_to_dbus(dt, variant_level=0):

921

def datetime_to_dbus (dt, variant_level=0):

1054

922

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

1055

923

if dt is None:

1056

924

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

1058

926

variant_level=variant_level)

1059

927

1060

928

1061

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1062

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

1063

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

1064

interface names according to the "alt_interface_names" mapping.

1065

Usage:

1066

1067

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

1068

"net.example.AlternateInterface"})

1069

class SampleDBusObject(dbus.service.Object):

1070

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

1071

def SampleDBusMethod():

1072

pass

1073

1074

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

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

1076

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

1077

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

1078

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

1079

1080

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

1081

(from DBusObjectWithProperties) and interfaces (from the

1082

dbus_interface_annotations decorator).

929

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

930

.__metaclass__):

931

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

932

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

1083

933

"""

1084

def wrapper(cls):

1085

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1087

attr = {}

1088

interface_names = set()

1089

# Go though all attributes of the class

1090

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

934

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

935

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

936

# methods, signals, or properties in them

937

for base in (b for b in bases

938

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

939

# Go though all attributes of the base class

940

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

1091

941

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

1092

942

# with the wrong interface name

1093

943

if (not hasattr(attribute, "_dbus_interface")

1094

944

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

945

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

1096

946

continue

1097

947

# Create an alternate D-Bus interface name based on

1098

948

# the current name

1099

949

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1102

interface_names.add(alt_interface)

950

.replace("se.recompile.Mandos",

951

"se.bsnet.fukt.Mandos"))

1103

952

# Is this a D-Bus signal?

1104

953

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

1105

# Extract the original non-method undecorated

1106

# function by black magic

954

# Extract the original non-method function by

955

# black magic

1107

956

nonmethod_func = (dict(

1108

957

zip(attribute.func_code.co_freevars,

1109

958

attribute.__closure__))["func"]

1120

969

nonmethod_func.func_name,

1121

970

nonmethod_func.func_defaults,

1122

971

nonmethod_func.func_closure)))

1123

# Copy annotations, if any

1124

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1127

except AttributeError:

1128

pass

1129

972

# Define a creator of a function to call both the

1130

# original and alternate functions, so both the

1131

# original and alternate signals gets sent when

1132

# the function is called

973

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

974

# signals gets sent when the function is called

1133

975

def fixscope(func1, func2):

1134

976

"""This function is a scope container to pass

1135

977

func1 and func2 to the "call_both" function

1142

984

return call_both

1143

985

# Create the "call_both" function and add it to

1144

986

# the class

1145

attr[attrname] = fixscope(attribute, new_function)

987

attr[attrname] = fixscope(attribute,

988

new_function)

1146

989

# Is this a D-Bus method?

1147

990

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

1148

991

# Create a new, but exactly alike, function

1159

1002

attribute.func_name,

1160

1003

attribute.func_defaults,

1161

1004

attribute.func_closure)))

1162

# Copy annotations, if any

1163

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1166

except AttributeError:

1167

pass

1168

1005

# Is this a D-Bus property?

1169

1006

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

1170

1007

# Create a new, but exactly alike, function

1184

1021

attribute.func_name,

1185

1022

attribute.func_defaults,

1186

1023

attribute.func_closure)))

1187

# Copy annotations, if any

1188

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1191

except AttributeError:

1192

pass

1193

# Is this a D-Bus interface?

1194

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

1195

# Create a new, but exactly alike, function

1196

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

1197

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

1198

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1207

if deprecate:

1208

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1210

for interface_name in interface_names:

1211

@dbus_interface_annotations(interface_name)

1212

def func(self):

1213

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

1214

"true" }

1215

# Find an unused name

1216

for aname in (iname.format(i)

1217

for i in itertools.count()):

1218

if aname not in attr:

1219

attr[aname] = func

1220

break

1221

if interface_names:

1222

# Replace the class with a new subclass of it with

1223

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1226

return cls

1227

return wrapper

1228

1229

1230

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

1231

"se.bsnet.fukt.Mandos"})

1024

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

1025

1026

1232

1027

class ClientDBus(Client, DBusObjectWithProperties):

1233

1028

"""A Client class using D-Bus

1234

1029

1245

1040

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

1246

1041

self.bus = bus

1247

1042

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

1043

self._approvals_pending = 0

1044

1045

self._approvals_pending = 0

1248

1046

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

1249

1047

# the D-Bus

1250

1048

client_object_name = unicode(self.name).translate(

1254

1052

("/clients/" + client_object_name))

1255

1053

DBusObjectWithProperties.__init__(self, self.bus,

1256

1054

self.dbus_object_path)

1257

1055

1258

1056

def notifychangeproperty(transform_func,

1259

1057

dbus_name, type_func=lambda x: x,

1260

1058

variant_level=1):

1283

1081

1284

1082

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

1285

1083

1084

1286

1085

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1287

1086

approvals_pending = notifychangeproperty(dbus.Boolean,

1288

1087

"ApprovalPending",

1295

1094

checker is not None)

1296

1095

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1297

1096

"LastCheckedOK")

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1299

"LastCheckerStatus")

1300

1097

last_approval_request = notifychangeproperty(

1301

1098

datetime_to_dbus, "LastApprovalRequest")

1302

1099

approved_by_default = notifychangeproperty(dbus.Boolean,

1370

1167

return False

1371

1168

1372

1169

def approve(self, value=True):

1170

self.send_changedstate()

1373

1171

self.approved = value

1374

1172

gobject.timeout_add(timedelta_to_milliseconds

1375

1173

(self.approval_duration),

1376

1174

self._reset_approved)

1377

self.send_changedstate()

1175

1378

1176

1379

1177

## D-Bus methods, signals & properties

1380

1178

_interface = "se.recompile.Mandos.Client"

1381

1179

1382

## Interfaces

1383

1384

@dbus_interface_annotations(_interface)

1385

def _foo(self):

1386

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

1387

"false"}

1388

1389

1180

## Signals

1390

1181

1391

1182

# CheckerCompleted - signal

1427

1218

"D-Bus signal"

1428

1219

return self.need_approval()

1429

1220

1221

# NeRwequest - signal

1222

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

1223

def NewRequest(self, ip):

1224

"""D-Bus signal

1225

Is sent after a client request a password.

1226

"""

1227

pass

1228

1430

1229

## Methods

1431

1230

1432

1231

# Approve - method

1542

1341

return

1543

1342

return datetime_to_dbus(self.last_checked_ok)

1544

1343

1545

# LastCheckerStatus - property

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

1548

def LastCheckerStatus_dbus_property(self):

1549

return dbus.Int16(self.last_checker_status)

1550

1551

1344

# Expires - property

1552

1345

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

1553

1346

def Expires_dbus_property(self):

1564

1357

def Timeout_dbus_property(self, value=None):

1565

1358

if value is None: # get

1566

1359

return dbus.UInt64(self.timeout_milliseconds())

1567

old_timeout = self.timeout

1568

1360

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

1569

# Reschedule disabling

1570

if self.enabled:

1571

now = datetime.datetime.utcnow()

1572

self.expires += self.timeout - old_timeout

1573

if self.expires <= now:

1574

# The timeout has passed

1575

self.disable()

1576

else:

1577

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

1578

is None):

1579

return

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

timedelta_to_milliseconds(self.expires - now),

1584

self.disable))

1361

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

1362

return

1363

# Reschedule timeout

1364

gobject.source_remove(self.disable_initiator_tag)

1365

self.disable_initiator_tag = None

1366

self.expires = None

1367

time_to_die = timedelta_to_milliseconds((self

1368

.last_checked_ok

1369

+ self.timeout)

1370

- datetime.datetime

1371

.utcnow())

1372

if time_to_die <= 0:

1373

# The timeout has passed

1374

self.disable()

1375

else:

1376

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

1377

+ datetime.timedelta(milliseconds =

1378

time_to_die))

1379

self.disable_initiator_tag = (gobject.timeout_add

1380

(time_to_die, self.disable))

1585

1381

1586

1382

# ExtendedTimeout - property

1587

1383

@dbus_service_property(_interface, signature="t",

1666

1462

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

1667

1463

1668

1464

1465

class ClientDBusTransitional(ClientDBus):

1466

__metaclass__ = AlternateDBusNamesMetaclass

1467

1468

1669

1469

class ClientHandler(socketserver.BaseRequestHandler, object):

1670

1470

"""A class to handle client connections.

1671

1471

1707

1507

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

1708

1508

try:

1709

1509

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

1710

raise RuntimeError(line)

1510

raise RuntimeError

1711

1511

except (ValueError, IndexError, RuntimeError) as error:

1712

1512

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

1713

1513

return

1739

1539

except KeyError:

1740

1540

return

1741

1541

1542

if self.server.use_dbus:

1543

# Emit D-Bus signal

1544

client.NewRequest(str(self.client_address))

1545

1742

1546

if client.approval_delay:

1743

1547

delay = client.approval_delay

1744

1548

client.approvals_pending += 1

1775

1579

#wait until timeout or approved

1776

1580

time = datetime.datetime.now()

1777

1581

client.changedstate.acquire()

1778

client.changedstate.wait(

1779

float(timedelta_to_milliseconds(delay)

1780

/ 1000))

1582

(client.changedstate.wait

1583

(float(client.timedelta_to_milliseconds(delay)

1584

/ 1000)))

1781

1585

client.changedstate.release()

1782

1586

time2 = datetime.datetime.now()

1783

1587

if (time2 - time) >= delay:

1799

1603

try:

1800

1604

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

1801

1605

except gnutls.errors.GNUTLSError as error:

1802

logger.warning("gnutls send failed",

1803

exc_info=error)

1606

logger.warning("gnutls send failed")

1804

1607

return

1805

1608

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

1806

1609

sent, len(client.secret)

1809

1612

1810

1613

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

1811

1614

# bump the timeout using extended_timeout

1812

client.bump_timeout(client.extended_timeout)

1615

client.checked_ok(client.extended_timeout)

1813

1616

if self.server.use_dbus:

1814

1617

# Emit D-Bus signal

1815

1618

client.GotSecret()

1820

1623

try:

1821

1624

session.bye()

1822

1625

except gnutls.errors.GNUTLSError as error:

1823

logger.warning("GnuTLS bye failed",

1824

exc_info=error)

1626

logger.warning("GnuTLS bye failed")

1825

1627

1826

1628

@staticmethod

1827

1629

def peer_certificate(session):

1899

1701

def process_request(self, request, address):

1900

1702

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

1901

1703

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

1902

args = (request, address))

1704

args = (request,

1705

address))

1903

1706

proc.start()

1904

1707

return proc

1905

1708

1920

1723

1921

1724

def add_pipe(self, parent_pipe, proc):

1922

1725

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

1923

raise NotImplementedError()

1726

raise NotImplementedError

1924

1727

1925

1728

1926

1729

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1933

1736

use_ipv6: Boolean; to use IPv6 or not

1934

1737

"""

1935

1738

def __init__(self, server_address, RequestHandlerClass,

1936

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

1937

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

1938

creating a new one with socket.socket().

1939

"""

1739

interface=None, use_ipv6=True):

1940

1740

self.interface = interface

1941

1741

if use_ipv6:

1942

1742

self.address_family = socket.AF_INET6

1943

if socketfd is not None:

1944

# Save the file descriptor

1945

self.socketfd = socketfd

1946

# Save the original socket.socket() function

1947

self.socket_socket = socket.socket

1948

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

1949

#

1950

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

1951

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

1952

# patching socket.socket.)

1953

#

1954

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

1955

@functools.wraps(socket.socket)

1956

def socket_wrapper(*args, **kwargs):

1957

# Restore original function so subsequent calls are

1958

# not affected.

1959

socket.socket = self.socket_socket

1960

del self.socket_socket

1961

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

1962

# saved file descriptor.

1963

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

1964

# Replace socket.socket() function with wrapper

1965

socket.socket = socket_wrapper

1966

# The socketserver.TCPServer.__init__ will call

1967

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

1968

# socket_wrapper(), if socketfd was set.

1969

1743

socketserver.TCPServer.__init__(self, server_address,

1970

1744

RequestHandlerClass)

1971

1972

1745

def server_bind(self):

1973

1746

"""This overrides the normal server_bind() function

1974

1747

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

1982

1755

try:

1983

1756

self.socket.setsockopt(socket.SOL_SOCKET,

1984

1757

SO_BINDTODEVICE,

1985

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

1758

str(self.interface

1759

+ '\0'))

1986

1760

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1761

if error[0] == errno.EPERM:

1762

logger.error("No permission to"

1763

" bind to interface %s",

1764

self.interface)

1765

elif error[0] == errno.ENOPROTOOPT:

1991

1766

logger.error("SO_BINDTODEVICE not available;"

1992

1767

" cannot bind to interface %s",

1993

1768

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

1769

else:

1998

1770

raise

1999

1771

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

2002

1774

if self.address_family == socket.AF_INET6:

2003

1775

any_address = "::" # in6addr_any

2004

1776

else:

2005

any_address = "0.0.0.0" # INADDR_ANY

1777

any_address = socket.INADDR_ANY

2006

1778

self.server_address = (any_address,

2007

1779

self.server_address[1])

2008

1780

elif not self.server_address[1]:

2029

1801

"""

2030

1802

def __init__(self, server_address, RequestHandlerClass,

2031

1803

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

2032

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

1804

gnutls_priority=None, use_dbus=True):

2033

1805

self.enabled = False

2034

1806

self.clients = clients

2035

1807

if self.clients is None:

2039

1811

IPv6_TCPServer.__init__(self, server_address,

2040

1812

RequestHandlerClass,

2041

1813

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

1814

use_ipv6 = use_ipv6)

2044

1815

def server_activate(self):

2045

1816

if self.enabled:

2046

1817

return socketserver.TCPServer.server_activate(self)

2059

1830

2060

1831

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

2061

1832

proc = None, client_object=None):

1833

condition_names = {

1834

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

1835

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

1836

# blocking).

1837

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

1838

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

1839

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

1840

# broken, usually for pipes and

1841

# sockets).

1842

}

1843

conditions_string = ' | '.join(name

1844

for cond, name in

1845

condition_names.iteritems()

1846

if cond & condition)

2062

1847

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

2063

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

1848

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

2064

1849

# Wait for other process to exit

2065

1850

proc.join()

2066

1851

return False

2124

1909

return True

2125

1910

2126

1911

2127

def rfc3339_duration_to_delta(duration):

2128

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

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

2144

"""

2145

2146

# Parsing an RFC 3339 duration with regular expressions is not

2147

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

2148

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

2149

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

2150

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

2151

# avoid excessive use of external libraries.

2152

2153

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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2163

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

2164

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

2165

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

2166

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

2167

datetime.timedelta(seconds=1),

2168

frozenset((token_end,)))

2169

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

2170

datetime.timedelta(minutes=1),

2171

frozenset((token_second, token_end)))

2172

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

2173

datetime.timedelta(hours=1),

2174

frozenset((token_minute, token_end)))

2175

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

2176

None,

2177

frozenset((token_hour, token_minute,

2178

token_second)))

2179

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

2180

datetime.timedelta(days=1),

2181

frozenset((token_time, token_end)))

2182

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

2183

datetime.timedelta(weeks=4),

2184

frozenset((token_day, token_end)))

2185

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

2186

datetime.timedelta(weeks=52),

2187

frozenset((token_month, token_end)))

2188

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

2189

datetime.timedelta(weeks=1),

2190

frozenset((token_end,)))

2191

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

2192

frozenset((token_year, token_month,

2193

token_day, token_time,

2194

token_week))),

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2197

found_token = None

2198

followers = frozenset(token_duration,) # Following valid tokens

2199

s = duration # String left to parse

2200

# Loop until end token is found

2201

while found_token is not token_end:

2202

# Search for any currently valid tokens

2203

for token in followers:

2204

match = token.regexp.match(s)

2205

if match is not None:

2206

# Token found

2207

if token.value is not None:

2208

# Value found, parse digits

2209

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

2210

# Add to value so far

2211

value += factor * token.value

2212

# Strip token from string

2213

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

2214

# Go to found token

2215

found_token = token

2216

# Set valid next tokens

2217

followers = found_token.followers

2218

break

2219

else:

2220

# No currently valid tokens were found

2221

raise ValueError("Invalid RFC 3339 duration")

2222

# End token found

2223

return value

2224

2225

2226

1912

def string_to_delta(interval):

2227

1913

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

2228

1914

2239

1925

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

2240

1926

datetime.timedelta(0, 330)

2241

1927

"""

2242

2243

try:

2244

return rfc3339_duration_to_delta(interval)

2245

except ValueError:

2246

pass

2247

2248

1928

timevalue = datetime.timedelta(0)

2249

1929

for s in interval.split():

2250

1930

try:

2261

1941

elif suffix == "w":

2262

1942

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

2263

1943

else:

2264

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

2265

.format(suffix))

2266

except IndexError as e:

1944

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

1945

except (ValueError, IndexError) as e:

2267

1946

raise ValueError(*(e.args))

2268

1947

timevalue += delta

2269

1948

return timevalue

2282

1961

sys.exit()

2283

1962

if not noclose:

2284

1963

# Close all standard open file descriptors

2285

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

1964

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

2286

1965

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

2287

1966

raise OSError(errno.ENODEV,

2288

"{0} not a character device"

2289

.format(os.devnull))

1967

"%s not a character device"

1968

% os.path.devnull)

2290

1969

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

2291

1970

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

2292

1971

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

2301

1980

2302

1981

parser = argparse.ArgumentParser()

2303

1982

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

2304

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

1983

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

2305

1984

help="show version number and exit")

2306

1985

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

2307

1986

help="Bind to interface IF")

2313

1992

help="Run self-test")

2314

1993

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

2315

1994

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

2316

" to terminal", default=None)

1995

" to terminal")

2317

1996

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

2318

1997

help="Debug level for stdout output")

2319

1998

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

2326

2005

" files")

2327

2006

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

2328

2007

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

2329

" system bus interface", default=None)

2008

" system bus interface")

2330

2009

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

2331

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

2332

default=None)

2010

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

2333

2011

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

2334

2012

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

2335

" state", default=None)

2336

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

2337

help="Specify a file descriptor to a network"

2338

" socket to use instead of creating one")

2013

" state")

2339

2014

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

2340

2015

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

2341

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

2342

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

2343

2016

2344

2017

options = parser.parse_args()

2345

2018

2346

2019

if options.check:

2347

2020

import doctest

2348

fail_count, test_count = doctest.testmod()

2349

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

2021

doctest.testmod()

2022

sys.exit()

2350

2023

2351

2024

# Default values for config file for server-global settings

2352

2025

server_defaults = { "interface": "",

2354

2027

"port": "",

2355

2028

"debug": "False",

2356

2029

"priority":

2357

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

2030

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

2358

2031

"servicename": "Mandos",

2359

2032

"use_dbus": "True",

2360

2033

"use_ipv6": "True",

2361

2034

"debuglevel": "",

2362

2035

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2036

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

2366

2037

}

2367

2038

2368

2039

# Parse config file for server-global settings

2373

2044

# Convert the SafeConfigParser object to a dict

2374

2045

server_settings = server_config.defaults()

2375

2046

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

2376

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

2047

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

2377

2048

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

2378

2049

option)

2379

2050

if server_settings["port"]:

2380

2051

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

2381

2052

"port")

2382

if server_settings["socket"]:

2383

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

2384

"socket")

2385

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

2386

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

2387

# happen with a supplied network socket.

2388

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

2389

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

2390

["socket"])

2391

2053

del server_config

2392

2054

2393

2055

# Override the settings from the config file with command line

2395

2057

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

2396

2058

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

2397

2059

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

2398

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

2060

"statedir"):

2399

2061

value = getattr(options, option)

2400

2062

if value is not None:

2401

2063

server_settings[option] = value

2404

2066

for option in server_settings.keys():

2405

2067

if type(server_settings[option]) is str:

2406

2068

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

2407

# Force all boolean options to be boolean

2408

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

2409

"foreground"):

2410

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

2411

# Debug implies foreground

2412

if server_settings["debug"]:

2413

server_settings["foreground"] = True

2414

2069

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

2415

2070

2416

2071

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

2422

2077

use_ipv6 = server_settings["use_ipv6"]

2423

2078

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

2424

2079

stored_state_file)

2425

foreground = server_settings["foreground"]

2426

2080

2427

2081

if debug:

2428

2082

initlogger(debug, logging.DEBUG)

2435

2089

2436

2090

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

2437

2091

syslogger.setFormatter(logging.Formatter

2438

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

2439

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

2440

.format(server_settings

2441

["servicename"])))

2092

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

2093

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

2094

% server_settings["servicename"]))

2442

2095

2443

2096

# Parse config file with clients

2444

client_config = configparser.SafeConfigParser(Client

2445

.client_defaults)

2097

client_config = configparser.SafeConfigParser(Client.client_defaults)

2446

2098

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

2447

2099

"clients.conf"))

2448

2100

2457

2109

use_ipv6=use_ipv6,

2458

2110

gnutls_priority=

2459

2111

server_settings["priority"],

2460

use_dbus=use_dbus,

2461

socketfd=(server_settings["socket"]

2462

or None))

2463

if not foreground:

2464

pidfilename = "/run/mandos.pid"

2465

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

2466

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

2467

pidfile = None

2112

use_dbus=use_dbus)

2113

if not debug:

2114

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

2468

2115

try:

2469

2116

pidfile = open(pidfilename, "w")

2470

except IOError as e:

2471

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

2472

exc_info=e)

2117

except IOError:

2118

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

2473

2119

2474

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

2120

try:

2121

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

2122

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

2123

except KeyError:

2475

2124

try:

2476

uid = pwd.getpwnam(name).pw_uid

2477

gid = pwd.getpwnam(name).pw_gid

2478

break

2125

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

2126

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

2479

2127

except KeyError:

2480

continue

2481

else:

2482

uid = 65534

2483

gid = 65534

2128

try:

2129

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

2130

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

2131

except KeyError:

2132

uid = 65534

2133

gid = 65534

2484

2134

try:

2485

2135

os.setgid(gid)

2486

2136

os.setuid(uid)

2487

2137

except OSError as error:

2488

if error.errno != errno.EPERM:

2489

raise

2138

if error[0] != errno.EPERM:

2139

raise error

2490

2140

2491

2141

if debug:

2492

2142

# Enable all possible GnuTLS debugging

2503

2153

.gnutls_global_set_log_function(debug_gnutls))

2504

2154

2505

2155

# Redirect stdin so all checkers get /dev/null

2506

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

2156

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

2507

2157

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

2508

2158

if null > 2:

2509

2159

os.close(null)

2510

2160

2511

2161

# Need to fork before connecting to D-Bus

2512

if not foreground:

2162

if not debug:

2513

2163

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

2514

2164

daemon()

2515

2165

2516

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

2517

# need to inform gobject that threads will be used.

2518

2166

gobject.threads_init()

2519

2167

2520

2168

global main_loop

2521

2169

# From the Avahi example code

2522

DBusGMainLoop(set_as_default=True)

2170

DBusGMainLoop(set_as_default=True )

2523

2171

main_loop = gobject.MainLoop()

2524

2172

bus = dbus.SystemBus()

2525

2173

# End of Avahi example code

2531

2179

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

2532

2180

do_not_queue=True))

2533

2181

except dbus.exceptions.NameExistsException as e:

2534

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

2182

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

2535

2183

use_dbus = False

2536

2184

server_settings["use_dbus"] = False

2537

2185

tcp_server.use_dbus = False

2549

2197

2550

2198

client_class = Client

2551

2199

if use_dbus:

2552

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

2200

client_class = functools.partial(ClientDBusTransitional,

2201

bus = bus)

2553

2202

2554

2203

client_settings = Client.config_parser(client_config)

2555

2204

old_client_settings = {}

2556

2205

clients_data = {}

2557

2206

2558

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

2559

global wnull

2560

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

2561

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

2562

# mode

2563

if debug or not foreground:

2564

wnull.close()

2565

2566

2207

# Get client data and settings from last running state.

2567

2208

if server_settings["restore"]:

2568

2209

try:

2571

2212

(stored_state))

2572

2213

os.remove(stored_state_path)

2573

2214

except IOError as e:

2574

if e.errno == errno.ENOENT:

2575

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

2576

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

2577

else:

2578

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

2579

exc_info=e)

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

2580

2218

raise

2581

2219

except EOFError as e:

2582

2220

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

2583

"EOFError:", exc_info=e)

2221

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

2584

2222

2585

2223

with PGPEngine() as pgp:

2586

2224

for client_name, client in clients_data.iteritems():

2587

# Skip removed clients

2588

if client_name not in client_settings:

2589

continue

2590

2591

2225

# Decide which value to use after restoring saved state.

2592

2226

# We have three different values: Old config file,

2593

2227

# new config file, and saved state.

2607

2241

2608

2242

# Clients who has passed its expire date can still be

2609

2243

# enabled if its last checker was successful. Clients

2610

# whose checker succeeded before we stored its state is

2611

# assumed to have successfully run all checkers during

2612

# downtime.

2244

# whose checker failed before we stored its state is

2245

# assumed to have failed all checkers during downtime.

2613

2246

if client["enabled"]:

2614

2247

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

2615

2248

if not client["last_checked_ok"]:

2616

2249

logger.warning(

2617

2250

"disabling client {0} - Client never "

2618

"performed a successful checker"

2619

.format(client_name))

2251

"performed a successfull checker"

2252

.format(client["name"]))

2620

2253

client["enabled"] = False

2621

2254

elif client["last_checker_status"] != 0:

2622

2255

logger.warning(

2623

2256

"disabling client {0} - Client "

2624

2257

"last checker failed with error code {1}"

2625

.format(client_name,

2258

.format(client["name"],

2626

2259

client["last_checker_status"]))

2627

2260

client["enabled"] = False

2628

2261

else:

2629

2262

client["expires"] = (datetime.datetime

2630

2263

.utcnow()

2631

2264

+ client["timeout"])

2632

logger.debug("Last checker succeeded,"

2633

" keeping {0} enabled"

2634

.format(client_name))

2265

2635

2266

try:

2636

2267

client["secret"] = (

2637

2268

pgp.decrypt(client["encrypted_secret"],

2643

2274

.format(client_name))

2644

2275

client["secret"] = (

2645

2276

client_settings[client_name]["secret"])

2277

2646

2278

2647

2279

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

2648

for client_name in (set(old_client_settings)

2649

- set(client_settings)):

2280

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

2650

2281

del clients_data[client_name]

2651

for client_name in (set(client_settings)

2652

- set(old_client_settings)):

2282

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

2653

2283

clients_data[client_name] = client_settings[client_name]

2654

2655

# Create all client objects

2284

2285

# Create clients all clients

2656

2286

for client_name, client in clients_data.iteritems():

2657

2287

tcp_server.clients[client_name] = client_class(

2658

name = client_name, settings = client,

2659

server_settings = server_settings)

2288

name = client_name, settings = client)

2660

2289

2661

2290

if not tcp_server.clients:

2662

2291

logger.warning("No clients defined")

2663

2664

if not foreground:

2665

if pidfile is not None:

2666

try:

2667

with pidfile:

2668

pid = os.getpid()

2669

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

2670

except IOError:

2671

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

2672

pidfilename, pid)

2673

del pidfile

2292

2293

if not debug:

2294

try:

2295

with pidfile:

2296

pid = os.getpid()

2297

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

2298

del pidfile

2299

except IOError:

2300

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

2301

pidfilename, pid)

2302

except NameError:

2303

# "pidfile" was never created

2304

pass

2674

2305

del pidfilename

2306

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

2675

2307

2676

2308

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

2677

2309

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

2678

2310

2679

2311

if use_dbus:

2680

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

2681

"se.bsnet.fukt.Mandos"})

2682

class MandosDBusService(DBusObjectWithProperties):

2312

class MandosDBusService(dbus.service.Object):

2683

2313

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

2684

2314

def __init__(self):

2685

2315

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

2686

2316

_interface = "se.recompile.Mandos"

2687

2317

2688

@dbus_interface_annotations(_interface)

2689

def _foo(self):

2690

return { "org.freedesktop.DBus.Property"

2691

".EmitsChangedSignal":

2692

"false"}

2693

2694

2318

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

2695

2319

def ClientAdded(self, objpath):

2696

2320

"D-Bus signal"

2738

2362

2739

2363

del _interface

2740

2364

2741

mandos_dbus_service = MandosDBusService()

2365

class MandosDBusServiceTransitional(MandosDBusService):

2366

__metaclass__ = AlternateDBusNamesMetaclass

2367

mandos_dbus_service = MandosDBusServiceTransitional()

2742

2368

2743

2369

def cleanup():

2744

2370

"Cleanup function; run on exit"

2745

2371

service.cleanup()

2746

2372

2747

2373

multiprocessing.active_children()

2748

wnull.close()

2749

2374

if not (tcp_server.clients or client_settings):

2750

2375

return

2751

2376

2763

2388

# A list of attributes that can not be pickled

2764

2389

# + secret.

2765

2390

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

2766

"checker", "server_settings"))

2391

"checker"))

2767

2392

for name, typ in (inspect.getmembers

2768

2393

(dbus.service.Object)):

2769

2394

exclude.add(name)

2778

2403

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

2779

2404

2780

2405

try:

2781

with (tempfile.NamedTemporaryFile

2782

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

2783

dir=os.path.dirname(stored_state_path),

2784

delete=False)) as stored_state:

2406

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

2407

prefix="clients-",

2408

dir=os.path.dirname

2409

(stored_state_path))

2410

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

2785

2411

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

2786

tempname=stored_state.name

2787

2412

os.rename(tempname, stored_state_path)

2788

2413

except (IOError, OSError) as e:

2414

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

2415

.format(e))

2789

2416

if not debug:

2790

2417

try:

2791

2418

os.remove(tempname)

2792

2419

except NameError:

2793

2420

pass

2794

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

2795

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

2796

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

2797

else:

2798

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

2799

exc_info=e)

2800

raise

2421

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

2422

errno.EEXIST)):

2423

raise e

2801

2424

2802

2425

# Delete all clients, and settings from config

2803

2426

while tcp_server.clients:

2830

2453

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

2831

2454

if use_ipv6:

2832

2455

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

2833

" flowinfo %d, scope_id %d",

2834

*tcp_server.socket.getsockname())

2456

" flowinfo %d, scope_id %d"

2457

% tcp_server.socket.getsockname())

2835

2458

else: # IPv4

2836

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

2837

*tcp_server.socket.getsockname())

2459

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

2460

% tcp_server.socket.getsockname())

2838

2461

2839

2462

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

2840

2463

2843

2466

try:

2844

2467

service.activate()

2845

2468

except dbus.exceptions.DBusException as error:

2846

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

2469

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

2847

2470

cleanup()

2848

2471

sys.exit(1)

2849

2472

# End of Avahi example code

2856

2479

logger.debug("Starting main loop")

2857

2480

main_loop.run()

2858

2481

except AvahiError as error:

2859

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

2482

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

2860

2483

cleanup()

2861

2484

sys.exit(1)

2862

2485

except KeyboardInterrupt: