/mandos/trunk : revision 660

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

38

37

39

import SocketServer as socketserver

38

40

import socket

39

41

import argparse

65

67

import types

66

68

import binascii

67

69

import tempfile

70

import itertools

71

import collections

68

72

69

73

import dbus

70

74

import dbus.service

75

79

import ctypes.util

76

80

import xml.dom.minidom

77

81

import inspect

78

import GnuPGInterface

79

82

80

83

try:

81

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

88

except ImportError:

86

89

SO_BINDTODEVICE = None

87

90

88

version = "1.4.1"

91

version = "1.6.4"

89

92

stored_state_file = "clients.pickle"

90

93

91

94

logger = logging.getLogger()

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

95

syslogger = None

95

96

97

try:

97

98

if_nametoindex = (ctypes.cdll.LoadLibrary

113

114

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

114

115

"""init logger and add loglevel"""

115

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

116

121

syslogger.setFormatter(logging.Formatter

117

122

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

118

123

' %(message)s'))

136

141

class PGPEngine(object):

137

142

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

138

143

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

140

144

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

141

self.gnupg = GnuPGInterface.GnuPG()

142

self.gnupg.options.meta_interactive = False

143

self.gnupg.options.homedir = self.tempdir

144

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

145

'--quiet'])

145

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

147

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

146

150

147

151

def __enter__(self):

148

152

return self

149

153

150

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

154

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

151

155

self._cleanup()

152

156

return False

153

157

170

174

def password_encode(self, password):

171

175

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

172

176

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

173

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

177

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

178

if len(encoded) > 2048:

179

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

180

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

181

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

182

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

183

return encoded

174

184

175

185

def encrypt(self, data, password):

176

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

177

with open(os.devnull) as devnull:

178

try:

179

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

180

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

181

attach_fhs={'stderr': devnull})

182

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

183

f.write(data)

184

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

185

ciphertext = f.read()

186

proc.wait()

187

except IOError as e:

188

raise PGPError(e)

189

self.gnupg.passphrase = None

186

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

189

passfile.write(passphrase)

190

passfile.flush()

191

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

192

'--passphrase-file',

193

passfile.name]

194

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

199

if proc.returncode != 0:

200

raise PGPError(err)

190

201

return ciphertext

191

202

192

203

def decrypt(self, data, password):

193

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

194

with open(os.devnull) as devnull:

195

try:

196

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

197

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

198

attach_fhs={'stderr': devnull})

199

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

200

f.write(data)

201

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

202

decrypted_plaintext = f.read()

203

proc.wait()

204

except IOError as e:

205

raise PGPError(e)

206

self.gnupg.passphrase = None

204

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

207

passfile.write(passphrase)

208

passfile.flush()

209

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

210

'--passphrase-file',

211

passfile.name]

212

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

218

if proc.returncode != 0:

219

raise PGPError(err)

207

220

return decrypted_plaintext

208

221

209

222

210

211

223

class AvahiError(Exception):

212

224

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

213

225

self.value = value

230

242

Used to optionally bind to the specified interface.

231

243

name: string; Example: 'Mandos'

232

244

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

233

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

245

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

234

246

port: integer; what port to announce

235

247

TXT: list of strings; TXT record for the service

236

248

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

242

254

server: D-Bus Server

243

255

bus: dbus.SystemBus()

244

256

"""

257

245

258

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

246

259

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

247

260

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

260

273

self.server = None

261

274

self.bus = bus

262

275

self.entry_group_state_changed_match = None

276

263

277

def rename(self):

264

278

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

265

279

if self.rename_count >= self.max_renames:

275

289

try:

276

290

self.add()

277

291

except dbus.exceptions.DBusException as error:

278

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

292

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

279

293

self.cleanup()

280

294

os._exit(1)

281

295

self.rename_count += 1

296

282

297

def remove(self):

283

298

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

284

299

if self.entry_group_state_changed_match is not None:

286

301

self.entry_group_state_changed_match = None

287

302

if self.group is not None:

288

303

self.group.Reset()

304

289

305

def add(self):

290

306

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

291

307

self.remove()

308

324

dbus.UInt16(self.port),

309

325

avahi.string_array_to_txt_array(self.TXT))

310

326

self.group.Commit()

327

311

328

def entry_group_state_changed(self, state, error):

312

329

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

313

330

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

320

337

elif state == avahi.ENTRY_GROUP_FAILURE:

321

338

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

322

339

unicode(error))

323

raise AvahiGroupError("State changed: %s"

324

% unicode(error))

340

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

341

.format(error))

342

325

343

def cleanup(self):

326

344

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

327

345

if self.group is not None:

332

350

pass

333

351

self.group = None

334

352

self.remove()

353

335

354

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

336

355

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

337

356

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

356

375

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

357

376

else:

358

377

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

378

359

379

def activate(self):

360

380

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

361

381

if self.server is None:

368

388

self.server_state_changed)

369

389

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

370

390

391

371

392

class AvahiServiceToSyslog(AvahiService):

372

393

def rename(self):

373

394

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

374

395

ret = AvahiService.rename(self)

375

396

syslogger.setFormatter(logging.Formatter

376

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

377

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

378

% self.name))

397

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

398

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

399

.format(self.name)))

379

400

return ret

380

401

402

381

403

def timedelta_to_milliseconds(td):

382

404

"Convert a datetime.timedelta() to milliseconds"

383

405

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

384

406

+ (td.seconds * 1000)

385

407

+ (td.microseconds // 1000))

386

408

409

387

410

class Client(object):

388

411

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

389

412

414

437

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

415

438

last_checker_status: integer between 0 and 255 reflecting exit

416

439

status of last checker. -1 reflects crashed

417

checker, or None.

440

checker, -2 means no checker completed yet.

418

441

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

419

442

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

420

443

D-Bus identifiers

421

444

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

422

445

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

423

446

until this client is disabled

424

extended_timeout: extra long timeout when password has been sent

447

extended_timeout: extra long timeout when secret has been sent

425

448

runtime_expansions: Allowed attributes for runtime expansion.

426

449

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

427

450

disabled, or None

451

server_settings: The server_settings dict from main()

428

452

"""

