/mandos/trunk : revision 742

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

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

66

68

import binascii

67

69

import tempfile

68

70

import itertools

71

import collections

69

72

70

73

import dbus

71

74

import dbus.service

76

79

import ctypes.util

77

80

import xml.dom.minidom

78

81

import inspect

79

import GnuPGInterface

80

82

81

83

try:

82

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

88

except ImportError:

87

89

SO_BINDTODEVICE = None

88

90

89

version = "1.5.3"

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.9"

90

95

stored_state_file = "clients.pickle"

91

96

92

97

logger = logging.getLogger()

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

98

syslogger = None

96

99

97

100

try:

98

101

if_nametoindex = (ctypes.cdll.LoadLibrary

104

107

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

105

108

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

106

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

110

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

111

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

111

112

return interface_index

112

113

114

115

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

115

116

"""init logger and add loglevel"""

116

117

118

global syslogger

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

117

123

syslogger.setFormatter(logging.Formatter

118

124

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

119

125

' %(message)s'))

137

143

class PGPEngine(object):

138

144

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

139

145

def __init__(self):

140

self.gnupg = GnuPGInterface.GnuPG()

141

146

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

142

self.gnupg = GnuPGInterface.GnuPG()

143

self.gnupg.options.meta_interactive = False

144

self.gnupg.options.homedir = self.tempdir

145

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

146

'--quiet',

147

'--no-use-agent'])

147

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

149

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

148

152

149

153

def __enter__(self):

150

154

return self

151

155

152

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

156

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

153

157

self._cleanup()

154

158

return False

155

159

172

176

def password_encode(self, password):

173

177

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

174

178

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

175

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

179

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

180

if len(encoded) > 2048:

181

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

182

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

183

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

184

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

185

return encoded

176

186

177

187

def encrypt(self, data, password):

178

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

179

with open(os.devnull, "w") as devnull:

180

try:

181

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

182

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

183

attach_fhs={'stderr': devnull})

184

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

185

f.write(data)

186

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

187

ciphertext = f.read()

188

proc.wait()

189

except IOError as e:

190

raise PGPError(e)

191

self.gnupg.passphrase = None

188

passphrase = self.password_encode(password)

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

191

passfile.write(passphrase)

192

passfile.flush()

193

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

194

'--passphrase-file',

195

passfile.name]

196

+ self.gnupgargs,

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

201

if proc.returncode != 0:

202

raise PGPError(err)

192

203

return ciphertext

193

204

194

205

def decrypt(self, data, password):

195

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

196

with open(os.devnull, "w") as devnull:

197

try:

198

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

199

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

200

attach_fhs={'stderr': devnull})

201

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

202

f.write(data)

203

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

204

decrypted_plaintext = f.read()

205

proc.wait()

206

except IOError as e:

207

raise PGPError(e)

208

self.gnupg.passphrase = None

206

passphrase = self.password_encode(password)

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

209

passfile.write(passphrase)

210

passfile.flush()

211

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

212

'--passphrase-file',

213

passfile.name]

214

+ self.gnupgargs,

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

220

if proc.returncode != 0:

221

raise PGPError(err)

209

222

return decrypted_plaintext

210

223

211

224

212

225

class AvahiError(Exception):

213

226

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

214

227

self.value = value

215

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

216

def __unicode__(self):

217

return unicode(repr(self.value))

228

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

229

**kwargs)

218

230

219

231

class AvahiServiceError(AvahiError):

220

232

pass

231

243

Used to optionally bind to the specified interface.

232

244

name: string; Example: 'Mandos'

233

245

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

234

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

246

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

235

247

port: integer; what port to announce

236

248

TXT: list of strings; TXT record for the service

237

249

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

263

275

self.bus = bus

264

276

self.entry_group_state_changed_match = None

265

277

266

def rename(self):

278

def rename(self, remove=True):

267

279

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

268

280

if self.rename_count >= self.max_renames:

269

281

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

270

282

" after %i retries, exiting.",

271

283

self.rename_count)

272

284

raise AvahiServiceError("Too many renames")

273

self.name = unicode(self.server

274

.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

287

self.rename_count += 1

275

288

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

276

289

self.name)

277

self.remove()

290

if remove:

291

self.remove()

278

292

try:

279

293

self.add()

280

294

except dbus.exceptions.DBusException as error:

281

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

282

self.cleanup()

283

os._exit(1)

284

self.rename_count += 1

295

if (error.get_dbus_name()

296

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

297

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

298

return self.rename(remove=False)

299

else:

300

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

301

self.cleanup()

302

os._exit(1)

285

303

286

304

def remove(self):

287

305

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

325

343

self.rename()

326

344

elif state == avahi.ENTRY_GROUP_FAILURE:

327

345

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

328

unicode(error))

329

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

346

str(error))

347

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

330

348

.format(error))

331

349

332

350

def cleanup(self):

377

395

self.server_state_changed)

378

396

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

379

397

398

380

399

class AvahiServiceToSyslog(AvahiService):

381

def rename(self):

400

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

382

401

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

383

ret = AvahiService.rename(self)

402

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

384

403

syslogger.setFormatter(logging.Formatter

385

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

404

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

386

405

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

387

406

.format(self.name)))

388

407

return ret

389

408

390

def timedelta_to_milliseconds(td):

391

"Convert a datetime.timedelta() to milliseconds"

392

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

393

+ (td.seconds * 1000)

394

+ (td.microseconds // 1000))

395

409

396

410

class Client(object):

397

411

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

434

448

runtime_expansions: Allowed attributes for runtime expansion.

435

449

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

436

450

disabled, or None

451

server_settings: The server_settings dict from main()

437

452

"""

438

453

439

454

runtime_expansions = ("approval_delay", "approval_duration",

440

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

441

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

455

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

456

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

457

"last_approval_request", "last_checked_ok",

442

458

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

443

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

444

"extended_timeout": "15m",

445

"interval": "2m",

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

446

462

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

447

463

"host": "",

448

"approval_delay": "0s",

449

"approval_duration": "1s",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

450

466

"approved_by_default": "True",

451

467

"enabled": "True",

452

468

}

453

469

454

def timeout_milliseconds(self):

455

"Return the 'timeout' attribute in milliseconds"

456

return timedelta_to_milliseconds(self.timeout)

457

458

def extended_timeout_milliseconds(self):

459

"Return the 'extended_timeout' attribute in milliseconds"

460

return timedelta_to_milliseconds(self.extended_timeout)

461

462

def interval_milliseconds(self):

463

"Return the 'interval' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.interval)

465

466

def approval_delay_milliseconds(self):

467

return timedelta_to_milliseconds(self.approval_delay)

468

469

470

@staticmethod

470

471

def config_parser(config):

471

472

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

486

487

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

487

488

"enabled")

488

489

490

# Uppercase and remove spaces from fingerprint for later

491

# comparison purposes with return value from the

492

# fingerprint() function

489

493

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

490

494

.replace(" ", ""))

491

495

if "secret" in section:

496

500

"rb") as secfile:

497

501

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

498

502

else:

499

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

503

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

500

504

.format(section))

501

505

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

502

506

client["extended_timeout"] = string_to_delta(

513

517

514

518

return settings

515

519

516

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

520

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

517

521

self.name = name

522

if server_settings is None:

523

server_settings = {}

524

self.server_settings = server_settings

518

525

# adding all client settings

519

for setting, value in settings.iteritems():

526

for setting, value in settings.items():

520

527

setattr(self, setting, value)

521

528

522

529

if self.enabled:

530

537

self.expires = None

531

538

532

539

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

533

# Uppercase and remove spaces from fingerprint for later

534

# comparison purposes with return value from the fingerprint()

535

# function

536

540

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

537

541

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

538

542

datetime.datetime.utcnow())

570

574

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

571

575

# Already enabled

572

576

return

573

self.send_changedstate()

574

577

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

575

578

self.enabled = True

576

579

self.last_enabled = datetime.datetime.utcnow()

577

580

self.init_checker()

581

self.send_changedstate()

578

582

579

583

def disable(self, quiet=True):

580

584

"""Disable this client."""

581

585

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

582

586

return False

583

587

if not quiet:

584

self.send_changedstate()

585

if not quiet:

586

588

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

587

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

589

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

588

590

gobject.source_remove(self.disable_initiator_tag)

589

591

self.disable_initiator_tag = None

590

592

self.expires = None

591

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

593

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

592

594

gobject.source_remove(self.checker_initiator_tag)

593

595

self.checker_initiator_tag = None

594

596

self.stop_checker()

595

597

self.enabled = False

598

if not quiet:

599

self.send_changedstate()

596

600

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

597

601

return False

598

602

606

def init_checker(self):

603

607

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

604

608

# and every interval from then on.

609

if self.checker_initiator_tag is not None:

610

gobject.source_remove(self.checker_initiator_tag)

605

611

self.checker_initiator_tag = (gobject.timeout_add

606

(self.interval_milliseconds(),

612

(int(self.interval

613

.total_seconds() * 1000),

607

614

self.start_checker))

608

615

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

616

if self.disable_initiator_tag is not None:

617

gobject.source_remove(self.disable_initiator_tag)

609

618

self.disable_initiator_tag = (gobject.timeout_add

610

(self.timeout_milliseconds(),

611

self.disable))

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

612

622

# Also start a new checker *right now*.

613

623

self.start_checker()

614

624

642

652

timeout = self.timeout

643

653

if self.disable_initiator_tag is not None:

644

654

gobject.source_remove(self.disable_initiator_tag)

655

self.disable_initiator_tag = None

645

656

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

646

657

self.disable_initiator_tag = (gobject.timeout_add

647

(timedelta_to_milliseconds

648

(timeout), self.disable))

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

649

660

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

650

661

651

662

def need_approval(self):

657

668

If a checker already exists, leave it running and do

658

669

nothing."""

659

670

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

660

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

661

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

662

# client would inevitably timeout, since no checker would get

663

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

671

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

672

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

673

# would inevitably timeout, since no checker would get a

674

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

664

675

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

665

676

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

666

677

# should be.

668

679

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

669

680

try:

670

681

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

671

except (AttributeError, OSError) as error:

672

if (isinstance(error, OSError)

673

and error.errno != errno.ECHILD):

674

raise error

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

675

687

else:

676

688

if pid:

677

689

logger.warning("Checker was a zombie")

680

692

self.current_checker_command)

681

693

# Start a new checker if needed

682

694

if self.checker is None:

695

# Escape attributes for the shell

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

683

699

try:

684

# In case checker_command has exactly one % operator

685

command = self.checker_command % self.host

686

except TypeError:

687

# Escape attributes for the shell

688

escaped_attrs = dict(

689

(attr,

690

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

691

errors=

692

'replace')))

693

for attr in

694

self.runtime_expansions)

695

696

try:

697

command = self.checker_command % escaped_attrs

698

except TypeError as error:

699

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

700

self.checker_command, exc_info=error)

701

return True # Try again later

700

command = self.checker_command % escaped_attrs

701

except TypeError as error:

702

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

702

705

self.current_checker_command = command

703

706

try:

704

707

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

707

710

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

708

711

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

709

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

710

721

self.checker = subprocess.Popen(command,

711

722

close_fds=True,

712

shell=True, cwd="/")

713

self.checker_callback_tag = (gobject.child_watch_add

714

(self.checker.pid,

715

self.checker_callback,

716

data=command))

717

# The checker may have completed before the gobject

718

# watch was added. Check for this.

719

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

720

if pid:

721

gobject.source_remove(self.checker_callback_tag)

722

self.checker_callback(pid, status, command)

723

shell=True, cwd="/",

724

**popen_args)

723

725

except OSError as error:

724

726

logger.error("Failed to start subprocess",

725

727

exc_info=error)

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

726

747

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

727

748

return True

728

749

761

782

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

762

783

if byte_arrays and signature != "ay":

763

784

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

764

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

785

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

765

786

def decorator(func):

766

787

func._dbus_is_property = True

767

788

func._dbus_interface = dbus_interface

798

819

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

799

820

Usage:

800

821

822

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

823

"org.freedesktop.DBus.Property."

824

"EmitsChangedSignal": "false"})

801

825

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

802

826

access="r")

803

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

804

"org.freedesktop.DBus.Property."

805

"EmitsChangedSignal": "false"})

806

827

def Property_dbus_property(self):

807

828

return dbus.Boolean(False)

808

829

"""

815

836

class DBusPropertyException(dbus.exceptions.DBusException):

816

837

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

817

838

"""

818

def __unicode__(self):

819

return unicode(str(self))

820

839

pass

821

840

822

841

class DBusPropertyAccessException(DBusPropertyException):

823

842

"""A property's access permissions disallows an operation.

846

865

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

847

866

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

848

867

"""

849

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

868

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

850

869

False)

851

870

852

871

def _get_all_dbus_things(self, thing):

901

920

# The byte_arrays option is not supported yet on

902

921

# signatures other than "ay".

903

922

if prop._dbus_signature != "ay":

904

raise ValueError

923

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

924

"'ay' signature {!r}"

925

.format(prop._dbus_signature))

905

926

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

906

927

for byte in value))

907

928

prop(value)

931

952

value.variant_level+1)

932

953

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

933

954

955

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

956

def PropertiesChanged(self, interface_name, changed_properties,

957

invalidated_properties):

958

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

959

standard.

960

"""

961

pass

962

934

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

935

964

out_signature="s",

936

965

path_keyword='object_path',

971

1000

(prop,

972

1001

"_dbus_annotations",

973

1002

{}))

974

for name, value in annots.iteritems():

1003

for name, value in annots.items():

975

1004

ann_tag = document.createElement(

976

1005

"annotation")

977

1006

ann_tag.setAttribute("name", name)

979

1008

tag.appendChild(ann_tag)

980

1009

# Add interface annotation tags

981

1010

for annotation, value in dict(

982

itertools.chain(

983

*(annotations().iteritems()

984

for name, annotations in

985

self._get_all_dbus_things("interface")

986

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

987

))).iteritems():

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

988

1017

ann_tag = document.createElement("annotation")

989

1018

ann_tag.setAttribute("name", annotation)

990

1019

ann_tag.setAttribute("value", value)

1013

1042

return xmlstring

1014

1043

1015

1044

1016

def datetime_to_dbus (dt, variant_level=0):

1045

def datetime_to_dbus(dt, variant_level=0):

1017

1046

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

1018

1047

if dt is None:

1019

1048

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

1021

1050

variant_level=variant_level)

1022

1051

1023

1052

1024

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

1025

.__metaclass__):

1026

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

1027

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

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1054

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

1055

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

1056

interface names according to the "alt_interface_names" mapping.

1057

Usage:

1058

1059

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

1060

"net.example.AlternateInterface"})

1061

class SampleDBusObject(dbus.service.Object):

1062

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

1063

def SampleDBusMethod():

1064

pass

1065

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1067

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

1068

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

1069

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

1070

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

1071

1072

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

1073

(from DBusObjectWithProperties) and interfaces (from the

1074

dbus_interface_annotations decorator).

1028

1075

"""

1029

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

1030

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

1031

# methods, signals, or properties in them

1032

old_interface_names = []

1033

for base in (b for b in bases

1034

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

1035

# Go though all attributes of the base class

1036

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

1076

def wrapper(cls):

1077

for orig_interface_name, alt_interface_name in (

1078

alt_interface_names.items()):

1079

attr = {}

1080

interface_names = set()

1081

# Go though all attributes of the class

1082

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

1037

1083

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

1038

1084

# with the wrong interface name

1039

1085

if (not hasattr(attribute, "_dbus_interface")

1040

1086

or not attribute._dbus_interface

1041

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

1087

.startswith(orig_interface_name)):

1042

1088

continue

1043

1089

# Create an alternate D-Bus interface name based on

1044

1090

# the current name

1045

1091

alt_interface = (attribute._dbus_interface

1046

.replace("se.recompile.Mandos",

1047

"se.bsnet.fukt.Mandos"))

1048

if alt_interface != attribute._dbus_interface:

1049

old_interface_names.append(alt_interface)

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1094

interface_names.add(alt_interface)

1050

1095

# Is this a D-Bus signal?

1051

1096

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

1052

# Extract the original non-method function by

1053

# black magic

1097

# Extract the original non-method undecorated

1098

# function by black magic

1054

1099

nonmethod_func = (dict(

1055

1100

zip(attribute.func_code.co_freevars,

1056

1101

attribute.__closure__))["func"]

1074

1119

except AttributeError:

1075

1120

pass

1076

1121

# Define a creator of a function to call both the

1077

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

1078

# signals gets sent when the function is called

1122

# original and alternate functions, so both the

1123

# original and alternate signals gets sent when

1124

# the function is called

1079

1125

def fixscope(func1, func2):

1080

1126

"""This function is a scope container to pass

1081

1127

func1 and func2 to the "call_both" function

1088

1134

return call_both

1089

1135

# Create the "call_both" function and add it to

1090

1136

# the class

1091

attr[attrname] = fixscope(attribute,

1092

new_function)

1137

attr[attrname] = fixscope(attribute, new_function)

1093

1138

# Is this a D-Bus method?

1094

1139

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

1095

1140

# Create a new, but exactly alike, function

1151

1196

attribute.func_name,

1152

1197

attribute.func_defaults,

1153

1198

attribute.func_closure)))

1154

# Deprecate all old interfaces

1155

iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"

1156

for old_interface_name in old_interface_names:

1157

@dbus_interface_annotations(old_interface_name)

1158

def func(self):

1159

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

1160

# Find an unused name

1161

for aname in (iname.format(i) for i in itertools.count()):

1162

if aname not in attr:

1163

attr[aname] = func

1164

break

1165

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

1166

1167

1199

if deprecate:

1200

# Deprecate all alternate interfaces

1201

iname="_AlternateDBusNames_interface_annotation{}"

1202

for interface_name in interface_names:

1203

@dbus_interface_annotations(interface_name)

1204

def func(self):

1205

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

1206

"true" }

1207

# Find an unused name

1208

for aname in (iname.format(i)

1209

for i in itertools.count()):

1210

if aname not in attr:

1211

attr[aname] = func

1212

break

1213

if interface_names:

1214

# Replace the class with a new subclass of it with

1215

# methods, signals, etc. as created above.

1216

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

1217

(cls,), attr)

1218

return cls

1219

return wrapper

1220

1221

1222

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

1223

"se.bsnet.fukt.Mandos"})

1168

1224

class ClientDBus(Client, DBusObjectWithProperties):

1169

1225

"""A Client class using D-Bus

1170

1226

1176

1232

runtime_expansions = (Client.runtime_expansions

1177

1233

+ ("dbus_object_path",))

1178

1234

1235

_interface = "se.recompile.Mandos.Client"

1236

1179

1237

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

1180

1238

1181

1239

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

1183

1241

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

1184

1242

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

1185

1243

# the D-Bus

1186

client_object_name = unicode(self.name).translate(

1244

client_object_name = str(self.name).translate(

1187

1245

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

1188

1246

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

1189

1247

self.dbus_object_path = (dbus.ObjectPath

1193

1251

1194

1252

def notifychangeproperty(transform_func,

1195

1253

dbus_name, type_func=lambda x: x,

1196

variant_level=1):

1254

variant_level=1, invalidate_only=False,

1255

_interface=_interface):

1197

1256

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

1198

1257

its changes to DBus.

1199

1258

1204

1263

to the D-Bus. Default: no transform

1205

1264

variant_level: D-Bus variant level. Default: 1

1206

1265

"""

1207

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

1266

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

1208

1267

def setter(self, value):

1209

1268

if hasattr(self, "dbus_object_path"):

1210

1269

if (not hasattr(self, attrname) or

1211

1270

type_func(getattr(self, attrname, None))

1212

1271

!= type_func(value)):

1213

dbus_value = transform_func(type_func(value),

1214

variant_level

1215

=variant_level)

1216

self.PropertyChanged(dbus.String(dbus_name),

1217

dbus_value)

1272

if invalidate_only:

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1277

else:

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1218

1287

setattr(self, attrname, value)

1219

1288

1220

1289

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

1240

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1241

1310

"ApprovalDelay",

1242

1311

type_func =

1243

timedelta_to_milliseconds)

1312

lambda td: td.total_seconds()

1313

* 1000)

1244

1314

approval_duration = notifychangeproperty(

1245

1315

dbus.UInt64, "ApprovalDuration",

1246

type_func = timedelta_to_milliseconds)

1316

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

1247

1317

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

1248

1318

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

1249

type_func =

1250

timedelta_to_milliseconds)

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1251

1321

extended_timeout = notifychangeproperty(

1252

1322

dbus.UInt64, "ExtendedTimeout",

1253

type_func = timedelta_to_milliseconds)

1323

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

1254

1324

interval = notifychangeproperty(dbus.UInt64,

1255

1325

"Interval",

1256

1326

type_func =

1257

timedelta_to_milliseconds)

1327

lambda td: td.total_seconds()

1328

* 1000)

1258

1329

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

1330

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

1331

invalidate_only=True)

1259

1332

1260

1333

del notifychangeproperty

1261

1334

1288

1361

*args, **kwargs)

1289

1362

1290

1363

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

1291

old_checker = self.checker

1292

if self.checker is not None:

1293

old_checker_pid = self.checker.pid

1294

else:

1295

old_checker_pid = None

1364

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

1296

1365

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

1297

1366

# Only if new checker process was started

1298

1367

if (self.checker is not None

1306

1375

return False

1307

1376

1308

1377

def approve(self, value=True):

1309

self.send_changedstate()

1310

1378

self.approved = value

1311

gobject.timeout_add(timedelta_to_milliseconds

1312

(self.approval_duration),

1313

self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1381

self.send_changedstate()

1314

1382

1315

1383

## D-Bus methods, signals & properties

1316

_interface = "se.recompile.Mandos.Client"

1317

1384

1318

1385

## Interfaces

1319

1386

1320

@dbus_interface_annotations(_interface)

1321

def _foo(self):

1322

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

1323

"false"}

1324

1325

1387

## Signals

1326

1388

1327

1389

# CheckerCompleted - signal

1337

1399

pass

1338

1400

1339

1401

# PropertyChanged - signal

1402

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

1340

1403

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

1341

1404

def PropertyChanged(self, property, value):

1342

1405

"D-Bus signal"

1418

1481

access="readwrite")

1419

1482

def ApprovalDelay_dbus_property(self, value=None):

1420

1483

if value is None: # get

1421

return dbus.UInt64(self.approval_delay_milliseconds())

1484

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

1485

* 1000)

1422

1486

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

1423

1487

1424

1488

# ApprovalDuration - property

1426

1490

access="readwrite")

1427

1491

def ApprovalDuration_dbus_property(self, value=None):

1428

1492

if value is None: # get

1429

return dbus.UInt64(timedelta_to_milliseconds(

1430

self.approval_duration))

1493

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

1494

* 1000)

1431

1495

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

1432

1496

1433

1497

# Name - property

1446

1510

def Host_dbus_property(self, value=None):

1447

1511

if value is None: # get

1448

1512

return dbus.String(self.host)

1449

self.host = unicode(value)

1513

self.host = str(value)

1450

1514

1451

1515

# Created - property

1452

1516

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

1499

1563

access="readwrite")

1500

1564

def Timeout_dbus_property(self, value=None):

1501

1565

if value is None: # get

1502

return dbus.UInt64(self.timeout_milliseconds())

1566

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

1567

old_timeout = self.timeout

1503

1568

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

1504

# Reschedule timeout

1569

# Reschedule disabling

1505

1570

if self.enabled:

1506

1571

now = datetime.datetime.utcnow()

1507

time_to_die = timedelta_to_milliseconds(

1508

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

1509

if time_to_die <= 0:

1572

self.expires += self.timeout - old_timeout

1573

if self.expires <= now:

1510

1574

# The timeout has passed

1511

1575

self.disable()

1512

1576

else:

1513

self.expires = (now +

1514

datetime.timedelta(milliseconds =

1515

time_to_die))

1516

1577

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

1517

1578

is None):

1518

1579

return

1519

1580

gobject.source_remove(self.disable_initiator_tag)

1520

self.disable_initiator_tag = (gobject.timeout_add

1521

(time_to_die,

1522

self.disable))

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

int((self.expires - now).total_seconds()

1584

* 1000), self.disable))

1523

1585

1524

1586

# ExtendedTimeout - property

1525

1587

@dbus_service_property(_interface, signature="t",

1526

1588

access="readwrite")

1527

1589

def ExtendedTimeout_dbus_property(self, value=None):

1528

1590

if value is None: # get

1529

return dbus.UInt64(self.extended_timeout_milliseconds())

1591

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

1592

* 1000)

1530

1593

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

1531

1594

1532

1595

# Interval - property

1534

1597

access="readwrite")

1535

1598

def Interval_dbus_property(self, value=None):

1536

1599

if value is None: # get

1537

return dbus.UInt64(self.interval_milliseconds())

1600

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

1538

1601

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

1539

1602

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

1540

1603

return

1551

1614

def Checker_dbus_property(self, value=None):

1552

1615

if value is None: # get

1553

1616

return dbus.String(self.checker_command)

1554

self.checker_command = unicode(value)

1617

self.checker_command = str(value)

1555

1618

1556

1619

# CheckerRunning - property

1557

1620

@dbus_service_property(_interface, signature="b",

1573

1636

@dbus_service_property(_interface, signature="ay",

1574

1637

access="write", byte_arrays=True)

1575

1638

def Secret_dbus_property(self, value):

1576

self.secret = str(value)

1639

self.secret = bytes(value)

1577

1640

1578

1641

del _interface

1579

1642

1604

1667

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

1605

1668

1606

1669

1607

class ClientDBusTransitional(ClientDBus):

1608

__metaclass__ = AlternateDBusNamesMetaclass

1609

1610

1611

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

1612

1671

"""A class to handle client connections.

1613

1672

1617

1676

def handle(self):

1618

1677

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

1619

1678

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

1620

unicode(self.client_address))

1679

str(self.client_address))

1621

1680

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

1622

1681

self.server.child_pipe.fileno())

1623

1682

1649

1708

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

1650

1709

try:

1651

1710

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

1652

raise RuntimeError

1711

raise RuntimeError(line)

1653

1712

except (ValueError, IndexError, RuntimeError) as error:

1654

1713

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

1655

1714

return

1704

1763

if self.server.use_dbus:

1705

1764

# Emit D-Bus signal

1706

1765

client.NeedApproval(

1707

client.approval_delay_milliseconds(),

1708

client.approved_by_default)

1766

client.approval_delay.total_seconds()

1767

* 1000, client.approved_by_default)

1709

1768

else:

1710

1769

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

1711

1770

client.name)

1717

1776

#wait until timeout or approved

1718

1777

time = datetime.datetime.now()

1719

1778

client.changedstate.acquire()

1720

(client.changedstate.wait

1721

(float(client.timedelta_to_milliseconds(delay)

1722

/ 1000)))

1779

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

1723

1780

client.changedstate.release()

1724

1781

time2 = datetime.datetime.now()

1725

1782

if (time2 - time) >= delay:

1841

1898

def process_request(self, request, address):

1842

1899

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

1843

1900

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

1844

args = (request,

1845

address))

1901

args = (request, address))

1846

1902

proc.start()

1847

1903

return proc

1848

1904

1863

1919

1864

1920

def add_pipe(self, parent_pipe, proc):

1865

1921

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

1866

raise NotImplementedError

1922

raise NotImplementedError()

1867

1923

1868

1924

1869

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1876

1932

use_ipv6: Boolean; to use IPv6 or not

1877

1933

"""

1878

1934

def __init__(self, server_address, RequestHandlerClass,

1879

interface=None, use_ipv6=True):

1935

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

1936

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

1937

creating a new one with socket.socket().

1938

"""

1880

1939

self.interface = interface

1881

1940

if use_ipv6:

1882

1941

self.address_family = socket.AF_INET6

1942

if socketfd is not None:

1943

# Save the file descriptor

1944

self.socketfd = socketfd

1945

# Save the original socket.socket() function

1946

self.socket_socket = socket.socket

1947

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

1948

#

1949

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

1950

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

1951

# patching socket.socket.)

1952

#

1953

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

1954

@functools.wraps(socket.socket)

1955

def socket_wrapper(*args, **kwargs):

1956

# Restore original function so subsequent calls are

1957

# not affected.

1958

socket.socket = self.socket_socket

1959

del self.socket_socket

1960

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

1961

# saved file descriptor.

1962

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

1963

# Replace socket.socket() function with wrapper

1964

socket.socket = socket_wrapper

1965

# The socketserver.TCPServer.__init__ will call

1966

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

1967

# socket_wrapper(), if socketfd was set.

1883

1968

socketserver.TCPServer.__init__(self, server_address,

1884

1969

RequestHandlerClass)

1970

1885

1971

def server_bind(self):

1886

1972

"""This overrides the normal server_bind() function

1887

1973

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

1895

1981

try:

1896

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1897

1983

SO_BINDTODEVICE,

1898

str(self.interface

1899

+ '\0'))

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1900

1986

except socket.error as error:

1901

if error[0] == errno.EPERM:

1902

logger.error("No permission to"

1903

" bind to interface %s",

1904

self.interface)

1905

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:

1906

1991

logger.error("SO_BINDTODEVICE not available;"

1907

1992

" cannot bind to interface %s",

1908

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1909

1997

else:

1910

1998

raise

1911

1999

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

1914

2002

if self.address_family == socket.AF_INET6:

1915

2003

any_address = "::" # in6addr_any

1916

2004

else:

1917

any_address = socket.INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

1918

2006

self.server_address = (any_address,

1919

2007

self.server_address[1])

1920

2008

elif not self.server_address[1]:

1941

2029

"""

1942

2030

def __init__(self, server_address, RequestHandlerClass,

1943

2031

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

1944

gnutls_priority=None, use_dbus=True):

2032

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

1945

2033

self.enabled = False

1946

2034

self.clients = clients

1947

2035

if self.clients is None:

1951

2039

IPv6_TCPServer.__init__(self, server_address,

1952

2040

RequestHandlerClass,

1953

2041

interface = interface,

1954

use_ipv6 = use_ipv6)

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

1955

2044

def server_activate(self):

1956

2045

if self.enabled:

1957

2046

return socketserver.TCPServer.server_activate(self)

1970

2059

1971

2060

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

1972

2061

proc = None, client_object=None):

1973

condition_names = {

1974

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

1975

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

1976

# blocking).

1977

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

1978

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

1979

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

1980

# broken, usually for pipes and

1981

# sockets).

1982

}

1983

conditions_string = ' | '.join(name

1984

for cond, name in

1985

condition_names.iteritems()

1986

if cond & condition)

1987

2062

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

1988

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

2063

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

1989

2064

# Wait for other process to exit

1990

2065

proc.join()

1991

2066

return False

2049

2124

return True

2050

2125

2051

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

2052

2226

def string_to_delta(interval):

2053

2227

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

2054

2228

2065

2239

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

2066

2240

datetime.timedelta(0, 330)

2067

2241

"""

2242

2243

try:

2244

return rfc3339_duration_to_delta(interval)

2245

except ValueError:

2246

pass

2247

2068

2248

timevalue = datetime.timedelta(0)

2069

2249

for s in interval.split():

2070

2250

try:

2071

suffix = unicode(s[-1])

2251

suffix = s[-1]

2072

2252

value = int(s[:-1])

2073

2253

if suffix == "d":

2074

2254

delta = datetime.timedelta(value)

2081

2261

elif suffix == "w":

2082

2262

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

2083

2263

else:

2084

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

2264

raise ValueError("Unknown suffix {!r}"

2085

2265

.format(suffix))

2086

except (ValueError, IndexError) as e:

2266

except IndexError as e:

2087

2267

raise ValueError(*(e.args))

2088

2268

timevalue += delta

2089

2269

return timevalue

2104

2284

# Close all standard open file descriptors

2105

2285

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

2106

2286

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

2107

raise OSError(errno.ENODEV,

2108

"{0} not a character device"

2287

raise OSError(errno.ENODEV, "{} not a character device"

2109

2288

.format(os.devnull))

2110

2289

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

2111

2290

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

2121

2300

2122

2301

parser = argparse.ArgumentParser()

2123

2302

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

2124

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

2303

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

2125

2304

help="show version number and exit")

2126

2305

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

2127

2306

help="Bind to interface IF")

2133

2312

help="Run self-test")

2134

2313

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

2135

2314

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

2136

" to terminal")

2315

" to terminal", default=None)

2137

2316

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

2138

2317

help="Debug level for stdout output")

2139

2318

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

2146

2325

" files")

2147

2326

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

2148

2327

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

2149

" system bus interface")

2328

" system bus interface", default=None)

2150

2329

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

2151

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

2330

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

2331

default=None)

2152

2332

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

2153

2333

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

2154

" state")

2334

" state", default=None)

2335

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

2336

help="Specify a file descriptor to a network"

2337

" socket to use instead of creating one")

2155

2338

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

2156

2339

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

2340

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

2341

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

2342

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

2343

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

2344

default=None)

2157

2345

2158

2346

options = parser.parse_args()

2159

2347

2160

2348

if options.check:

2161

2349

import doctest

2162

doctest.testmod()

2163

sys.exit()

2350

fail_count, test_count = doctest.testmod()

2351

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

2164

2352

2165

2353

# Default values for config file for server-global settings

2166

2354

server_defaults = { "interface": "",

2168

2356

"port": "",

2169

2357

"debug": "False",

2170

2358

"priority":

2171

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

2359

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

2360

":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",

2172

2361

"servicename": "Mandos",

2173

2362

"use_dbus": "True",

2174

2363

"use_ipv6": "True",

2175

2364

"debuglevel": "",

2176

2365

"restore": "True",

2177

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

2366

"socket": "",

2367

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

2368

"foreground": "False",

2369

"zeroconf": "True",

2178

2370

}

2179

2371

2180

2372

# Parse config file for server-global settings

2185

2377

# Convert the SafeConfigParser object to a dict

2186

2378

server_settings = server_config.defaults()

2187

2379

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

2188

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

2380

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

2189

2381

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

2190

2382

option)

2191

2383

if server_settings["port"]:

2192

2384

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

2193

2385

"port")

2386

if server_settings["socket"]:

2387

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

2388

"socket")

2389

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

2390

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

2391

# happen with a supplied network socket.

2392

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

2393

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

2394

["socket"])

2194

2395

del server_config

2195

2396

2196

2397

# Override the settings from the config file with command line

2198

2399

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

2199

2400

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

2200

2401

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

2201

"statedir"):

2402

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

2202

2403

value = getattr(options, option)

2203

2404

if value is not None:

2204

2405

server_settings[option] = value

2205

2406

del options

2206

2407

# Force all strings to be unicode

2207

2408

for option in server_settings.keys():

2208

if type(server_settings[option]) is str:

2209

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

2409

if isinstance(server_settings[option], bytes):

2410

server_settings[option] = (server_settings[option]

2411

.decode("utf-8"))

2412

# Force all boolean options to be boolean

2413

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

2414

"foreground", "zeroconf"):

2415

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

2416

# Debug implies foreground

2417

if server_settings["debug"]:

2418

server_settings["foreground"] = True

2210

2419

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

2211

2420

2212

2421

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

2213

2422

2423

if (not server_settings["zeroconf"] and

2424

not (server_settings["port"]

2425

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

2426

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

2427

" Zeroconf")

2428

2214

2429

# For convenience

2215

2430

debug = server_settings["debug"]

2216

2431

debuglevel = server_settings["debuglevel"]

2218

2433

use_ipv6 = server_settings["use_ipv6"]

2219

2434

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

2220

2435

stored_state_file)

2436

foreground = server_settings["foreground"]

2437

zeroconf = server_settings["zeroconf"]

2221

2438

2222

2439

if debug:

2223

2440

initlogger(debug, logging.DEBUG)

2230

2447

2231

2448

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

2232

2449

syslogger.setFormatter(logging.Formatter

2233

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

2450

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

2234

2451

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

2235

2452

.format(server_settings

2236

2453

["servicename"])))

2244

2461

global mandos_dbus_service

2245

2462

mandos_dbus_service = None

2246

2463

2464

socketfd = None

2465

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

2466

socketfd = server_settings["socket"]

2247

2467

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

2248

2468

server_settings["port"]),

2249

2469

ClientHandler,

2252

2472

use_ipv6=use_ipv6,

2253

2473

gnutls_priority=

2254

2474

server_settings["priority"],

2255

use_dbus=use_dbus)

2256

if not debug:

2257

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

2475

use_dbus=use_dbus,

2476

socketfd=socketfd)

2477

if not foreground:

2478

pidfilename = "/run/mandos.pid"

2479

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

2480

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

2481

pidfile = None

2258

2482

try:

2259

2483

pidfile = open(pidfilename, "w")

2260

2484

except IOError as e:

2275

2499

os.setgid(gid)

2276

2500

os.setuid(uid)

2277

2501

except OSError as error:

2278

if error[0] != errno.EPERM:

2279

raise error

2502

if error.errno != errno.EPERM:

2503

raise

2280

2504

2281

2505

if debug:

2282

2506

# Enable all possible GnuTLS debugging

2299

2523

os.close(null)

2300

2524

2301

2525

# Need to fork before connecting to D-Bus

2302

if not debug:

2526

if not foreground:

2303

2527

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

2304

2528

daemon()

2305

2529

2530

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

2531

# need to inform gobject that threads will be used.

2306

2532

gobject.threads_init()

2307

2533

2308

2534

global main_loop

2323

2549

use_dbus = False

2324

2550

server_settings["use_dbus"] = False

2325

2551

tcp_server.use_dbus = False

2326

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2327

service = AvahiServiceToSyslog(name =

2328

server_settings["servicename"],

2329

servicetype = "_mandos._tcp",

2330

protocol = protocol, bus = bus)

2331

if server_settings["interface"]:

2332

service.interface = (if_nametoindex

2333

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

2552

if zeroconf:

2553

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2554

service = AvahiServiceToSyslog(name =

2555

server_settings["servicename"],

2556

servicetype = "_mandos._tcp",

2557

protocol = protocol, bus = bus)

2558

if server_settings["interface"]:

2559

service.interface = (if_nametoindex

2560

(server_settings["interface"]

2561

.encode("utf-8")))

2334

2562

2335

2563

global multiprocessing_manager

2336

2564

multiprocessing_manager = multiprocessing.Manager()

2337

2565

2338

2566

client_class = Client

2339

2567

if use_dbus:

2340

client_class = functools.partial(ClientDBusTransitional,

2341

bus = bus)

2568

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

2342

2569

2343

2570

client_settings = Client.config_parser(client_config)

2344

2571

old_client_settings = {}

2345

2572

clients_data = {}

2346

2573

2574

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

2575

global wnull

2576

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

2577

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

2578

# mode

2579

if debug or not foreground:

2580

wnull.close()

2581

2347

2582

# Get client data and settings from last running state.

2348

2583

if server_settings["restore"]:

2349

2584

try:

2353

2588

os.remove(stored_state_path)

2354

2589

except IOError as e:

2355

2590

if e.errno == errno.ENOENT:

2356

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

2591

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

2357

2592

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

2358

2593

else:

2359

2594

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

2364

2599

"EOFError:", exc_info=e)

2365

2600

2366

2601

with PGPEngine() as pgp:

2367

for client_name, client in clients_data.iteritems():

2602

for client_name, client in clients_data.items():

2603

# Skip removed clients

2604

if client_name not in client_settings:

2605

continue

2606

2368

2607

# Decide which value to use after restoring saved state.

2369

2608

# We have three different values: Old config file,

2370

2609

# new config file, and saved state.

2391

2630

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

2392

2631

if not client["last_checked_ok"]:

2393

2632

logger.warning(

2394

"disabling client {0} - Client never "

2633

"disabling client {} - Client never "

2395

2634

"performed a successful checker"

2396

2635

.format(client_name))

2397

2636

client["enabled"] = False

2398

2637

elif client["last_checker_status"] != 0:

2399

2638

logger.warning(

2400

"disabling client {0} - Client "

2401

"last checker failed with error code {1}"

2639

"disabling client {} - Client last"

2640

" checker failed with error code {}"

2402

2641

.format(client_name,

2403

2642

client["last_checker_status"]))

2404

2643

client["enabled"] = False

2407

2646

.utcnow()

2408

2647

+ client["timeout"])

2409

2648

logger.debug("Last checker succeeded,"

2410

" keeping {0} enabled"

2649

" keeping {} enabled"

2411

2650

.format(client_name))

2412

2651

try:

2413

2652

client["secret"] = (

2416

2655

["secret"]))

2417

2656

except PGPError:

2418

2657

# If decryption fails, we use secret from new settings

2419

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

2658

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

2420

2659

.format(client_name))

2421

2660

client["secret"] = (

2422

2661

client_settings[client_name]["secret"])

2430

2669

clients_data[client_name] = client_settings[client_name]

2431

2670

2432

2671

# Create all client objects

2433

for client_name, client in clients_data.iteritems():

2672

for client_name, client in clients_data.items():

2434

2673

tcp_server.clients[client_name] = client_class(

2435

name = client_name, settings = client)

2674

name = client_name, settings = client,

2675

server_settings = server_settings)

2436

2676

2437

2677

if not tcp_server.clients:

2438

2678

logger.warning("No clients defined")

2439

2679

2440

if not debug:

2441

try:

2442

with pidfile:

2443

pid = os.getpid()

2444

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

2445

del pidfile

2446

except IOError:

2447

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

2448

pidfilename, pid)

2449

except NameError:

2450

# "pidfile" was never created

2451

pass

2680

if not foreground:

2681

if pidfile is not None:

2682

try:

2683

with pidfile:

2684

pid = os.getpid()

2685

pidfile.write("{}\n".format(pid).encode("utf-8"))

2686

except IOError:

2687

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

2688

pidfilename, pid)

2689

del pidfile

2452

2690

del pidfilename

2453

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

2454

2691

2455

2692

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

2456

2693

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

2457

2694

2458

2695

if use_dbus:

2696

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

2697

"se.bsnet.fukt.Mandos"})

2459

2698

class MandosDBusService(DBusObjectWithProperties):

2460

2699

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

2461

2700

def __init__(self):

2495

2734

def GetAllClientsWithProperties(self):

2496

2735

"D-Bus method"

2497

2736

return dbus.Dictionary(

2498

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

2499

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

2737

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

2738

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

2500

2739

signature="oa{sv}")

2501

2740

2502

2741

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

2515

2754

2516

2755

del _interface

2517

2756

2518

class MandosDBusServiceTransitional(MandosDBusService):

2519

__metaclass__ = AlternateDBusNamesMetaclass

2520

mandos_dbus_service = MandosDBusServiceTransitional()

2757

mandos_dbus_service = MandosDBusService()

2521

2758

2522

2759

def cleanup():

2523

2760

"Cleanup function; run on exit"

2524

service.cleanup()

2761

if zeroconf:

2762

service.cleanup()

2525

2763

2526

2764

multiprocessing.active_children()

2765

wnull.close()

2527

2766

if not (tcp_server.clients or client_settings):

2528

2767

return

2529

2768

2540

2779

2541

2780

# A list of attributes that can not be pickled

2542

2781

# + secret.

2543

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

2544

"checker"))

2782

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

2783

"checker", "server_settings" }

2545

2784

for name, typ in (inspect.getmembers

2546

2785

(dbus.service.Object)):

2547

2786

exclude.add(name)

2556

2795

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

2557

2796

2558

2797

try:

2559

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

2560

prefix="clients-",

2561

dir=os.path.dirname

2562

(stored_state_path))

2563

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

2798

with (tempfile.NamedTemporaryFile

2799

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

2800

dir=os.path.dirname(stored_state_path),

2801

delete=False)) as stored_state:

2564

2802

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

2803

tempname=stored_state.name

2565

2804

os.rename(tempname, stored_state_path)

2566

2805

except (IOError, OSError) as e:

2567

2806

if not debug:

2570

2809

except NameError:

2571

2810

pass

2572

2811

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

2573

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

2812

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

2574

2813

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

2575

2814

else:

2576

2815

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

2577

2816

exc_info=e)

2578

raise e

2817

raise

2579

2818

2580

2819

# Delete all clients, and settings from config

2581

2820

while tcp_server.clients:

2605

2844

tcp_server.server_activate()

2606

2845

2607

2846

# Find out what port we got

2608

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

2847

if zeroconf:

2848

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

2609

2849

if use_ipv6:

2610

2850

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

2611

2851

" flowinfo %d, scope_id %d",

2617

2857

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

2618

2858

2619

2859

try:

2620

# From the Avahi example code

2621

try:

2622

service.activate()

2623

except dbus.exceptions.DBusException as error:

2624

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

2625

cleanup()

2626

sys.exit(1)

2627

# End of Avahi example code

2860

if zeroconf:

2861

# From the Avahi example code

2862

try:

2863

service.activate()

2864

except dbus.exceptions.DBusException as error:

2865

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

2866

cleanup()

2867

sys.exit(1)

2868

# End of Avahi example code

2628

2869

2629

2870

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

2630

2871

lambda *args, **kwargs: