/mandos/trunk : revision 712

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

65

67

import types

66

68

import binascii

67

69

import tempfile

70

import itertools

71

import collections

68

72

69

73

import dbus

70

74

import dbus.service

75

79

import ctypes.util

76

80

import xml.dom.minidom

77

81

import inspect

78

import GnuPGInterface

79

82

80

83

try:

81

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

88

except ImportError:

86

89

SO_BINDTODEVICE = None

87

90

88

version = "1.5.1"

91

version = "1.6.6"

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

95

syslogger = None

95

96

97

try:

97

98

if_nametoindex = (ctypes.cdll.LoadLibrary

113

114

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

114

115

"""init logger and add loglevel"""

115

116

117

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

116

122

syslogger.setFormatter(logging.Formatter

117

123

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

118

124

' %(message)s'))

136

142

class PGPEngine(object):

137

143

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

138

144

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

145

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet',

146

'--no-use-agent'])

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

147

151

148

152

def __enter__(self):

149

153

return self

150

154

151

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

155

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

152

156

self._cleanup()

153

157

return False

154

158

171

175

def password_encode(self, password):

172

176

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

173

177

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

174

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

178

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

179

if len(encoded) > 2048:

180

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

181

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

182

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

183

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

184

return encoded

175

185

176

186

def encrypt(self, data, password):

177

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

178

with open(os.devnull) as devnull:

179

try:

180

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

181

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

182

attach_fhs={'stderr': devnull})

183

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

184

f.write(data)

185

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

186

ciphertext = f.read()

187

proc.wait()

188

except IOError as e:

189

raise PGPError(e)

190

self.gnupg.passphrase = None

187

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

190

passfile.write(passphrase)

191

passfile.flush()

192

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

193

'--passphrase-file',

194

passfile.name]

195

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

200

if proc.returncode != 0:

201

raise PGPError(err)

191

202

return ciphertext

192

203

193

204

def decrypt(self, data, password):

194

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

195

with open(os.devnull) as devnull:

196

try:

197

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

198

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

199

attach_fhs={'stderr': devnull})

200

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

201

f.write(data)

202

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

203

decrypted_plaintext = f.read()

204

proc.wait()

205

except IOError as e:

206

raise PGPError(e)

207

self.gnupg.passphrase = None

205

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

208

passfile.write(passphrase)

209

passfile.flush()

210

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

211

'--passphrase-file',

212

passfile.name]

213

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

219

if proc.returncode != 0:

220

raise PGPError(err)

208

221

return decrypted_plaintext

209

222

210

223

211

212

224

class AvahiError(Exception):

213

225

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

214

226

self.value = value

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.

243

255

server: D-Bus Server

244

256

bus: dbus.SystemBus()

245

257

"""

258

246

259

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

247

260

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

248

261

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

261

274

self.server = None

262

275

self.bus = bus

263

276

self.entry_group_state_changed_match = None

277

264

278

def rename(self):

265

279

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

266

280

if self.rename_count >= self.max_renames:

276

290

try:

277

291

self.add()

278

292

except dbus.exceptions.DBusException as error:

279

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

293

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

280

294

self.cleanup()

281

295

os._exit(1)

282

296

self.rename_count += 1

297

283

298

def remove(self):

284

299

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

285

300

if self.entry_group_state_changed_match is not None:

287

302

self.entry_group_state_changed_match = None

288

303

if self.group is not None:

289

304

self.group.Reset()

305

290

306

def add(self):

291

307

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

292

308

self.remove()

309

325

dbus.UInt16(self.port),

310

326

avahi.string_array_to_txt_array(self.TXT))

311

327

self.group.Commit()

328

312

329

def entry_group_state_changed(self, state, error):

313

330

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

314

331

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

321

338

elif state == avahi.ENTRY_GROUP_FAILURE:

322

339

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

323

340

unicode(error))

324

raise AvahiGroupError("State changed: %s"

325

% unicode(error))

341

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

342

.format(error))

343

326

344

def cleanup(self):

327

345

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

328

346

if self.group is not None:

333

351

pass

334

352

self.group = None

335

353

self.remove()

354

336

355

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

337

356

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

338

357

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

357

376

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

358

377

else:

359

378

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

379

360

380

def activate(self):

361

381

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

362

382

if self.server is None:

369

389

self.server_state_changed)

370

390

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

371

391

392

372

393

class AvahiServiceToSyslog(AvahiService):

373

394

def rename(self):

374

395

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

375

396

ret = AvahiService.rename(self)

376

397

syslogger.setFormatter(logging.Formatter

377

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

378

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

379

% self.name))

398

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

399

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

400

.format(self.name)))

380

401

return ret

381

402

403

382

404

def timedelta_to_milliseconds(td):

383

405

"Convert a datetime.timedelta() to milliseconds"

384

406

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

385

407

+ (td.seconds * 1000)

386

408

+ (td.microseconds // 1000))

387

409

410

388

411

class Client(object):

389

412

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

390

413

415

438

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

416

439

last_checker_status: integer between 0 and 255 reflecting exit

417

440

status of last checker. -1 reflects crashed

418

checker, or None.

441

checker, -2 means no checker completed yet.

419

442

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

420

443

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

421

444

D-Bus identifiers

426

449

runtime_expansions: Allowed attributes for runtime expansion.

427

450

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

428

451

disabled, or None

452

server_settings: The server_settings dict from main()

429

453

"""

430

454

431

455

runtime_expansions = ("approval_delay", "approval_duration",

432

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

433

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

456

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

457

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

458

"last_approval_request", "last_checked_ok",

434

459

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

435

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

436

"extended_timeout": "15m",

437

"interval": "2m",

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

438

463

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

439

464

"host": "",

440

"approval_delay": "0s",

441

"approval_duration": "1s",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

442

467

"approved_by_default": "True",

443

468

"enabled": "True",

444

469

}

457

482

458

483

def approval_delay_milliseconds(self):

459

484

return timedelta_to_milliseconds(self.approval_delay)

460

485

461

486

@staticmethod

462

487

def config_parser(config):

463

488

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

488

513

"rb") as secfile:

489

514

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

490

515

else:

491

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

492

% section)

516

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

517

.format(section))

493

518

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

494

519

client["extended_timeout"] = string_to_delta(

495

520

section["extended_timeout"])

501

526

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

502

527

client["last_approval_request"] = None

503

528

client["last_checked_ok"] = None

504

client["last_checker_status"] = None

529

client["last_checker_status"] = -2

505

530

506

531

return settings

507

508

509

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

510

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

511

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

512

attribute."""

532

533

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

513

534

self.name = name

535

if server_settings is None:

536

server_settings = {}

537

self.server_settings = server_settings

514

538

# adding all client settings

515

539

for setting, value in settings.iteritems():

516

540

setattr(self, setting, value)

524

548

else:

525

549

self.last_enabled = None

526

550

self.expires = None

527

551

528

552

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

529

553

# Uppercase and remove spaces from fingerprint for later

530

554

# comparison purposes with return value from the fingerprint()

532

556

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

533

557

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

534

558

datetime.datetime.utcnow())

535

559

536

560

# attributes specific for this server instance

537

561

self.checker = None

538

562

self.checker_initiator_tag = None

566

590

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

567

591

# Already enabled

568

592

return

569

self.send_changedstate()

570

593

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

571

594

self.enabled = True

572

595

self.last_enabled = datetime.datetime.utcnow()

573

596

self.init_checker()

597

self.send_changedstate()

574

598

575

599

def disable(self, quiet=True):

576

600

"""Disable this client."""

577

601

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

578

602

return False

579

603

if not quiet:

580

self.send_changedstate()

581

if not quiet:

582

604

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

583

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

605

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

584

606

gobject.source_remove(self.disable_initiator_tag)

585

607

self.disable_initiator_tag = None

586

608

self.expires = None

587

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

609

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

588

610

gobject.source_remove(self.checker_initiator_tag)

589

611

self.checker_initiator_tag = None

590

612

self.stop_checker()

591

613

self.enabled = False

614

if not quiet:

615

self.send_changedstate()

592

616

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

593

617

return False

594

618

598

622

def init_checker(self):

599

623

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

600

624

# and every interval from then on.

625

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

601

627

self.checker_initiator_tag = (gobject.timeout_add

602

628

(self.interval_milliseconds(),

603

629

self.start_checker))

604

630

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

631

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

605

633

self.disable_initiator_tag = (gobject.timeout_add

606

634

(self.timeout_milliseconds(),

607

635

self.disable))

626

654

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

627

655

vars(self))

628

656

629

def checked_ok(self, timeout=None):

630

"""Bump up the timeout for this client.

631

632

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

633

alive and well.

634

"""

657

def checked_ok(self):

658

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

659

self.last_checked_ok = datetime.datetime.utcnow()

660

self.last_checker_status = 0

661

self.bump_timeout()

662

663

def bump_timeout(self, timeout=None):

664

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

635

665

if timeout is None:

636

666

timeout = self.timeout

637

self.last_checked_ok = datetime.datetime.utcnow()

638

667

if self.disable_initiator_tag is not None:

639

668

gobject.source_remove(self.disable_initiator_tag)

669

self.disable_initiator_tag = None

640

670

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

641

671

self.disable_initiator_tag = (gobject.timeout_add

642

672

(timedelta_to_milliseconds

652

682

If a checker already exists, leave it running and do

653

683

nothing."""

654

684

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

655

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

656

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

657

# client would inevitably timeout, since no checker would get

658

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

685

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

686

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

687

# would inevitably timeout, since no checker would get a

688

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

659

689

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

660

690

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

661

691

# should be.

663

693

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

664

694

try:

665

695

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

666

except (AttributeError, OSError) as error:

667

if (isinstance(error, OSError)

668

and error.errno != errno.ECHILD):

669

raise error

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

670

701

else:

671

702

if pid:

672

703

logger.warning("Checker was a zombie")

675

706

self.current_checker_command)

676

707

# Start a new checker if needed

677

708

if self.checker is None:

709

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

678

714

try:

679

# In case checker_command has exactly one % operator

680

command = self.checker_command % self.host

681

except TypeError:

682

# Escape attributes for the shell

683

escaped_attrs = dict(

684

(attr,

685

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

686

errors=

687

'replace')))

688

for attr in

689

self.runtime_expansions)

690

691

try:

692

command = self.checker_command % escaped_attrs

693

except TypeError as error:

694

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

695

' %s', self.checker_command, error)

696

return True # Try again later

715

command = self.checker_command % escaped_attrs

716

except TypeError as error:

717

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

697

720

self.current_checker_command = command

698

721

try:

699

722

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

702

725

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

703

726

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

704

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

705

736

self.checker = subprocess.Popen(command,

706

737

close_fds=True,

707

shell=True, cwd="/")

708

self.checker_callback_tag = (gobject.child_watch_add

709

(self.checker.pid,

710

self.checker_callback,

711

data=command))

712

# The checker may have completed before the gobject

713

# watch was added. Check for this.

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

714

751

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

715

if pid:

716

gobject.source_remove(self.checker_callback_tag)

717

self.checker_callback(pid, status, command)

718

752

except OSError as error:

719

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

720

error)

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

721

762

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

722

763

return True

723

764

730

771

return

731

772

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

732

773

try:

733

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

774

self.checker.terminate()

734

775

#time.sleep(0.5)

735

776

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

736

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

777

# self.checker.kill()

737

778

except OSError as error:

738

779

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

739

780

raise

756

797

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

757

798

if byte_arrays and signature != "ay":

758

799

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

759

" signature %r" % signature)

800

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

760

801

def decorator(func):

761

802

func._dbus_is_property = True

762

803

func._dbus_interface = dbus_interface

770

811

return decorator

771

812

772

813

814

def dbus_interface_annotations(dbus_interface):

815

"""Decorator for marking functions returning interface annotations

816

817

Usage:

818

819

@dbus_interface_annotations("org.example.Interface")

820

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

821

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

822

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

823

"false"}

824

"""

825

def decorator(func):

826

func._dbus_is_interface = True

827

func._dbus_interface = dbus_interface

828

func._dbus_name = dbus_interface

829

return func

830

return decorator

831

832

833

def dbus_annotations(annotations):

834

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

835

Usage:

836

837

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

838

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

def Property_dbus_property(self):

843

return dbus.Boolean(False)

844

"""

845

def decorator(func):

846

func._dbus_annotations = annotations

847

return func

848

return decorator

849

850

773

851

class DBusPropertyException(dbus.exceptions.DBusException):

774

852

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

775

853

"""

798

876

"""

799

877

800

878

@staticmethod

801

def _is_dbus_property(obj):

802

return getattr(obj, "_dbus_is_property", False)

879

def _is_dbus_thing(thing):

880

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

881

882

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

883

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

884

"""

885

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

886

False)

803

887

804

def _get_all_dbus_properties(self):

888

def _get_all_dbus_things(self, thing):

805

889

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

806

890

"""

807

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

891

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

892

name),

893

athing.__get__(self))

808

894

for cls in self.__class__.__mro__

809

for name, prop in

810

inspect.getmembers(cls, self._is_dbus_property))

895

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

811

898

812

899

def _get_dbus_property(self, interface_name, property_name):

813

900

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

815

902

"""

816

903

for cls in self.__class__.__mro__:

817

904

for name, value in (inspect.getmembers

818

(cls, self._is_dbus_property)):

905

(cls,

906

self._is_dbus_thing("property"))):

819

907

if (value._dbus_name == property_name

820

908

and value._dbus_interface == interface_name):

821

909

return value.__get__(self)

849

937

# The byte_arrays option is not supported yet on

850

938

# signatures other than "ay".

851

939

if prop._dbus_signature != "ay":

852

raise ValueError

940

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

941

"'ay' signature {0!r}"

942

.format(prop._dbus_signature))

853

943

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

854

944

for byte in value))

855

945

prop(value)

863

953

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

864

954

"""

865

955

properties = {}

866

for name, prop in self._get_all_dbus_properties():

956

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

867

957

if (interface_name

868

958

and interface_name != prop._dbus_interface):

869

959

# Interface non-empty but did not match

884

974

path_keyword='object_path',

885

975

connection_keyword='connection')

886

976

def Introspect(self, object_path, connection):

887

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

977

"""Overloading of standard D-Bus method.

978

979

Inserts property tags and interface annotation tags.

888

980

"""

889

981

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

890

982

connection)

897

989

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

898

990

return e

899

991

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

992

# Add property tags

900

993

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

901

994

for name, prop

902

in self._get_all_dbus_properties()

995

in self._get_all_dbus_things("property")

903

996

if prop._dbus_interface

904

997

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

905

998

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

906

1030

# Add the names to the return values for the

907

1031

# "org.freedesktop.DBus.Properties" methods

908

1032

if (if_tag.getAttribute("name")

923

1047

except (AttributeError, xml.dom.DOMException,

924

1048

xml.parsers.expat.ExpatError) as error:

925

1049

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

926

error)

1050

exc_info=error)

927

1051

return xmlstring

928

1052

929

1053

930

def datetime_to_dbus (dt, variant_level=0):

1054

def datetime_to_dbus(dt, variant_level=0):

931

1055

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

932

1056

if dt is None:

933

1057

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

935

1059

variant_level=variant_level)

936

1060

937

1061

938

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

939

.__metaclass__):

940

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

941

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

1062

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1063

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

1064

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

1065

interface names according to the "alt_interface_names" mapping.

1066

Usage:

1067

1068

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

1069

"net.example.AlternateInterface"})

1070

class SampleDBusObject(dbus.service.Object):

1071

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

1072

def SampleDBusMethod():

1073

pass

1074

1075

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

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

1077

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

1078

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

1079

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

1080

1081

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

1082

(from DBusObjectWithProperties) and interfaces (from the

1083

dbus_interface_annotations decorator).

942

1084

"""

943

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

944

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

945

# methods, signals, or properties in them

946

for base in (b for b in bases

947

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

948

# Go though all attributes of the base class

949

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

1085

def wrapper(cls):

1086

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1088

attr = {}

1089

interface_names = set()

1090

# Go though all attributes of the class

1091

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

950

1092

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

951

1093

# with the wrong interface name

952

1094

if (not hasattr(attribute, "_dbus_interface")

953

1095

or not attribute._dbus_interface

954

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

1096

.startswith(orig_interface_name)):

955

1097

continue

956

1098

# Create an alternate D-Bus interface name based on

957

1099

# the current name

958

1100

alt_interface = (attribute._dbus_interface

959

.replace("se.recompile.Mandos",

960

"se.bsnet.fukt.Mandos"))

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1103

interface_names.add(alt_interface)

961

1104

# Is this a D-Bus signal?

962

1105

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

963

# Extract the original non-method function by

964

# black magic

1106

# Extract the original non-method undecorated

1107

# function by black magic

965

1108

nonmethod_func = (dict(

966

1109

zip(attribute.func_code.co_freevars,

967

1110

attribute.__closure__))["func"]

978

1121

nonmethod_func.func_name,

979

1122

nonmethod_func.func_defaults,

980

1123

nonmethod_func.func_closure)))

1124

# Copy annotations, if any

1125

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1128

except AttributeError:

1129

pass

981

1130

# Define a creator of a function to call both the

982

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

983

# signals gets sent when the function is called

1131

# original and alternate functions, so both the

1132

# original and alternate signals gets sent when

1133

# the function is called

984

1134

def fixscope(func1, func2):

985

1135

"""This function is a scope container to pass

986

1136

func1 and func2 to the "call_both" function

993

1143

return call_both

994

1144

# Create the "call_both" function and add it to

995

1145

# the class

996

attr[attrname] = fixscope(attribute,

997

new_function)

1146

attr[attrname] = fixscope(attribute, new_function)

998

1147

# Is this a D-Bus method?

999

1148

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

1000

1149

# Create a new, but exactly alike, function

1011

1160

attribute.func_name,

1012

1161

attribute.func_defaults,

1013

1162

attribute.func_closure)))

1163

# Copy annotations, if any

1164

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1167

except AttributeError:

1168

pass

1014

1169

# Is this a D-Bus property?

1015

1170

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

1016

1171

# Create a new, but exactly alike, function

1030

1185

attribute.func_name,

1031

1186

attribute.func_defaults,

1032

1187

attribute.func_closure)))

1033

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

1034

1035

1188

# Copy annotations, if any

1189

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1192

except AttributeError:

1193

pass

1194

# Is this a D-Bus interface?

1195

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

1196

# Create a new, but exactly alike, function

1197

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

1198

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

1199

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1208

if deprecate:

1209

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1211

for interface_name in interface_names:

1212

@dbus_interface_annotations(interface_name)

1213

def func(self):

1214

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

1215

"true" }

1216

# Find an unused name

1217

for aname in (iname.format(i)

1218

for i in itertools.count()):

1219

if aname not in attr:

1220

attr[aname] = func

1221

break

1222

if interface_names:

1223

# Replace the class with a new subclass of it with

1224

# methods, signals, etc. as created above.

1225

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

1226

(cls,), attr)

1227

return cls

1228

return wrapper

1229

1230

1231

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

1232

"se.bsnet.fukt.Mandos"})

1036

1233

class ClientDBus(Client, DBusObjectWithProperties):

1037

1234

"""A Client class using D-Bus

1038

1235

1058

1255

("/clients/" + client_object_name))

1059

1256

DBusObjectWithProperties.__init__(self, self.bus,

1060

1257

self.dbus_object_path)

1061

1258

1062

1259

def notifychangeproperty(transform_func,

1063

1260

dbus_name, type_func=lambda x: x,

1064

1261

variant_level=1):

1087

1284

1088

1285

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

1089

1286

1090

1091

1287

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1092

1288

approvals_pending = notifychangeproperty(dbus.Boolean,

1093

1289

"ApprovalPending",

1100

1296

checker is not None)

1101

1297

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1102

1298

"LastCheckedOK")

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1300

"LastCheckerStatus")

1103

1301

last_approval_request = notifychangeproperty(

1104

1302

datetime_to_dbus, "LastApprovalRequest")

1105

1303

approved_by_default = notifychangeproperty(dbus.Boolean,

1155

1353

*args, **kwargs)

1156

1354

1157

1355

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

1158

old_checker = self.checker

1159

if self.checker is not None:

1160

old_checker_pid = self.checker.pid

1161

else:

1162

old_checker_pid = None

1356

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

1163

1357

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

1164

1358

# Only if new checker process was started

1165

1359

if (self.checker is not None

1173

1367

return False

1174

1368

1175

1369

def approve(self, value=True):

1176

self.send_changedstate()

1177

1370

self.approved = value

1178

1371

gobject.timeout_add(timedelta_to_milliseconds

1179

1372

(self.approval_duration),

1180

1373

self._reset_approved)

1181

1374

self.send_changedstate()

1182

1375

1183

1376

## D-Bus methods, signals & properties

1184

1377

_interface = "se.recompile.Mandos.Client"

1185

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1186

1386

## Signals

1187

1387

1188

1388

# CheckerCompleted - signal

1224

1424

"D-Bus signal"

1225

1425

return self.need_approval()

1226

1426

1227

# NewRequest - signal

1228

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

1229

def NewRequest(self, ip):

1230

"""D-Bus signal

1231

Is sent after a client request a secret.

1232

"""

1233

pass

1234

1235

1427

## Methods

1236

1428

1237

1429

# Approve - method

1347

1539

return

1348

1540

return datetime_to_dbus(self.last_checked_ok)

1349

1541

1542

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

1545

def LastCheckerStatus_dbus_property(self):

1546

return dbus.Int16(self.last_checker_status)

1547

1350

1548

# Expires - property

1351

1549

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

1352

1550

def Expires_dbus_property(self):

1363

1561

def Timeout_dbus_property(self, value=None):

1364

1562

if value is None: # get

1365

1563

return dbus.UInt64(self.timeout_milliseconds())

1564

old_timeout = self.timeout

1366

1565

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

1367

# Reschedule timeout

1566

# Reschedule disabling

1368

1567

if self.enabled:

1369

1568

now = datetime.datetime.utcnow()

1370

time_to_die = timedelta_to_milliseconds(

1371

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

1372

if time_to_die <= 0:

1569

self.expires += self.timeout - old_timeout

1570

if self.expires <= now:

1373

1571

# The timeout has passed

1374

1572

self.disable()

1375

1573

else:

1376

self.expires = (now +

1377

datetime.timedelta(milliseconds =

1378

time_to_die))

1379

1574

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

1380

1575

is None):

1381

1576

return

1382

1577

gobject.source_remove(self.disable_initiator_tag)

1383

self.disable_initiator_tag = (gobject.timeout_add

1384

(time_to_die,

1385

self.disable))

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1386

1582

1387

1583

# ExtendedTimeout - property

1388

1584

@dbus_service_property(_interface, signature="t",

1467

1663

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

1468

1664

1469

1665

1470

class ClientDBusTransitional(ClientDBus):

1471

__metaclass__ = AlternateDBusNamesMetaclass

1472

1473

1474

1666

class ClientHandler(socketserver.BaseRequestHandler, object):

1475

1667

"""A class to handle client connections.

1476

1668

1512

1704

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

1513

1705

try:

1514

1706

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

1515

raise RuntimeError

1707

raise RuntimeError(line)

1516

1708

except (ValueError, IndexError, RuntimeError) as error:

1517

1709

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

1518

1710

return

1544

1736

except KeyError:

1545

1737

return

1546

1738

1547

if self.server.use_dbus:

1548

# Emit D-Bus signal

1549

client.NewRequest(unicode(self.client_address)[0])

1550

1551

1739

if client.approval_delay:

1552

1740

delay = client.approval_delay

1553

1741

client.approvals_pending += 1

1584

1772

#wait until timeout or approved

1585

1773

time = datetime.datetime.now()

1586

1774

client.changedstate.acquire()

1587

(client.changedstate.wait

1588

(float(client.timedelta_to_milliseconds(delay)

1589

/ 1000)))

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

1590

1778

client.changedstate.release()

1591

1779

time2 = datetime.datetime.now()

1592

1780

if (time2 - time) >= delay:

1608

1796

try:

1609

1797

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

1610

1798

except gnutls.errors.GNUTLSError as error:

1611

logger.warning("gnutls send failed")

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1612

1801

return

1613

1802

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

1614

1803

sent, len(client.secret)

1617

1806

1618

1807

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

1619

1808

# bump the timeout using extended_timeout

1620

client.checked_ok(client.extended_timeout)

1809

client.bump_timeout(client.extended_timeout)

1621

1810

if self.server.use_dbus:

1622

1811

# Emit D-Bus signal

1623

1812

client.GotSecret()

1628

1817

try:

1629

1818

session.bye()

1630

1819

except gnutls.errors.GNUTLSError as error:

1631

logger.warning("GnuTLS bye failed")

1820

logger.warning("GnuTLS bye failed",

1821

exc_info=error)

1632

1822

1633

1823

@staticmethod

1634

1824

def peer_certificate(session):

1706

1896

def process_request(self, request, address):

1707

1897

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

1708

1898

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

1709

args = (request,

1710

address))

1899

args = (request, address))

1711

1900

proc.start()

1712

1901

return proc

1713

1902

1728

1917

1729

1918

def add_pipe(self, parent_pipe, proc):

1730

1919

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

1731

raise NotImplementedError

1920

raise NotImplementedError()

1732

1921

1733

1922

1734

1923

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1741

1930

use_ipv6: Boolean; to use IPv6 or not

1742

1931

"""

1743

1932

def __init__(self, server_address, RequestHandlerClass,

1744

interface=None, use_ipv6=True):

1933

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

1934

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

1935

creating a new one with socket.socket().

1936

"""

1745

1937

self.interface = interface

1746

1938

if use_ipv6:

1747

1939

self.address_family = socket.AF_INET6

1940

if socketfd is not None:

1941

# Save the file descriptor

1942

self.socketfd = socketfd

1943

# Save the original socket.socket() function

1944

self.socket_socket = socket.socket

1945

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

1946

#

1947

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

1948

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

1949

# patching socket.socket.)

1950

#

1951

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

1952

@functools.wraps(socket.socket)

1953

def socket_wrapper(*args, **kwargs):

1954

# Restore original function so subsequent calls are

1955

# not affected.

1956

socket.socket = self.socket_socket

1957

del self.socket_socket

1958

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

1959

# saved file descriptor.

1960

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

1961

# Replace socket.socket() function with wrapper

1962

socket.socket = socket_wrapper

1963

# The socketserver.TCPServer.__init__ will call

1964

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

1965

# socket_wrapper(), if socketfd was set.

1748

1966

socketserver.TCPServer.__init__(self, server_address,

1749

1967

RequestHandlerClass)

1968

1750

1969

def server_bind(self):

1751

1970

"""This overrides the normal server_bind() function

1752

1971

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

1760

1979

try:

1761

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1762

1981

SO_BINDTODEVICE,

1763

str(self.interface

1764

+ '\0'))

1982

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

1765

1983

except socket.error as error:

1766

if error[0] == errno.EPERM:

1767

logger.error("No permission to"

1768

" bind to interface %s",

1769

self.interface)

1770

elif error[0] == errno.ENOPROTOOPT:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1771

1988

logger.error("SO_BINDTODEVICE not available;"

1772

1989

" cannot bind to interface %s",

1773

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1774

1994

else:

1775

1995

raise

1776

1996

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

1779

1999

if self.address_family == socket.AF_INET6:

1780

2000

any_address = "::" # in6addr_any

1781

2001

else:

1782

any_address = socket.INADDR_ANY

2002

any_address = "0.0.0.0" # INADDR_ANY

1783

2003

self.server_address = (any_address,

1784

2004

self.server_address[1])

1785

2005

elif not self.server_address[1]:

1806

2026

"""

1807

2027

def __init__(self, server_address, RequestHandlerClass,

1808

2028

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

1809

gnutls_priority=None, use_dbus=True):

2029

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

1810

2030

self.enabled = False

1811

2031

self.clients = clients

1812

2032

if self.clients is None:

1816

2036

IPv6_TCPServer.__init__(self, server_address,

1817

2037

RequestHandlerClass,

1818

2038

interface = interface,

1819

use_ipv6 = use_ipv6)

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

1820

2041

def server_activate(self):

1821

2042

if self.enabled:

1822

2043

return socketserver.TCPServer.server_activate(self)

1835

2056

1836

2057

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

1837

2058

proc = None, client_object=None):

1838

condition_names = {

1839

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

1840

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

1841

# blocking).

1842

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

1843

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

1844

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

1845

# broken, usually for pipes and

1846

# sockets).

1847

}

1848

conditions_string = ' | '.join(name

1849

for cond, name in

1850

condition_names.iteritems()

1851

if cond & condition)

1852

2059

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

1853

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

2060

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

1854

2061

# Wait for other process to exit

1855

2062

proc.join()

1856

2063

return False

1914

2121

return True

1915

2122

1916

2123

2124

def rfc3339_duration_to_delta(duration):

2125

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

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2141

"""

2142

2143

# Parsing an RFC 3339 duration with regular expressions is not

2144

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

2145

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

2146

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

2147

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

2148

# avoid excessive use of external libraries.

2149

2150

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2160

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

2161

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

2162

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

2163

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

2164

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2166

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

2167

datetime.timedelta(minutes=1),

2168

frozenset((token_second, token_end)))

2169

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

2170

datetime.timedelta(hours=1),

2171

frozenset((token_minute, token_end)))

2172

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

2173

None,

2174

frozenset((token_hour, token_minute,

2175

token_second)))

2176

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

2177

datetime.timedelta(days=1),

2178

frozenset((token_time, token_end)))

2179

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

2180

datetime.timedelta(weeks=4),

2181

frozenset((token_day, token_end)))

2182

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

2183

datetime.timedelta(weeks=52),

2184

frozenset((token_month, token_end)))

2185

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

2186

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2188

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

2189

frozenset((token_year, token_month,

2190

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2194

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2197

# Loop until end token is found

2198

while found_token is not token_end:

2199

# Search for any currently valid tokens

2200

for token in followers:

2201

match = token.regexp.match(s)

2202

if match is not None:

2203

# Token found

2204

if token.value is not None:

2205

# Value found, parse digits

2206

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

2207

# Add to value so far

2208

value += factor * token.value

2209

# Strip token from string

2210

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

2211

# Go to found token

2212

found_token = token

2213

# Set valid next tokens

2214

followers = found_token.followers

2215

break

2216

else:

2217

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2219

# End token found

2220

return value

2221

2222

1917

2223

def string_to_delta(interval):

1918

2224

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

1919

2225

1930

2236

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

1931

2237

datetime.timedelta(0, 330)

1932

2238

"""

2239

2240

try:

2241

return rfc3339_duration_to_delta(interval)

2242

except ValueError:

2243

pass

2244

1933

2245

timevalue = datetime.timedelta(0)

1934

2246

for s in interval.split():

1935

2247

try:

1946

2258

elif suffix == "w":

1947

2259

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

1948

2260

else:

1949

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

1950

except (ValueError, IndexError) as e:

2261

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

2262

.format(suffix))

2263

except IndexError as e:

1951

2264

raise ValueError(*(e.args))

1952

2265

timevalue += delta

1953

2266

return timevalue

1966

2279

sys.exit()

1967

2280

if not noclose:

1968

2281

# Close all standard open file descriptors

1969

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

2282

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

1970

2283

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

1971

2284

raise OSError(errno.ENODEV,

1972

"%s not a character device"

1973

% os.path.devnull)

2285

"{0} not a character device"

2286

.format(os.devnull))

1974

2287

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

1975

2288

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

1976

2289

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

1985

2298

1986

2299

parser = argparse.ArgumentParser()

1987

2300

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

1988

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

2301

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

1989

2302

help="show version number and exit")

1990

2303

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

1991

2304

help="Bind to interface IF")

1997

2310

help="Run self-test")

1998

2311

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

1999

2312

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

2000

" to terminal")

2313

" to terminal", default=None)

2001

2314

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

2002

2315

help="Debug level for stdout output")

2003

2316

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

2010

2323

" files")

2011

2324

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

2012

2325

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

2013

" system bus interface")

2326

" system bus interface", default=None)

2014

2327

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

2015

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

2328

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

2329

default=None)

2016

2330

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

2017

2331

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

2018

" state")

2332

" state", default=None)

2333

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

2334

help="Specify a file descriptor to a network"

2335

" socket to use instead of creating one")

2019

2336

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

2020

2337

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

2338

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

2339

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

2340

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

2341

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

2342

default=None)

2021

2343

2022

2344

options = parser.parse_args()

2023

2345

2024

2346

if options.check:

2025

2347

import doctest

2026

doctest.testmod()

2027

sys.exit()

2348

fail_count, test_count = doctest.testmod()

2349

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

2028

2350

2029

2351

# Default values for config file for server-global settings

2030

2352

server_defaults = { "interface": "",

2032

2354

"port": "",

2033

2355

"debug": "False",

2034

2356

"priority":

2035

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

2357

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

2036

2358

"servicename": "Mandos",

2037

2359

"use_dbus": "True",

2038

2360

"use_ipv6": "True",

2039

2361

"debuglevel": "",

2040

2362

"restore": "True",

2041

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

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2042

2367

}

2043

2368

2044

2369

# Parse config file for server-global settings

2049

2374

# Convert the SafeConfigParser object to a dict

2050

2375

server_settings = server_config.defaults()

2051

2376

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

2052

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

2377

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

2053

2378

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

2054

2379

option)

2055

2380

if server_settings["port"]:

2056

2381

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

2057

2382

"port")

2383

if server_settings["socket"]:

2384

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

2385

"socket")

2386

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

2387

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

2388

# happen with a supplied network socket.

2389

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

2390

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

2391

["socket"])

2058

2392

del server_config

2059

2393

2060

2394

# Override the settings from the config file with command line

2062

2396

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

2063

2397

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

2064

2398

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

2065

"statedir"):

2399

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

2066

2400

value = getattr(options, option)

2067

2401

if value is not None:

2068

2402

server_settings[option] = value

2071

2405

for option in server_settings.keys():

2072

2406

if type(server_settings[option]) is str:

2073

2407

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

2408

# Force all boolean options to be boolean

2409

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

2410

"foreground", "zeroconf"):

2411

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

2412

# Debug implies foreground

2413

if server_settings["debug"]:

2414

server_settings["foreground"] = True

2074

2415

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

2075

2416

2076

2417

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

2077

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

2078

2425

# For convenience

2079

2426

debug = server_settings["debug"]

2080

2427

debuglevel = server_settings["debuglevel"]

2082

2429

use_ipv6 = server_settings["use_ipv6"]

2083

2430

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

2084

2431

stored_state_file)

2432

foreground = server_settings["foreground"]

2433

zeroconf = server_settings["zeroconf"]

2085

2434

2086

2435

if debug:

2087

2436

initlogger(debug, logging.DEBUG)

2094

2443

2095

2444

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

2096

2445

syslogger.setFormatter(logging.Formatter

2097

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

2098

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

2099

% server_settings["servicename"]))

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2100

2450

2101

2451

# Parse config file with clients

2102

2452

client_config = configparser.SafeConfigParser(Client

2107

2457

global mandos_dbus_service

2108

2458

mandos_dbus_service = None

2109

2459

2460

socketfd = None

2461

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

2462

socketfd = server_settings["socket"]

2110

2463

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

2111

2464

server_settings["port"]),

2112

2465

ClientHandler,

2115

2468

use_ipv6=use_ipv6,

2116

2469

gnutls_priority=

2117

2470

server_settings["priority"],

2118

use_dbus=use_dbus)

2119

if not debug:

2120

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

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

2473

if not foreground:

2474

pidfilename = "/run/mandos.pid"

2475

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

2476

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

2477

pidfile = None

2121

2478

try:

2122

2479

pidfile = open(pidfilename, "w")

2123

except IOError:

2124

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

2480

except IOError as e:

2481

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

2482

exc_info=e)

2125

2483

2126

try:

2127

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

2128

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

2129

except KeyError:

2484

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

2130

2485

try:

2131

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

2132

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

2486

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

2488

break

2133

2489

except KeyError:

2134

try:

2135

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

2136

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

2137

except KeyError:

2138

uid = 65534

2139

gid = 65534

2490

continue

2491

else:

2492

uid = 65534

2493

gid = 65534

2140

2494

try:

2141

2495

os.setgid(gid)

2142

2496

os.setuid(uid)

2143

2497

except OSError as error:

2144

if error[0] != errno.EPERM:

2145

raise error

2498

if error.errno != errno.EPERM:

2499

raise

2146

2500

2147

2501

if debug:

2148

2502

# Enable all possible GnuTLS debugging

2159

2513

.gnutls_global_set_log_function(debug_gnutls))

2160

2514

2161

2515

# Redirect stdin so all checkers get /dev/null

2162

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

2516

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

2163

2517

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

2164

2518

if null > 2:

2165

2519

os.close(null)

2166

2520

2167

2521

# Need to fork before connecting to D-Bus

2168

if not debug:

2522

if not foreground:

2169

2523

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

2170

2524

daemon()

2171

2525

2526

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

2527

# need to inform gobject that threads will be used.

2172

2528

gobject.threads_init()

2173

2529

2174

2530

global main_loop

2175

2531

# From the Avahi example code

2176

DBusGMainLoop(set_as_default=True )

2532

DBusGMainLoop(set_as_default=True)

2177

2533

main_loop = gobject.MainLoop()

2178

2534

bus = dbus.SystemBus()

2179

2535

# End of Avahi example code

2185

2541

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

2186

2542

do_not_queue=True))

2187

2543

except dbus.exceptions.NameExistsException as e:

2188

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

2544

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

2189

2545

use_dbus = False

2190

2546

server_settings["use_dbus"] = False

2191

2547

tcp_server.use_dbus = False

2192

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2193

service = AvahiServiceToSyslog(name =

2194

server_settings["servicename"],

2195

servicetype = "_mandos._tcp",

2196

protocol = protocol, bus = bus)

2197

if server_settings["interface"]:

2198

service.interface = (if_nametoindex

2199

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

2548

if zeroconf:

2549

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

2554

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2200

2557

2201

2558

global multiprocessing_manager

2202

2559

multiprocessing_manager = multiprocessing.Manager()

2203

2560

2204

2561

client_class = Client

2205

2562

if use_dbus:

2206

client_class = functools.partial(ClientDBusTransitional,

2207

bus = bus)

2563

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

2208

2564

2209

2565

client_settings = Client.config_parser(client_config)

2210

2566

old_client_settings = {}

2211

2567

clients_data = {}

2212

2568

2569

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

2570

global wnull

2571

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

2572

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

2573

# mode

2574

if debug or not foreground:

2575

wnull.close()

2576

2213

2577

# Get client data and settings from last running state.

2214

2578

if server_settings["restore"]:

2215

2579

try:

2218

2582

(stored_state))

2219

2583

os.remove(stored_state_path)

2220

2584

except IOError as e:

2221

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

2222

.format(e))

2223

if e.errno != errno.ENOENT:

2585

if e.errno == errno.ENOENT:

2586

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

2587

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

2588

else:

2589

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

2590

exc_info=e)

2224

2591

raise

2225

2592

except EOFError as e:

2226

2593

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

2227

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

2594

"EOFError:", exc_info=e)

2228

2595

2229

2596

with PGPEngine() as pgp:

2230

2597

for client_name, client in clients_data.iteritems():

2598

# Skip removed clients

2599

if client_name not in client_settings:

2600

continue

2601

2231

2602

# Decide which value to use after restoring saved state.

2232

2603

# We have three different values: Old config file,

2233

2604

# new config file, and saved state.

2283

2654

.format(client_name))

2284

2655

client["secret"] = (

2285

2656

client_settings[client_name]["secret"])

2286

2287

2657

2288

2658

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

2289

2659

for client_name in (set(old_client_settings)

2292

2662

for client_name in (set(client_settings)

2293

2663

- set(old_client_settings)):

2294

2664

clients_data[client_name] = client_settings[client_name]

2295

2665

2296

2666

# Create all client objects

2297

2667

for client_name, client in clients_data.iteritems():

2298

2668

tcp_server.clients[client_name] = client_class(

2299

name = client_name, settings = client)

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2300

2671

2301

2672

if not tcp_server.clients:

2302

2673

logger.warning("No clients defined")

2303

2304

if not debug:

2305

try:

2306

with pidfile:

2307

pid = os.getpid()

2308

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

2309

del pidfile

2310

except IOError:

2311

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

2312

pidfilename, pid)

2313

except NameError:

2314

# "pidfile" was never created

2315

pass

2674

2675

if not foreground:

2676

if pidfile is not None:

2677

try:

2678

with pidfile:

2679

pid = os.getpid()

2680

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

2681

except IOError:

2682

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

2683

pidfilename, pid)

2684

del pidfile

2316

2685

del pidfilename

2317

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

2318

2686

2319

2687

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

2320

2688

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

2321

2689

2322

2690

if use_dbus:

2323

class MandosDBusService(dbus.service.Object):

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

2324

2694

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

2325

2695

def __init__(self):

2326

2696

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

2327

2697

_interface = "se.recompile.Mandos"

2328

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

2329

2705

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

2330

2706

def ClientAdded(self, objpath):

2331

2707

"D-Bus signal"

2373

2749

2374

2750

del _interface

2375

2751

2376

class MandosDBusServiceTransitional(MandosDBusService):

2377

__metaclass__ = AlternateDBusNamesMetaclass

2378

mandos_dbus_service = MandosDBusServiceTransitional()

2752

mandos_dbus_service = MandosDBusService()

2379

2753

2380

2754

def cleanup():

2381

2755

"Cleanup function; run on exit"

2382

service.cleanup()

2756

if zeroconf:

2757

service.cleanup()

2383

2758

2384

2759

multiprocessing.active_children()

2760

wnull.close()

2385

2761

if not (tcp_server.clients or client_settings):

2386

2762

return

2387

2763

2399

2775

# A list of attributes that can not be pickled

2400

2776

# + secret.

2401

2777

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

2402

"checker"))

2778

"checker", "server_settings"))

2403

2779

for name, typ in (inspect.getmembers

2404

2780

(dbus.service.Object)):

2405

2781

exclude.add(name)

2414

2790

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

2415

2791

2416

2792

try:

2417

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

2418

prefix="clients-",

2419

dir=os.path.dirname

2420

(stored_state_path))

2421

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

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2422

2797

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

2798

tempname=stored_state.name

2423

2799

os.rename(tempname, stored_state_path)

2424

2800

except (IOError, OSError) as e:

2425

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

2426

.format(e))

2427

2801

if not debug:

2428

2802

try:

2429

2803

os.remove(tempname)

2430

2804

except NameError:

2431

2805

pass

2432

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

2433

errno.EEXIST)):

2434

raise e

2806

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

2807

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

2808

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

2809

else:

2810

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

2811

exc_info=e)

2812

raise

2435

2813

2436

2814

# Delete all clients, and settings from config

2437

2815

while tcp_server.clients:

2461

2839

tcp_server.server_activate()

2462

2840

2463

2841

# Find out what port we got

2464

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

2842

if zeroconf:

2843

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

2465

2844

if use_ipv6:

2466

2845

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

2467

" flowinfo %d, scope_id %d"

2468

% tcp_server.socket.getsockname())

2846

" flowinfo %d, scope_id %d",

2847

*tcp_server.socket.getsockname())

2469

2848

else: # IPv4

2470

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

2471

% tcp_server.socket.getsockname())

2849

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

2850

*tcp_server.socket.getsockname())

2472

2851

2473

2852

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

2474

2853

2475

2854

try:

2476

# From the Avahi example code

2477

try:

2478

service.activate()

2479

except dbus.exceptions.DBusException as error:

2480

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

2481

cleanup()

2482

sys.exit(1)

2483

# End of Avahi example code

2855

if zeroconf:

2856

# From the Avahi example code

2857

try:

2858

service.activate()

2859

except dbus.exceptions.DBusException as error:

2860

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

2861

cleanup()

2862

sys.exit(1)

2863

# End of Avahi example code

2484

2864

2485

2865

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

2486

2866

lambda *args, **kwargs:

2490

2870

logger.debug("Starting main loop")

2491

2871

main_loop.run()

2492

2872

except AvahiError as error:

2493

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

2873

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

2494

2874

cleanup()

2495

2875

sys.exit(1)

2496

2876

except KeyboardInterrupt: