/mandos/release : revision 237.7.87

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

39

37

import SocketServer as socketserver

40

38

import socket

41

39

import argparse

67

65

import types

68

66

import binascii

69

67

import tempfile

70

import itertools

71

import collections

72

68

73

69

import dbus

74

70

import dbus.service

79

75

import ctypes.util

80

76

import xml.dom.minidom

81

77

import inspect

78

import GnuPGInterface

82

79

83

80

try:

84

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

88

85

except ImportError:

89

86

SO_BINDTODEVICE = None

90

87

91

version = "1.6.5"

88

version = "1.4.1"

92

89

stored_state_file = "clients.pickle"

93

90

94

91

logger = logging.getLogger()

95

syslogger = None

92

syslogger = (logging.handlers.SysLogHandler

93

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

94

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

96

95

97

96

try:

98

97

if_nametoindex = (ctypes.cdll.LoadLibrary

114

113

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

115

114

"""init logger and add loglevel"""

116

115

117

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

122

116

syslogger.setFormatter(logging.Formatter

123

117

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

124

118

' %(message)s'))

142

136

class PGPEngine(object):

143

137

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

144

138

def __init__(self):

139

self.gnupg = GnuPGInterface.GnuPG()

145

140

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

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

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

151

146

152

147

def __enter__(self):

153

148

return self

154

149

155

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

150

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

156

151

self._cleanup()

157

152

return False

158

153

175

170

def password_encode(self, password):

176

171

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

177

172

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

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

173

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

185

174

186

175

def encrypt(self, data, password):

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)

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

202

190

return ciphertext

203

191

204

192

def decrypt(self, data, password):

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)

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

221

207

return decrypted_plaintext

222

208

223

209

210

224

211

class AvahiError(Exception):

225

212

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

226

213

self.value = value

243

230

Used to optionally bind to the specified interface.

244

231

name: string; Example: 'Mandos'

245

232

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

246

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

233

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

247

234

port: integer; what port to announce

248

235

TXT: list of strings; TXT record for the service

249

236

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

255

242

server: D-Bus Server

256

243

bus: dbus.SystemBus()

257

244

"""

258

259

245

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

260

246

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

261

247

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

274

260

self.server = None

275

261

self.bus = bus

276

262

self.entry_group_state_changed_match = None

277

278

263

def rename(self):

279

264

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

280

265

if self.rename_count >= self.max_renames:

290

275

try:

291

276

self.add()

292

277

except dbus.exceptions.DBusException as error:

293

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

278

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

294

279

self.cleanup()

295

280

os._exit(1)

296

281

self.rename_count += 1

297

298

282

def remove(self):

299

283

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

300

284

if self.entry_group_state_changed_match is not None:

302

286

self.entry_group_state_changed_match = None

303

287

if self.group is not None:

304

288

self.group.Reset()

305

306

289

def add(self):

307

290

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

308

291

self.remove()

325

308

dbus.UInt16(self.port),

326

309

avahi.string_array_to_txt_array(self.TXT))

327

310

self.group.Commit()

328

329

311

def entry_group_state_changed(self, state, error):

330

312

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

331

313

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

338

320

elif state == avahi.ENTRY_GROUP_FAILURE:

339

321

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

340

322

unicode(error))

341

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

342

.format(error))

343

323

raise AvahiGroupError("State changed: %s"

324

% unicode(error))

344

325

def cleanup(self):

345

326

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

346

327

if self.group is not None:

351

332

pass

352

333

self.group = None

353

334

self.remove()

354

355

335

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

356

336

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

357

337

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

376

356

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

377

357

else:

378

358

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

379

380

359

def activate(self):

381

360

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

382

361

if self.server is None:

389

368

self.server_state_changed)

390

369

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

391

370

392

393

371

class AvahiServiceToSyslog(AvahiService):

394

372

def rename(self):

395

373

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

396

374

ret = AvahiService.rename(self)

397

375

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

376

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

377

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

378

% self.name))

401

379

return ret

402

380

403

404

381

def timedelta_to_milliseconds(td):

405

382

"Convert a datetime.timedelta() to milliseconds"

406

383

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

407

384

+ (td.seconds * 1000)

408

385

+ (td.microseconds // 1000))

409

410

386

411

387

class Client(object):

412

388

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

413

389

438

414

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

439

415

last_checker_status: integer between 0 and 255 reflecting exit

440

416

status of last checker. -1 reflects crashed

441

checker, -2 means no checker completed yet.

417

checker, or None.

442

418

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

443

419

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

444

420

D-Bus identifiers

445

421

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

446

422

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

447

423

until this client is disabled

448

extended_timeout: extra long timeout when secret has been sent

424

extended_timeout: extra long timeout when password has been sent

449

425

runtime_expansions: Allowed attributes for runtime expansion.

450

426

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

451

427

disabled, or None

452

server_settings: The server_settings dict from main()

453

428

"""

454

429

455

430

runtime_expansions = ("approval_delay", "approval_duration",

456

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

457

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

458

"last_approval_request", "last_checked_ok",

431

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

432

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

459

433

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

434

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

435

"extended_timeout": "15m",

436

"interval": "2m",

463

437

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

464

438

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

439

"approval_delay": "0s",

440

"approval_duration": "1s",

467

441

"approved_by_default": "True",

468

442

"enabled": "True",

469

443

}

482

456

483

457

def approval_delay_milliseconds(self):

484

458

return timedelta_to_milliseconds(self.approval_delay)

485

459

486

460

@staticmethod

487

461

def config_parser(config):

488

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

462

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

489

463

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

490

with exceptions for any special settings as defined above.

491

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

492

value given the same arguments.

493

"""

464

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

494

465

settings = {}

495

466

for client_name in config.sections():

496

467

section = dict(config.items(client_name))

500

471

# Reformat values from string types to Python types

501

472

client["approved_by_default"] = config.getboolean(

502

473

client_name, "approved_by_default")

503

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

504

"enabled")

474

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

505

475

506

476

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

507

477

.replace(" ", ""))

513

483

"rb") as secfile:

514

484

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

515

485

else:

516

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

517

.format(section))

486

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

487

% section)

518

488

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

519

489

client["extended_timeout"] = string_to_delta(

520

490

section["extended_timeout"])

526

496

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

527

497

client["last_approval_request"] = None

528

498

client["last_checked_ok"] = None

529

client["last_checker_status"] = -2

530

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

531

508

return settings

532

533

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

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

534

515

self.name = name

535

if server_settings is None:

536

server_settings = {}

537

self.server_settings = server_settings

538

516

# adding all client settings

539

517

for setting, value in settings.iteritems():

540

518

setattr(self, setting, value)

541

519

542

if self.enabled:

543

if not hasattr(self, "last_enabled"):

544

self.last_enabled = datetime.datetime.utcnow()

545

if not hasattr(self, "expires"):

546

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

547

+ self.timeout)

548

else:

549

self.last_enabled = None

550

self.expires = None

551

552

520

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

553

521

# Uppercase and remove spaces from fingerprint for later

554

522

# comparison purposes with return value from the fingerprint()

555

523

# function

556

524

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

557

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

558

datetime.datetime.utcnow())

559

525

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

526

560

527

# attributes specific for this server instance

561

528

self.checker = None

562

529

self.checker_initiator_tag = None

590

557

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

591

558

# Already enabled

592

559

return

560

self.send_changedstate()

593

561

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

594

562

self.enabled = True

595

563

self.last_enabled = datetime.datetime.utcnow()

596

564

self.init_checker()

597

self.send_changedstate()

598

565

599

566

def disable(self, quiet=True):

600

567

"""Disable this client."""

601

568

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

602

569

return False

603

570

if not quiet:

571

self.send_changedstate()

572

if not quiet:

604

573

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

605

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

574

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

606

575

gobject.source_remove(self.disable_initiator_tag)

607

576

self.disable_initiator_tag = None

608

577

self.expires = None

609

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

578

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

610

579

gobject.source_remove(self.checker_initiator_tag)

611

580

self.checker_initiator_tag = None

612

581

self.stop_checker()

613

582

self.enabled = False

614

if not quiet:

615

self.send_changedstate()

616

583

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

617

584

return False

618

585

622

589

def init_checker(self):

623

590

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

624

591

# and every interval from then on.

625

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

592

self.checker_initiator_tag = (gobject.timeout_add

628

593

(self.interval_milliseconds(),

629

594

self.start_checker))

630

595

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

631

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

596

self.disable_initiator_tag = (gobject.timeout_add

634

597

(self.timeout_milliseconds(),

635

598

self.disable))

654

617

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

655

618

vars(self))

656

619

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

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

"""

665

626

if timeout is None:

666

627

timeout = self.timeout

628

self.last_checked_ok = datetime.datetime.utcnow()

667

629

if self.disable_initiator_tag is not None:

668

630

gobject.source_remove(self.disable_initiator_tag)

669

self.disable_initiator_tag = None

670

631

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

671

632

self.disable_initiator_tag = (gobject.timeout_add

672

633

(timedelta_to_milliseconds

682

643

If a checker already exists, leave it running and do

683

644

nothing."""

684

645

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

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

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

689

650

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

690

651

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

691

652

# should be.

693

654

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

694

655

try:

695

656

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

657

except (AttributeError, OSError) as error:

658

if (isinstance(error, OSError)

659

and error.errno != errno.ECHILD):

660

raise error

701

661

else:

702

662

if pid:

703

663

logger.warning("Checker was a zombie")

706

666

self.current_checker_command)

707

667

# Start a new checker if needed

708

668

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)

714

669

try:

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

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

720

688

self.current_checker_command = command

721

689

try:

722

690

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

725

693

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

726

694

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

727

695

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

736

696

self.checker = subprocess.Popen(command,

737

697

close_fds=True,

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:

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.

751

705

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)

752

709

except OSError as 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)

710

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

711

error)

762

712

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

763

713

return True

764

714

771

721

return

772

722

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

773

723

try:

774

self.checker.terminate()

724

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

775

725

#time.sleep(0.5)

776

726

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

777

# self.checker.kill()

727

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

778

728

except OSError as error:

779

729

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

780

730

raise

797

747

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

798

748

if byte_arrays and signature != "ay":

799

749

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

800

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

750

" signature %r" % signature)

801

751

def decorator(func):

802

752

func._dbus_is_property = True

803

753

func._dbus_interface = dbus_interface

811

761

return decorator

812

762

813

763

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

851

764

class DBusPropertyException(dbus.exceptions.DBusException):

852

765

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

853

766

"""

876

789

"""

877

790

878

791

@staticmethod

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)

792

def _is_dbus_property(obj):

793

return getattr(obj, "_dbus_is_property", False)

887

794

888

def _get_all_dbus_things(self, thing):

795

def _get_all_dbus_properties(self):

889

796

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

890

797

"""

891

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

892

name),

893

athing.__get__(self))

798

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

894

799

for cls in self.__class__.__mro__

895

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

800

for name, prop in

801

inspect.getmembers(cls, self._is_dbus_property))

898

802

899

803

def _get_dbus_property(self, interface_name, property_name):

900

804

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

902

806

"""

903

807

for cls in self.__class__.__mro__:

904

808

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

809

(cls, self._is_dbus_property)):

907

810

if (value._dbus_name == property_name

908

811

and value._dbus_interface == interface_name):

909

812

return value.__get__(self)

937

840

# The byte_arrays option is not supported yet on

938

841

# signatures other than "ay".

939

842

if prop._dbus_signature != "ay":

940

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

941

"'ay' signature {0!r}"

942

.format(prop._dbus_signature))

943

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

944

for byte in value))

843

raise ValueError

844

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

845

for byte in value))

945

846

prop(value)

946

847

947

848

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

953

854

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

954

855

"""

955

856

properties = {}

956

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

857

for name, prop in self._get_all_dbus_properties():

957

858

if (interface_name

958

859

and interface_name != prop._dbus_interface):

959

860

# Interface non-empty but did not match

974

875

path_keyword='object_path',

975

876

connection_keyword='connection')

976

877

def Introspect(self, object_path, connection):

977

"""Overloading of standard D-Bus method.

978

979

Inserts property tags and interface annotation tags.

878

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

980

879

"""

981

880

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

982

881

connection)

989

888

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

990

889

return e

991

890

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

992

# Add property tags

993

891

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

994

892

for name, prop

995

in self._get_all_dbus_things("property")

893

in self._get_all_dbus_properties()

996

894

if prop._dbus_interface

997

895

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

998

896

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)

1030

897

# Add the names to the return values for the

1031

898

# "org.freedesktop.DBus.Properties" methods

1032

899

if (if_tag.getAttribute("name")

1047

914

except (AttributeError, xml.dom.DOMException,

1048

915

xml.parsers.expat.ExpatError) as error:

1049

916

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

1050

exc_info=error)

917

error)

1051

918

return xmlstring

1052

919

1053

920

1054

def datetime_to_dbus(dt, variant_level=0):

921

def datetime_to_dbus (dt, variant_level=0):

1055

922

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

1056

923

if dt is None:

1057

924

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

1059

926

variant_level=variant_level)

1060

927

1061

928

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

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.

1084

933

"""

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

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

1092

941

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

1093

942

# with the wrong interface name

1094

943

if (not hasattr(attribute, "_dbus_interface")

1095

944

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

945

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

1097

946

continue

1098

947

# Create an alternate D-Bus interface name based on

1099

948

# the current name

1100

949

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1103

interface_names.add(alt_interface)

950

.replace("se.recompile.Mandos",

951

"se.bsnet.fukt.Mandos"))

1104

952

# Is this a D-Bus signal?

1105

953

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

1106

# Extract the original non-method undecorated

1107

# function by black magic

954

# Extract the original non-method function by

955

# black magic

1108

956

nonmethod_func = (dict(

1109

957

zip(attribute.func_code.co_freevars,

1110

958

attribute.__closure__))["func"]

1121

969

nonmethod_func.func_name,

1122

970

nonmethod_func.func_defaults,

1123

971

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

1130

972

# Define a creator of a function to call both the

1131

# original and alternate functions, so both the

1132

# original and alternate signals gets sent when

1133

# the function is called

973

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

974

# signals gets sent when the function is called

1134

975

def fixscope(func1, func2):

1135

976

"""This function is a scope container to pass

1136

977

func1 and func2 to the "call_both" function

1143

984

return call_both

1144

985

# Create the "call_both" function and add it to

1145

986

# the class

1146

attr[attrname] = fixscope(attribute, new_function)

987

attr[attrname] = fixscope(attribute,

988

new_function)

1147

989

# Is this a D-Bus method?

1148

990

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

1149

991

# Create a new, but exactly alike, function

1160

1002

attribute.func_name,

1161

1003

attribute.func_defaults,

1162

1004

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

1169

1005

# Is this a D-Bus property?

1170

1006

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

1171

1007

# Create a new, but exactly alike, function

1185

1021

attribute.func_name,

1186

1022

attribute.func_defaults,

1187

1023

attribute.func_closure)))

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

1024

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

1025

1026

1233

1027

class ClientDBus(Client, DBusObjectWithProperties):

1234

1028

"""A Client class using D-Bus

1235

1029

1246

1040

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

1247

1041

self.bus = bus

1248

1042

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

1043

self._approvals_pending = 0

1044

1045

self._approvals_pending = 0

1249

1046

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

1250

1047

# the D-Bus

1251

1048

client_object_name = unicode(self.name).translate(

1255

1052

("/clients/" + client_object_name))

1256

1053

DBusObjectWithProperties.__init__(self, self.bus,

1257

1054

self.dbus_object_path)

1258

1055

1259

1056

def notifychangeproperty(transform_func,

1260

1057

dbus_name, type_func=lambda x: x,

1261

1058

variant_level=1):

1284

1081

1285

1082

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

1286

1083

1084

1287

1085

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1086

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1087

"ApprovalPending",

1296

1094

checker is not None)

1297

1095

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1096

"LastCheckedOK")

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1300

"LastCheckerStatus")

1301

1097

last_approval_request = notifychangeproperty(

1302

1098

datetime_to_dbus, "LastApprovalRequest")

1303

1099

approved_by_default = notifychangeproperty(dbus.Boolean,

1353

1149

*args, **kwargs)

1354

1150

1355

1151

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

1356

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

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

1357

1157

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

1358

1158

# Only if new checker process was started

1359

1159

if (self.checker is not None

1367

1167

return False

1368

1168

1369

1169

def approve(self, value=True):

1170

self.send_changedstate()

1370

1171

self.approved = value

1371

1172

gobject.timeout_add(timedelta_to_milliseconds

1372

1173

(self.approval_duration),

1373

1174

self._reset_approved)

1374

self.send_changedstate()

1175

1375

1176

1376

1177

## D-Bus methods, signals & properties

1377

1178

_interface = "se.recompile.Mandos.Client"

1378

1179

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

1180

## Signals

1387

1181

1388

1182

# CheckerCompleted - signal

1424

1218

"D-Bus signal"

1425

1219

return self.need_approval()

1426

1220

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

1427

1229

## Methods

1428

1230

1429

1231

# Approve - method

1539

1341

return

1540

1342

return datetime_to_dbus(self.last_checked_ok)

1541

1343

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

1548

1344

# Expires - property

1549

1345

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

1550

1346

def Expires_dbus_property(self):

1561

1357

def Timeout_dbus_property(self, value=None):

1562

1358

if value is None: # get

1563

1359

return dbus.UInt64(self.timeout_milliseconds())

1564

old_timeout = self.timeout

1565

1360

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

1566

# Reschedule disabling

1567

if self.enabled:

1568

now = datetime.datetime.utcnow()

1569

self.expires += self.timeout - old_timeout

1570

if self.expires <= now:

1571

# The timeout has passed

1572

self.disable()

1573

else:

1574

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

1575

is None):

1576

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

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

1582

1381

1583

1382

# ExtendedTimeout - property

1584

1383

@dbus_service_property(_interface, signature="t",

1663

1462

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

1664

1463

1665

1464

1465

class ClientDBusTransitional(ClientDBus):

1466

__metaclass__ = AlternateDBusNamesMetaclass

1467

1468

1666

1469

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

1470

"""A class to handle client connections.

1668

1471

1704

1507

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

1705

1508

try:

1706

1509

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

1707

raise RuntimeError(line)

1510

raise RuntimeError

1708

1511

except (ValueError, IndexError, RuntimeError) as error:

1709

1512

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

1710

1513

return

1736

1539

except KeyError:

1737

1540

return

1738

1541

1542

if self.server.use_dbus:

1543

# Emit D-Bus signal

1544

client.NewRequest(str(self.client_address))

1545

1739

1546

if client.approval_delay:

1740

1547

delay = client.approval_delay

1741

1548

client.approvals_pending += 1

1772

1579

#wait until timeout or approved

1773

1580

time = datetime.datetime.now()

1774

1581

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

1582

(client.changedstate.wait

1583

(float(client.timedelta_to_milliseconds(delay)

1584

/ 1000)))

1778

1585

client.changedstate.release()

1779

1586

time2 = datetime.datetime.now()

1780

1587

if (time2 - time) >= delay:

1796

1603

try:

1797

1604

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

1798

1605

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1606

logger.warning("gnutls send failed")

1801

1607

return

1802

1608

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

1803

1609

sent, len(client.secret)

1806

1612

1807

1613

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

1808

1614

# bump the timeout using extended_timeout

1809

client.bump_timeout(client.extended_timeout)

1615

client.checked_ok(client.extended_timeout)

1810

1616

if self.server.use_dbus:

1811

1617

# Emit D-Bus signal

1812

1618

client.GotSecret()

1817

1623

try:

1818

1624

session.bye()

1819

1625

except gnutls.errors.GNUTLSError as error:

1820

logger.warning("GnuTLS bye failed",

1821

exc_info=error)

1626

logger.warning("GnuTLS bye failed")

1822

1627

1823

1628

@staticmethod

1824

1629

def peer_certificate(session):

1896

1701

def process_request(self, request, address):

1897

1702

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

1898

1703

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

1899

args = (request, address))

1704

args = (request,

1705

address))

1900

1706

proc.start()

1901

1707

return proc

1902

1708

1917

1723

1918

1724

def add_pipe(self, parent_pipe, proc):

1919

1725

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

1920

raise NotImplementedError()

1726

raise NotImplementedError

1921

1727

1922

1728

1923

1729

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1930

1736

use_ipv6: Boolean; to use IPv6 or not

1931

1737

"""

1932

1738

def __init__(self, server_address, RequestHandlerClass,

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

"""

1739

interface=None, use_ipv6=True):

1937

1740

self.interface = interface

1938

1741

if use_ipv6:

1939

1742

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.

1966

1743

socketserver.TCPServer.__init__(self, server_address,

1967

1744

RequestHandlerClass)

1968

1969

1745

def server_bind(self):

1970

1746

"""This overrides the normal server_bind() function

1971

1747

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

1979

1755

try:

1980

1756

self.socket.setsockopt(socket.SOL_SOCKET,

1981

1757

SO_BINDTODEVICE,

1982

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

1758

str(self.interface

1759

+ '\0'))

1983

1760

except socket.error as error:

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:

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:

1988

1766

logger.error("SO_BINDTODEVICE not available;"

1989

1767

" cannot bind to interface %s",

1990

1768

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

1769

else:

1995

1770

raise

1996

1771

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

1999

1774

if self.address_family == socket.AF_INET6:

2000

1775

any_address = "::" # in6addr_any

2001

1776

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

1777

any_address = socket.INADDR_ANY

2003

1778

self.server_address = (any_address,

2004

1779

self.server_address[1])

2005

1780

elif not self.server_address[1]:

2026

1801

"""

2027

1802

def __init__(self, server_address, RequestHandlerClass,

2028

1803

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

2029

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

1804

gnutls_priority=None, use_dbus=True):

2030

1805

self.enabled = False

2031

1806

self.clients = clients

2032

1807

if self.clients is None:

2036

1811

IPv6_TCPServer.__init__(self, server_address,

2037

1812

RequestHandlerClass,

2038

1813

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

1814

use_ipv6 = use_ipv6)

2041

1815

def server_activate(self):

2042

1816

if self.enabled:

2043

1817

return socketserver.TCPServer.server_activate(self)

2056

1830

2057

1831

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

2058

1832

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)

2059

1847

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

2060

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

1848

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

2061

1849

# Wait for other process to exit

2062

1850

proc.join()

2063

1851

return False

2121

1909

return True

2122

1910

2123

1911

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

2223

1912

def string_to_delta(interval):

2224

1913

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

2225

1914

2236

1925

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

2237

1926

datetime.timedelta(0, 330)

2238

1927

"""

2239

2240

try:

2241

return rfc3339_duration_to_delta(interval)

2242

except ValueError:

2243

pass

2244

2245

1928

timevalue = datetime.timedelta(0)

2246

1929

for s in interval.split():

2247

1930

try:

2258

1941

elif suffix == "w":

2259

1942

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

2260

1943

else:

2261

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

2262

.format(suffix))

2263

except IndexError as e:

1944

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

1945

except (ValueError, IndexError) as e:

2264

1946

raise ValueError(*(e.args))

2265

1947

timevalue += delta

2266

1948

return timevalue

2279

1961

sys.exit()

2280

1962

if not noclose:

2281

1963

# Close all standard open file descriptors

2282

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

1964

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

2283

1965

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

2284

1966

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2286

.format(os.devnull))

1967

"%s not a character device"

1968

% os.path.devnull)

2287

1969

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

2288

1970

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

2289

1971

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

2298

1980

2299

1981

parser = argparse.ArgumentParser()

2300

1982

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

2301

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

1983

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

2302

1984

help="show version number and exit")

2303

1985

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

2304

1986

help="Bind to interface IF")

2310

1992

help="Run self-test")

2311

1993

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

2312

1994

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

2313

" to terminal", default=None)

1995

" to terminal")

2314

1996

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

2315

1997

help="Debug level for stdout output")

2316

1998

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

2323

2005

" files")

2324

2006

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

2325

2007

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

2326

" system bus interface", default=None)

2008

" system bus interface")

2327

2009

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

2328

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

2329

default=None)

2010

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

2330

2011

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

2331

2012

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

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

2013

" state")

2336

2014

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

2337

2015

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

2338

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

2339

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

2340

2016

2341

2017

options = parser.parse_args()

2342

2018

2343

2019

if options.check:

2344

2020

import doctest

2345

fail_count, test_count = doctest.testmod()

2346

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

2021

doctest.testmod()

2022

sys.exit()

2347

2023

2348

2024

# Default values for config file for server-global settings

2349

2025

server_defaults = { "interface": "",

2351

2027

"port": "",

2352

2028

"debug": "False",

2353

2029

"priority":

2354

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

2030

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

2355

2031

"servicename": "Mandos",

2356

2032

"use_dbus": "True",

2357

2033

"use_ipv6": "True",

2358

2034

"debuglevel": "",

2359

2035

"restore": "True",

2360

"socket": "",

2361

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

2362

"foreground": "False",

2036

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

2363

2037

}

2364

2038

2365

2039

# Parse config file for server-global settings

2370

2044

# Convert the SafeConfigParser object to a dict

2371

2045

server_settings = server_config.defaults()

2372

2046

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

2373

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

2047

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

2374

2048

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

2375

2049

option)

2376

2050

if server_settings["port"]:

2377

2051

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

2378

2052

"port")

2379

if server_settings["socket"]:

2380

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

2381

"socket")

2382

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

2383

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

2384

# happen with a supplied network socket.

2385

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

2386

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

2387

["socket"])

2388

2053

del server_config

2389

2054

2390

2055

# Override the settings from the config file with command line

2392

2057

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

2393

2058

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

2394

2059

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

2395

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

2060

"statedir"):

2396

2061

value = getattr(options, option)

2397

2062

if value is not None:

2398

2063

server_settings[option] = value

2401

2066

for option in server_settings.keys():

2402

2067

if type(server_settings[option]) is str:

2403

2068

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

2404

# Force all boolean options to be boolean

2405

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

2406

"foreground"):

2407

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

2408

# Debug implies foreground

2409

if server_settings["debug"]:

2410

server_settings["foreground"] = True

2411

2069

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

2412

2070

2413

2071

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

2419

2077

use_ipv6 = server_settings["use_ipv6"]

2420

2078

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

2421

2079

stored_state_file)

2422

foreground = server_settings["foreground"]

2423

2080

2424

2081

if debug:

2425

2082

initlogger(debug, logging.DEBUG)

2432

2089

2433

2090

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

2434

2091

syslogger.setFormatter(logging.Formatter

2435

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

2436

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

2437

.format(server_settings

2438

["servicename"])))

2092

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

2093

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

2094

% server_settings["servicename"]))

2439

2095

2440

2096

# Parse config file with clients

2441

client_config = configparser.SafeConfigParser(Client

2442

.client_defaults)

2097

client_config = configparser.SafeConfigParser(Client.client_defaults)

2443

2098

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

2444

2099

"clients.conf"))

2445

2100

2454

2109

use_ipv6=use_ipv6,

2455

2110

gnutls_priority=

2456

2111

server_settings["priority"],

2457

use_dbus=use_dbus,

2458

socketfd=(server_settings["socket"]

2459

or None))

2460

if not foreground:

2461

pidfilename = "/run/mandos.pid"

2462

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

2463

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

2464

pidfile = None

2112

use_dbus=use_dbus)

2113

if not debug:

2114

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

2465

2115

try:

2466

2116

pidfile = open(pidfilename, "w")

2467

except IOError as e:

2468

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

2469

exc_info=e)

2117

except IOError:

2118

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

2470

2119

2471

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

2120

try:

2121

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

2122

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

2123

except KeyError:

2472

2124

try:

2473

uid = pwd.getpwnam(name).pw_uid

2474

gid = pwd.getpwnam(name).pw_gid

2475

break

2125

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

2126

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

2476

2127

except KeyError:

2477

continue

2478

else:

2479

uid = 65534

2480

gid = 65534

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

2481

2134

try:

2482

2135

os.setgid(gid)

2483

2136

os.setuid(uid)

2484

2137

except OSError as error:

2485

if error.errno != errno.EPERM:

2486

raise

2138

if error[0] != errno.EPERM:

2139

raise error

2487

2140

2488

2141

if debug:

2489

2142

# Enable all possible GnuTLS debugging

2500

2153

.gnutls_global_set_log_function(debug_gnutls))

2501

2154

2502

2155

# Redirect stdin so all checkers get /dev/null

2503

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

2156

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

2504

2157

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

2505

2158

if null > 2:

2506

2159

os.close(null)

2507

2160

2508

2161

# Need to fork before connecting to D-Bus

2509

if not foreground:

2162

if not debug:

2510

2163

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

2511

2164

daemon()

2512

2165

2513

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

2514

# need to inform gobject that threads will be used.

2515

2166

gobject.threads_init()

2516

2167

2517

2168

global main_loop

2518

2169

# From the Avahi example code

2519

DBusGMainLoop(set_as_default=True)

2170

DBusGMainLoop(set_as_default=True )

2520

2171

main_loop = gobject.MainLoop()

2521

2172

bus = dbus.SystemBus()

2522

2173

# End of Avahi example code

2528

2179

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

2529

2180

do_not_queue=True))

2530

2181

except dbus.exceptions.NameExistsException as e:

2531

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

2182

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

2532

2183

use_dbus = False

2533

2184

server_settings["use_dbus"] = False

2534

2185

tcp_server.use_dbus = False

2546

2197

2547

2198

client_class = Client

2548

2199

if use_dbus:

2549

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

2200

client_class = functools.partial(ClientDBusTransitional,

2201

bus = bus)

2550

2202

2551

2203

client_settings = Client.config_parser(client_config)

2552

2204

old_client_settings = {}

2553

2205

clients_data = {}

2554

2206

2555

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

2556

global wnull

2557

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

2558

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

2559

# mode

2560

if debug or not foreground:

2561

wnull.close()

2562

2563

2207

# Get client data and settings from last running state.

2564

2208

if server_settings["restore"]:

2565

2209

try:

2568

2212

(stored_state))

2569

2213

os.remove(stored_state_path)

2570

2214

except IOError as e:

2571

if e.errno == errno.ENOENT:

2572

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

2573

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

2574

else:

2575

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

2576

exc_info=e)

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

2577

2218

raise

2578

2219

except EOFError as e:

2579

2220

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

2580

"EOFError:", exc_info=e)

2221

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

2581

2222

2582

2223

with PGPEngine() as pgp:

2583

2224

for client_name, client in clients_data.iteritems():

2584

# Skip removed clients

2585

if client_name not in client_settings:

2586

continue

2587

2588

2225

# Decide which value to use after restoring saved state.

2589

2226

# We have three different values: Old config file,

2590

2227

# new config file, and saved state.

2604

2241

2605

2242

# Clients who has passed its expire date can still be

2606

2243

# enabled if its last checker was successful. Clients

2607

# whose checker succeeded before we stored its state is

2608

# assumed to have successfully run all checkers during

2609

# downtime.

2244

# whose checker failed before we stored its state is

2245

# assumed to have failed all checkers during downtime.

2610

2246

if client["enabled"]:

2611

2247

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

2612

2248

if not client["last_checked_ok"]:

2613

2249

logger.warning(

2614

2250

"disabling client {0} - Client never "

2615

"performed a successful checker"

2616

.format(client_name))

2251

"performed a successfull checker"

2252

.format(client["name"]))

2617

2253

client["enabled"] = False

2618

2254

elif client["last_checker_status"] != 0:

2619

2255

logger.warning(

2620

2256

"disabling client {0} - Client "

2621

2257

"last checker failed with error code {1}"

2622

.format(client_name,

2258

.format(client["name"],

2623

2259

client["last_checker_status"]))

2624

2260

client["enabled"] = False

2625

2261

else:

2626

2262

client["expires"] = (datetime.datetime

2627

2263

.utcnow()

2628

2264

+ client["timeout"])

2629

logger.debug("Last checker succeeded,"

2630

" keeping {0} enabled"

2631

.format(client_name))

2265

2632

2266

try:

2633

2267

client["secret"] = (

2634

2268

pgp.decrypt(client["encrypted_secret"],

2640

2274

.format(client_name))

2641

2275

client["secret"] = (

2642

2276

client_settings[client_name]["secret"])

2277

2643

2278

2644

2279

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

2645

for client_name in (set(old_client_settings)

2646

- set(client_settings)):

2280

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

2647

2281

del clients_data[client_name]

2648

for client_name in (set(client_settings)

2649

- set(old_client_settings)):

2282

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

2650

2283

clients_data[client_name] = client_settings[client_name]

2651

2652

# Create all client objects

2284

2285

# Create clients all clients

2653

2286

for client_name, client in clients_data.iteritems():

2654

2287

tcp_server.clients[client_name] = client_class(

2655

name = client_name, settings = client,

2656

server_settings = server_settings)

2288

name = client_name, settings = client)

2657

2289

2658

2290

if not tcp_server.clients:

2659

2291

logger.warning("No clients defined")

2660

2661

if not foreground:

2662

if pidfile is not None:

2663

try:

2664

with pidfile:

2665

pid = os.getpid()

2666

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

2667

except IOError:

2668

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

2669

pidfilename, pid)

2670

del pidfile

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

2671

2305

del pidfilename

2306

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

2672

2307

2673

2308

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

2674

2309

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

2675

2310

2676

2311

if use_dbus:

2677

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

2678

"se.bsnet.fukt.Mandos"})

2679

class MandosDBusService(DBusObjectWithProperties):

2312

class MandosDBusService(dbus.service.Object):

2680

2313

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

2681

2314

def __init__(self):

2682

2315

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

2683

2316

_interface = "se.recompile.Mandos"

2684

2317

2685

@dbus_interface_annotations(_interface)

2686

def _foo(self):

2687

return { "org.freedesktop.DBus.Property"

2688

".EmitsChangedSignal":

2689

"false"}

2690

2691

2318

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

2692

2319

def ClientAdded(self, objpath):

2693

2320

"D-Bus signal"

2735

2362

2736

2363

del _interface

2737

2364

2738

mandos_dbus_service = MandosDBusService()

2365

class MandosDBusServiceTransitional(MandosDBusService):

2366

__metaclass__ = AlternateDBusNamesMetaclass

2367

mandos_dbus_service = MandosDBusServiceTransitional()

2739

2368

2740

2369

def cleanup():

2741

2370

"Cleanup function; run on exit"

2742

2371

service.cleanup()

2743

2372

2744

2373

multiprocessing.active_children()

2745

wnull.close()

2746

2374

if not (tcp_server.clients or client_settings):

2747

2375

return

2748

2376

2760

2388

# A list of attributes that can not be pickled

2761

2389

# + secret.

2762

2390

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

2763

"checker", "server_settings"))

2391

"checker"))

2764

2392

for name, typ in (inspect.getmembers

2765

2393

(dbus.service.Object)):

2766

2394

exclude.add(name)

2775

2403

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

2776

2404

2777

2405

try:

2778

with (tempfile.NamedTemporaryFile

2779

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

2780

dir=os.path.dirname(stored_state_path),

2781

delete=False)) as stored_state:

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:

2782

2411

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

2783

tempname=stored_state.name

2784

2412

os.rename(tempname, stored_state_path)

2785

2413

except (IOError, OSError) as e:

2414

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

2415

.format(e))

2786

2416

if not debug:

2787

2417

try:

2788

2418

os.remove(tempname)

2789

2419

except NameError:

2790

2420

pass

2791

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

2792

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

2793

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

2794

else:

2795

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

2796

exc_info=e)

2797

raise

2421

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

2422

errno.EEXIST)):

2423

raise e

2798

2424

2799

2425

# Delete all clients, and settings from config

2800

2426

while tcp_server.clients:

2827

2453

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

2828

2454

if use_ipv6:

2829

2455

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

2830

" flowinfo %d, scope_id %d",

2831

*tcp_server.socket.getsockname())

2456

" flowinfo %d, scope_id %d"

2457

% tcp_server.socket.getsockname())

2832

2458

else: # IPv4

2833

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

2834

*tcp_server.socket.getsockname())

2459

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

2460

% tcp_server.socket.getsockname())

2835

2461

2836

2462

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

2837

2463

2840

2466

try:

2841

2467

service.activate()

2842

2468

except dbus.exceptions.DBusException as error:

2843

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

2469

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

2844

2470

cleanup()

2845

2471

sys.exit(1)

2846

2472

# End of Avahi example code

2853

2479

logger.debug("Starting main loop")

2854

2480

main_loop.run()

2855

2481

except AvahiError as error:

2856

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

2482

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

2857

2483

cleanup()

2858

2484

sys.exit(1)

2859

2485

except KeyboardInterrupt: