/mandos/release : revision 237.7.332

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

# -*- mode: python; coding: utf-8 -*-

3

#

4

# Mandos server - give out binary blobs to connecting clients.

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

36

37

from future_builtins import *

38

39

import SocketServer as socketserver

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

40

43

import socket

41

44

import argparse

42

45

import datetime

47

50

import gnutls.library.functions

48

51

import gnutls.library.constants

49

52

import gnutls.library.types

50

import ConfigParser as configparser

53

try:

54

import ConfigParser as configparser

55

except ImportError:

56

import configparser

51

57

import sys

52

58

import re

53

59

import os

62

68

import struct

63

69

import fcntl

64

70

import functools

65

import cPickle as pickle

71

try:

72

import cPickle as pickle

73

except ImportError:

74

import pickle

66

75

import multiprocessing

67

76

import types

68

77

import binascii

69

78

import tempfile

70

79

import itertools

71

80

import collections

81

import codecs

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

85

try:

86

import gobject

87

except ImportError:

88

from gi.repository import GObject as gobject

76

89

import avahi

77

90

from dbus.mainloop.glib import DBusGMainLoop

78

91

import ctypes

88

101

except ImportError:

89

102

SO_BINDTODEVICE = None

90

103

91

version = "1.6.2"

104

if sys.version_info.major == 2:

105

str = unicode

106

107

version = "1.6.9"

92

108

stored_state_file = "clients.pickle"

93

109

94

110

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

111

syslogger = None

98

112

99

113

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

(ctypes.util.find_library("c"))

102

.if_nametoindex)

114

if_nametoindex = ctypes.cdll.LoadLibrary(

115

ctypes.util.find_library("c")).if_nametoindex

103

116

except (OSError, AttributeError):

117

104

118

def if_nametoindex(interface):

105

119

"Get an interface index the hard way, i.e. using fcntl()"

106

120

SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h

107

121

with contextlib.closing(socket.socket()) as s:

108

122

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

struct.pack(str("16s16x"),

110

interface))

111

interface_index = struct.unpack(str("I"),

112

ifreq[16:20])[0]

123

struct.pack(b"16s16x", interface))

124

interface_index = struct.unpack("I", ifreq[16:20])[0]

113

125

return interface_index

114

126

115

127

116

128

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

117

129

"""init logger and add loglevel"""

118

130

131

global syslogger

132

syslogger = (logging.handlers.SysLogHandler(

133

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

134

address = "/dev/log"))

119

135

syslogger.setFormatter(logging.Formatter

120

136

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

121

137

' %(message)s'))

138

154

139

155

class PGPEngine(object):

140

156

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

157

141

158

def __init__(self):

142

159

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

143

160

self.gnupgargs = ['--batch',

182

199

183

200

def encrypt(self, data, password):

184

201

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

202

with tempfile.NamedTemporaryFile(

203

dir=self.tempdir) as passfile:

187

204

passfile.write(passphrase)

188

205

passfile.flush()

189

206

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

200

217

201

218

def decrypt(self, data, password):

202

219

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

220

with tempfile.NamedTemporaryFile(

221

dir = self.tempdir) as passfile:

205

222

passfile.write(passphrase)

206

223

passfile.flush()

207

224

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

211

228

stdin = subprocess.PIPE,

212

229

stdout = subprocess.PIPE,

213

230

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

231

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

216

232

if proc.returncode != 0:

217

233

raise PGPError(err)

218

234

return decrypted_plaintext

221

237

class AvahiError(Exception):

222

238

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

223

239

self.value = value

224

super(AvahiError, self).__init__(value, *args, **kwargs)

225

def __unicode__(self):

226

return unicode(repr(self.value))

240

return super(AvahiError, self).__init__(value, *args,

241

**kwargs)

242

227

243

228

244

class AvahiServiceError(AvahiError):

229

245

pass

230

246

247

231

248

class AvahiGroupError(AvahiError):

232

249

pass

233

250

253

270

bus: dbus.SystemBus()

254

271

"""

255

272

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

273

def __init__(self,

274

interface = avahi.IF_UNSPEC,

275

name = None,

276

servicetype = None,

277

port = None,

278

TXT = None,

279

domain = "",

280

host = "",

281

max_renames = 32768,

282

protocol = avahi.PROTO_UNSPEC,

283

bus = None):

260

284

self.interface = interface

261

285

self.name = name

262

286

self.type = servicetype

272

296

self.bus = bus

273

297

self.entry_group_state_changed_match = None

274

298

275

def rename(self):

299

def rename(self, remove=True):

276

300

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

277

301

if self.rename_count >= self.max_renames:

278

302

logger.critical("No suitable Zeroconf service name found"

279

303

" after %i retries, exiting.",

280

304

self.rename_count)

281

305

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

306

self.name = str(

307

self.server.GetAlternativeServiceName(self.name))

308

self.rename_count += 1

284

309

logger.info("Changing Zeroconf service name to %r ...",

285

310

self.name)

286

self.remove()

311

if remove:

312

self.remove()

287

313

try:

288

314

self.add()

289

315

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

316

if (error.get_dbus_name()

317

== "org.freedesktop.Avahi.CollisionError"):

318

logger.info("Local Zeroconf service name collision.")

319

return self.rename(remove=False)

320

else:

321

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

322

self.cleanup()

323

os._exit(1)

294

324

295

325

def remove(self):

296

326

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

334

364

self.rename()

335

365

elif state == avahi.ENTRY_GROUP_FAILURE:

336

366

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

337

unicode(error))

338

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

339

.format(error))

367

str(error))

368

raise AvahiGroupError("State changed: {!s}".format(error))

340

369

341

370

def cleanup(self):

342

371

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

352

381

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

353

382

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

354

383

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

384

bad_states = {

385

avahi.SERVER_INVALID: "Zeroconf server invalid",

386

avahi.SERVER_REGISTERING: None,

387

avahi.SERVER_COLLISION: "Zeroconf server name collision",

388

avahi.SERVER_FAILURE: "Zeroconf server failure",

389

}

362

390

if state in bad_states:

363

391

if bad_states[state] is not None:

364

392

if error is None:

367

395

logger.error(bad_states[state] + ": %r", error)

368

396

self.cleanup()

369

397

elif state == avahi.SERVER_RUNNING:

370

self.add()

398

try:

399

self.add()

400

except dbus.exceptions.DBusException as error:

401

if (error.get_dbus_name()

402

== "org.freedesktop.Avahi.CollisionError"):

403

logger.info("Local Zeroconf service name"

404

" collision.")

405

return self.rename(remove=False)

406

else:

407

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

408

self.cleanup()

409

os._exit(1)

371

410

else:

372

411

if error is None:

373

412

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

383

422

follow_name_owner_changes=True),

384

423

avahi.DBUS_INTERFACE_SERVER)

385

424

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

425

self.server_state_changed)

387

426

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

388

427

389

428

390

429

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

430

def rename(self, *args, **kwargs):

392

431

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

432

ret = AvahiService.rename(self, *args, **kwargs)

433

syslogger.setFormatter(logging.Formatter(

434

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

435

.format(self.name)))

398

436

return ret

399

437

400

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

406

438

def call_pipe(connection, # : multiprocessing.Connection

439

func, *args, **kwargs):

440

"""This function is meant to be called by multiprocessing.Process

441

442

This function runs func(*args, **kwargs), and writes the resulting

443

return value on the provided multiprocessing.Connection.

444

"""

445

connection.send(func(*args, **kwargs))

446

connection.close()

407

447

408

448

class Client(object):

409

449

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

436

476

last_checker_status: integer between 0 and 255 reflecting exit

437

477

status of last checker. -1 reflects crashed

438

478

checker, -2 means no checker completed yet.

479

last_checker_signal: The signal which killed the last checker, if

480

last_checker_status is -1

439

481

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

440

482

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

441

483

D-Bus identifiers

454

496

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

455

497

"last_approval_request", "last_checked_ok",

456

498

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

499

client_defaults = {

500

"timeout": "PT5M",

501

"extended_timeout": "PT15M",

502

"interval": "PT2M",

503

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

504

"host": "",

505

"approval_delay": "PT0S",

506

"approval_duration": "PT1S",

507

"approved_by_default": "True",

508

"enabled": "True",

509

}

482

510

483

511

@staticmethod

484

512

def config_parser(config):

500

528

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

501

529

"enabled")

502

530

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the

533

# fingerprint() function

503

534

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

504

535

.replace(" ", ""))

505

536

if "secret" in section:

510

541

"rb") as secfile:

511

542

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

512

543

else:

513

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

544

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

514

545

.format(section))

515

546

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

516

547

client["extended_timeout"] = string_to_delta(

533

564

server_settings = {}

534

565

self.server_settings = server_settings

535

566

# adding all client settings

536

for setting, value in settings.iteritems():

567

for setting, value in settings.items():

537

568

setattr(self, setting, value)

538

569

539

570

if self.enabled:

547

578

self.expires = None

548

579

549

580

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

553

581

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

554

582

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

555

583

datetime.datetime.utcnow())

562

590

self.current_checker_command = None

563

591

self.approved = None

564

592

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

593

self.changedstate = multiprocessing_manager.Condition(

594

multiprocessing_manager.Lock())

595

self.client_structure = [attr

596

for attr in self.__dict__.iterkeys()

570

597

if not attr.startswith("_")]

571

598

self.client_structure.append("client_structure")

572

599

573

for name, t in inspect.getmembers(type(self),

574

lambda obj:

575

isinstance(obj,

576

property)):

600

for name, t in inspect.getmembers(

601

type(self), lambda obj: isinstance(obj, property)):

577

602

if not name.startswith("_"):

578

603

self.client_structure.append(name)

579

604

621

646

# and every interval from then on.

622

647

if self.checker_initiator_tag is not None:

623

648

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

649

self.checker_initiator_tag = gobject.timeout_add(

650

int(self.interval.total_seconds() * 1000),

651

self.start_checker)

627

652

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

628

653

if self.disable_initiator_tag is not None:

629

654

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

655

self.disable_initiator_tag = gobject.timeout_add(

656

int(self.timeout.total_seconds() * 1000), self.disable)

633

657

# Also start a new checker *right now*.

634

658

self.start_checker()

635

659

636

def checker_callback(self, pid, condition, command):

660

def checker_callback(self, source, condition, connection,

661

command):

637

662

"""The checker has completed, so take appropriate actions."""

638

663

self.checker_callback_tag = None

639

664

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

665

# Read return code from connection (see call_pipe)

666

returncode = connection.recv()

667

connection.close()

668

669

if returncode >= 0:

670

self.last_checker_status = returncode

671

self.last_checker_signal = None

642

672

if self.last_checker_status == 0:

643

673

logger.info("Checker for %(name)s succeeded",

644

674

vars(self))

645

675

self.checked_ok()

646

676

else:

647

logger.info("Checker for %(name)s failed",

648

vars(self))

677

logger.info("Checker for %(name)s failed", vars(self))

649

678

else:

650

679

self.last_checker_status = -1

680

self.last_checker_signal = -returncode

651

681

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

652

682

vars(self))

683

return False

653

684

654

685

def checked_ok(self):

655

686

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

656

687

self.last_checked_ok = datetime.datetime.utcnow()

657

688

self.last_checker_status = 0

689

self.last_checker_signal = None

658

690

self.bump_timeout()

659

691

660

692

def bump_timeout(self, timeout=None):

665

697

gobject.source_remove(self.disable_initiator_tag)

666

698

self.disable_initiator_tag = None

667

699

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

700

self.disable_initiator_tag = gobject.timeout_add(

701

int(timeout.total_seconds() * 1000), self.disable)

671

702

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

672

703

673

704

def need_approval(self):

687

718

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

688

719

# should be.

689

720

690

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

691

try:

692

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

721

if self.checker is not None and not self.checker.is_alive():

722

logger.warning("Checker was not alive; joining")

723

self.checker.join()

724

self.checker = None

704

725

# Start a new checker if needed

705

726

if self.checker is None:

706

727

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

728

escaped_attrs = {

729

attr: re.escape(str(getattr(self, attr)))

730

for attr in self.runtime_expansions }

711

731

try:

712

732

command = self.checker_command % escaped_attrs

713

733

except TypeError as error:

714

734

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

735

self.checker_command,

736

exc_info=error)

737

return True # Try again later

717

738

self.current_checker_command = command

718

try:

719

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

720

command, self.name)

721

# We don't need to redirect stdout and stderr, since

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

739

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

740

self.name)

741

# We don't need to redirect stdout and stderr, since

742

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

743

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

744

# always replaced by /dev/null.)

745

# The exception is when not debugging but nevertheless

746

# running in the foreground; use the previously

747

# created wnull.

748

popen_args = { "close_fds": True,

749

"shell": True,

750

"cwd": "/" }

751

if (not self.server_settings["debug"]

752

and self.server_settings["foreground"]):

753

popen_args.update({"stdout": wnull,

754

"stderr": wnull })

755

pipe = multiprocessing.Pipe(duplex = False)

756

self.checker = multiprocessing.Process(

757

target = call_pipe,

758

args = (pipe[1], subprocess.call, command),

759

kwargs = popen_args)

760

self.checker.start()

761

self.checker_callback_tag = gobject.io_add_watch(

762

pipe[0].fileno(), gobject.IO_IN,

763

self.checker_callback, pipe[0], command)

759

764

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

760

765

return True

761

766

767

772

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

768

773

return

769

774

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

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

775

self.checker.terminate()

778

776

self.checker = None

779

777

780

778

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

779

def dbus_service_property(dbus_interface,

780

signature="v",

781

access="readwrite",

782

byte_arrays=False):

783

"""Decorators for marking methods of a DBusObjectWithProperties to

784

become properties on the D-Bus.

785

794

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

795

if byte_arrays and signature != "ay":

796

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

797

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

797

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

798

799

def decorator(func):

799

800

func._dbus_is_property = True

800

801

func._dbus_interface = dbus_interface

805

806

func._dbus_name = func._dbus_name[:-14]

806

807

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

807

808

return func

809

808

810

return decorator

809

811

810

812

819

821

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

820

822

"false"}

821

823

"""

824

822

825

def decorator(func):

823

826

func._dbus_is_interface = True

824

827

func._dbus_interface = dbus_interface

825

828

func._dbus_name = dbus_interface

826

829

return func

830

827

831

return decorator

828

832

829

833

831

835

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

832

836

Usage:

833

837

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

834

841

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

835

842

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

843

def Property_dbus_property(self):

840

844

return dbus.Boolean(False)

845

846

See also the DBusObjectWithAnnotations class.

841

847

"""

848

842

849

def decorator(func):

843

850

func._dbus_annotations = annotations

844

851

return func

852

845

853

return decorator

846

854

847

855

848

856

class DBusPropertyException(dbus.exceptions.DBusException):

849

857

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

850

858

"""

851

def __unicode__(self):

852

return unicode(str(self))

859

pass

853

860

854

861

855

862

class DBusPropertyAccessException(DBusPropertyException):

864

871

pass

865

872

866

873

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

874

class DBusObjectWithAnnotations(dbus.service.Object):

875

"""A D-Bus object with annotations.

869

876

870

Classes inheriting from this can use the dbus_service_property

871

decorator to expose methods as D-Bus properties. It exposes the

872

standard Get(), Set(), and GetAll() methods on the D-Bus.

877

Classes inheriting from this can use the dbus_annotations

878

decorator to add annotations to methods or signals.

873

879

"""

874

880

875

881

@staticmethod

879

885

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

880

886

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

881

887

"""

882

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

888

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

883

889

False)

884

890

885

891

def _get_all_dbus_things(self, thing):

886

892

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

887

893

"""

888

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

889

name),

894

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

890

895

athing.__get__(self))

891

896

for cls in self.__class__.__mro__

892

897

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

898

inspect.getmembers(cls, self._is_dbus_thing(thing)))

899

900

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

901

out_signature = "s",

902

path_keyword = 'object_path',

903

connection_keyword = 'connection')

904

def Introspect(self, object_path, connection):

905

"""Overloading of standard D-Bus method.

906

907

Inserts annotation tags on methods and signals.

908

"""

909

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

910

connection)

911

try:

912

document = xml.dom.minidom.parseString(xmlstring)

913

914

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

915

# Add annotation tags

916

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

917

for tag in if_tag.getElementsByTagName(typ):

918

annots = dict()

919

for name, prop in (self.

920

_get_all_dbus_things(typ)):

921

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

922

and prop._dbus_interface

923

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

924

annots.update(getattr(

925

prop, "_dbus_annotations", {}))

926

for name, value in annots.items():

927

ann_tag = document.createElement(

928

"annotation")

929

ann_tag.setAttribute("name", name)

930

ann_tag.setAttribute("value", value)

931

tag.appendChild(ann_tag)

932

# Add interface annotation tags

933

for annotation, value in dict(

934

itertools.chain.from_iterable(

935

annotations().items()

936

for name, annotations

937

in self._get_all_dbus_things("interface")

938

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

939

)).items():

940

ann_tag = document.createElement("annotation")

941

ann_tag.setAttribute("name", annotation)

942

ann_tag.setAttribute("value", value)

943

if_tag.appendChild(ann_tag)

944

# Fix argument name for the Introspect method itself

945

if (if_tag.getAttribute("name")

946

== dbus.INTROSPECTABLE_IFACE):

947

for cn in if_tag.getElementsByTagName("method"):

948

if cn.getAttribute("name") == "Introspect":

949

for arg in cn.getElementsByTagName("arg"):

950

if (arg.getAttribute("direction")

951

== "out"):

952

arg.setAttribute("name",

953

"xml_data")

954

xmlstring = document.toxml("utf-8")

955

document.unlink()

956

except (AttributeError, xml.dom.DOMException,

957

xml.parsers.expat.ExpatError) as error:

958

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

959

exc_info=error)

960

return xmlstring

961

962

963

class DBusObjectWithProperties(DBusObjectWithAnnotations):

964

"""A D-Bus object with properties.

965

966

Classes inheriting from this can use the dbus_service_property

967

decorator to expose methods as D-Bus properties. It exposes the

968

standard Get(), Set(), and GetAll() methods on the D-Bus.

969

"""

895

970

896

971

def _get_dbus_property(self, interface_name, property_name):

897

972

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

898

973

property with the specified name and interface.

899

974

"""

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

975

for cls in self.__class__.__mro__:

976

for name, value in inspect.getmembers(

977

cls, self._is_dbus_thing("property")):

904

978

if (value._dbus_name == property_name

905

979

and value._dbus_interface == interface_name):

906

980

return value.__get__(self)

907

981

908

982

# No such property

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

983

raise DBusPropertyNotFound("{}:{}.{}".format(

984

self.dbus_object_path, interface_name, property_name))

912

985

913

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

986

@dbus.service.method(dbus.PROPERTIES_IFACE,

987

in_signature="ss",

914

988

out_signature="v")

915

989

def Get(self, interface_name, property_name):

916

990

"""Standard D-Bus property Get() method, see D-Bus standard.

934

1008

# The byte_arrays option is not supported yet on

935

1009

# signatures other than "ay".

936

1010

if prop._dbus_signature != "ay":

937

raise ValueError

1011

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

1012

"'ay' signature {!r}"

1013

.format(prop._dbus_signature))

938

1014

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

939

1015

for byte in value))

940

1016

prop(value)

941

1017

942

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

1018

@dbus.service.method(dbus.PROPERTIES_IFACE,

1019

in_signature="s",

943

1020

out_signature="a{sv}")

944

1021

def GetAll(self, interface_name):

945

1022

"""Standard D-Bus property GetAll() method, see D-Bus

960

1037

if not hasattr(value, "variant_level"):

961

1038

properties[name] = value

962

1039

continue

963

properties[name] = type(value)(value, variant_level=

964

value.variant_level+1)

1040

properties[name] = type(value)(

1041

value, variant_level = value.variant_level + 1)

965

1042

return dbus.Dictionary(properties, signature="sv")

966

1043

1044

@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")

1045

def PropertiesChanged(self, interface_name, changed_properties,

1046

invalidated_properties):

1047

"""Standard D-Bus PropertiesChanged() signal, see D-Bus

1048

standard.

1049

"""

1050

pass

1051

967

1052

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

968

1053

out_signature="s",

969

1054

path_keyword='object_path',

973

1058

974

1059

Inserts property tags and interface annotation tags.

975

1060

"""

976

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

977

connection)

1061

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1062

object_path,

1063

connection)

978

1064

try:

979

1065

document = xml.dom.minidom.parseString(xmlstring)

1066

980

1067

def make_tag(document, name, prop):

981

1068

e = document.createElement("property")

982

1069

e.setAttribute("name", name)

983

1070

e.setAttribute("type", prop._dbus_signature)

984

1071

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

985

1072

return e

1073

986

1074

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

987

1075

# Add property tags

988

1076

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

991

1079

if prop._dbus_interface

992

1080

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

993

1081

if_tag.appendChild(tag)

994

# Add annotation tags

995

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

996

for tag in if_tag.getElementsByTagName(typ):

997

annots = dict()

998

for name, prop in (self.

999

_get_all_dbus_things(typ)):

1000

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

1001

and prop._dbus_interface

1002

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

1003

annots.update(getattr

1004

(prop,

1005

"_dbus_annotations",

1006

{}))

1007

for name, value in annots.iteritems():

1008

ann_tag = document.createElement(

1009

"annotation")

1010

ann_tag.setAttribute("name", name)

1011

ann_tag.setAttribute("value", value)

1012

tag.appendChild(ann_tag)

1013

# Add interface annotation tags

1014

for annotation, value in dict(

1015

itertools.chain.from_iterable(

1016

annotations().iteritems()

1017

for name, annotations in

1018

self._get_all_dbus_things("interface")

1019

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

1020

)).iteritems():

1021

ann_tag = document.createElement("annotation")

1022

ann_tag.setAttribute("name", annotation)

1023

ann_tag.setAttribute("value", value)

1024

if_tag.appendChild(ann_tag)

1082

# Add annotation tags for properties

1083

for tag in if_tag.getElementsByTagName("property"):

1084

annots = dict()

1085

for name, prop in self._get_all_dbus_things(

1086

"property"):

1087

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

1088

and prop._dbus_interface

1089

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

1090

annots.update(getattr(

1091

prop, "_dbus_annotations", {}))

1092

for name, value in annots.items():

1093

ann_tag = document.createElement(

1094

"annotation")

1095

ann_tag.setAttribute("name", name)

1096

ann_tag.setAttribute("value", value)

1097

tag.appendChild(ann_tag)

1025

1098

# Add the names to the return values for the

1026

1099

# "org.freedesktop.DBus.Properties" methods

1027

1100

if (if_tag.getAttribute("name")

1050

1123

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

1051

1124

if dt is None:

1052

1125

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

1053

return dbus.String(dt.isoformat(),

1054

variant_level=variant_level)

1126

return dbus.String(dt.isoformat(), variant_level=variant_level)

1055

1127

1056

1128

1057

1129

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1077

1149

(from DBusObjectWithProperties) and interfaces (from the

1078

1150

dbus_interface_annotations decorator).

1079

1151

"""

1152

1080

1153

def wrapper(cls):

1081

1154

for orig_interface_name, alt_interface_name in (

1082

alt_interface_names.iteritems()):

1155

alt_interface_names.items()):

1083

1156

attr = {}

1084

1157

interface_names = set()

1085

1158

# Go though all attributes of the class

1087

1160

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

1088

1161

# with the wrong interface name

1089

1162

if (not hasattr(attribute, "_dbus_interface")

1090

or not attribute._dbus_interface

1091

.startswith(orig_interface_name)):

1163

or not attribute._dbus_interface.startswith(

1164

orig_interface_name)):

1092

1165

continue

1093

1166

# Create an alternate D-Bus interface name based on

1094

1167

# the current name

1095

alt_interface = (attribute._dbus_interface

1096

.replace(orig_interface_name,

1097

alt_interface_name))

1168

alt_interface = attribute._dbus_interface.replace(

1169

orig_interface_name, alt_interface_name)

1098

1170

interface_names.add(alt_interface)

1099

1171

# Is this a D-Bus signal?

1100

1172

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

1101

# Extract the original non-method undecorated

1102

# function by black magic

1103

nonmethod_func = (dict(

1173

if sys.version_info.major == 2:

1174

# Extract the original non-method undecorated

1175

# function by black magic

1176

nonmethod_func = (dict(

1104

1177

zip(attribute.func_code.co_freevars,

1105

attribute.__closure__))["func"]

1106

.cell_contents)

1178

attribute.__closure__))

1179

["func"].cell_contents)

1180

else:

1181

nonmethod_func = attribute

1107

1182

# Create a new, but exactly alike, function

1108

1183

# object, and decorate it to be a new D-Bus signal

1109

1184

# with the alternate D-Bus interface name

1110

new_function = (dbus.service.signal

1111

(alt_interface,

1112

attribute._dbus_signature)

1113

(types.FunctionType(

1114

nonmethod_func.func_code,

1115

nonmethod_func.func_globals,

1116

nonmethod_func.func_name,

1117

nonmethod_func.func_defaults,

1118

nonmethod_func.func_closure)))

1185

if sys.version_info.major == 2:

1186

new_function = types.FunctionType(

1187

nonmethod_func.func_code,

1188

nonmethod_func.func_globals,

1189

nonmethod_func.func_name,

1190

nonmethod_func.func_defaults,

1191

nonmethod_func.func_closure)

1192

else:

1193

new_function = types.FunctionType(

1194

nonmethod_func.__code__,

1195

nonmethod_func.__globals__,

1196

nonmethod_func.__name__,

1197

nonmethod_func.__defaults__,

1198

nonmethod_func.__closure__)

1199

new_function = (dbus.service.signal(

1200

alt_interface,

1201

attribute._dbus_signature)(new_function))

1119

1202

# Copy annotations, if any

1120

1203

try:

1121

new_function._dbus_annotations = (

1122

dict(attribute._dbus_annotations))

1204

new_function._dbus_annotations = dict(

1205

attribute._dbus_annotations)

1123

1206

except AttributeError:

1124

1207

pass

1125

1208

# Define a creator of a function to call both the

1130

1213

"""This function is a scope container to pass

1131

1214

func1 and func2 to the "call_both" function

1132

1215

outside of its arguments"""

1216

1133

1217

def call_both(*args, **kwargs):

1134

1218

"""This function will emit two D-Bus

1135

1219

signals by calling func1 and func2"""

1136

1220

func1(*args, **kwargs)

1137

1221

func2(*args, **kwargs)

1222

1138

1223

return call_both

1139

1224

# Create the "call_both" function and add it to

1140

1225

# the class

1145

1230

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

1146

1231

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

1147

1232

# to the class.

1148

attr[attrname] = (dbus.service.method

1149

(alt_interface,

1150

attribute._dbus_in_signature,

1151

attribute._dbus_out_signature)

1152

(types.FunctionType

1153

(attribute.func_code,

1154

attribute.func_globals,

1155

attribute.func_name,

1156

attribute.func_defaults,

1157

attribute.func_closure)))

1233

attr[attrname] = (

1234

dbus.service.method(

1235

alt_interface,

1236

attribute._dbus_in_signature,

1237

attribute._dbus_out_signature)

1238

(types.FunctionType(attribute.func_code,

1239

attribute.func_globals,

1240

attribute.func_name,

1241

attribute.func_defaults,

1242

attribute.func_closure)))

1158

1243

# Copy annotations, if any

1159

1244

try:

1160

attr[attrname]._dbus_annotations = (

1161

dict(attribute._dbus_annotations))

1245

attr[attrname]._dbus_annotations = dict(

1246

attribute._dbus_annotations)

1162

1247

except AttributeError:

1163

1248

pass

1164

1249

# Is this a D-Bus property?

1167

1252

# object, and decorate it to be a new D-Bus

1168

1253

# property with the alternate D-Bus interface

1169

1254

# name. Add it to the class.

1170

attr[attrname] = (dbus_service_property

1171

(alt_interface,

1172

attribute._dbus_signature,

1173

attribute._dbus_access,

1174

attribute

1175

._dbus_get_args_options

1176

["byte_arrays"])

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1255

attr[attrname] = (dbus_service_property(

1256

alt_interface, attribute._dbus_signature,

1257

attribute._dbus_access,

1258

attribute._dbus_get_args_options

1259

["byte_arrays"])

1260

(types.FunctionType(

1261

attribute.func_code,

1262

attribute.func_globals,

1263

attribute.func_name,

1264

attribute.func_defaults,

1265

attribute.func_closure)))

1183

1266

# Copy annotations, if any

1184

1267

try:

1185

attr[attrname]._dbus_annotations = (

1186

dict(attribute._dbus_annotations))

1268

attr[attrname]._dbus_annotations = dict(

1269

attribute._dbus_annotations)

1187

1270

except AttributeError:

1188

1271

pass

1189

1272

# Is this a D-Bus interface?

1192

1275

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

1193

1276

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

1194

1277

# to the class.

1195

attr[attrname] = (dbus_interface_annotations

1196

(alt_interface)

1197

(types.FunctionType

1198

(attribute.func_code,

1199

attribute.func_globals,

1200

attribute.func_name,

1201

attribute.func_defaults,

1202

attribute.func_closure)))

1278

attr[attrname] = (

1279

dbus_interface_annotations(alt_interface)

1280

(types.FunctionType(attribute.func_code,

1281

attribute.func_globals,

1282

attribute.func_name,

1283

attribute.func_defaults,

1284

attribute.func_closure)))

1203

1285

if deprecate:

1204

1286

# Deprecate all alternate interfaces

1205

iname="_AlternateDBusNames_interface_annotation{0}"

1287

iname="_AlternateDBusNames_interface_annotation{}"

1206

1288

for interface_name in interface_names:

1289

1207

1290

@dbus_interface_annotations(interface_name)

1208

1291

def func(self):

1209

1292

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

1210

"true" }

1293

"true" }

1211

1294

# Find an unused name

1212

1295

for aname in (iname.format(i)

1213

1296

for i in itertools.count()):

1217

1300

if interface_names:

1218

1301

# Replace the class with a new subclass of it with

1219

1302

# methods, signals, etc. as created above.

1220

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

1221

(cls,), attr)

1303

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

1304

(cls, ), attr)

1222

1305

return cls

1306

1223

1307

return wrapper

1224

1308

1225

1309

1226

1310

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

1227

"se.bsnet.fukt.Mandos"})

1311

"se.bsnet.fukt.Mandos"})

1228

1312

class ClientDBus(Client, DBusObjectWithProperties):

1229

1313

"""A Client class using D-Bus

1230

1314

1234

1318

"""

1235

1319

1236

1320

runtime_expansions = (Client.runtime_expansions

1237

+ ("dbus_object_path",))

1321

+ ("dbus_object_path", ))

1322

1323

_interface = "se.recompile.Mandos.Client"

1238

1324

1239

1325

# dbus.service.Object doesn't use super(), so we can't either.

1240

1326

1243

1329

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

1244

1330

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

1245

1331

# the D-Bus

1246

client_object_name = unicode(self.name).translate(

1332

client_object_name = str(self.name).translate(

1247

1333

{ord("."): ord("_"),

1248

1334

ord("-"): ord("_")})

1249

self.dbus_object_path = (dbus.ObjectPath

1250

("/clients/" + client_object_name))

1335

self.dbus_object_path = dbus.ObjectPath(

1336

"/clients/" + client_object_name)

1251

1337

DBusObjectWithProperties.__init__(self, self.bus,

1252

1338

self.dbus_object_path)

1253

1339

1254

def notifychangeproperty(transform_func,

1255

dbus_name, type_func=lambda x: x,

1256

variant_level=1):

1340

def notifychangeproperty(transform_func, dbus_name,

1341

type_func=lambda x: x,

1342

variant_level=1,

1343

invalidate_only=False,

1344

_interface=_interface):

1257

1345

""" Modify a variable so that it's a property which announces

1258

1346

its changes to DBus.

1259

1347

1264

1352

to the D-Bus. Default: no transform

1265

1353

variant_level: D-Bus variant level. Default: 1

1266

1354

"""

1267

attrname = "_{0}".format(dbus_name)

1355

attrname = "_{}".format(dbus_name)

1356

1268

1357

def setter(self, value):

1269

1358

if hasattr(self, "dbus_object_path"):

1270

1359

if (not hasattr(self, attrname) or

1271

1360

type_func(getattr(self, attrname, None))

1272

1361

!= type_func(value)):

1273

dbus_value = transform_func(type_func(value),

1274

variant_level

1275

=variant_level)

1276

self.PropertyChanged(dbus.String(dbus_name),

1277

dbus_value)

1362

if invalidate_only:

1363

self.PropertiesChanged(

1364

_interface, dbus.Dictionary(),

1365

dbus.Array((dbus_name, )))

1366

else:

1367

dbus_value = transform_func(

1368

type_func(value),

1369

variant_level = variant_level)

1370

self.PropertyChanged(dbus.String(dbus_name),

1371

dbus_value)

1372

self.PropertiesChanged(

1373

_interface,

1374

dbus.Dictionary({ dbus.String(dbus_name):

1375

dbus_value }),

1376

dbus.Array())

1278

1377

setattr(self, attrname, value)

1279

1378

1280

1379

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

1286

1385

enabled = notifychangeproperty(dbus.Boolean, "Enabled")

1287

1386

last_enabled = notifychangeproperty(datetime_to_dbus,

1288

1387

"LastEnabled")

1289

checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",

1290

type_func = lambda checker:

1291

checker is not None)

1388

checker = notifychangeproperty(

1389

dbus.Boolean, "CheckerRunning",

1390

type_func = lambda checker: checker is not None)

1292

1391

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1293

1392

"LastCheckedOK")

1294

1393

last_checker_status = notifychangeproperty(dbus.Int16,

1297

1396

datetime_to_dbus, "LastApprovalRequest")

1298

1397

approved_by_default = notifychangeproperty(dbus.Boolean,

1299

1398

"ApprovedByDefault")

1300

approval_delay = notifychangeproperty(dbus.UInt64,

1301

"ApprovalDelay",

1302

type_func =

1303

timedelta_to_milliseconds)

1399

approval_delay = notifychangeproperty(

1400

dbus.UInt64, "ApprovalDelay",

1401

type_func = lambda td: td.total_seconds() * 1000)

1304

1402

approval_duration = notifychangeproperty(

1305

1403

dbus.UInt64, "ApprovalDuration",

1306

type_func = timedelta_to_milliseconds)

1404

type_func = lambda td: td.total_seconds() * 1000)

1307

1405

host = notifychangeproperty(dbus.String, "Host")

1308

timeout = notifychangeproperty(dbus.UInt64, "Timeout",

1309

type_func =

1310

timedelta_to_milliseconds)

1406

timeout = notifychangeproperty(

1407

dbus.UInt64, "Timeout",

1408

type_func = lambda td: td.total_seconds() * 1000)

1311

1409

extended_timeout = notifychangeproperty(

1312

1410

dbus.UInt64, "ExtendedTimeout",

1313

type_func = timedelta_to_milliseconds)

1314

interval = notifychangeproperty(dbus.UInt64,

1315

"Interval",

1316

type_func =

1317

timedelta_to_milliseconds)

1411

type_func = lambda td: td.total_seconds() * 1000)

1412

interval = notifychangeproperty(

1413

dbus.UInt64, "Interval",

1414

type_func = lambda td: td.total_seconds() * 1000)

1318

1415

checker_command = notifychangeproperty(dbus.String, "Checker")

1416

secret = notifychangeproperty(dbus.ByteArray, "Secret",

1417

invalidate_only=True)

1319

1418

1320

1419

del notifychangeproperty

1321

1420

1328

1427

DBusObjectWithProperties.__del__(self, *args, **kwargs)

1329

1428

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

1330

1429

1331

def checker_callback(self, pid, condition, command,

1332

*args, **kwargs):

1333

self.checker_callback_tag = None

1334

self.checker = None

1335

if os.WIFEXITED(condition):

1336

exitstatus = os.WEXITSTATUS(condition)

1430

def checker_callback(self, source, condition,

1431

connection, command, *args, **kwargs):

1432

ret = Client.checker_callback(self, source, condition,

1433

connection, command, *args,

1434

**kwargs)

1435

exitstatus = self.last_checker_status

1436

if exitstatus >= 0:

1337

1437

# Emit D-Bus signal

1338

1438

self.CheckerCompleted(dbus.Int16(exitstatus),

1339

dbus.Int64(condition),

1439

# This is specific to GNU libC

1440

dbus.Int64(exitstatus << 8),

1340

1441

dbus.String(command))

1341

1442

else:

1342

1443

# Emit D-Bus signal

1343

1444

self.CheckerCompleted(dbus.Int16(-1),

1344

dbus.Int64(condition),

1445

dbus.Int64(

1446

# This is specific to GNU libC

1447

(exitstatus << 8)

1448

| self.last_checker_signal),

1345

1449

dbus.String(command))

1346

1347

return Client.checker_callback(self, pid, condition, command,

1348

*args, **kwargs)

1450

return ret

1349

1451

1350

1452

def start_checker(self, *args, **kwargs):

1351

old_checker = self.checker

1352

if self.checker is not None:

1353

old_checker_pid = self.checker.pid

1354

else:

1355

old_checker_pid = None

1453

old_checker_pid = getattr(self.checker, "pid", None)

1356

1454

r = Client.start_checker(self, *args, **kwargs)

1357

1455

# Only if new checker process was started

1358

1456

if (self.checker is not None

1367

1465

1368

1466

def approve(self, value=True):

1369

1467

self.approved = value

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1468

gobject.timeout_add(int(self.approval_duration.total_seconds()

1469

* 1000), self._reset_approved)

1373

1470

self.send_changedstate()

1374

1471

1375

1472

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1473

1378

1474

## Interfaces

1379

1475

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

1476

## Signals

1386

1477

1387

1478

# CheckerCompleted - signal

1397

1488

pass

1398

1489

1399

1490

# PropertyChanged - signal

1491

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

1400

1492

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

1401

1493

def PropertyChanged(self, property, value):

1402

1494

"D-Bus signal"

1436

1528

self.checked_ok()

1437

1529

1438

1530

# Enable - method

1531

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

1439

1532

@dbus.service.method(_interface)

1440

1533

def Enable(self):

1441

1534

"D-Bus method"

1442

1535

self.enable()

1443

1536

1444

1537

# StartChecker - method

1538

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

1445

1539

@dbus.service.method(_interface)

1446

1540

def StartChecker(self):

1447

1541

"D-Bus method"

1448

1542

self.start_checker()

1449

1543

1450

1544

# Disable - method

1545

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

1451

1546

@dbus.service.method(_interface)

1452

1547

def Disable(self):

1453

1548

"D-Bus method"

1454

1549

self.disable()

1455

1550

1456

1551

# StopChecker - method

1552

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

1457

1553

@dbus.service.method(_interface)

1458

1554

def StopChecker(self):

1459

1555

self.stop_checker()

1466

1562

return dbus.Boolean(bool(self.approvals_pending))

1467

1563

1468

1564

# ApprovedByDefault - property

1469

@dbus_service_property(_interface, signature="b",

1565

@dbus_service_property(_interface,

1566

signature="b",

1470

1567

access="readwrite")

1471

1568

def ApprovedByDefault_dbus_property(self, value=None):

1472

1569

if value is None: # get

1474

1571

self.approved_by_default = bool(value)

1475

1572

1476

1573

# ApprovalDelay - property

1477

@dbus_service_property(_interface, signature="t",

1574

@dbus_service_property(_interface,

1575

signature="t",

1478

1576

access="readwrite")

1479

1577

def ApprovalDelay_dbus_property(self, value=None):

1480

1578

if value is None: # get

1481

return dbus.UInt64(self.approval_delay_milliseconds())

1579

return dbus.UInt64(self.approval_delay.total_seconds()

1580

* 1000)

1482

1581

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

1483

1582

1484

1583

# ApprovalDuration - property

1485

@dbus_service_property(_interface, signature="t",

1584

@dbus_service_property(_interface,

1585

signature="t",

1486

1586

access="readwrite")

1487

1587

def ApprovalDuration_dbus_property(self, value=None):

1488

1588

if value is None: # get

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

1589

return dbus.UInt64(self.approval_duration.total_seconds()

1590

* 1000)

1491

1591

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

1492

1592

1493

1593

# Name - property

1594

@dbus_annotations(

1595

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1494

1596

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

1495

1597

def Name_dbus_property(self):

1496

1598

return dbus.String(self.name)

1497

1599

1498

1600

# Fingerprint - property

1601

@dbus_annotations(

1602

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1499

1603

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

1500

1604

def Fingerprint_dbus_property(self):

1501

1605

return dbus.String(self.fingerprint)

1502

1606

1503

1607

# Host - property

1504

@dbus_service_property(_interface, signature="s",

1608

@dbus_service_property(_interface,

1609

signature="s",

1505

1610

access="readwrite")

1506

1611

def Host_dbus_property(self, value=None):

1507

1612

if value is None: # get

1508

1613

return dbus.String(self.host)

1509

self.host = unicode(value)

1614

self.host = str(value)

1510

1615

1511

1616

# Created - property

1617

@dbus_annotations(

1618

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})

1512

1619

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

1513

1620

def Created_dbus_property(self):

1514

1621

return datetime_to_dbus(self.created)

1519

1626

return datetime_to_dbus(self.last_enabled)

1520

1627

1521

1628

# Enabled - property

1522

@dbus_service_property(_interface, signature="b",

1629

@dbus_service_property(_interface,

1630

signature="b",

1523

1631

access="readwrite")

1524

1632

def Enabled_dbus_property(self, value=None):

1525

1633

if value is None: # get

1530

1638

self.disable()

1531

1639

1532

1640

# LastCheckedOK - property

1533

@dbus_service_property(_interface, signature="s",

1641

@dbus_service_property(_interface,

1642

signature="s",

1534

1643

access="readwrite")

1535

1644

def LastCheckedOK_dbus_property(self, value=None):

1536

1645

if value is not None:

1539

1648

return datetime_to_dbus(self.last_checked_ok)

1540

1649

1541

1650

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

1651

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

1544

1652

def LastCheckerStatus_dbus_property(self):

1545

1653

return dbus.Int16(self.last_checker_status)

1546

1654

1555

1663

return datetime_to_dbus(self.last_approval_request)

1556

1664

1557

1665

# Timeout - property

1558

@dbus_service_property(_interface, signature="t",

1666

@dbus_service_property(_interface,

1667

signature="t",

1559

1668

access="readwrite")

1560

1669

def Timeout_dbus_property(self, value=None):

1561

1670

if value is None: # get

1562

return dbus.UInt64(self.timeout_milliseconds())

1671

return dbus.UInt64(self.timeout.total_seconds() * 1000)

1563

1672

old_timeout = self.timeout

1564

1673

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

1565

1674

# Reschedule disabling

1574

1683

is None):

1575

1684

return

1576

1685

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1686

self.disable_initiator_tag = gobject.timeout_add(

1687

int((self.expires - now).total_seconds() * 1000),

1688

self.disable)

1581

1689

1582

1690

# ExtendedTimeout - property

1583

@dbus_service_property(_interface, signature="t",

1691

@dbus_service_property(_interface,

1692

signature="t",

1584

1693

access="readwrite")

1585

1694

def ExtendedTimeout_dbus_property(self, value=None):

1586

1695

if value is None: # get

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

1696

return dbus.UInt64(self.extended_timeout.total_seconds()

1697

* 1000)

1588

1698

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

1589

1699

1590

1700

# Interval - property

1591

@dbus_service_property(_interface, signature="t",

1701

@dbus_service_property(_interface,

1702

signature="t",

1592

1703

access="readwrite")

1593

1704

def Interval_dbus_property(self, value=None):

1594

1705

if value is None: # get

1595

return dbus.UInt64(self.interval_milliseconds())

1706

return dbus.UInt64(self.interval.total_seconds() * 1000)

1596

1707

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

1597

1708

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

1598

1709

return

1599

1710

if self.enabled:

1600

1711

# Reschedule checker run

1601

1712

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1713

self.checker_initiator_tag = gobject.timeout_add(

1714

value, self.start_checker)

1715

self.start_checker() # Start one now, too

1605

1716

1606

1717

# Checker - property

1607

@dbus_service_property(_interface, signature="s",

1718

@dbus_service_property(_interface,

1719

signature="s",

1608

1720

access="readwrite")

1609

1721

def Checker_dbus_property(self, value=None):

1610

1722

if value is None: # get

1611

1723

return dbus.String(self.checker_command)

1612

self.checker_command = unicode(value)

1724

self.checker_command = str(value)

1613

1725

1614

1726

# CheckerRunning - property

1615

@dbus_service_property(_interface, signature="b",

1727

@dbus_service_property(_interface,

1728

signature="b",

1616

1729

access="readwrite")

1617

1730

def CheckerRunning_dbus_property(self, value=None):

1618

1731

if value is None: # get

1623

1736

self.stop_checker()

1624

1737

1625

1738

# ObjectPath - property

1739

@dbus_annotations(

1740

{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",

1741

"org.freedesktop.DBus.Deprecated": "true"})

1626

1742

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

1627

1743

def ObjectPath_dbus_property(self):

1628

1744

return self.dbus_object_path # is already a dbus.ObjectPath

1629

1745

1630

1746

# Secret = property

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

1747

@dbus_annotations(

1748

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

1749

"invalidates"})

1750

@dbus_service_property(_interface,

1751

signature="ay",

1752

access="write",

1753

byte_arrays=True)

1633

1754

def Secret_dbus_property(self, value):

1634

self.secret = str(value)

1755

self.secret = bytes(value)

1635

1756

1636

1757

del _interface

1637

1758

1641

1762

self._pipe = child_pipe

1642

1763

self._pipe.send(('init', fpr, address))

1643

1764

if not self._pipe.recv():

1644

raise KeyError()

1765

raise KeyError(fpr)

1645

1766

1646

1767

def __getattribute__(self, name):

1647

1768

if name == '_pipe':

1651

1772

if data[0] == 'data':

1652

1773

return data[1]

1653

1774

if data[0] == 'function':

1775

1654

1776

def func(*args, **kwargs):

1655

1777

self._pipe.send(('funcall', name, args, kwargs))

1656

1778

return self._pipe.recv()[1]

1779

1657

1780

return func

1658

1781

1659

1782

def __setattr__(self, name, value):

1671

1794

def handle(self):

1672

1795

with contextlib.closing(self.server.child_pipe) as child_pipe:

1673

1796

logger.info("TCP connection from: %s",

1674

unicode(self.client_address))

1797

str(self.client_address))

1675

1798

logger.debug("Pipe FD: %d",

1676

1799

self.server.child_pipe.fileno())

1677

1800

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1801

session = gnutls.connection.ClientSession(

1802

self.request, gnutls.connection .X509Credentials())

1682

1803

1683

1804

# Note: gnutls.connection.X509Credentials is really a

1684

1805

# generic GnuTLS certificate credentials object so long as

1693

1814

priority = self.server.gnutls_priority

1694

1815

if priority is None:

1695

1816

priority = "NORMAL"

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1817

gnutls.library.functions.gnutls_priority_set_direct(

1818

session._c_object, priority, None)

1699

1819

1700

1820

# Start communication using the Mandos protocol

1701

1821

# Get protocol number

1721

1841

approval_required = False

1722

1842

try:

1723

1843

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1844

fpr = self.fingerprint(

1845

self.peer_certificate(session))

1726

1846

except (TypeError,

1727

1847

gnutls.errors.GNUTLSError) as error:

1728

1848

logger.warning("Bad certificate: %s", error)

1743

1863

while True:

1744

1864

if not client.enabled:

1745

1865

logger.info("Client %s is disabled",

1746

client.name)

1866

client.name)

1747

1867

if self.server.use_dbus:

1748

1868

# Emit D-Bus signal

1749

1869

client.Rejected("Disabled")

1758

1878

if self.server.use_dbus:

1759

1879

# Emit D-Bus signal

1760

1880

client.NeedApproval(

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

1881

client.approval_delay.total_seconds()

1882

* 1000, client.approved_by_default)

1763

1883

else:

1764

1884

logger.warning("Client %s was not approved",

1765

1885

client.name)

1771

1891

#wait until timeout or approved

1772

1892

time = datetime.datetime.now()

1773

1893

client.changedstate.acquire()

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

1894

client.changedstate.wait(delay.total_seconds())

1777

1895

client.changedstate.release()

1778

1896

time2 = datetime.datetime.now()

1779

1897

if (time2 - time) >= delay:

1798

1916

logger.warning("gnutls send failed",

1799

1917

exc_info=error)

1800

1918

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1919

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

1920

len(client.secret) - (sent_size

1921

+ sent))

1804

1922

sent_size += sent

1805

1923

1806

1924

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

1823

1941

def peer_certificate(session):

1824

1942

"Return the peer's OpenPGP certificate as a bytestring"

1825

1943

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1944

if (gnutls.library.functions.gnutls_certificate_type_get(

1945

session._c_object)

1828

1946

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

1947

# ...do the normal thing

1830

1948

return session.peer_certificate

1844

1962

def fingerprint(openpgp):

1845

1963

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1846

1964

# New GnuTLS "datum" with the OpenPGP public key

1847

datum = (gnutls.library.types

1848

.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

1965

datum = gnutls.library.types.gnutls_datum_t(

1966

ctypes.cast(ctypes.c_char_p(openpgp),

1967

ctypes.POINTER(ctypes.c_ubyte)),

1968

ctypes.c_uint(len(openpgp)))

1852

1969

# New empty GnuTLS certificate

1853

1970

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

1971

gnutls.library.functions.gnutls_openpgp_crt_init(

1972

ctypes.byref(crt))

1856

1973

# Import the OpenPGP public key into the certificate

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

1974

gnutls.library.functions.gnutls_openpgp_crt_import(

1975

crt, ctypes.byref(datum),

1976

gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)

1861

1977

# Verify the self signature in the key

1862

1978

crtverify = ctypes.c_uint()

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

1979

gnutls.library.functions.gnutls_openpgp_crt_verify_self(

1980

crt, 0, ctypes.byref(crtverify))

1866

1981

if crtverify.value != 0:

1867

1982

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

1983

raise gnutls.errors.CertificateSecurityError(

1984

"Verify failed")

1870

1985

# New buffer for the fingerprint

1871

1986

buf = ctypes.create_string_buffer(20)

1872

1987

buf_len = ctypes.c_size_t()

1873

1988

# Get the fingerprint from the certificate into the buffer

1874

(gnutls.library.functions

1875

.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),

1876

ctypes.byref(buf_len)))

1989

gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(

1990

crt, ctypes.byref(buf), ctypes.byref(buf_len))

1877

1991

# Deinit the certificate

1878

1992

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1879

1993

# Convert the buffer to a Python bytestring

1885

1999

1886

2000

class MultiprocessingMixIn(object):

1887

2001

"""Like socketserver.ThreadingMixIn, but with multiprocessing"""

2002

1888

2003

def sub_process_main(self, request, address):

1889

2004

try:

1890

2005

self.finish_request(request, address)

1902

2017

1903

2018

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1904

2019

""" adds a pipe to the MixIn """

2020

1905

2021

def process_request(self, request, client_address):

1906

2022

"""Overrides and wraps the original process_request().

1907

2023

1928

2044

interface: None or a network interface name (string)

1929

2045

use_ipv6: Boolean; to use IPv6 or not

1930

2046

"""

2047

1931

2048

def __init__(self, server_address, RequestHandlerClass,

1932

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

2049

interface=None,

2050

use_ipv6=True,

2051

socketfd=None):

1933

2052

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

1934

2053

creating a new one with socket.socket().

1935

2054

"""

1976

2095

self.interface)

1977

2096

else:

1978

2097

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

2098

self.socket.setsockopt(

2099

socket.SOL_SOCKET, SO_BINDTODEVICE,

2100

(self.interface + "\0").encode("utf-8"))

1982

2101

except socket.error as error:

1983

2102

if error.errno == errno.EPERM:

1984

2103

logger.error("No permission to bind to"

2002

2121

self.server_address = (any_address,

2003

2122

self.server_address[1])

2004

2123

elif not self.server_address[1]:

2005

self.server_address = (self.server_address[0],

2006

0)

2124

self.server_address = (self.server_address[0], 0)

2007

2125

# if self.interface:

2008

2126

# self.server_address = (self.server_address[0],

2009

2127

# 0, # port

2023

2141

2024

2142

Assumes a gobject.MainLoop event loop.

2025

2143

"""

2144

2026

2145

def __init__(self, server_address, RequestHandlerClass,

2027

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

2028

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

2146

interface=None,

2147

use_ipv6=True,

2148

clients=None,

2149

gnutls_priority=None,

2150

use_dbus=True,

2151

socketfd=None):

2029

2152

self.enabled = False

2030

2153

self.clients = clients

2031

2154

if self.clients is None:

2037

2160

interface = interface,

2038

2161

use_ipv6 = use_ipv6,

2039

2162

socketfd = socketfd)

2163

2040

2164

def server_activate(self):

2041

2165

if self.enabled:

2042

2166

return socketserver.TCPServer.server_activate(self)

2046

2170

2047

2171

def add_pipe(self, parent_pipe, proc):

2048

2172

# Call "handle_ipc" for both data and EOF events

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2173

gobject.io_add_watch(

2174

parent_pipe.fileno(),

2175

gobject.IO_IN | gobject.IO_HUP,

2176

functools.partial(self.handle_ipc,

2177

parent_pipe = parent_pipe,

2178

proc = proc))

2055

2179

2056

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

2057

proc = None, client_object=None):

2180

def handle_ipc(self, source, condition,

2181

parent_pipe=None,

2182

proc = None,

2183

client_object=None):

2058

2184

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

2059

2185

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

2060

2186

# Wait for other process to exit

2083

2209

parent_pipe.send(False)

2084

2210

return False

2085

2211

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2212

gobject.io_add_watch(

2213

parent_pipe.fileno(),

2214

gobject.IO_IN | gobject.IO_HUP,

2215

functools.partial(self.handle_ipc,

2216

parent_pipe = parent_pipe,

2217

proc = proc,

2218

client_object = client))

2094

2219

parent_pipe.send(True)

2095

2220

# remove the old hook in favor of the new above hook on

2096

2221

# same fileno

2102

2227

2103

2228

parent_pipe.send(('data', getattr(client_object,

2104

2229

funcname)(*args,

2105

**kwargs)))

2230

**kwargs)))

2106

2231

2107

2232

if command == 'getattr':

2108

2233

attrname = request[1]

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2234

if isinstance(client_object.__getattribute__(attrname),

2235

collections.Callable):

2236

parent_pipe.send(('function', ))

2111

2237

else:

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2238

parent_pipe.send((

2239

'data', client_object.__getattribute__(attrname)))

2114

2240

2115

2241

if command == 'setattr':

2116

2242

attrname = request[1]

2147

2273

# avoid excessive use of external libraries.

2148

2274

2149

2275

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2276

Token = collections.namedtuple("Token", (

2277

"regexp", # To match token; if "value" is not None, must have

2278

# a "group" containing digits

2279

"value", # datetime.timedelta or None

2280

"followers")) # Tokens valid after this token

2159

2281

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

2160

2282

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

2161

2283

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

2162

2284

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

2163

2285

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2286

frozenset((token_end, )))

2165

2287

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

2166

2288

datetime.timedelta(minutes=1),

2167

2289

frozenset((token_second, token_end)))

2183

2305

frozenset((token_month, token_end)))

2184

2306

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

2185

2307

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2308

frozenset((token_end, )))

2187

2309

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

2188

2310

frozenset((token_year, token_month,

2189

2311

token_day, token_time,

2190

token_week))),

2312

token_week)))

2191

2313

# Define starting values

2192

2314

value = datetime.timedelta() # Value so far

2193

2315

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2316

followers = frozenset((token_duration, )) # Following valid tokens

2195

2317

s = duration # String left to parse

2196

2318

# Loop until end token is found

2197

2319

while found_token is not token_end:

2214

2336

break

2215

2337

else:

2216

2338

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2339

raise ValueError("Invalid RFC 3339 duration: {!r}"

2340

.format(duration))

2218

2341

# End token found

2219

2342

return value

2220

2343

2244

2367

timevalue = datetime.timedelta(0)

2245

2368

for s in interval.split():

2246

2369

try:

2247

suffix = unicode(s[-1])

2370

suffix = s[-1]

2248

2371

value = int(s[:-1])

2249

2372

if suffix == "d":

2250

2373

delta = datetime.timedelta(value)

2257

2380

elif suffix == "w":

2258

2381

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

2259

2382

else:

2260

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

2261

.format(suffix))

2383

raise ValueError("Unknown suffix {!r}".format(suffix))

2262

2384

except IndexError as e:

2263

2385

raise ValueError(*(e.args))

2264

2386

timevalue += delta

2281

2403

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

2282

2404

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

2283

2405

raise OSError(errno.ENODEV,

2284

"{0} not a character device"

2406

"{} not a character device"

2285

2407

.format(os.devnull))

2286

2408

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

2287

2409

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

2297

2419

2298

2420

parser = argparse.ArgumentParser()

2299

2421

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

2300

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

2422

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

2301

2423

help="show version number and exit")

2302

2424

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

2303

2425

help="Bind to interface IF")

2336

2458

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

2337

2459

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

2338

2460

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

2461

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

2462

dest="zeroconf", help="Do not use Zeroconf",

2463

default=None)

2339

2464

2340

2465

options = parser.parse_args()

2341

2466

2342

2467

if options.check:

2343

2468

import doctest

2344

doctest.testmod()

2345

sys.exit()

2469

fail_count, test_count = doctest.testmod()

2470

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

2346

2471

2347

2472

# Default values for config file for server-global settings

2348

2473

server_defaults = { "interface": "",

2350

2475

"port": "",

2351

2476

"debug": "False",

2352

2477

"priority":

2353

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

2478

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

2479

":+SIGN-DSA-SHA256",

2354

2480

"servicename": "Mandos",

2355

2481

"use_dbus": "True",

2356

2482

"use_ipv6": "True",

2359

2485

"socket": "",

2360

2486

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

2361

2487

"foreground": "False",

2362

}

2488

"zeroconf": "True",

2489

}

2363

2490

2364

2491

# Parse config file for server-global settings

2365

2492

server_config = configparser.SafeConfigParser(server_defaults)

2366

2493

del server_defaults

2367

server_config.read(os.path.join(options.configdir,

2368

"mandos.conf"))

2494

server_config.read(os.path.join(options.configdir, "mandos.conf"))

2369

2495

# Convert the SafeConfigParser object to a dict

2370

2496

server_settings = server_config.defaults()

2371

2497

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

2389

2515

# Override the settings from the config file with command line

2390

2516

# options, if set.

2391

2517

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

2392

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

2393

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

2394

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

2518

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

2519

"use_ipv6", "debuglevel", "restore", "statedir",

2520

"socket", "foreground", "zeroconf"):

2395

2521

value = getattr(options, option)

2396

2522

if value is not None:

2397

2523

server_settings[option] = value

2398

2524

del options

2399

2525

# Force all strings to be unicode

2400

2526

for option in server_settings.keys():

2401

if type(server_settings[option]) is str:

2402

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

2527

if isinstance(server_settings[option], bytes):

2528

server_settings[option] = (server_settings[option]

2529

.decode("utf-8"))

2403

2530

# Force all boolean options to be boolean

2404

2531

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

2405

"foreground"):

2532

"foreground", "zeroconf"):

2406

2533

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

2407

2534

# Debug implies foreground

2408

2535

if server_settings["debug"]:

2411

2538

2412

2539

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

2413

2540

2541

if (not server_settings["zeroconf"]

2542

and not (server_settings["port"]

2543

or server_settings["socket"] != "")):

2544

parser.error("Needs port or socket to work without Zeroconf")

2545

2414

2546

# For convenience

2415

2547

debug = server_settings["debug"]

2416

2548

debuglevel = server_settings["debuglevel"]

2419

2551

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

2420

2552

stored_state_file)

2421

2553

foreground = server_settings["foreground"]

2554

zeroconf = server_settings["zeroconf"]

2422

2555

2423

2556

if debug:

2424

2557

initlogger(debug, logging.DEBUG)

2430

2563

initlogger(debug, level)

2431

2564

2432

2565

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

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2566

syslogger.setFormatter(

2567

logging.Formatter('Mandos ({}) [%(process)d]:'

2568

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

2569

server_settings["servicename"])))

2438

2570

2439

2571

# Parse config file with clients

2440

2572

client_config = configparser.SafeConfigParser(Client

2445

2577

global mandos_dbus_service

2446

2578

mandos_dbus_service = None

2447

2579

2448

tcp_server = MandosServer((server_settings["address"],

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

2580

socketfd = None

2581

if server_settings["socket"] != "":

2582

socketfd = server_settings["socket"]

2583

tcp_server = MandosServer(

2584

(server_settings["address"], server_settings["port"]),

2585

ClientHandler,

2586

interface=(server_settings["interface"] or None),

2587

use_ipv6=use_ipv6,

2588

gnutls_priority=server_settings["priority"],

2589

use_dbus=use_dbus,

2590

socketfd=socketfd)

2459

2591

if not foreground:

2460

2592

pidfilename = "/run/mandos.pid"

2461

2593

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

2462

2594

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

2463

2595

pidfile = None

2464

2596

try:

2465

pidfile = open(pidfilename, "w")

2597

pidfile = codecs.open(pidfilename, "w", encoding="utf-8")

2466

2598

except IOError as e:

2467

2599

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

2468

2600

exc_info=e)

2495

2627

def debug_gnutls(level, string):

2496

2628

logger.debug("GnuTLS: %s", string[:-1])

2497

2629

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2630

gnutls.library.functions.gnutls_global_set_log_function(

2631

debug_gnutls)

2500

2632

2501

2633

# Redirect stdin so all checkers get /dev/null

2502

2634

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

2522

2654

if use_dbus:

2523

2655

try:

2524

2656

bus_name = dbus.service.BusName("se.recompile.Mandos",

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

2657

bus,

2658

do_not_queue=True)

2659

old_bus_name = dbus.service.BusName(

2660

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

2661

do_not_queue=True)

2662

except dbus.exceptions.DBusException as e:

2530

2663

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

2531

2664

use_dbus = False

2532

2665

server_settings["use_dbus"] = False

2533

2666

tcp_server.use_dbus = False

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

(str(server_settings["interface"])))

2667

if zeroconf:

2668

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2669

service = AvahiServiceToSyslog(

2670

name = server_settings["servicename"],

2671

servicetype = "_mandos._tcp",

2672

protocol = protocol,

2673

bus = bus)

2674

if server_settings["interface"]:

2675

service.interface = if_nametoindex(

2676

server_settings["interface"].encode("utf-8"))

2542

2677

2543

2678

global multiprocessing_manager

2544

2679

multiprocessing_manager = multiprocessing.Manager()

2563

2698

if server_settings["restore"]:

2564

2699

try:

2565

2700

with open(stored_state_path, "rb") as stored_state:

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

2701

clients_data, old_client_settings = pickle.load(

2702

stored_state)

2568

2703

os.remove(stored_state_path)

2569

2704

except IOError as e:

2570

2705

if e.errno == errno.ENOENT:

2571

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

2572

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

2706

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

2707

" {}".format(os.strerror(e.errno)))

2573

2708

else:

2574

2709

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

2575

2710

exc_info=e)

2576

2711

raise

2577

2712

except EOFError as e:

2578

2713

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

2579

"EOFError:", exc_info=e)

2714

"EOFError:",

2715

exc_info=e)

2580

2716

2581

2717

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

2718

for client_name, client in clients_data.items():

2583

2719

# Skip removed clients

2584

2720

if client_name not in client_settings:

2585

2721

continue

2594

2730

# For each value in new config, check if it

2595

2731

# differs from the old config value (Except for

2596

2732

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

2733

if (name != "secret"

2734

and (value !=

2735

old_client_settings[client_name][name])):

2600

2736

client[name] = value

2601

2737

except KeyError:

2602

2738

pass

2603

2739

2604

2740

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

2741

# enabled if its last checker was successful. A Client

2606

2742

# whose checker succeeded before we stored its state is

2607

2743

# assumed to have successfully run all checkers during

2608

2744

# downtime.

2610

2746

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

2611

2747

if not client["last_checked_ok"]:

2612

2748

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

2749

"disabling client {} - Client never "

2750

"performed a successful checker".format(

2751

client_name))

2616

2752

client["enabled"] = False

2617

2753

elif client["last_checker_status"] != 0:

2618

2754

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

2755

"disabling client {} - Client last"

2756

" checker failed with error code"

2757

" {}".format(

2758

client_name,

2759

client["last_checker_status"]))

2623

2760

client["enabled"] = False

2624

2761

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

2762

client["expires"] = (

2763

datetime.datetime.utcnow()

2764

+ client["timeout"])

2628

2765

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

2766

" keeping {} enabled".format(

2767

client_name))

2631

2768

try:

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

2769

client["secret"] = pgp.decrypt(

2770

client["encrypted_secret"],

2771

client_settings[client_name]["secret"])

2636

2772

except PGPError:

2637

2773

# If decryption fails, we use secret from new settings

2638

logger.debug("Failed to decrypt {0} old secret"

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2774

logger.debug("Failed to decrypt {} old secret".format(

2775

client_name))

2776

client["secret"] = (client_settings[client_name]

2777

["secret"])

2642

2778

2643

2779

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

2644

2780

for client_name in (set(old_client_settings)

2649

2785

clients_data[client_name] = client_settings[client_name]

2650

2786

2651

2787

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

2788

for client_name, client in clients_data.items():

2653

2789

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2790

name = client_name,

2791

settings = client,

2655

2792

server_settings = server_settings)

2656

2793

2657

2794

if not tcp_server.clients:

2659

2796

2660

2797

if not foreground:

2661

2798

if pidfile is not None:

2799

pid = os.getpid()

2662

2800

try:

2663

2801

with pidfile:

2664

pid = os.getpid()

2665

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

2802

print(pid, file=pidfile)

2666

2803

except IOError:

2667

2804

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

2668

2805

pidfilename, pid)

2673

2810

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

2674

2811

2675

2812

if use_dbus:

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

2813

2814

@alternate_dbus_interfaces(

2815

{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })

2816

class MandosDBusService(DBusObjectWithAnnotations):

2679

2817

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

2818

2680

2819

def __init__(self):

2681

2820

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

2821

2682

2822

_interface = "se.recompile.Mandos"

2683

2823

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

2690

2824

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

2691

2825

def ClientAdded(self, objpath):

2692

2826

"D-Bus signal"

2705

2839

@dbus.service.method(_interface, out_signature="ao")

2706

2840

def GetAllClients(self):

2707

2841

"D-Bus method"

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2842

return dbus.Array(c.dbus_object_path for c in

2710

2843

tcp_server.clients.itervalues())

2711

2844

2712

2845

@dbus.service.method(_interface,

2714

2847

def GetAllClientsWithProperties(self):

2715

2848

"D-Bus method"

2716

2849

return dbus.Dictionary(

2717

((c.dbus_object_path, c.GetAll(""))

2718

for c in tcp_server.clients.itervalues()),

2850

{ c.dbus_object_path: c.GetAll("")

2851

for c in tcp_server.clients.itervalues() },

2719

2852

signature="oa{sv}")

2720

2853

2721

2854

@dbus.service.method(_interface, in_signature="o")

2738

2871

2739

2872

def cleanup():

2740

2873

"Cleanup function; run on exit"

2741

service.cleanup()

2874

if zeroconf:

2875

service.cleanup()

2742

2876

2743

2877

multiprocessing.active_children()

2744

2878

wnull.close()

2758

2892

2759

2893

# A list of attributes that can not be pickled

2760

2894

# + secret.

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

2895

exclude = { "bus", "changedstate", "secret",

2896

"checker", "server_settings" }

2897

for name, typ in inspect.getmembers(dbus.service

2898

.Object):

2765

2899

exclude.add(name)

2766

2900

2767

2901

client_dict["encrypted_secret"] = (client

2774

2908

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

2775

2909

2776

2910

try:

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2911

with tempfile.NamedTemporaryFile(

2912

mode='wb',

2913

suffix=".pickle",

2914

prefix='clients-',

2915

dir=os.path.dirname(stored_state_path),

2916

delete=False) as stored_state:

2781

2917

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

2782

tempname=stored_state.name

2918

tempname = stored_state.name

2783

2919

os.rename(tempname, stored_state_path)

2784

2920

except (IOError, OSError) as e:

2785

2921

if not debug:

2788

2924

except NameError:

2789

2925

pass

2790

2926

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

2791

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

2927

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

2792

2928

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

2793

2929

else:

2794

2930

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

2804

2940

client.disable(quiet=True)

2805

2941

if use_dbus:

2806

2942

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

2943

mandos_dbus_service.ClientRemoved(

2944

client.dbus_object_path, client.name)

2810

2945

client_settings.clear()

2811

2946

2812

2947

atexit.register(cleanup)

2823

2958

tcp_server.server_activate()

2824

2959

2825

2960

# Find out what port we got

2826

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

2961

if zeroconf:

2962

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

2827

2963

if use_ipv6:

2828

2964

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

2829

2965

" flowinfo %d, scope_id %d",

2835

2971

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

2836

2972

2837

2973

try:

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2974

if zeroconf:

2975

# From the Avahi example code

2976

try:

2977

service.activate()

2978

except dbus.exceptions.DBusException as error:

2979

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

2980

cleanup()

2981

sys.exit(1)

2982

# End of Avahi example code

2846

2983

2847

2984

gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,

2848

2985

lambda *args, **kwargs:

2863

3000

# Must run before the D-Bus bus name gets deregistered

2864

3001

cleanup()

2865

3002

3003

2866

3004

if __name__ == '__main__':

2867

3005

main()