429

453

430

454

runtime_expansions = ("approval_delay", "approval_duration",

431

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

432

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

455

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

456

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

457

"last_approval_request", "last_checked_ok",

433

458

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

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

437

462

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

438

463

"host": "",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

441

466

"approved_by_default": "True",

442

467

"enabled": "True",

443

468

}

456

481

457

482

def approval_delay_milliseconds(self):

458

483

return timedelta_to_milliseconds(self.approval_delay)

459

484

460

485

@staticmethod

461

486

def config_parser(config):

462

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

487

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

463

488

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

464

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

489

with exceptions for any special settings as defined above.

490

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

491

value given the same arguments.

492

"""

465

493

settings = {}

466

494

for client_name in config.sections():

467

495

section = dict(config.items(client_name))

471

499

# Reformat values from string types to Python types

472

500

client["approved_by_default"] = config.getboolean(

473

501

client_name, "approved_by_default")

474

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

502

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

503

"enabled")

475

504

476

505

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

477

506

.replace(" ", ""))

483

512

"rb") as secfile:

484

513

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

485

514

else:

486

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

487

% section)

515

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

516

.format(section))

488

517

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

489

518

client["extended_timeout"] = string_to_delta(

490

519

section["extended_timeout"])

496

525

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

497

526

client["last_approval_request"] = None

498

527

client["last_checked_ok"] = None

499

client["last_checker_status"] = None

500

if client["enabled"]:

501

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

502

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

503

+ client["timeout"])

504

else:

505

client["last_enabled"] = None

506

client["expires"] = None

507

528

client["last_checker_status"] = -2

529

508

530

return settings

509

510

511

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

512

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

513

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

514

attribute."""

531

532

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

515

533

self.name = name

534

if server_settings is None:

535

server_settings = {}

536

self.server_settings = server_settings

516

537

# adding all client settings

517

538

for setting, value in settings.iteritems():

518

539

setattr(self, setting, value)

519

540

541

if self.enabled:

542

if not hasattr(self, "last_enabled"):

543

self.last_enabled = datetime.datetime.utcnow()

544

if not hasattr(self, "expires"):

545

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

546

+ self.timeout)

547

else:

548

self.last_enabled = None

549

self.expires = None

550

520

551

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

521

552

# Uppercase and remove spaces from fingerprint for later

522

553

# comparison purposes with return value from the fingerprint()

523

554

# function

524

555

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

525

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

526

556

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

557

datetime.datetime.utcnow())

558

527

559

# attributes specific for this server instance

528

560

self.checker = None

529

561

self.checker_initiator_tag = None

557

589

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

558

590

# Already enabled

559

591

return

560

self.send_changedstate()

561

592

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

562

593

self.enabled = True

563

594

self.last_enabled = datetime.datetime.utcnow()

564

595

self.init_checker()

596

self.send_changedstate()

565

597

566

598

def disable(self, quiet=True):

567

599

"""Disable this client."""

568

600

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

569

601

return False

570

602

if not quiet:

571

self.send_changedstate()

572

if not quiet:

573

603

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

574

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

604

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

575

605

gobject.source_remove(self.disable_initiator_tag)

576

606

self.disable_initiator_tag = None

577

607

self.expires = None

578

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

608

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

579

609

gobject.source_remove(self.checker_initiator_tag)

580

610

self.checker_initiator_tag = None

581

611

self.stop_checker()

582

612

self.enabled = False

613

if not quiet:

614

self.send_changedstate()

583

615

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

584

616

return False

585

617

589

621

def init_checker(self):

590

622

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

591

623

# and every interval from then on.

624

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

592

626

self.checker_initiator_tag = (gobject.timeout_add

593

627

(self.interval_milliseconds(),

594

628

self.start_checker))

595

629

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

630

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

596

632

self.disable_initiator_tag = (gobject.timeout_add

597

633

(self.timeout_milliseconds(),

598

634

self.disable))

617

653

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

618

654

vars(self))

619

655

620

def checked_ok(self, timeout=None):

621

"""Bump up the timeout for this client.

622

623

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

624

alive and well.

625

"""

656

def checked_ok(self):

657

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

658

self.last_checked_ok = datetime.datetime.utcnow()

659

self.last_checker_status = 0

660

self.bump_timeout()

661

662

def bump_timeout(self, timeout=None):

663

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

626

664

if timeout is None:

627

665

timeout = self.timeout

628

self.last_checked_ok = datetime.datetime.utcnow()

629

666

if self.disable_initiator_tag is not None:

630

667

gobject.source_remove(self.disable_initiator_tag)

668

self.disable_initiator_tag = None

631

669

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

632

670

self.disable_initiator_tag = (gobject.timeout_add

633

671

(timedelta_to_milliseconds

643

681

If a checker already exists, leave it running and do

644

682

nothing."""

645

683

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

646

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

647

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

648

# client would inevitably timeout, since no checker would get

649

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

684

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

685

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

686

# would inevitably timeout, since no checker would get a

687

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

650

688

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

651

689

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

652

690

# should be.

654

692

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

655

693

try:

656

694

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

657

except (AttributeError, OSError) as error:

658

if (isinstance(error, OSError)

659

and error.errno != errno.ECHILD):

660

raise error

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

661

700

else:

662

701

if pid:

663

702

logger.warning("Checker was a zombie")

666

705

self.current_checker_command)

667

706

# Start a new checker if needed

668

707

if self.checker is None:

708

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

669

713

try:

670

# In case checker_command has exactly one % operator

671

command = self.checker_command % self.host

672

except TypeError:

673

# Escape attributes for the shell

674

escaped_attrs = dict(

675

(attr,

676

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

677

errors=

678

'replace')))

679

for attr in

680

self.runtime_expansions)

681

682

try:

683

command = self.checker_command % escaped_attrs

684

except TypeError as error:

685

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

686

' %s', self.checker_command, error)

687

return True # Try again later

714

command = self.checker_command % escaped_attrs

715

except TypeError as error:

716

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

688

719

self.current_checker_command = command

689

720

try:

690

721

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

693

724

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

694

725

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

695

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

696

735

self.checker = subprocess.Popen(command,

697

736

close_fds=True,

698

shell=True, cwd="/")

699

self.checker_callback_tag = (gobject.child_watch_add

700

(self.checker.pid,

701

self.checker_callback,

702

data=command))

703

# The checker may have completed before the gobject

704

# watch was added. Check for this.

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

705

750

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

706

if pid:

707

gobject.source_remove(self.checker_callback_tag)

708

self.checker_callback(pid, status, command)

709

751

except OSError as error:

710

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

711

error)

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

712

761

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

713

762

return True

714

763

721

770

return

722

771

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

723

772

try:

724

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

773

self.checker.terminate()

725

774

#time.sleep(0.5)

726

775

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

727

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

776

# self.checker.kill()

728

777

except OSError as error:

729

778

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

730

779

raise

747

796

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

748

797

if byte_arrays and signature != "ay":

749

798

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

750

" signature %r" % signature)

799

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

751

800

def decorator(func):

752

801

func._dbus_is_property = True

753

802

func._dbus_interface = dbus_interface

761

810

return decorator

762

811

763

812

813

def dbus_interface_annotations(dbus_interface):

814

"""Decorator for marking functions returning interface annotations

815

816

Usage:

817

818

@dbus_interface_annotations("org.example.Interface")

819

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

820

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

821

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

822

"false"}

823

"""

824

def decorator(func):

825

func._dbus_is_interface = True

826

func._dbus_interface = dbus_interface

827

func._dbus_name = dbus_interface

828

return func

829

return decorator

830

831

832

def dbus_annotations(annotations):

833

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

834

Usage:

835

836

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

837

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

def Property_dbus_property(self):

842

return dbus.Boolean(False)

843

"""

844

def decorator(func):

845

func._dbus_annotations = annotations

846

return func

847

return decorator

848

849

764

850

class DBusPropertyException(dbus.exceptions.DBusException):

765

851

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

766

852

"""

789

875

"""

790

876

791

877

@staticmethod

792

def _is_dbus_property(obj):

793

return getattr(obj, "_dbus_is_property", False)

878

def _is_dbus_thing(thing):

879

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

880

881

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

882

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

883

"""

884

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

885

False)

794

886

795

def _get_all_dbus_properties(self):

887

def _get_all_dbus_things(self, thing):

796

888

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

797

889

"""

798

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

890

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

891

name),

892

athing.__get__(self))

799

893

for cls in self.__class__.__mro__

800

for name, prop in

801

inspect.getmembers(cls, self._is_dbus_property))

894

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

802

897

803

898

def _get_dbus_property(self, interface_name, property_name):

804

899

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

806

901

"""

807

902

for cls in self.__class__.__mro__:

808

903

for name, value in (inspect.getmembers

809

(cls, self._is_dbus_property)):

904

(cls,

905

self._is_dbus_thing("property"))):

810

906

if (value._dbus_name == property_name

811

907

and value._dbus_interface == interface_name):

812

908

return value.__get__(self)

840

936

# The byte_arrays option is not supported yet on

841

937

# signatures other than "ay".

842

938

if prop._dbus_signature != "ay":

843

raise ValueError

844

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

845

for byte in value))

939

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

940

"'ay' signature {0!r}"

941

.format(prop._dbus_signature))

942

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

943

for byte in value))

846

944

prop(value)

847

945

848

946

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

854

952

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

855

953

"""

856

954

properties = {}

857

for name, prop in self._get_all_dbus_properties():

955

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

858

956

if (interface_name

859

957

and interface_name != prop._dbus_interface):

860

958

# Interface non-empty but did not match

875

973

path_keyword='object_path',

876

974

connection_keyword='connection')

877

975

def Introspect(self, object_path, connection):

878

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

976

"""Overloading of standard D-Bus method.

977

978

Inserts property tags and interface annotation tags.

879

979

"""

880

980

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

881

981

connection)

888

988

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

889

989

return e

890

990

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

991

# Add property tags

891

992

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

892

993

for name, prop

893

in self._get_all_dbus_properties()

994

in self._get_all_dbus_things("property")

894

995

if prop._dbus_interface

895

996

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

896

997

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

897

1029

# Add the names to the return values for the

898

1030

# "org.freedesktop.DBus.Properties" methods

899

1031

if (if_tag.getAttribute("name")

914

1046

except (AttributeError, xml.dom.DOMException,

915

1047

xml.parsers.expat.ExpatError) as error:

916

1048

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

917

error)

1049

exc_info=error)

918

1050

return xmlstring

919

1051

920

1052

921

def datetime_to_dbus (dt, variant_level=0):

1053

def datetime_to_dbus(dt, variant_level=0):

922

1054

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

923

1055

if dt is None:

924

1056

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

926

1058

variant_level=variant_level)

927

1059

928

1060

929

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

930

.__metaclass__):

931

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

932

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

1061

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1062

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

1063

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

1064

interface names according to the "alt_interface_names" mapping.

1065

Usage:

1066

1067

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

1068

"net.example.AlternateInterface"})

1069

class SampleDBusObject(dbus.service.Object):

1070

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

1071

def SampleDBusMethod():

1072

pass

1073

1074

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

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

1076

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

1077

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

1078

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

1079

1080

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

1081

(from DBusObjectWithProperties) and interfaces (from the

1082

dbus_interface_annotations decorator).

933

1083

"""

934

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

935

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

936

# methods, signals, or properties in them

937

for base in (b for b in bases

938

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

939

# Go though all attributes of the base class

940

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

1084

def wrapper(cls):

1085

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1087

attr = {}

1088

interface_names = set()

1089

# Go though all attributes of the class

1090

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

941

1091

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

942

1092

# with the wrong interface name

943

1093

if (not hasattr(attribute, "_dbus_interface")

944

1094

or not attribute._dbus_interface

945

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

1095

.startswith(orig_interface_name)):

946

1096

continue

947

1097

# Create an alternate D-Bus interface name based on

948

1098

# the current name

949

1099

alt_interface = (attribute._dbus_interface

950

.replace("se.recompile.Mandos",

951

"se.bsnet.fukt.Mandos"))

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1102

interface_names.add(alt_interface)

952

1103

# Is this a D-Bus signal?

953

1104

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

954

# Extract the original non-method function by

955

# black magic

1105

# Extract the original non-method undecorated

1106

# function by black magic

956

1107

nonmethod_func = (dict(

957

1108

zip(attribute.func_code.co_freevars,

958

1109

attribute.__closure__))["func"]

969

1120

nonmethod_func.func_name,

970

1121

nonmethod_func.func_defaults,

971

1122

nonmethod_func.func_closure)))

1123

# Copy annotations, if any

1124

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1127

except AttributeError:

1128

pass

972

1129

# Define a creator of a function to call both the

973

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

974

# signals gets sent when the function is called

1130

# original and alternate functions, so both the

1131

# original and alternate signals gets sent when

1132

# the function is called

975

1133

def fixscope(func1, func2):

976

1134

"""This function is a scope container to pass

977

1135

func1 and func2 to the "call_both" function

984

1142

return call_both

985

1143

# Create the "call_both" function and add it to

986

1144

# the class

987

attr[attrname] = fixscope(attribute,

988

new_function)

1145

attr[attrname] = fixscope(attribute, new_function)

989

1146

# Is this a D-Bus method?

990

1147

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

991

1148

# Create a new, but exactly alike, function

1002

1159

attribute.func_name,

1003

1160

attribute.func_defaults,

1004

1161

attribute.func_closure)))

1162

# Copy annotations, if any

1163

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1166

except AttributeError:

1167

pass

1005

1168

# Is this a D-Bus property?

1006

1169

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

1007

1170

# Create a new, but exactly alike, function

1021

1184

attribute.func_name,

1022

1185

attribute.func_defaults,

1023

1186

attribute.func_closure)))

1024

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

1025

1026

1187

# Copy annotations, if any

1188

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1191

except AttributeError:

1192

pass

1193

# Is this a D-Bus interface?

1194

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

1195

# Create a new, but exactly alike, function

1196

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

1197

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

1198

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1207

if deprecate:

1208

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1210

for interface_name in interface_names:

1211

@dbus_interface_annotations(interface_name)

1212

def func(self):

1213

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

1214

"true" }

1215

# Find an unused name

1216

for aname in (iname.format(i)

1217

for i in itertools.count()):

1218

if aname not in attr:

1219

attr[aname] = func

1220

break

1221

if interface_names:

1222

# Replace the class with a new subclass of it with

1223

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1226

return cls

1227

return wrapper

1228

1229

1230

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

1231

"se.bsnet.fukt.Mandos"})

1027

1232

class ClientDBus(Client, DBusObjectWithProperties):

1028

1233

"""A Client class using D-Bus

1029

1234

1040

1245

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

1041

1246

self.bus = bus

1042

1247

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

1043

self._approvals_pending = 0

1044

1045

self._approvals_pending = 0

1046

1248

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

1047

1249

# the D-Bus

1048

1250

client_object_name = unicode(self.name).translate(

1052

1254

("/clients/" + client_object_name))

1053

1255

DBusObjectWithProperties.__init__(self, self.bus,

1054

1256

self.dbus_object_path)

1055

1257

1056

1258

def notifychangeproperty(transform_func,

1057

1259

dbus_name, type_func=lambda x: x,

1058

1260

variant_level=1):

1081

1283

1082

1284

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

1083

1285

1084

1085

1286

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1086

1287

approvals_pending = notifychangeproperty(dbus.Boolean,

1087

1288

"ApprovalPending",

1094

1295

checker is not None)

1095

1296

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1096

1297

"LastCheckedOK")

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1299

"LastCheckerStatus")

1097

1300

last_approval_request = notifychangeproperty(

1098

1301

datetime_to_dbus, "LastApprovalRequest")

1099

1302

approved_by_default = notifychangeproperty(dbus.Boolean,

1149

1352

*args, **kwargs)

1150

1353

1151

1354

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

1152

old_checker = self.checker

1153

if self.checker is not None:

1154

old_checker_pid = self.checker.pid

1155

else:

1156

old_checker_pid = None

1355

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

1157

1356

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

1158

1357

# Only if new checker process was started

1159

1358

if (self.checker is not None

1167

1366

return False

1168

1367

1169

1368

def approve(self, value=True):

1170

self.send_changedstate()

1171

1369

self.approved = value

1172

1370

gobject.timeout_add(timedelta_to_milliseconds

1173

1371

(self.approval_duration),

1174

1372

self._reset_approved)

1175

1373

self.send_changedstate()

1176

1374

1177

1375

## D-Bus methods, signals & properties

1178

1376

_interface = "se.recompile.Mandos.Client"

1179

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1180

1385

## Signals

1181

1386

1182

1387

# CheckerCompleted - signal

1218

1423

"D-Bus signal"

1219

1424

return self.need_approval()

1220

1425

1221

# NeRwequest - signal

1222

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

1223

def NewRequest(self, ip):

1224

"""D-Bus signal

1225

Is sent after a client request a password.

1226

"""

1227

pass

1228

1229

1426

## Methods

1230

1427

1231

1428

# Approve - method

1341

1538

return

1342

1539

return datetime_to_dbus(self.last_checked_ok)

1343

1540

1541

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

1544

def LastCheckerStatus_dbus_property(self):

1545

return dbus.Int16(self.last_checker_status)

1546

1344

1547

# Expires - property

1345

1548

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

1346

1549

def Expires_dbus_property(self):

1357

1560

def Timeout_dbus_property(self, value=None):

1358

1561

if value is None: # get

1359

1562

return dbus.UInt64(self.timeout_milliseconds())

1563

old_timeout = self.timeout

1360

1564

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

1361

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

1362

return

1363

# Reschedule timeout

1364

gobject.source_remove(self.disable_initiator_tag)

1365

self.disable_initiator_tag = None

1366

self.expires = None

1367

time_to_die = timedelta_to_milliseconds((self

1368

.last_checked_ok

1369

+ self.timeout)

1370

- datetime.datetime

1371

.utcnow())

1372

if time_to_die <= 0:

1373

# The timeout has passed

1374

self.disable()

1375

else:

1376

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

1377

+ datetime.timedelta(milliseconds =

1378

time_to_die))

1379

self.disable_initiator_tag = (gobject.timeout_add

1380

(time_to_die, self.disable))

1565

# Reschedule disabling

1566

if self.enabled:

1567

now = datetime.datetime.utcnow()

1568

self.expires += self.timeout - old_timeout

1569

if self.expires <= now:

1570

# The timeout has passed

1571

self.disable()

1572

else:

1573

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

1574

is None):

1575

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1381

1581

1382

1582

# ExtendedTimeout - property

1383

1583

@dbus_service_property(_interface, signature="t",

1462

1662

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

1463

1663

1464

1664

1465

class ClientDBusTransitional(ClientDBus):

1466

__metaclass__ = AlternateDBusNamesMetaclass

1467

1468

1469

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

1470

1666

"""A class to handle client connections.

1471

1667

1507

1703

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

1508

1704

try:

1509

1705

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

1510

raise RuntimeError

1706

raise RuntimeError(line)

1511

1707

except (ValueError, IndexError, RuntimeError) as error:

1512

1708

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

1513

1709

return

1539

1735

except KeyError:

1540

1736

return

1541

1737

1542

if self.server.use_dbus:

1543

# Emit D-Bus signal

1544

client.NewRequest(str(self.client_address))

1545

1546

1738

if client.approval_delay:

1547

1739

delay = client.approval_delay

1548

1740

client.approvals_pending += 1

1579

1771

#wait until timeout or approved

1580

1772

time = datetime.datetime.now()

1581

1773

client.changedstate.acquire()

1582

(client.changedstate.wait

1583

(float(client.timedelta_to_milliseconds(delay)

1584

/ 1000)))

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

1585

1777

client.changedstate.release()

1586

1778

time2 = datetime.datetime.now()

1587

1779

if (time2 - time) >= delay:

1603

1795

try:

1604

1796

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

1605

1797

except gnutls.errors.GNUTLSError as error:

1606

logger.warning("gnutls send failed")

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1607

1800

return

1608

1801

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

1609

1802

sent, len(client.secret)

1612

1805

1613

1806

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

1614

1807

# bump the timeout using extended_timeout

1615

client.checked_ok(client.extended_timeout)

1808

client.bump_timeout(client.extended_timeout)

1616

1809

if self.server.use_dbus:

1617

1810

# Emit D-Bus signal

1618

1811

client.GotSecret()

1623

1816

try:

1624

1817

session.bye()

1625

1818

except gnutls.errors.GNUTLSError as error:

1626

logger.warning("GnuTLS bye failed")

1819

logger.warning("GnuTLS bye failed",

1820

exc_info=error)

1627

1821

1628

1822

@staticmethod

1629

1823

def peer_certificate(session):

1701

1895

def process_request(self, request, address):

1702

1896

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

1703

1897

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

1704

args = (request,

1705

address))

1898

args = (request, address))

1706

1899

proc.start()

1707

1900

return proc

1708

1901

1723

1916

1724

1917

def add_pipe(self, parent_pipe, proc):

1725

1918

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

1726

raise NotImplementedError

1919

raise NotImplementedError()

1727

1920

1728

1921

1729

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1736

1929

use_ipv6: Boolean; to use IPv6 or not

1737

1930

"""

1738

1931

def __init__(self, server_address, RequestHandlerClass,

1739

interface=None, use_ipv6=True):

1932

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

1933

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

1934

creating a new one with socket.socket().

1935

"""

1740

1936

self.interface = interface

1741

1937

if use_ipv6:

1742

1938

self.address_family = socket.AF_INET6

1939

if socketfd is not None:

1940

# Save the file descriptor

1941

self.socketfd = socketfd

1942

# Save the original socket.socket() function

1943

self.socket_socket = socket.socket

1944

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

1945

#

1946

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

1947

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

1948

# patching socket.socket.)

1949

#

1950

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

1951

@functools.wraps(socket.socket)

1952

def socket_wrapper(*args, **kwargs):

1953

# Restore original function so subsequent calls are

1954

# not affected.

1955

socket.socket = self.socket_socket

1956

del self.socket_socket

1957

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

1958

# saved file descriptor.

1959

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

1960

# Replace socket.socket() function with wrapper

1961

socket.socket = socket_wrapper

1962

# The socketserver.TCPServer.__init__ will call

1963

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

1964

# socket_wrapper(), if socketfd was set.

1743

1965

socketserver.TCPServer.__init__(self, server_address,

1744

1966

RequestHandlerClass)

1967

1745

1968

def server_bind(self):

1746

1969

"""This overrides the normal server_bind() function

1747

1970

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

1755

1978

try:

1756

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1757

1980

SO_BINDTODEVICE,

1758

str(self.interface

1759

+ '\0'))

1981

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

1760

1982

except socket.error as error:

1761

if error[0] == errno.EPERM:

1762

logger.error("No permission to"

1763

" bind to interface %s",

1764

self.interface)

1765

elif error[0] == errno.ENOPROTOOPT:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1766

1987

logger.error("SO_BINDTODEVICE not available;"

1767

1988

" cannot bind to interface %s",

1768

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1769

1993

else:

1770

1994

raise

1771

1995

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

1774

1998

if self.address_family == socket.AF_INET6:

1775

1999

any_address = "::" # in6addr_any

1776

2000

else:

1777

any_address = socket.INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

1778

2002

self.server_address = (any_address,

1779

2003

self.server_address[1])

1780

2004

elif not self.server_address[1]:

1801

2025

"""

1802

2026

def __init__(self, server_address, RequestHandlerClass,

1803

2027

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

1804

gnutls_priority=None, use_dbus=True):

2028

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

1805

2029

self.enabled = False

1806

2030

self.clients = clients

1807

2031

if self.clients is None:

1811

2035

IPv6_TCPServer.__init__(self, server_address,

1812

2036

RequestHandlerClass,

1813

2037

interface = interface,

1814

use_ipv6 = use_ipv6)

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

1815

2040

def server_activate(self):

1816

2041

if self.enabled:

1817

2042

return socketserver.TCPServer.server_activate(self)

1830

2055

1831

2056

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

1832

2057

proc = None, client_object=None):

1833

condition_names = {

1834

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

1835

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

1836

# blocking).

1837

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

1838

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

1839

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

1840

# broken, usually for pipes and

1841

# sockets).

1842

}

1843

conditions_string = ' | '.join(name

1844

for cond, name in

1845

condition_names.iteritems()

1846

if cond & condition)

1847

2058

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

1848

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

2059

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

1849

2060

# Wait for other process to exit

1850

2061

proc.join()

1851

2062

return False

1909

2120

return True

1910

2121

1911

2122

2123

def rfc3339_duration_to_delta(duration):

2124

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

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2140

"""

2141

2142

# Parsing an RFC 3339 duration with regular expressions is not

2143

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

2144

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

2145

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

2146

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

2147

# avoid excessive use of external libraries.

2148

2149

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2159

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

2160

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

2161

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

2162

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

2163

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2165

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

2166

datetime.timedelta(minutes=1),

2167

frozenset((token_second, token_end)))

2168

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

2169

datetime.timedelta(hours=1),

2170

frozenset((token_minute, token_end)))

2171

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

2172

None,

2173

frozenset((token_hour, token_minute,

2174

token_second)))

2175

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

2176

datetime.timedelta(days=1),

2177

frozenset((token_time, token_end)))

2178

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

2179

datetime.timedelta(weeks=4),

2180

frozenset((token_day, token_end)))

2181

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

2182

datetime.timedelta(weeks=52),

2183

frozenset((token_month, token_end)))

2184

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

2185

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2187

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

2188

frozenset((token_year, token_month,

2189

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2193

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2196

# Loop until end token is found

2197

while found_token is not token_end:

2198

# Search for any currently valid tokens

2199

for token in followers:

2200

match = token.regexp.match(s)

2201

if match is not None:

2202

# Token found

2203

if token.value is not None:

2204

# Value found, parse digits

2205

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

2206

# Add to value so far

2207

value += factor * token.value

2208

# Strip token from string

2209

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

2210

# Go to found token

2211

found_token = token

2212

# Set valid next tokens

2213

followers = found_token.followers

2214

break

2215

else:

2216

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2218

# End token found

2219

return value

2220

2221

1912

2222

def string_to_delta(interval):

1913

2223

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

1914

2224

1925

2235

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

1926

2236

datetime.timedelta(0, 330)

1927

2237

"""

2238

2239

try:

2240

return rfc3339_duration_to_delta(interval)

2241

except ValueError:

2242

pass

2243

1928

2244

timevalue = datetime.timedelta(0)

1929

2245

for s in interval.split():

1930

2246

try:

1941

2257

elif suffix == "w":

1942

2258

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

1943

2259

else:

1944

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

1945

except (ValueError, IndexError) as e:

2260

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

2261

.format(suffix))

2262

except IndexError as e:

1946

2263

raise ValueError(*(e.args))

1947

2264

timevalue += delta

1948

2265

return timevalue

1961

2278

sys.exit()

1962

2279

if not noclose:

1963

2280

# Close all standard open file descriptors

1964

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

2281

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

1965

2282

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

1966

2283

raise OSError(errno.ENODEV,

1967

"%s not a character device"

1968

% os.path.devnull)

2284

"{0} not a character device"

2285

.format(os.devnull))

1969

2286

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

1970

2287

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

1971

2288

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

1980

2297

1981

2298

parser = argparse.ArgumentParser()

1982

2299

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

1983

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

2300

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

1984

2301

help="show version number and exit")

1985

2302

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

1986

2303

help="Bind to interface IF")

1992

2309

help="Run self-test")

1993

2310

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

1994

2311

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

1995

" to terminal")

2312

" to terminal", default=None)

1996

2313

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

1997

2314

help="Debug level for stdout output")

1998

2315

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

2005

2322

" files")

2006

2323

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

2007

2324

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

2008

" system bus interface")

2325

" system bus interface", default=None)

2009

2326

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

2010

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

2327

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

2328

default=None)

2011

2329

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

2012

2330

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

2013

" state")

2331

" state", default=None)

2332

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

2333

help="Specify a file descriptor to a network"

2334

" socket to use instead of creating one")

2014

2335

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

2015

2336

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

2337

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

2338

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

2016

2339

2017

2340

options = parser.parse_args()

2018

2341

2019

2342

if options.check:

2020

2343

import doctest

2021

doctest.testmod()

2022

sys.exit()

2344

fail_count, test_count = doctest.testmod()

2345

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

2023

2346

2024

2347

# Default values for config file for server-global settings

2025

2348

server_defaults = { "interface": "",

2027

2350

"port": "",

2028

2351

"debug": "False",

2029

2352

"priority":

2030

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

2353

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

2031

2354

"servicename": "Mandos",

2032

2355

"use_dbus": "True",

2033

2356

"use_ipv6": "True",

2034

2357

"debuglevel": "",

2035

2358

"restore": "True",

2036

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

2359

"socket": "",

2360

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

2361

"foreground": "False",

2037

2362

}

2038

2363

2039

2364

# Parse config file for server-global settings

2044

2369

# Convert the SafeConfigParser object to a dict

2045

2370

server_settings = server_config.defaults()

2046

2371

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

2047

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

2372

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

2048

2373

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

2049

2374

option)

2050

2375

if server_settings["port"]:

2051

2376

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

2052

2377

"port")

2378

if server_settings["socket"]:

2379

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

2380

"socket")

2381

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

2382

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

2383

# happen with a supplied network socket.

2384

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

2385

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

2386

["socket"])

2053

2387

del server_config

2054

2388

2055

2389

# Override the settings from the config file with command line

2057

2391

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

2058

2392

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

2059

2393

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

2060

"statedir"):

2394

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

2061

2395

value = getattr(options, option)

2062

2396

if value is not None:

2063

2397

server_settings[option] = value

2066

2400

for option in server_settings.keys():

2067

2401

if type(server_settings[option]) is str:

2068

2402

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

2403

# Force all boolean options to be boolean

2404

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

2405

"foreground"):

2406

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

2407

# Debug implies foreground

2408

if server_settings["debug"]:

2409

server_settings["foreground"] = True

2069

2410

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

2070

2411

2071

2412

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

2077

2418

use_ipv6 = server_settings["use_ipv6"]

2078

2419

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

2079

2420

stored_state_file)

2421

foreground = server_settings["foreground"]

2080

2422

2081

2423

if debug:

2082

2424

initlogger(debug, logging.DEBUG)

2089

2431

2090

2432

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

2091

2433

syslogger.setFormatter(logging.Formatter

2092

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

2093

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

2094

% server_settings["servicename"]))

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2095

2438

2096

2439

# Parse config file with clients

2097

client_config = configparser.SafeConfigParser(Client.client_defaults)

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

2098

2442

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

2099

2443

"clients.conf"))

2100

2444

2109

2453

use_ipv6=use_ipv6,

2110

2454

gnutls_priority=

2111

2455

server_settings["priority"],

2112

use_dbus=use_dbus)

2113

if not debug:

2114

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

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

2459

if not foreground:

2460

pidfilename = "/run/mandos.pid"

2461

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

2462

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

2463

pidfile = None

2115

2464

try:

2116

2465

pidfile = open(pidfilename, "w")

2117

except IOError:

2118

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

2466

except IOError as e:

2467

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

2468

exc_info=e)

2119

2469

2120

try:

2121

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

2122

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

2123

except KeyError:

2470

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

2124

2471

try:

2125

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

2126

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

2472

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

2474

break

2127

2475

except KeyError:

2128

try:

2129

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

2130

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

2131

except KeyError:

2132

uid = 65534

2133

gid = 65534

2476

continue

2477

else:

2478

uid = 65534

2479

gid = 65534

2134

2480

try:

2135

2481

os.setgid(gid)

2136

2482

os.setuid(uid)

2137

2483

except OSError as error:

2138

if error[0] != errno.EPERM:

2139

raise error

2484

if error.errno != errno.EPERM:

2485

raise

2140

2486

2141

2487

if debug:

2142

2488

# Enable all possible GnuTLS debugging

2153

2499

.gnutls_global_set_log_function(debug_gnutls))

2154

2500

2155

2501

# Redirect stdin so all checkers get /dev/null

2156

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

2502

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

2157

2503

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

2158

2504

if null > 2:

2159

2505

os.close(null)

2160

2506

2161

2507

# Need to fork before connecting to D-Bus

2162

if not debug:

2508

if not foreground:

2163

2509

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

2164

2510

daemon()

2165

2511

2512

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

2513

# need to inform gobject that threads will be used.

2166

2514

gobject.threads_init()

2167

2515

2168

2516

global main_loop

2169

2517

# From the Avahi example code

2170

DBusGMainLoop(set_as_default=True )

2518

DBusGMainLoop(set_as_default=True)

2171

2519

main_loop = gobject.MainLoop()

2172

2520

bus = dbus.SystemBus()

2173

2521

# End of Avahi example code

2179

2527

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

2180

2528

do_not_queue=True))

2181

2529

except dbus.exceptions.NameExistsException as e:

2182

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

2530

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

2183

2531

use_dbus = False

2184

2532

server_settings["use_dbus"] = False

2185

2533

tcp_server.use_dbus = False

2197

2545

2198

2546

client_class = Client

2199

2547

if use_dbus:

2200

client_class = functools.partial(ClientDBusTransitional,

2201

bus = bus)

2548

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

2202

2549

2203

2550

client_settings = Client.config_parser(client_config)

2204

2551

old_client_settings = {}

2205

2552

clients_data = {}

2206

2553

2554

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

2555

global wnull

2556

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

2557

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

2558

# mode

2559

if debug or not foreground:

2560

wnull.close()

2561

2207

2562

# Get client data and settings from last running state.

2208

2563

if server_settings["restore"]:

2209

2564

try:

2212

2567

(stored_state))

2213

2568

os.remove(stored_state_path)

2214

2569

except IOError as e:

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

2570

if e.errno == errno.ENOENT:

2571

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

2572

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

2573

else:

2574

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

2575

exc_info=e)

2218

2576

raise

2219

2577

except EOFError as e:

2220

2578

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

2221

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

2579

"EOFError:", exc_info=e)

2222

2580

2223

2581

with PGPEngine() as pgp:

2224

2582

for client_name, client in clients_data.iteritems():

2583

# Skip removed clients

2584

if client_name not in client_settings:

2585

continue

2586

2225

2587

# Decide which value to use after restoring saved state.

2226

2588

# We have three different values: Old config file,

2227

2589

# new config file, and saved state.

2241

2603

2242

2604

# Clients who has passed its expire date can still be

2243

2605

# enabled if its last checker was successful. Clients

2244

# whose checker failed before we stored its state is

2245

# assumed to have failed all checkers during downtime.

2606

# whose checker succeeded before we stored its state is

2607

# assumed to have successfully run all checkers during

2608

# downtime.

2246

2609

if client["enabled"]:

2247

2610

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

2248

2611

if not client["last_checked_ok"]:

2249

2612

logger.warning(

2250

2613

"disabling client {0} - Client never "

2251

"performed a successfull checker"

2252

.format(client["name"]))

2614

"performed a successful checker"

2615

.format(client_name))

2253

2616

client["enabled"] = False

2254

2617

elif client["last_checker_status"] != 0:

2255

2618

logger.warning(

2256

2619

"disabling client {0} - Client "

2257

2620

"last checker failed with error code {1}"

2258

.format(client["name"],

2621

.format(client_name,

2259

2622

client["last_checker_status"]))

2260

2623

client["enabled"] = False

2261

2624

else:

2262

2625

client["expires"] = (datetime.datetime

2263

2626

.utcnow()

2264

2627

+ client["timeout"])

2265

2628

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

2266

2631

try:

2267

2632

client["secret"] = (

2268

2633

pgp.decrypt(client["encrypted_secret"],

2274

2639

.format(client_name))

2275

2640

client["secret"] = (

2276

2641

client_settings[client_name]["secret"])

2277

2278

2642

2279

2643

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

2280

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

2644

for client_name in (set(old_client_settings)

2645

- set(client_settings)):

2281

2646

del clients_data[client_name]

2282

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

2647

for client_name in (set(client_settings)

2648

- set(old_client_settings)):

2283

2649

clients_data[client_name] = client_settings[client_name]

2284

2285

# Create clients all clients

2650

2651

# Create all client objects

2286

2652

for client_name, client in clients_data.iteritems():

2287

2653

tcp_server.clients[client_name] = client_class(

2288

name = client_name, settings = client)

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2289

2656

2290

2657

if not tcp_server.clients:

2291

2658

logger.warning("No clients defined")

2292

2293

if not debug:

2294

try:

2295

with pidfile:

2296

pid = os.getpid()

2297

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

2298

del pidfile

2299

except IOError:

2300

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

2301

pidfilename, pid)

2302

except NameError:

2303

# "pidfile" was never created

2304

pass

2659

2660

if not foreground:

2661

if pidfile is not None:

2662

try:

2663

with pidfile:

2664

pid = os.getpid()

2665

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

2666

except IOError:

2667

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

2668

pidfilename, pid)

2669

del pidfile

2305

2670

del pidfilename

2306

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

2307

2671

2308

2672

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

2309

2673

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

2310

2674

2311

2675

if use_dbus:

2312

class MandosDBusService(dbus.service.Object):

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

2313

2679

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

2314

2680

def __init__(self):

2315

2681

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

2316

2682

_interface = "se.recompile.Mandos"

2317

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

2318

2690

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

2319

2691

def ClientAdded(self, objpath):

2320

2692

"D-Bus signal"

2362

2734

2363

2735

del _interface

2364

2736

2365

class MandosDBusServiceTransitional(MandosDBusService):

2366

__metaclass__ = AlternateDBusNamesMetaclass

2367

mandos_dbus_service = MandosDBusServiceTransitional()

2737

mandos_dbus_service = MandosDBusService()

2368

2738

2369

2739

def cleanup():

2370

2740

"Cleanup function; run on exit"

2371

2741

service.cleanup()

2372

2742

2373

2743

multiprocessing.active_children()

2744

wnull.close()

2374

2745

if not (tcp_server.clients or client_settings):

2375

2746

return

2376

2747

2388

2759

# A list of attributes that can not be pickled

2389

2760

# + secret.

2390

2761

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

2391

"checker"))

2762

"checker", "server_settings"))

2392

2763

for name, typ in (inspect.getmembers

2393

2764

(dbus.service.Object)):

2394

2765

exclude.add(name)

2403

2774

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

2404

2775

2405

2776

try:

2406

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

2407

prefix="clients-",

2408

dir=os.path.dirname

2409

(stored_state_path))

2410

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

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2411

2781

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

2782

tempname=stored_state.name

2412

2783

os.rename(tempname, stored_state_path)

2413

2784

except (IOError, OSError) as e:

2414

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

2415

.format(e))

2416

2785

if not debug:

2417

2786

try:

2418

2787

os.remove(tempname)

2419

2788

except NameError:

2420

2789

pass

2421

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

2422

errno.EEXIST)):

2423

raise e

2790

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

2791

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

2792

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

2793

else:

2794

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

2795

exc_info=e)

2796

raise

2424

2797

2425

2798

# Delete all clients, and settings from config

2426

2799

while tcp_server.clients:

2453

2826

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

2454

2827

if use_ipv6:

2455

2828

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

2456

" flowinfo %d, scope_id %d"

2457

% tcp_server.socket.getsockname())

2829

" flowinfo %d, scope_id %d",

2830

*tcp_server.socket.getsockname())

2458

2831

else: # IPv4

2459

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

2460

% tcp_server.socket.getsockname())

2832

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

2833

*tcp_server.socket.getsockname())

2461

2834

2462

2835

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

2463

2836

2466

2839

try:

2467

2840

service.activate()

2468

2841

except dbus.exceptions.DBusException as error:

2469

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

2842

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

2470

2843

cleanup()

2471

2844

sys.exit(1)

2472

2845

# End of Avahi example code

2479

2852

logger.debug("Starting main loop")

2480

2853

main_loop.run()

2481

2854

except AvahiError as error:

2482

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

2855

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

2483

2856

cleanup()

2484

2857

sys.exit(1)

2485

2858

except KeyboardInterrupt: