/mandos/release : revision 237.7.203

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

65

67

import types

66

68

import binascii

67

69

import tempfile

70

import itertools

71

import collections

68

72

69

73

import dbus

70

74

import dbus.service

75

79

import ctypes.util

76

80

import xml.dom.minidom

77

81

import inspect

78

import GnuPGInterface

79

82

80

83

try:

81

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

88

except ImportError:

86

89

SO_BINDTODEVICE = None

87

90

88

version = "1.4.1"

91

version = "1.6.3"

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

95

syslogger = None

95

96

97

try:

97

98

if_nametoindex = (ctypes.cdll.LoadLibrary

113

114

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

114

115

"""init logger and add loglevel"""

115

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

116

121

syslogger.setFormatter(logging.Formatter

117

122

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

118

123

' %(message)s'))

136

141

class PGPEngine(object):

137

142

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

138

143

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

144

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

145

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

147

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

147

150

148

151

def __enter__(self):

149

152

return self

150

153

151

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

154

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

152

155

self._cleanup()

153

156

return False

154

157

171

174

def password_encode(self, password):

172

175

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

173

176

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

174

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

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

175

184

176

185

def encrypt(self, data, password):

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

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)

191

201

return ciphertext

192

202

193

203

def decrypt(self, data, password):

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

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)

208

220

return decrypted_plaintext

209

221

210

222

211

212

223

class AvahiError(Exception):

213

224

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

214

225

self.value = value

231

242

Used to optionally bind to the specified interface.

232

243

name: string; Example: 'Mandos'

233

244

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

234

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

245

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

235

246

port: integer; what port to announce

236

247

TXT: list of strings; TXT record for the service

237

248

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

243

254

server: D-Bus Server

244

255

bus: dbus.SystemBus()

245

256

"""

257

246

258

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

247

259

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

248

260

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

261

273

self.server = None

262

274

self.bus = bus

263

275

self.entry_group_state_changed_match = None

276

264

277

def rename(self):

265

278

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

266

279

if self.rename_count >= self.max_renames:

276

289

try:

277

290

self.add()

278

291

except dbus.exceptions.DBusException as error:

279

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

292

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

280

293

self.cleanup()

281

294

os._exit(1)

282

295

self.rename_count += 1

296

283

297

def remove(self):

284

298

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

285

299

if self.entry_group_state_changed_match is not None:

287

301

self.entry_group_state_changed_match = None

288

302

if self.group is not None:

289

303

self.group.Reset()

304

290

305

def add(self):

291

306

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

292

307

self.remove()

309

324

dbus.UInt16(self.port),

310

325

avahi.string_array_to_txt_array(self.TXT))

311

326

self.group.Commit()

327

312

328

def entry_group_state_changed(self, state, error):

313

329

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

314

330

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

321

337

elif state == avahi.ENTRY_GROUP_FAILURE:

322

338

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

323

339

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

340

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

341

.format(error))

342

326

343

def cleanup(self):

327

344

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

328

345

if self.group is not None:

333

350

pass

334

351

self.group = None

335

352

self.remove()

353

336

354

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

337

355

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

338

356

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

357

375

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

358

376

else:

359

377

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

378

360

379

def activate(self):

361

380

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

362

381

if self.server is None:

369

388

self.server_state_changed)

370

389

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

371

390

391

372

392

class AvahiServiceToSyslog(AvahiService):

373

393

def rename(self):

374

394

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

375

395

ret = AvahiService.rename(self)

376

396

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

397

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

398

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

399

.format(self.name)))

380

400

return ret

381

401

402

382

403

def timedelta_to_milliseconds(td):

383

404

"Convert a datetime.timedelta() to milliseconds"

384

405

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

385

406

+ (td.seconds * 1000)

386

407

+ (td.microseconds // 1000))

387

408

409

388

410

class Client(object):

389

411

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

390

412

415

437

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

416

438

last_checker_status: integer between 0 and 255 reflecting exit

417

439

status of last checker. -1 reflects crashed

418

checker, or None.

440

checker, -2 means no checker completed yet.

419

441

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

420

442

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

421

443

D-Bus identifiers

422

444

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

423

445

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

424

446

until this client is disabled

425

extended_timeout: extra long timeout when password has been sent

447

extended_timeout: extra long timeout when secret has been sent

426

448

runtime_expansions: Allowed attributes for runtime expansion.

427

449

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

428

450

disabled, or None

451

server_settings: The server_settings dict from main()

429

452

"""

430

453

431

454

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

455

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

456

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

457

"last_approval_request", "last_checked_ok",

434

458

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

438

462

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

439

463

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

442

466

"approved_by_default": "True",

443

467

"enabled": "True",

444

468

}

457

481

458

482

def approval_delay_milliseconds(self):

459

483

return timedelta_to_milliseconds(self.approval_delay)

460

484

461

485

@staticmethod

462

486

def config_parser(config):

463

487

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

488

512

"rb") as secfile:

489

513

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

490

514

else:

491

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

492

% section)

515

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

516

.format(section))

493

517

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

494

518

client["extended_timeout"] = string_to_delta(

495

519

section["extended_timeout"])

501

525

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

502

526

client["last_approval_request"] = None

503

527

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

528

client["last_checker_status"] = -2

505

529

506

530

return settings

507

508

509

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

510

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

511

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

512

attribute."""

531

532

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

513

533

self.name = name

534

if server_settings is None:

535

server_settings = {}

536

self.server_settings = server_settings

514

537

# adding all client settings

515

538

for setting, value in settings.iteritems():

516

539

setattr(self, setting, value)

524

547

else:

525

548

self.last_enabled = None

526

549

self.expires = None

527

550

528

551

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

529

552

# Uppercase and remove spaces from fingerprint for later

530

553

# comparison purposes with return value from the fingerprint()

532

555

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

533

556

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

534

557

datetime.datetime.utcnow())

535

558

536

559

# attributes specific for this server instance

537

560

self.checker = None

538

561

self.checker_initiator_tag = None

566

589

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

567

590

# Already enabled

568

591

return

569

self.send_changedstate()

570

592

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

571

593

self.enabled = True

572

594

self.last_enabled = datetime.datetime.utcnow()

573

595

self.init_checker()

596

self.send_changedstate()

574

597

575

598

def disable(self, quiet=True):

576

599

"""Disable this client."""

577

600

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

578

601

return False

579

602

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

603

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

583

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

604

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

584

605

gobject.source_remove(self.disable_initiator_tag)

585

606

self.disable_initiator_tag = None

586

607

self.expires = None

587

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

608

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

588

609

gobject.source_remove(self.checker_initiator_tag)

589

610

self.checker_initiator_tag = None

590

611

self.stop_checker()

591

612

self.enabled = False

613

if not quiet:

614

self.send_changedstate()

592

615

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

593

616

return False

594

617

598

621

def init_checker(self):

599

622

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

600

623

# and every interval from then on.

624

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

601

626

self.checker_initiator_tag = (gobject.timeout_add

602

627

(self.interval_milliseconds(),

603

628

self.start_checker))

604

629

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

630

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

605

632

self.disable_initiator_tag = (gobject.timeout_add

606

633

(self.timeout_milliseconds(),

607

634

self.disable))

626

653

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

627

654

vars(self))

628

655

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

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

635

664

if timeout is None:

636

665

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

666

if self.disable_initiator_tag is not None:

639

667

gobject.source_remove(self.disable_initiator_tag)

668

self.disable_initiator_tag = None

640

669

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

641

670

self.disable_initiator_tag = (gobject.timeout_add

642

671

(timedelta_to_milliseconds

652

681

If a checker already exists, leave it running and do

653

682

nothing."""

654

683

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

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

659

688

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

660

689

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

661

690

# should be.

663

692

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

664

693

try:

665

694

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

670

700

else:

671

701

if pid:

672

702

logger.warning("Checker was a zombie")

675

705

self.current_checker_command)

676

706

# Start a new checker if needed

677

707

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)

678

713

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

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

697

719

self.current_checker_command = command

698

720

try:

699

721

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

702

724

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

703

725

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

704

726

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

705

735

self.checker = subprocess.Popen(command,

706

736

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

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:

714

750

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

751

except OSError as error:

719

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

720

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)

721

761

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

722

762

return True

723

763

730

770

return

731

771

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

732

772

try:

733

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

773

self.checker.terminate()

734

774

#time.sleep(0.5)

735

775

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

736

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

776

# self.checker.kill()

737

777

except OSError as error:

738

778

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

739

779

raise

756

796

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

757

797

if byte_arrays and signature != "ay":

758

798

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

759

" signature %r" % signature)

799

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

760

800

def decorator(func):

761

801

func._dbus_is_property = True

762

802

func._dbus_interface = dbus_interface

770

810

return decorator

771

811

772

812

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

773

850

class DBusPropertyException(dbus.exceptions.DBusException):

774

851

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

775

852

"""

798

875

"""

799

876

800

877

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

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)

803

886

804

def _get_all_dbus_properties(self):

887

def _get_all_dbus_things(self, thing):

805

888

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

806

889

"""

807

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

890

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

891

name),

892

athing.__get__(self))

808

893

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

894

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

811

897

812

898

def _get_dbus_property(self, interface_name, property_name):

813

899

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

815

901

"""

816

902

for cls in self.__class__.__mro__:

817

903

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

904

(cls,

905

self._is_dbus_thing("property"))):

819

906

if (value._dbus_name == property_name

820

907

and value._dbus_interface == interface_name):

821

908

return value.__get__(self)

849

936

# The byte_arrays option is not supported yet on

850

937

# signatures other than "ay".

851

938

if prop._dbus_signature != "ay":

852

raise ValueError

939

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

940

"'ay' signature {0!r}"

941

.format(prop._dbus_signature))

853

942

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

854

943

for byte in value))

855

944

prop(value)

863

952

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

864

953

"""

865

954

properties = {}

866

for name, prop in self._get_all_dbus_properties():

955

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

867

956

if (interface_name

868

957

and interface_name != prop._dbus_interface):

869

958

# Interface non-empty but did not match

884

973

path_keyword='object_path',

885

974

connection_keyword='connection')

886

975

def Introspect(self, object_path, connection):

887

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

976

"""Overloading of standard D-Bus method.

977

978

Inserts property tags and interface annotation tags.

888

979

"""

889

980

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

890

981

connection)

897

988

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

898

989

return e

899

990

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

991

# Add property tags

900

992

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

901

993

for name, prop

902

in self._get_all_dbus_properties()

994

in self._get_all_dbus_things("property")

903

995

if prop._dbus_interface

904

996

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

905

997

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)

906

1029

# Add the names to the return values for the

907

1030

# "org.freedesktop.DBus.Properties" methods

908

1031

if (if_tag.getAttribute("name")

923

1046

except (AttributeError, xml.dom.DOMException,

924

1047

xml.parsers.expat.ExpatError) as error:

925

1048

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

926

error)

1049

exc_info=error)

927

1050

return xmlstring

928

1051

929

1052

930

def datetime_to_dbus (dt, variant_level=0):

1053

def datetime_to_dbus(dt, variant_level=0):

931

1054

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

932

1055

if dt is None:

933

1056

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

935

1058

variant_level=variant_level)

936

1059

937

1060

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

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

942

1083

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

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

950

1091

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

951

1092

# with the wrong interface name

952

1093

if (not hasattr(attribute, "_dbus_interface")

953

1094

or not attribute._dbus_interface

954

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

1095

.startswith(orig_interface_name)):

955

1096

continue

956

1097

# Create an alternate D-Bus interface name based on

957

1098

# the current name

958

1099

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1102

interface_names.add(alt_interface)

961

1103

# Is this a D-Bus signal?

962

1104

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

963

# Extract the original non-method function by

964

# black magic

1105

# Extract the original non-method undecorated

1106

# function by black magic

965

1107

nonmethod_func = (dict(

966

1108

zip(attribute.func_code.co_freevars,

967

1109

attribute.__closure__))["func"]

978

1120

nonmethod_func.func_name,

979

1121

nonmethod_func.func_defaults,

980

1122

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

981

1129

# Define a creator of a function to call both the

982

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

983

# signals gets sent when the function is called

1130

# original and alternate functions, so both the

1131

# original and alternate signals gets sent when

1132

# the function is called

984

1133

def fixscope(func1, func2):

985

1134

"""This function is a scope container to pass

986

1135

func1 and func2 to the "call_both" function

993

1142

return call_both

994

1143

# Create the "call_both" function and add it to

995

1144

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1145

attr[attrname] = fixscope(attribute, new_function)

998

1146

# Is this a D-Bus method?

999

1147

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

1000

1148

# Create a new, but exactly alike, function

1011

1159

attribute.func_name,

1012

1160

attribute.func_defaults,

1013

1161

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

1014

1168

# Is this a D-Bus property?

1015

1169

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

1016

1170

# Create a new, but exactly alike, function

1030

1184

attribute.func_name,

1031

1185

attribute.func_defaults,

1032

1186

attribute.func_closure)))

1033

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

1034

1035

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

1036

1232

class ClientDBus(Client, DBusObjectWithProperties):

1037

1233

"""A Client class using D-Bus

1038

1234

1049

1245

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

1050

1246

self.bus = bus

1051

1247

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

1052

self._approvals_pending = 0

1053

1054

self._approvals_pending = 0

1055

1248

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

1056

1249

# the D-Bus

1057

1250

client_object_name = unicode(self.name).translate(

1061

1254

("/clients/" + client_object_name))

1062

1255

DBusObjectWithProperties.__init__(self, self.bus,

1063

1256

self.dbus_object_path)

1064

1257

1065

1258

def notifychangeproperty(transform_func,

1066

1259

dbus_name, type_func=lambda x: x,

1067

1260

variant_level=1):

1090

1283

1091

1284

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

1092

1285

1093

1094

1286

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1095

1287

approvals_pending = notifychangeproperty(dbus.Boolean,

1096

1288

"ApprovalPending",

1103

1295

checker is not None)

1104

1296

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1105

1297

"LastCheckedOK")

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1299

"LastCheckerStatus")

1106

1300

last_approval_request = notifychangeproperty(

1107

1301

datetime_to_dbus, "LastApprovalRequest")

1108

1302

approved_by_default = notifychangeproperty(dbus.Boolean,

1176

1370

return False

1177

1371

1178

1372

def approve(self, value=True):

1179

self.send_changedstate()

1180

1373

self.approved = value

1181

1374

gobject.timeout_add(timedelta_to_milliseconds

1182

1375

(self.approval_duration),

1183

1376

self._reset_approved)

1184

1377

self.send_changedstate()

1185

1378

1186

1379

## D-Bus methods, signals & properties

1187

1380

_interface = "se.recompile.Mandos.Client"

1188

1381

1382

## Interfaces

1383

1384

@dbus_interface_annotations(_interface)

1385

def _foo(self):

1386

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

1387

"false"}

1388

1189

1389

## Signals

1190

1390

1191

1391

# CheckerCompleted - signal

1227

1427

"D-Bus signal"

1228

1428

return self.need_approval()

1229

1429

1230

# NeRwequest - signal

1231

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

1232

def NewRequest(self, ip):

1233

"""D-Bus signal

1234

Is sent after a client request a password.

1235

"""

1236

pass

1237

1238

1430

## Methods

1239

1431

1240

1432

# Approve - method

1350

1542

return

1351

1543

return datetime_to_dbus(self.last_checked_ok)

1352

1544

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

1353

1551

# Expires - property

1354

1552

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

1355

1553

def Expires_dbus_property(self):

1366

1564

def Timeout_dbus_property(self, value=None):

1367

1565

if value is None: # get

1368

1566

return dbus.UInt64(self.timeout_milliseconds())

1567

old_timeout = self.timeout

1369

1568

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

1370

# Reschedule timeout

1569

# Reschedule disabling

1371

1570

if self.enabled:

1372

1571

now = datetime.datetime.utcnow()

1373

time_to_die = timedelta_to_milliseconds(

1374

(self.last_checked_ok + self.timeout) - now)

1375

if time_to_die <= 0:

1572

self.expires += self.timeout - old_timeout

1573

if self.expires <= now:

1376

1574

# The timeout has passed

1377

1575

self.disable()

1378

1576

else:

1379

self.expires = (now +

1380

datetime.timedelta(milliseconds =

1381

time_to_die))

1382

1577

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

1383

1578

is None):

1384

1579

return

1385

1580

gobject.source_remove(self.disable_initiator_tag)

1386

self.disable_initiator_tag = (gobject.timeout_add

1387

(time_to_die,

1388

self.disable))

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

timedelta_to_milliseconds(self.expires - now),

1584

self.disable))

1389

1585

1390

1586

# ExtendedTimeout - property

1391

1587

@dbus_service_property(_interface, signature="t",

1470

1666

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

1471

1667

1472

1668

1473

class ClientDBusTransitional(ClientDBus):

1474

__metaclass__ = AlternateDBusNamesMetaclass

1475

1476

1477

1669

class ClientHandler(socketserver.BaseRequestHandler, object):

1478

1670

"""A class to handle client connections.

1479

1671

1515

1707

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

1516

1708

try:

1517

1709

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

1518

raise RuntimeError

1710

raise RuntimeError(line)

1519

1711

except (ValueError, IndexError, RuntimeError) as error:

1520

1712

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

1521

1713

return

1547

1739

except KeyError:

1548

1740

return

1549

1741

1550

if self.server.use_dbus:

1551

# Emit D-Bus signal

1552

client.NewRequest(str(self.client_address))

1553

1554

1742

if client.approval_delay:

1555

1743

delay = client.approval_delay

1556

1744

client.approvals_pending += 1

1587

1775

#wait until timeout or approved

1588

1776

time = datetime.datetime.now()

1589

1777

client.changedstate.acquire()

1590

(client.changedstate.wait

1591

(float(client.timedelta_to_milliseconds(delay)

1592

/ 1000)))

1778

client.changedstate.wait(

1779

float(timedelta_to_milliseconds(delay)

1780

/ 1000))

1593

1781

client.changedstate.release()

1594

1782

time2 = datetime.datetime.now()

1595

1783

if (time2 - time) >= delay:

1611

1799

try:

1612

1800

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

1613

1801

except gnutls.errors.GNUTLSError as error:

1614

logger.warning("gnutls send failed")

1802

logger.warning("gnutls send failed",

1803

exc_info=error)

1615

1804

return

1616

1805

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

1617

1806

sent, len(client.secret)

1620

1809

1621

1810

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

1622

1811

# bump the timeout using extended_timeout

1623

client.checked_ok(client.extended_timeout)

1812

client.bump_timeout(client.extended_timeout)

1624

1813

if self.server.use_dbus:

1625

1814

# Emit D-Bus signal

1626

1815

client.GotSecret()

1631

1820

try:

1632

1821

session.bye()

1633

1822

except gnutls.errors.GNUTLSError as error:

1634

logger.warning("GnuTLS bye failed")

1823

logger.warning("GnuTLS bye failed",

1824

exc_info=error)

1635

1825

1636

1826

@staticmethod

1637

1827

def peer_certificate(session):

1709

1899

def process_request(self, request, address):

1710

1900

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

1711

1901

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

1712

args = (request,

1713

address))

1902

args = (request, address))

1714

1903

proc.start()

1715

1904

return proc

1716

1905

1731

1920

1732

1921

def add_pipe(self, parent_pipe, proc):

1733

1922

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

1734

raise NotImplementedError

1923

raise NotImplementedError()

1735

1924

1736

1925

1737

1926

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1744

1933

use_ipv6: Boolean; to use IPv6 or not

1745

1934

"""

1746

1935

def __init__(self, server_address, RequestHandlerClass,

1747

interface=None, use_ipv6=True):

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

"""

1748

1940

self.interface = interface

1749

1941

if use_ipv6:

1750

1942

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.

1751

1969

socketserver.TCPServer.__init__(self, server_address,

1752

1970

RequestHandlerClass)

1971

1753

1972

def server_bind(self):

1754

1973

"""This overrides the normal server_bind() function

1755

1974

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

1763

1982

try:

1764

1983

self.socket.setsockopt(socket.SOL_SOCKET,

1765

1984

SO_BINDTODEVICE,

1766

str(self.interface

1767

+ '\0'))

1985

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

1768

1986

except socket.error as error:

1769

if error[0] == errno.EPERM:

1770

logger.error("No permission to"

1771

" bind to interface %s",

1772

self.interface)

1773

elif error[0] == errno.ENOPROTOOPT:

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:

1774

1991

logger.error("SO_BINDTODEVICE not available;"

1775

1992

" cannot bind to interface %s",

1776

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1777

1997

else:

1778

1998

raise

1779

1999

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

1782

2002

if self.address_family == socket.AF_INET6:

1783

2003

any_address = "::" # in6addr_any

1784

2004

else:

1785

any_address = socket.INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

1786

2006

self.server_address = (any_address,

1787

2007

self.server_address[1])

1788

2008

elif not self.server_address[1]:

1809

2029

"""

1810

2030

def __init__(self, server_address, RequestHandlerClass,

1811

2031

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

1812

gnutls_priority=None, use_dbus=True):

2032

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

1813

2033

self.enabled = False

1814

2034

self.clients = clients

1815

2035

if self.clients is None:

1819

2039

IPv6_TCPServer.__init__(self, server_address,

1820

2040

RequestHandlerClass,

1821

2041

interface = interface,

1822

use_ipv6 = use_ipv6)

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

1823

2044

def server_activate(self):

1824

2045

if self.enabled:

1825

2046

return socketserver.TCPServer.server_activate(self)

1838

2059

1839

2060

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

1840

2061

proc = None, client_object=None):

1841

condition_names = {

1842

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

1843

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

1844

# blocking).

1845

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

1846

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

1847

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

1848

# broken, usually for pipes and

1849

# sockets).

1850

}

1851

conditions_string = ' | '.join(name

1852

for cond, name in

1853

condition_names.iteritems()

1854

if cond & condition)

1855

2062

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

1856

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

2063

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

1857

2064

# Wait for other process to exit

1858

2065

proc.join()

1859

2066

return False

1917

2124

return True

1918

2125

1919

2126

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

1920

2226

def string_to_delta(interval):

1921

2227

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

1922

2228

1933

2239

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

1934

2240

datetime.timedelta(0, 330)

1935

2241

"""

2242

2243

try:

2244

return rfc3339_duration_to_delta(interval)

2245

except ValueError:

2246

pass

2247

1936

2248

timevalue = datetime.timedelta(0)

1937

2249

for s in interval.split():

1938

2250

try:

1949

2261

elif suffix == "w":

1950

2262

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

1951

2263

else:

1952

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

1953

except (ValueError, IndexError) as e:

2264

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

2265

.format(suffix))

2266

except IndexError as e:

1954

2267

raise ValueError(*(e.args))

1955

2268

timevalue += delta

1956

2269

return timevalue

1969

2282

sys.exit()

1970

2283

if not noclose:

1971

2284

# Close all standard open file descriptors

1972

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

2285

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

1973

2286

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

1974

2287

raise OSError(errno.ENODEV,

1975

"%s not a character device"

1976

% os.path.devnull)

2288

"{0} not a character device"

2289

.format(os.devnull))

1977

2290

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

1978

2291

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

1979

2292

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

1988

2301

1989

2302

parser = argparse.ArgumentParser()

1990

2303

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

1991

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

2304

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

1992

2305

help="show version number and exit")

1993

2306

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

1994

2307

help="Bind to interface IF")

2000

2313

help="Run self-test")

2001

2314

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

2002

2315

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

2003

" to terminal")

2316

" to terminal", default=None)

2004

2317

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

2005

2318

help="Debug level for stdout output")

2006

2319

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

2013

2326

" files")

2014

2327

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

2015

2328

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

2016

" system bus interface")

2329

" system bus interface", default=None)

2017

2330

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

2018

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

2331

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

2332

default=None)

2019

2333

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

2020

2334

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

2021

" state")

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

2022

2339

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

2023

2340

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

2341

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

2342

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

2024

2343

2025

2344

options = parser.parse_args()

2026

2345

2027

2346

if options.check:

2028

2347

import doctest

2029

doctest.testmod()

2030

sys.exit()

2348

fail_count, test_count = doctest.testmod()

2349

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

2031

2350

2032

2351

# Default values for config file for server-global settings

2033

2352

server_defaults = { "interface": "",

2035

2354

"port": "",

2036

2355

"debug": "False",

2037

2356

"priority":

2038

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

2357

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

2039

2358

"servicename": "Mandos",

2040

2359

"use_dbus": "True",

2041

2360

"use_ipv6": "True",

2042

2361

"debuglevel": "",

2043

2362

"restore": "True",

2044

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

2363

"socket": "",

2364

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

2365

"foreground": "False",

2045

2366

}

2046

2367

2047

2368

# Parse config file for server-global settings

2052

2373

# Convert the SafeConfigParser object to a dict

2053

2374

server_settings = server_config.defaults()

2054

2375

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

2055

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

2376

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

2056

2377

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

2057

2378

option)

2058

2379

if server_settings["port"]:

2059

2380

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

2060

2381

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

2061

2391

del server_config

2062

2392

2063

2393

# Override the settings from the config file with command line

2065

2395

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

2066

2396

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

2067

2397

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

2068

"statedir"):

2398

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

2069

2399

value = getattr(options, option)

2070

2400

if value is not None:

2071

2401

server_settings[option] = value

2074

2404

for option in server_settings.keys():

2075

2405

if type(server_settings[option]) is str:

2076

2406

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

2077

2414

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

2078

2415

2079

2416

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

2085

2422

use_ipv6 = server_settings["use_ipv6"]

2086

2423

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

2087

2424

stored_state_file)

2425

foreground = server_settings["foreground"]

2088

2426

2089

2427

if debug:

2090

2428

initlogger(debug, logging.DEBUG)

2097

2435

2098

2436

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

2099

2437

syslogger.setFormatter(logging.Formatter

2100

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

2101

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

2102

% server_settings["servicename"]))

2438

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

2439

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

2440

.format(server_settings

2441

["servicename"])))

2103

2442

2104

2443

# Parse config file with clients

2105

2444

client_config = configparser.SafeConfigParser(Client

2118

2457

use_ipv6=use_ipv6,

2119

2458

gnutls_priority=

2120

2459

server_settings["priority"],

2121

use_dbus=use_dbus)

2122

if not debug:

2123

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

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

2124

2468

try:

2125

2469

pidfile = open(pidfilename, "w")

2126

except IOError:

2127

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

2470

except IOError as e:

2471

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

2472

exc_info=e)

2128

2473

2129

try:

2130

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

2131

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

2132

except KeyError:

2474

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

2133

2475

try:

2134

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

2135

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

2476

uid = pwd.getpwnam(name).pw_uid

2477

gid = pwd.getpwnam(name).pw_gid

2478

break

2136

2479

except KeyError:

2137

try:

2138

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

2139

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

2140

except KeyError:

2141

uid = 65534

2142

gid = 65534

2480

continue

2481

else:

2482

uid = 65534

2483

gid = 65534

2143

2484

try:

2144

2485

os.setgid(gid)

2145

2486

os.setuid(uid)

2146

2487

except OSError as error:

2147

if error[0] != errno.EPERM:

2148

raise error

2488

if error.errno != errno.EPERM:

2489

raise

2149

2490

2150

2491

if debug:

2151

2492

# Enable all possible GnuTLS debugging

2162

2503

.gnutls_global_set_log_function(debug_gnutls))

2163

2504

2164

2505

# Redirect stdin so all checkers get /dev/null

2165

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

2506

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

2166

2507

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

2167

2508

if null > 2:

2168

2509

os.close(null)

2169

2510

2170

2511

# Need to fork before connecting to D-Bus

2171

if not debug:

2512

if not foreground:

2172

2513

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

2173

2514

daemon()

2174

2515

2516

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

2517

# need to inform gobject that threads will be used.

2175

2518

gobject.threads_init()

2176

2519

2177

2520

global main_loop

2178

2521

# From the Avahi example code

2179

DBusGMainLoop(set_as_default=True )

2522

DBusGMainLoop(set_as_default=True)

2180

2523

main_loop = gobject.MainLoop()

2181

2524

bus = dbus.SystemBus()

2182

2525

# End of Avahi example code

2188

2531

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

2189

2532

do_not_queue=True))

2190

2533

except dbus.exceptions.NameExistsException as e:

2191

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

2534

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

2192

2535

use_dbus = False

2193

2536

server_settings["use_dbus"] = False

2194

2537

tcp_server.use_dbus = False

2206

2549

2207

2550

client_class = Client

2208

2551

if use_dbus:

2209

client_class = functools.partial(ClientDBusTransitional,

2210

bus = bus)

2552

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

2211

2553

2212

2554

client_settings = Client.config_parser(client_config)

2213

2555

old_client_settings = {}

2214

2556

clients_data = {}

2215

2557

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

2216

2566

# Get client data and settings from last running state.

2217

2567

if server_settings["restore"]:

2218

2568

try:

2221

2571

(stored_state))

2222

2572

os.remove(stored_state_path)

2223

2573

except IOError as e:

2224

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

2225

.format(e))

2226

if e.errno != errno.ENOENT:

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)

2227

2580

raise

2228

2581

except EOFError as e:

2229

2582

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

2230

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

2583

"EOFError:", exc_info=e)

2231

2584

2232

2585

with PGPEngine() as pgp:

2233

2586

for client_name, client in clients_data.iteritems():

2587

# Skip removed clients

2588

if client_name not in client_settings:

2589

continue

2590

2234

2591

# Decide which value to use after restoring saved state.

2235

2592

# We have three different values: Old config file,

2236

2593

# new config file, and saved state.

2250

2607

2251

2608

# Clients who has passed its expire date can still be

2252

2609

# enabled if its last checker was successful. Clients

2253

# whose checker failed before we stored its state is

2254

# assumed to have failed all checkers during downtime.

2610

# whose checker succeeded before we stored its state is

2611

# assumed to have successfully run all checkers during

2612

# downtime.

2255

2613

if client["enabled"]:

2256

2614

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

2257

2615

if not client["last_checked_ok"]:

2258

2616

logger.warning(

2259

2617

"disabling client {0} - Client never "

2260

"performed a successfull checker"

2261

.format(client["name"]))

2618

"performed a successful checker"

2619

.format(client_name))

2262

2620

client["enabled"] = False

2263

2621

elif client["last_checker_status"] != 0:

2264

2622

logger.warning(

2265

2623

"disabling client {0} - Client "

2266

2624

"last checker failed with error code {1}"

2267

.format(client["name"],

2625

.format(client_name,

2268

2626

client["last_checker_status"]))

2269

2627

client["enabled"] = False

2270

2628

else:

2273

2631

+ client["timeout"])

2274

2632

logger.debug("Last checker succeeded,"

2275

2633

" keeping {0} enabled"

2276

.format(client["name"]))

2634

.format(client_name))

2277

2635

try:

2278

2636

client["secret"] = (

2279

2637

pgp.decrypt(client["encrypted_secret"],

2285

2643

.format(client_name))

2286

2644

client["secret"] = (

2287

2645

client_settings[client_name]["secret"])

2288

2289

2646

2290

2647

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

2291

2648

for client_name in (set(old_client_settings)

2294

2651

for client_name in (set(client_settings)

2295

2652

- set(old_client_settings)):

2296

2653

clients_data[client_name] = client_settings[client_name]

2297

2298

# Create clients all clients

2654

2655

# Create all client objects

2299

2656

for client_name, client in clients_data.iteritems():

2300

2657

tcp_server.clients[client_name] = client_class(

2301

name = client_name, settings = client)

2658

name = client_name, settings = client,

2659

server_settings = server_settings)

2302

2660

2303

2661

if not tcp_server.clients:

2304

2662

logger.warning("No clients defined")

2305

2306

if not debug:

2307

try:

2308

with pidfile:

2309

pid = os.getpid()

2310

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

2311

del pidfile

2312

except IOError:

2313

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

2314

pidfilename, pid)

2315

except NameError:

2316

# "pidfile" was never created

2317

pass

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

2318

2674

del pidfilename

2319

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

2320

2675

2321

2676

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

2322

2677

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

2323

2678

2324

2679

if use_dbus:

2325

class MandosDBusService(dbus.service.Object):

2680

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

2681

"se.bsnet.fukt.Mandos"})

2682

class MandosDBusService(DBusObjectWithProperties):

2326

2683

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

2327

2684

def __init__(self):

2328

2685

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

2329

2686

_interface = "se.recompile.Mandos"

2330

2687

2688

@dbus_interface_annotations(_interface)

2689

def _foo(self):

2690

return { "org.freedesktop.DBus.Property"

2691

".EmitsChangedSignal":

2692

"false"}

2693

2331

2694

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

2332

2695

def ClientAdded(self, objpath):

2333

2696

"D-Bus signal"

2375

2738

2376

2739

del _interface

2377

2740

2378

class MandosDBusServiceTransitional(MandosDBusService):

2379

__metaclass__ = AlternateDBusNamesMetaclass

2380

mandos_dbus_service = MandosDBusServiceTransitional()

2741

mandos_dbus_service = MandosDBusService()

2381

2742

2382

2743

def cleanup():

2383

2744

"Cleanup function; run on exit"

2384

2745

service.cleanup()

2385

2746

2386

2747

multiprocessing.active_children()

2748

wnull.close()

2387

2749

if not (tcp_server.clients or client_settings):

2388

2750

return

2389

2751

2401

2763

# A list of attributes that can not be pickled

2402

2764

# + secret.

2403

2765

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

2404

"checker"))

2766

"checker", "server_settings"))

2405

2767

for name, typ in (inspect.getmembers

2406

2768

(dbus.service.Object)):

2407

2769

exclude.add(name)

2416

2778

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

2417

2779

2418

2780

try:

2419

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

2420

prefix="clients-",

2421

dir=os.path.dirname

2422

(stored_state_path))

2423

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

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:

2424

2785

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

2786

tempname=stored_state.name

2425

2787

os.rename(tempname, stored_state_path)

2426

2788

except (IOError, OSError) as e:

2427

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

2428

.format(e))

2429

2789

if not debug:

2430

2790

try:

2431

2791

os.remove(tempname)

2432

2792

except NameError:

2433

2793

pass

2434

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

2435

errno.EEXIST)):

2436

raise e

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

2437

2801

2438

2802

# Delete all clients, and settings from config

2439

2803

while tcp_server.clients:

2466

2830

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

2467

2831

if use_ipv6:

2468

2832

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

2469

" flowinfo %d, scope_id %d"

2470

% tcp_server.socket.getsockname())

2833

" flowinfo %d, scope_id %d",

2834

*tcp_server.socket.getsockname())

2471

2835

else: # IPv4

2472

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

2473

% tcp_server.socket.getsockname())

2836

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

2837

*tcp_server.socket.getsockname())

2474

2838

2475

2839

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

2476

2840

2479

2843

try:

2480

2844

service.activate()

2481

2845

except dbus.exceptions.DBusException as error:

2482

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

2846

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

2483

2847

cleanup()

2484

2848

sys.exit(1)

2485

2849

# End of Avahi example code

2492

2856

logger.debug("Starting main loop")

2493

2857

main_loop.run()

2494

2858

except AvahiError as error:

2495

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

2859

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

2496

2860

cleanup()

2497

2861

sys.exit(1)

2498

2862

except KeyboardInterrupt: