/mandos/release : revision 237.7.349

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

36

37

from future_builtins import *

38

39

import SocketServer as socketserver

39

try:

40

import SocketServer as socketserver

41

except ImportError:

42

import socketserver

40

43

import socket

41

44

import argparse

42

45

import datetime

43

46

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

47

try:

48

import ConfigParser as configparser

49

except ImportError:

50

import configparser

51

import sys

52

import re

53

import os

62

import struct

63

import fcntl

64

import functools

65

import cPickle as pickle

65

try:

66

import cPickle as pickle

67

except ImportError:

68

import pickle

66

69

import multiprocessing

67

70

import types

68

71

import binascii

69

72

import tempfile

70

73

import itertools

71

74

import collections

75

import codecs

72

76

73

77

import dbus

74

78

import dbus.service

75

import gobject

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

76

83

import avahi

77

84

from dbus.mainloop.glib import DBusGMainLoop

78

85

import ctypes

88

95

except ImportError:

89

96

SO_BINDTODEVICE = None

90

97

91

version = "1.6.0"

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

92

102

stored_state_file = "clients.pickle"

93

103

94

104

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

105

syslogger = None

98

106

99

107

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

108

if_nametoindex = ctypes.cdll.LoadLibrary(

109

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

103

110

except (OSError, AttributeError):

111

104

112

def if_nametoindex(interface):

105

113

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

106

114

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

107

115

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

108

116

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

117

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

118

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

113

119

return interface_index

114

120

115

121

116

122

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

117

123

"""init logger and add loglevel"""

118

124

125

global syslogger

126

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

119

129

syslogger.setFormatter(logging.Formatter

120

130

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

121

131

' %(message)s'))

138

148

139

149

class PGPEngine(object):

140

150

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

151

141

152

def __init__(self):

142

153

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

143

154

self.gnupgargs = ['--batch',

172

183

def password_encode(self, password):

173

184

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

174

185

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

175

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

186

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

187

if len(encoded) > 2048:

188

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

189

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

190

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

191

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

192

return encoded

176

193

177

194

def encrypt(self, data, password):

178

195

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

196

with tempfile.NamedTemporaryFile(

197

dir=self.tempdir) as passfile:

181

198

passfile.write(passphrase)

182

199

passfile.flush()

183

200

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

194

211

195

212

def decrypt(self, data, password):

196

213

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

214

with tempfile.NamedTemporaryFile(

215

dir = self.tempdir) as passfile:

199

216

passfile.write(passphrase)

200

217

passfile.flush()

201

218

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

205

222

stdin = subprocess.PIPE,

206

223

stdout = subprocess.PIPE,

207

224

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

225

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

210

226

if proc.returncode != 0:

211

227

raise PGPError(err)

212

228

return decrypted_plaintext

215

231

class AvahiError(Exception):

216

232

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

217

233

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

234

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

235

**kwargs)

236

221

237

222

238

class AvahiServiceError(AvahiError):

223

239

pass

224

240

241

225

242

class AvahiGroupError(AvahiError):

226

243

pass

227

244

247

264

bus: dbus.SystemBus()

248

265

"""

249

266

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

267

def __init__(self,

268

interface = avahi.IF_UNSPEC,

269

name = None,

270

servicetype = None,

271

port = None,

272

TXT = None,

273

domain = "",

274

host = "",

275

max_renames = 32768,

276

protocol = avahi.PROTO_UNSPEC,

277

bus = None):

254

278

self.interface = interface

255

279

self.name = name

256

280

self.type = servicetype

266

290

self.bus = bus

267

291

self.entry_group_state_changed_match = None

268

292

269

def rename(self):

293

def rename(self, remove=True):

270

294

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

271

295

if self.rename_count >= self.max_renames:

272

296

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

273

297

" after %i retries, exiting.",

274

298

self.rename_count)

275

299

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

300

self.name = str(

301

self.server.GetAlternativeServiceName(self.name))

302

self.rename_count += 1

278

303

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

279

304

self.name)

280

self.remove()

305

if remove:

306

self.remove()

281

307

try:

282

308

self.add()

283

309

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

310

if (error.get_dbus_name()

311

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

312

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

313

return self.rename(remove=False)

314

else:

315

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

316

self.cleanup()

317

os._exit(1)

288

318

289

319

def remove(self):

290

320

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

328

358

self.rename()

329

359

elif state == avahi.ENTRY_GROUP_FAILURE:

330

360

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

331

unicode(error))

332

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

333

.format(error))

361

str(error))

362

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

334

363

335

364

def cleanup(self):

336

365

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

346

375

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

347

376

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

348

377

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

378

bad_states = {

379

avahi.SERVER_INVALID: "Zeroconf server invalid",

380

avahi.SERVER_REGISTERING: None,

381

avahi.SERVER_COLLISION: "Zeroconf server name collision",

382

avahi.SERVER_FAILURE: "Zeroconf server failure",

383

}

356

384

if state in bad_states:

357

385

if bad_states[state] is not None:

358

386

if error is None:

361

389

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

362

390

self.cleanup()

363

391

elif state == avahi.SERVER_RUNNING:

364

self.add()

392

try:

393

self.add()

394

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

logger.info("Local Zeroconf service name"

398

" collision.")

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

365

404

else:

366

405

if error is None:

367

406

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

377

416

follow_name_owner_changes=True),

378

417

avahi.DBUS_INTERFACE_SERVER)

379

418

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

419

self.server_state_changed)

381

420

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

382

421

383

422

384

423

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

424

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

386

425

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

426

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

427

syslogger.setFormatter(logging.Formatter(

428

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

429

.format(self.name)))

392

430

return ret

393

431

394

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

432

# Pretend that we have a GnuTLS module

433

class GnuTLS(object):

434

"""This isn't so much a class as it is a module-like namespace.

435

It is instantiated once, and simulates having a GnuTLS module."""

436

437

_library = ctypes.cdll.LoadLibrary(

438

ctypes.util.find_library("gnutls"))

439

_need_version = "3.3.0"

440

def __init__(self):

441

# Need to use class name "GnuTLS" here, since this method is

442

# called before the assignment to the "gnutls" global variable

443

# happens.

444

if GnuTLS.check_version(self._need_version) is None:

445

raise GnuTLS.Error("Needs GnuTLS {} or later"

446

.format(self._need_version))

447

448

# Unless otherwise indicated, the constants and types below are

449

# all from the gnutls/gnutls.h C header file.

450

451

# Constants

452

E_SUCCESS = 0

453

CRT_OPENPGP = 2

454

CLIENT = 2

455

SHUT_RDWR = 0

456

CRD_CERTIFICATE = 1

457

E_NO_CERTIFICATE_FOUND = -49

458

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

459

460

# Types

461

class session_int(ctypes.Structure):

462

_fields_ = []

463

session_t = ctypes.POINTER(session_int)

464

class certificate_credentials_st(ctypes.Structure):

465

_fields_ = []

466

certificate_credentials_t = ctypes.POINTER(

467

certificate_credentials_st)

468

certificate_type_t = ctypes.c_int

469

class datum_t(ctypes.Structure):

470

_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),

471

('size', ctypes.c_uint)]

472

class openpgp_crt_int(ctypes.Structure):

473

_fields_ = []

474

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

475

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

476

log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)

477

credentials_type_t = ctypes.c_int #

478

transport_ptr_t = ctypes.c_void_p

479

close_request_t = ctypes.c_int

480

481

# Exceptions

482

class Error(Exception):

483

# We need to use the class name "GnuTLS" here, since this

484

# exception might be raised from within GnuTLS.__init__,

485

# which is called before the assignment to the "gnutls"

486

# global variable happens.

487

def __init__(self, message = None, code = None, args=()):

488

# Default usage is by a message string, but if a return

489

# code is passed, convert it to a string with

490

# gnutls.strerror()

491

if message is None and code is not None:

492

message = GnuTLS.strerror(code)

493

return super(GnuTLS.Error, self).__init__(

494

message, *args)

495

496

class CertificateSecurityError(Error):

497

pass

498

499

# Classes

500

class Credentials(object):

501

def __init__(self):

502

self._c_object = gnutls.certificate_credentials_t()

503

gnutls.certificate_allocate_credentials(

504

ctypes.byref(self._c_object))

505

self.type = gnutls.CRD_CERTIFICATE

506

507

def __del__(self):

508

gnutls.certificate_free_credentials(self._c_object)

509

510

class ClientSession(object):

511

def __init__(self, socket, credentials = None):

512

self._c_object = gnutls.session_t()

513

gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)

514

gnutls.set_default_priority(self._c_object)

515

gnutls.transport_set_ptr(self._c_object, socket.fileno())

516

gnutls.handshake_set_private_extensions(self._c_object,

517

True)

518

self.socket = socket

519

if credentials is None:

520

credentials = gnutls.Credentials()

521

gnutls.credentials_set(self._c_object, credentials.type,

522

ctypes.cast(credentials._c_object,

523

ctypes.c_void_p))

524

self.credentials = credentials

525

526

def __del__(self):

527

gnutls.deinit(self._c_object)

528

529

def handshake(self):

530

return gnutls.handshake(self._c_object)

531

532

def send(self, data):

533

data = bytes(data)

534

if not data:

535

return 0

536

return gnutls.record_send(self._c_object, data, len(data))

537

538

def bye(self):

539

return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)

540

541

# Error handling function

542

def _error_code(result):

543

"""A function to raise exceptions on errors, suitable

544

for the 'restype' attribute on ctypes functions"""

545

if result >= 0:

546

return result

547

if result == gnutls.E_NO_CERTIFICATE_FOUND:

548

raise gnutls.CertificateSecurityError(code = result)

549

raise gnutls.Error(code = result)

550

551

# Unless otherwise indicated, the function declarations below are

552

# all from the gnutls/gnutls.h C header file.

553

554

# Functions

555

priority_set_direct = _library.gnutls_priority_set_direct

556

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

557

ctypes.POINTER(ctypes.c_char_p)]

558

priority_set_direct.restype = _error_code

559

560

init = _library.gnutls_init

561

init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]

562

init.restype = _error_code

563

564

set_default_priority = _library.gnutls_set_default_priority

565

set_default_priority.argtypes = [session_t]

566

set_default_priority.restype = _error_code

567

568

record_send = _library.gnutls_record_send

569

record_send.argtypes = [session_t, ctypes.c_void_p,

570

ctypes.c_size_t]

571

record_send.restype = ctypes.c_ssize_t

572

573

certificate_allocate_credentials = (

574

_library.gnutls_certificate_allocate_credentials)

575

certificate_allocate_credentials.argtypes = [

576

ctypes.POINTER(certificate_credentials_t)]

577

certificate_allocate_credentials.restype = _error_code

578

579

certificate_free_credentials = (

580

_library.gnutls_certificate_free_credentials)

581

certificate_free_credentials.argtypes = [certificate_credentials_t]

582

certificate_free_credentials.restype = None

583

584

handshake_set_private_extensions = (

585

_library.gnutls_handshake_set_private_extensions)

586

handshake_set_private_extensions.argtypes = [session_t,

587

ctypes.c_int]

588

handshake_set_private_extensions.restype = None

589

590

credentials_set = _library.gnutls_credentials_set

591

credentials_set.argtypes = [session_t, credentials_type_t,

592

ctypes.c_void_p]

593

credentials_set.restype = _error_code

594

595

strerror = _library.gnutls_strerror

596

strerror.argtypes = [ctypes.c_int]

597

strerror.restype = ctypes.c_char_p

598

599

certificate_type_get = _library.gnutls_certificate_type_get

600

certificate_type_get.argtypes = [session_t]

601

certificate_type_get.restype = _error_code

602

603

certificate_get_peers = _library.gnutls_certificate_get_peers

604

certificate_get_peers.argtypes = [session_t,

605

ctypes.POINTER(ctypes.c_uint)]

606

certificate_get_peers.restype = ctypes.POINTER(datum_t)

607

608

global_set_log_level = _library.gnutls_global_set_log_level

609

global_set_log_level.argtypes = [ctypes.c_int]

610

global_set_log_level.restype = None

611

612

global_set_log_function = _library.gnutls_global_set_log_function

613

global_set_log_function.argtypes = [log_func]

614

global_set_log_function.restype = None

615

616

deinit = _library.gnutls_deinit

617

deinit.argtypes = [session_t]

618

deinit.restype = None

619

620

handshake = _library.gnutls_handshake

621

handshake.argtypes = [session_t]

622

handshake.restype = _error_code

623

624

transport_set_ptr = _library.gnutls_transport_set_ptr

625

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

626

transport_set_ptr.restype = None

627

628

bye = _library.gnutls_bye

629

bye.argtypes = [session_t, close_request_t]

630

bye.restype = _error_code

631

632

check_version = _library.gnutls_check_version

633

check_version.argtypes = [ctypes.c_char_p]

634

check_version.restype = ctypes.c_char_p

635

636

# All the function declarations below are from gnutls/openpgp.h

637

638

openpgp_crt_init = _library.gnutls_openpgp_crt_init

639

openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]

640

openpgp_crt_init.restype = _error_code

641

642

openpgp_crt_import = _library.gnutls_openpgp_crt_import

643

openpgp_crt_import.argtypes = [openpgp_crt_t,

644

ctypes.POINTER(datum_t),

645

openpgp_crt_fmt_t]

646

openpgp_crt_import.restype = _error_code

647

648

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

649

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

650

ctypes.POINTER(ctypes.c_uint)]

651

openpgp_crt_verify_self.restype = _error_code

652

653

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

654

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

655

openpgp_crt_deinit.restype = None

656

657

openpgp_crt_get_fingerprint = (

658

_library.gnutls_openpgp_crt_get_fingerprint)

659

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

660

ctypes.c_void_p,

661

ctypes.POINTER(

662

ctypes.c_size_t)]

663

openpgp_crt_get_fingerprint.restype = _error_code

664

665

# Remove non-public function

666

del _error_code

667

# Create the global "gnutls" object, simulating a module

668

gnutls = GnuTLS()

669

670

def call_pipe(connection, # : multiprocessing.Connection

671

func, *args, **kwargs):

672

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

673

674

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

675

return value on the provided multiprocessing.Connection.

676

"""

677

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

678

connection.close()

401

679

402

680

class Client(object):

403

681

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

430

708

last_checker_status: integer between 0 and 255 reflecting exit

431

709

status of last checker. -1 reflects crashed

432

710

checker, -2 means no checker completed yet.

711

last_checker_signal: The signal which killed the last checker, if

712

last_checker_status is -1

433

713

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

434

714

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

435

715

D-Bus identifiers

448

728

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

449

729

"last_approval_request", "last_checked_ok",

450

730

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

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

731

client_defaults = {

732

"timeout": "PT5M",

733

"extended_timeout": "PT15M",

734

"interval": "PT2M",

735

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

736

"host": "",

737

"approval_delay": "PT0S",

738

"approval_duration": "PT1S",

739

"approved_by_default": "True",

740

"enabled": "True",

741

}

476

742

477

743

@staticmethod

478

744

def config_parser(config):

494

760

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

495

761

"enabled")

496

762

763

# Uppercase and remove spaces from fingerprint for later

764

# comparison purposes with return value from the

765

# fingerprint() function

497

766

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

498

767

.replace(" ", ""))

499

768

if "secret" in section:

504

773

"rb") as secfile:

505

774

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

506

775

else:

507

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

776

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

508

777

.format(section))

509

778

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

510

779

client["extended_timeout"] = string_to_delta(

527

796

server_settings = {}

528

797

self.server_settings = server_settings

529

798

# adding all client settings

530

for setting, value in settings.iteritems():

799

for setting, value in settings.items():

531

800

setattr(self, setting, value)

532

801

533

802

if self.enabled:

541

810

self.expires = None

542

811

543

812

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

547

813

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

548

814

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

549

815

datetime.datetime.utcnow())

556

822

self.current_checker_command = None

557

823

self.approved = None

558

824

self.approvals_pending = 0

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

825

self.changedstate = multiprocessing_manager.Condition(

826

multiprocessing_manager.Lock())

827

self.client_structure = [attr

828

for attr in self.__dict__.iterkeys()

564

829

if not attr.startswith("_")]

565

830

self.client_structure.append("client_structure")

566

831

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

832

for name, t in inspect.getmembers(

833

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

571

834

if not name.startswith("_"):

572

835

self.client_structure.append(name)

573

836

615

878

# and every interval from then on.

616

879

if self.checker_initiator_tag is not None:

617

880

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

881

self.checker_initiator_tag = gobject.timeout_add(

882

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

883

self.start_checker)

621

884

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

622

885

if self.disable_initiator_tag is not None:

623

886

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

887

self.disable_initiator_tag = gobject.timeout_add(

888

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

627

889

# Also start a new checker *right now*.

628

890

self.start_checker()

629

891

630

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

892

def checker_callback(self, source, condition, connection,

893

command):

631

894

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

632

895

self.checker_callback_tag = None

633

896

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

897

# Read return code from connection (see call_pipe)

898

returncode = connection.recv()

899

connection.close()

900

901

if returncode >= 0:

902

self.last_checker_status = returncode

903

self.last_checker_signal = None

636

904

if self.last_checker_status == 0:

637

905

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

638

906

vars(self))

639

907

self.checked_ok()

640

908

else:

641

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

642

vars(self))

909

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

643

910

else:

644

911

self.last_checker_status = -1

912

self.last_checker_signal = -returncode

645

913

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

646

914

vars(self))

915

return False

647

916

648

917

def checked_ok(self):

649

918

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

650

919

self.last_checked_ok = datetime.datetime.utcnow()

651

920

self.last_checker_status = 0

921

self.last_checker_signal = None

652

922

self.bump_timeout()

653

923

654

924

def bump_timeout(self, timeout=None):

659

929

gobject.source_remove(self.disable_initiator_tag)

660

930

self.disable_initiator_tag = None

661

931

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

932

self.disable_initiator_tag = gobject.timeout_add(

933

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

665

934

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

666

935

667

936

def need_approval(self):

681

950

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

682

951

# should be.

683

952

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

953

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

954

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

955

self.checker.join()

956

self.checker = None

697

957

# Start a new checker if needed

698

958

if self.checker is None:

699

959

# Escape attributes for the shell

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

960

escaped_attrs = {

961

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

962

for attr in self.runtime_expansions }

704

963

try:

705

964

command = self.checker_command % escaped_attrs

706

965

except TypeError as error:

707

966

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

967

self.checker_command,

968

exc_info=error)

969

return True # Try again later

710

970

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

971

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

972

self.name)

973

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

974

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

975

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

976

# always replaced by /dev/null.)

977

# The exception is when not debugging but nevertheless

978

# running in the foreground; use the previously

979

# created wnull.

980

popen_args = { "close_fds": True,

981

"shell": True,

982

"cwd": "/" }

983

if (not self.server_settings["debug"]

984

and self.server_settings["foreground"]):

985

popen_args.update({"stdout": wnull,

986

"stderr": wnull })

987

pipe = multiprocessing.Pipe(duplex = False)

988

self.checker = multiprocessing.Process(

989

target = call_pipe,

990

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

991

kwargs = popen_args)

992

self.checker.start()

993

self.checker_callback_tag = gobject.io_add_watch(

994

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

995

self.checker_callback, pipe[0], command)

752

996

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

753

997

return True

754

998

760

1004

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

761

1005

return

762

1006

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1007

self.checker.terminate()

771

1008

self.checker = None

772

1009

773

1010

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1011

def dbus_service_property(dbus_interface,

1012

signature="v",

1013

access="readwrite",

1014

byte_arrays=False):

776

1015

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1016

become properties on the D-Bus.

778

1017

787

1026

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

788

1027

if byte_arrays and signature != "ay":

789

1028

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

790

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

1029

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

1030

791

1031

def decorator(func):

792

1032

func._dbus_is_property = True

793

1033

func._dbus_interface = dbus_interface

798

1038

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

799

1039

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

800

1040

return func

1041

801

1042

return decorator

802

1043

803

1044

812

1053

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

813

1054

"false"}

814

1055

"""

1056

815

1057

def decorator(func):

816

1058

func._dbus_is_interface = True

817

1059

func._dbus_interface = dbus_interface

818

1060

func._dbus_name = dbus_interface

819

1061

return func

1062

820

1063

return decorator

821

1064

822

1065

824

1067

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

825

1068

Usage:

826

1069

1070

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

1071

"org.freedesktop.DBus.Property."

1072

"EmitsChangedSignal": "false"})

827

1073

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

828

1074

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1075

def Property_dbus_property(self):

833

1076

return dbus.Boolean(False)

1077

1078

See also the DBusObjectWithAnnotations class.

834

1079

"""

1080

835

1081

def decorator(func):

836

1082

func._dbus_annotations = annotations

837

1083

return func

1084

838

1085

return decorator

839

1086

840

1087

841

1088

class DBusPropertyException(dbus.exceptions.DBusException):

842

1089

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

843

1090

"""

844

def __unicode__(self):

845

return unicode(str(self))

1091

pass

846

1092

847

1093

848

1094

class DBusPropertyAccessException(DBusPropertyException):

857

1103

pass

858

1104

859

1105

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

1106

class DBusObjectWithAnnotations(dbus.service.Object):

1107

"""A D-Bus object with annotations.

862

1108

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1109

Classes inheriting from this can use the dbus_annotations

1110

decorator to add annotations to methods or signals.

866

1111

"""

867

1112

868

1113

@staticmethod

872

1117

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

873

1118

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

874

1119

"""

875

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

1120

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

876

1121

False)

877

1122

878

1123

def _get_all_dbus_things(self, thing):

879

1124

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

880

1125

"""

881

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

882

name),

1126

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

883

1127

athing.__get__(self))

884

1128

for cls in self.__class__.__mro__

885

1129

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

1130

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

1131

1132

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1133

out_signature = "s",

1134

path_keyword = 'object_path',

1135

connection_keyword = 'connection')

1136

def Introspect(self, object_path, connection):

1137

"""Overloading of standard D-Bus method.

1138

1139

Inserts annotation tags on methods and signals.

1140

"""

1141

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

1142

connection)

1143

try:

1144

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

1145

1146

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

1147

# Add annotation tags

1148

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

1149

for tag in if_tag.getElementsByTagName(typ):

1150

annots = dict()

1151

for name, prop in (self.

1152

_get_all_dbus_things(typ)):

1153

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

1154

and prop._dbus_interface

1155

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

1156

annots.update(getattr(

1157

prop, "_dbus_annotations", {}))

1158

for name, value in annots.items():

1159

ann_tag = document.createElement(

1160

"annotation")

1161

ann_tag.setAttribute("name", name)

1162

ann_tag.setAttribute("value", value)

1163

tag.appendChild(ann_tag)

1164

# Add interface annotation tags

1165

for annotation, value in dict(

1166

itertools.chain.from_iterable(

1167

annotations().items()

1168

for name, annotations

1169

in self._get_all_dbus_things("interface")

1170

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

1171

)).items():

1172

ann_tag = document.createElement("annotation")

1173

ann_tag.setAttribute("name", annotation)

1174

ann_tag.setAttribute("value", value)

1175

if_tag.appendChild(ann_tag)

1176

# Fix argument name for the Introspect method itself

1177

if (if_tag.getAttribute("name")

1178

== dbus.INTROSPECTABLE_IFACE):

1179

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

1180

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

1181

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

1182

if (arg.getAttribute("direction")

1183

== "out"):

1184

arg.setAttribute("name",

1185

"xml_data")

1186

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

1187

document.unlink()

1188

except (AttributeError, xml.dom.DOMException,

1189

xml.parsers.expat.ExpatError) as error:

1190

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

1191

exc_info=error)

1192

return xmlstring

1193

1194

1195

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1196

"""A D-Bus object with properties.

1197

1198

Classes inheriting from this can use the dbus_service_property

1199

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

1200

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

1201

"""

888

1202

889

1203

def _get_dbus_property(self, interface_name, property_name):

890

1204

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

891

1205

property with the specified name and interface.

892

1206

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1207

for cls in self.__class__.__mro__:

1208

for name, value in inspect.getmembers(

1209

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

897

1210

if (value._dbus_name == property_name

898

1211

and value._dbus_interface == interface_name):

899

1212

return value.__get__(self)

900

1213

901

1214

# No such property

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1215

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

1216

self.dbus_object_path, interface_name, property_name))

1217

1218

@classmethod

1219

def _get_all_interface_names(cls):

1220

"""Get a sequence of all interfaces supported by an object"""

1221

return (name for name in set(getattr(getattr(x, attr),

1222

"_dbus_interface", None)

1223

for x in (inspect.getmro(cls))

1224

for attr in dir(x))

1225

if name is not None)

1226

1227

@dbus.service.method(dbus.PROPERTIES_IFACE,

1228

in_signature="ss",

907

1229

out_signature="v")

908

1230

def Get(self, interface_name, property_name):

909

1231

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

927

1249

# The byte_arrays option is not supported yet on

928

1250

# signatures other than "ay".

929

1251

if prop._dbus_signature != "ay":

930

raise ValueError

1252

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

1253

"'ay' signature {!r}"

1254

.format(prop._dbus_signature))

931

1255

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

932

1256

for byte in value))

933

1257

prop(value)

934

1258

935

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

1259

@dbus.service.method(dbus.PROPERTIES_IFACE,

1260

in_signature="s",

936

1261

out_signature="a{sv}")

937

1262

def GetAll(self, interface_name):

938

1263

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

953

1278

if not hasattr(value, "variant_level"):

954

1279

properties[name] = value

955

1280

continue

956

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

957

value.variant_level+1)

1281

properties[name] = type(value)(

1282

value, variant_level = value.variant_level + 1)

958

1283

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

959

1284

1285

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

1286

def PropertiesChanged(self, interface_name, changed_properties,

1287

invalidated_properties):

1288

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

1289

standard.

1290

"""

1291

pass

1292

960

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1294

out_signature="s",

962

1295

path_keyword='object_path',

966

1299

967

1300

Inserts property tags and interface annotation tags.

968

1301

"""

969

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

970

connection)

1302

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1303

object_path,

1304

connection)

971

1305

try:

972

1306

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

1307

973

1308

def make_tag(document, name, prop):

974

1309

e = document.createElement("property")

975

1310

e.setAttribute("name", name)

976

1311

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

977

1312

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

978

1313

return e

1314

979

1315

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

980

1316

# Add property tags

981

1317

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

984

1320

if prop._dbus_interface

985

1321

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

986

1322

if_tag.appendChild(tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1323

# Add annotation tags for properties

1324

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

1325

annots = dict()

1326

for name, prop in self._get_all_dbus_things(

1327

"property"):

1328

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

1329

and prop._dbus_interface

1330

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

1331

annots.update(getattr(

1332

prop, "_dbus_annotations", {}))

1333

for name, value in annots.items():

1334

ann_tag = document.createElement(

1335

"annotation")

1336

ann_tag.setAttribute("name", name)

1337

ann_tag.setAttribute("value", value)

1338

tag.appendChild(ann_tag)

1018

1339

# Add the names to the return values for the

1019

1340

# "org.freedesktop.DBus.Properties" methods

1020

1341

if (if_tag.getAttribute("name")

1038

1359

exc_info=error)

1039

1360

return xmlstring

1040

1361

1362

try:

1363

dbus.OBJECT_MANAGER_IFACE

1364

except AttributeError:

1365

dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"

1366

1367

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1368

"""A D-Bus object with an ObjectManager.

1369

1370

Classes inheriting from this exposes the standard

1371

GetManagedObjects call and the InterfacesAdded and

1372

InterfacesRemoved signals on the standard

1373

"org.freedesktop.DBus.ObjectManager" interface.

1374

1375

Note: No signals are sent automatically; they must be sent

1376

manually.

1377

"""

1378

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1379

out_signature = "a{oa{sa{sv}}}")

1380

def GetManagedObjects(self):

1381

"""This function must be overridden"""

1382

raise NotImplementedError()

1383

1384

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1385

signature = "oa{sa{sv}}")

1386

def InterfacesAdded(self, object_path, interfaces_and_properties):

1387

pass

1388

1389

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")

1390

def InterfacesRemoved(self, object_path, interfaces):

1391

pass

1392

1393

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1394

out_signature = "s",

1395

path_keyword = 'object_path',

1396

connection_keyword = 'connection')

1397

def Introspect(self, object_path, connection):

1398

"""Overloading of standard D-Bus method.

1399

1400

Override return argument name of GetManagedObjects to be

1401

"objpath_interfaces_and_properties"

1402

"""

1403

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1404

object_path,

1405

connection)

1406

try:

1407

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

1408

1409

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

1410

# Fix argument name for the GetManagedObjects method

1411

if (if_tag.getAttribute("name")

1412

== dbus.OBJECT_MANAGER_IFACE):

1413

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

1414

if (cn.getAttribute("name")

1415

== "GetManagedObjects"):

1416

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

1417

if (arg.getAttribute("direction")

1418

== "out"):

1419

arg.setAttribute(

1420

"name",

1421

"objpath_interfaces"

1422

"_and_properties")

1423

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

1424

document.unlink()

1425

except (AttributeError, xml.dom.DOMException,

1426

xml.parsers.expat.ExpatError) as error:

1427

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

1428

exc_info = error)

1429

return xmlstring

1041

1430

1042

1431

def datetime_to_dbus(dt, variant_level=0):

1043

1432

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

1044

1433

if dt is None:

1045

1434

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1435

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

1048

1436

1049

1437

1050

1438

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1070

1458

(from DBusObjectWithProperties) and interfaces (from the

1071

1459

dbus_interface_annotations decorator).

1072

1460

"""

1461

1073

1462

def wrapper(cls):

1074

1463

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1464

alt_interface_names.items()):

1076

1465

attr = {}

1077

1466

interface_names = set()

1078

1467

# Go though all attributes of the class

1080

1469

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

1081

1470

# with the wrong interface name

1082

1471

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1472

or not attribute._dbus_interface.startswith(

1473

orig_interface_name)):

1085

1474

continue

1086

1475

# Create an alternate D-Bus interface name based on

1087

1476

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1477

alt_interface = attribute._dbus_interface.replace(

1478

orig_interface_name, alt_interface_name)

1091

1479

interface_names.add(alt_interface)

1092

1480

# Is this a D-Bus signal?

1093

1481

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

1094

# Extract the original non-method undecorated

1095

# function by black magic

1096

nonmethod_func = (dict(

1482

if sys.version_info.major == 2:

1483

# Extract the original non-method undecorated

1484

# function by black magic

1485

nonmethod_func = (dict(

1097

1486

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1487

attribute.__closure__))

1488

["func"].cell_contents)

1489

else:

1490

nonmethod_func = attribute

1100

1491

# Create a new, but exactly alike, function

1101

1492

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

1102

1493

# with the alternate D-Bus interface name

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1494

if sys.version_info.major == 2:

1495

new_function = types.FunctionType(

1496

nonmethod_func.func_code,

1497

nonmethod_func.func_globals,

1498

nonmethod_func.func_name,

1499

nonmethod_func.func_defaults,

1500

nonmethod_func.func_closure)

1501

else:

1502

new_function = types.FunctionType(

1503

nonmethod_func.__code__,

1504

nonmethod_func.__globals__,

1505

nonmethod_func.__name__,

1506

nonmethod_func.__defaults__,

1507

nonmethod_func.__closure__)

1508

new_function = (dbus.service.signal(

1509

alt_interface,

1510

attribute._dbus_signature)(new_function))

1112

1511

# Copy annotations, if any

1113

1512

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1513

new_function._dbus_annotations = dict(

1514

attribute._dbus_annotations)

1116

1515

except AttributeError:

1117

1516

pass

1118

1517

# Define a creator of a function to call both the

1123

1522

"""This function is a scope container to pass

1124

1523

func1 and func2 to the "call_both" function

1125

1524

outside of its arguments"""

1525

1526

@functools.wraps(func2)

1126

1527

def call_both(*args, **kwargs):

1127

1528

"""This function will emit two D-Bus

1128

1529

signals by calling func1 and func2"""

1129

1530

func1(*args, **kwargs)

1130

1531

func2(*args, **kwargs)

1532

# Make wrapper function look like a D-Bus signal

1533

for name, attr in inspect.getmembers(func2):

1534

if name.startswith("_dbus_"):

1535

setattr(call_both, name, attr)

1536

1131

1537

return call_both

1132

1538

# Create the "call_both" function and add it to

1133

1539

# the class

1138

1544

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

1139

1545

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

1140

1546

# to the class.

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1547

attr[attrname] = (

1548

dbus.service.method(

1549

alt_interface,

1550

attribute._dbus_in_signature,

1551

attribute._dbus_out_signature)

1552

(types.FunctionType(attribute.func_code,

1553

attribute.func_globals,

1554

attribute.func_name,

1555

attribute.func_defaults,

1556

attribute.func_closure)))

1151

1557

# Copy annotations, if any

1152

1558

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1559

attr[attrname]._dbus_annotations = dict(

1560

attribute._dbus_annotations)

1155

1561

except AttributeError:

1156

1562

pass

1157

1563

# Is this a D-Bus property?

1160

1566

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

1161

1567

# property with the alternate D-Bus interface

1162

1568

# name. Add it to the class.

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1569

attr[attrname] = (dbus_service_property(

1570

alt_interface, attribute._dbus_signature,

1571

attribute._dbus_access,

1572

attribute._dbus_get_args_options

1573

["byte_arrays"])

1574

(types.FunctionType(

1575

attribute.func_code,

1576

attribute.func_globals,

1577

attribute.func_name,

1578

attribute.func_defaults,

1579

attribute.func_closure)))

1176

1580

# Copy annotations, if any

1177

1581

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1582

attr[attrname]._dbus_annotations = dict(

1583

attribute._dbus_annotations)

1180

1584

except AttributeError:

1181

1585

pass

1182

1586

# Is this a D-Bus interface?

1185

1589

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

1186

1590

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

1187

1591

# to the class.

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1592

attr[attrname] = (

1593

dbus_interface_annotations(alt_interface)

1594

(types.FunctionType(attribute.func_code,

1595

attribute.func_globals,

1596

attribute.func_name,

1597

attribute.func_defaults,

1598

attribute.func_closure)))

1196

1599

if deprecate:

1197

1600

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1601

iname="_AlternateDBusNames_interface_annotation{}"

1199

1602

for interface_name in interface_names:

1603

1200

1604

@dbus_interface_annotations(interface_name)

1201

1605

def func(self):

1202

1606

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

1203

"true" }

1607

"true" }

1204

1608

# Find an unused name

1205

1609

for aname in (iname.format(i)

1206

1610

for i in itertools.count()):

1210

1614

if interface_names:

1211

1615

# Replace the class with a new subclass of it with

1212

1616

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1617

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

1618

(cls, ), attr)

1215

1619

return cls

1620

1216

1621

return wrapper

1217

1622

1218

1623

1219

1624

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

1220

"se.bsnet.fukt.Mandos"})

1625

"se.bsnet.fukt.Mandos"})

1221

1626

class ClientDBus(Client, DBusObjectWithProperties):

1222

1627

"""A Client class using D-Bus

1223

1628

1227

1632

"""

1228

1633

1229

1634

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1635

+ ("dbus_object_path", ))

1636

1637

_interface = "se.recompile.Mandos.Client"

1231

1638

1232

1639

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

1233

1640

1236

1643

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

1237

1644

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

1238

1645

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1646

client_object_name = str(self.name).translate(

1240

1647

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

1241

1648

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1649

self.dbus_object_path = dbus.ObjectPath(

1650

"/clients/" + client_object_name)

1244

1651

DBusObjectWithProperties.__init__(self, self.bus,

1245

1652

self.dbus_object_path)

1246

1653

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1654

def notifychangeproperty(transform_func, dbus_name,

1655

type_func=lambda x: x,

1656

variant_level=1,

1657

invalidate_only=False,

1658

_interface=_interface):

1250

1659

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

1251

1660

its changes to DBus.

1252

1661

1257

1666

to the D-Bus. Default: no transform

1258

1667

variant_level: D-Bus variant level. Default: 1

1259

1668

"""

1260

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

1669

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

1670

1261

1671

def setter(self, value):

1262

1672

if hasattr(self, "dbus_object_path"):

1263

1673

if (not hasattr(self, attrname) or

1264

1674

type_func(getattr(self, attrname, None))

1265

1675

!= type_func(value)):

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1676

if invalidate_only:

1677

self.PropertiesChanged(

1678

_interface, dbus.Dictionary(),

1679

dbus.Array((dbus_name, )))

1680

else:

1681

dbus_value = transform_func(

1682

type_func(value),

1683

variant_level = variant_level)

1684

self.PropertyChanged(dbus.String(dbus_name),

1685

dbus_value)

1686

self.PropertiesChanged(

1687

_interface,

1688

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

1689

dbus_value }),

1690

dbus.Array())

1271

1691

setattr(self, attrname, value)

1272

1692

1273

1693

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

1279

1699

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

1280

1700

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1701

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1702

checker = notifychangeproperty(

1703

dbus.Boolean, "CheckerRunning",

1704

type_func = lambda checker: checker is not None)

1285

1705

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1706

"LastCheckedOK")

1287

1707

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1710

datetime_to_dbus, "LastApprovalRequest")

1291

1711

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1712

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1713

approval_delay = notifychangeproperty(

1714

dbus.UInt64, "ApprovalDelay",

1715

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

1297

1716

approval_duration = notifychangeproperty(

1298

1717

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1718

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

1300

1719

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1720

timeout = notifychangeproperty(

1721

dbus.UInt64, "Timeout",

1722

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

1304

1723

extended_timeout = notifychangeproperty(

1305

1724

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1725

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

1726

interval = notifychangeproperty(

1727

dbus.UInt64, "Interval",

1728

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

1311

1729

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

1730

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

1731

invalidate_only=True)

1312

1732

1313

1733

del notifychangeproperty

1314

1734

1321

1741

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

1322

1742

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

1323

1743

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1744

def checker_callback(self, source, condition,

1745

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

1746

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

1747

connection, command, *args,

1748

**kwargs)

1749

exitstatus = self.last_checker_status

1750

if exitstatus >= 0:

1330

1751

# Emit D-Bus signal

1331

1752

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1753

# This is specific to GNU libC

1754

dbus.Int64(exitstatus << 8),

1333

1755

dbus.String(command))

1334

1756

else:

1335

1757

# Emit D-Bus signal

1336

1758

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

1337

dbus.Int64(condition),

1759

dbus.Int64(

1760

# This is specific to GNU libC

1761

(exitstatus << 8)

1762

| self.last_checker_signal),

1338

1763

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1764

return ret

1342

1765

1343

1766

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1767

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

1349

1768

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

1350

1769

# Only if new checker process was started

1351

1770

if (self.checker is not None

1360

1779

1361

1780

def approve(self, value=True):

1362

1781

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1782

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

1783

* 1000), self._reset_approved)

1366

1784

self.send_changedstate()

1367

1785

1368

1786

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1787

1371

1788

## Interfaces

1372

1789

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

1790

## Signals

1379

1791

1380

1792

# CheckerCompleted - signal

1390

1802

pass

1391

1803

1392

1804

# PropertyChanged - signal

1805

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

1393

1806

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

1394

1807

def PropertyChanged(self, property, value):

1395

1808

"D-Bus signal"

1429

1842

self.checked_ok()

1430

1843

1431

1844

# Enable - method

1845

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

1432

1846

@dbus.service.method(_interface)

1433

1847

def Enable(self):

1434

1848

"D-Bus method"

1435

1849

self.enable()

1436

1850

1437

1851

# StartChecker - method

1852

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

1438

1853

@dbus.service.method(_interface)

1439

1854

def StartChecker(self):

1440

1855

"D-Bus method"

1441

1856

self.start_checker()

1442

1857

1443

1858

# Disable - method

1859

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

1444

1860

@dbus.service.method(_interface)

1445

1861

def Disable(self):

1446

1862

"D-Bus method"

1447

1863

self.disable()

1448

1864

1449

1865

# StopChecker - method

1866

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

1450

1867

@dbus.service.method(_interface)

1451

1868

def StopChecker(self):

1452

1869

self.stop_checker()

1459

1876

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

1460

1877

1461

1878

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

1879

@dbus_service_property(_interface,

1880

signature="b",

1463

1881

access="readwrite")

1464

1882

def ApprovedByDefault_dbus_property(self, value=None):

1465

1883

if value is None: # get

1467

1885

self.approved_by_default = bool(value)

1468

1886

1469

1887

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

1888

@dbus_service_property(_interface,

1889

signature="t",

1471

1890

access="readwrite")

1472

1891

def ApprovalDelay_dbus_property(self, value=None):

1473

1892

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

1893

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

1894

* 1000)

1475

1895

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

1476

1896

1477

1897

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

1898

@dbus_service_property(_interface,

1899

signature="t",

1479

1900

access="readwrite")

1480

1901

def ApprovalDuration_dbus_property(self, value=None):

1481

1902

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

1903

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

1904

* 1000)

1484

1905

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

1485

1906

1486

1907

# Name - property

1908

@dbus_annotations(

1909

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

1487

1910

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

1488

1911

def Name_dbus_property(self):

1489

1912

return dbus.String(self.name)

1490

1913

1491

1914

# Fingerprint - property

1915

@dbus_annotations(

1916

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

1492

1917

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

1493

1918

def Fingerprint_dbus_property(self):

1494

1919

return dbus.String(self.fingerprint)

1495

1920

1496

1921

# Host - property

1497

@dbus_service_property(_interface, signature="s",

1922

@dbus_service_property(_interface,

1923

signature="s",

1498

1924

access="readwrite")

1499

1925

def Host_dbus_property(self, value=None):

1500

1926

if value is None: # get

1501

1927

return dbus.String(self.host)

1502

self.host = unicode(value)

1928

self.host = str(value)

1503

1929

1504

1930

# Created - property

1931

@dbus_annotations(

1932

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

1505

1933

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

1506

1934

def Created_dbus_property(self):

1507

1935

return datetime_to_dbus(self.created)

1512

1940

return datetime_to_dbus(self.last_enabled)

1513

1941

1514

1942

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

1943

@dbus_service_property(_interface,

1944

signature="b",

1516

1945

access="readwrite")

1517

1946

def Enabled_dbus_property(self, value=None):

1518

1947

if value is None: # get

1523

1952

self.disable()

1524

1953

1525

1954

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

1955

@dbus_service_property(_interface,

1956

signature="s",

1527

1957

access="readwrite")

1528

1958

def LastCheckedOK_dbus_property(self, value=None):

1529

1959

if value is not None:

1532

1962

return datetime_to_dbus(self.last_checked_ok)

1533

1963

1534

1964

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

1965

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

1537

1966

def LastCheckerStatus_dbus_property(self):

1538

1967

return dbus.Int16(self.last_checker_status)

1539

1968

1548

1977

return datetime_to_dbus(self.last_approval_request)

1549

1978

1550

1979

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

1980

@dbus_service_property(_interface,

1981

signature="t",

1552

1982

access="readwrite")

1553

1983

def Timeout_dbus_property(self, value=None):

1554

1984

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

1985

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

1556

1986

old_timeout = self.timeout

1557

1987

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

1558

1988

# Reschedule disabling

1567

1997

is None):

1568

1998

return

1569

1999

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

2000

self.disable_initiator_tag = gobject.timeout_add(

2001

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

2002

self.disable)

1574

2003

1575

2004

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2005

@dbus_service_property(_interface,

2006

signature="t",

1577

2007

access="readwrite")

1578

2008

def ExtendedTimeout_dbus_property(self, value=None):

1579

2009

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2010

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

2011

* 1000)

1581

2012

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

1582

2013

1583

2014

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2015

@dbus_service_property(_interface,

2016

signature="t",

1585

2017

access="readwrite")

1586

2018

def Interval_dbus_property(self, value=None):

1587

2019

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2020

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

1589

2021

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

1590

2022

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

1591

2023

return

1592

2024

if self.enabled:

1593

2025

# Reschedule checker run

1594

2026

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

2027

self.checker_initiator_tag = gobject.timeout_add(

2028

value, self.start_checker)

2029

self.start_checker() # Start one now, too

1598

2030

1599

2031

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2032

@dbus_service_property(_interface,

2033

signature="s",

1601

2034

access="readwrite")

1602

2035

def Checker_dbus_property(self, value=None):

1603

2036

if value is None: # get

1604

2037

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

2038

self.checker_command = str(value)

1606

2039

1607

2040

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2041

@dbus_service_property(_interface,

2042

signature="b",

1609

2043

access="readwrite")

1610

2044

def CheckerRunning_dbus_property(self, value=None):

1611

2045

if value is None: # get

1616

2050

self.stop_checker()

1617

2051

1618

2052

# ObjectPath - property

2053

@dbus_annotations(

2054

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

2055

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

1619

2056

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

1620

2057

def ObjectPath_dbus_property(self):

1621

2058

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2059

1623

2060

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2061

@dbus_annotations(

2062

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

2063

"invalidates"})

2064

@dbus_service_property(_interface,

2065

signature="ay",

2066

access="write",

2067

byte_arrays=True)

1626

2068

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

2069

self.secret = bytes(value)

1628

2070

1629

2071

del _interface

1630

2072

1634

2076

self._pipe = child_pipe

1635

2077

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

1636

2078

if not self._pipe.recv():

1637

raise KeyError()

2079

raise KeyError(fpr)

1638

2080

1639

2081

def __getattribute__(self, name):

1640

2082

if name == '_pipe':

1644

2086

if data[0] == 'data':

1645

2087

return data[1]

1646

2088

if data[0] == 'function':

2089

1647

2090

def func(*args, **kwargs):

1648

2091

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

1649

2092

return self._pipe.recv()[1]

2093

1650

2094

return func

1651

2095

1652

2096

def __setattr__(self, name, value):

1664

2108

def handle(self):

1665

2109

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

1666

2110

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

1667

unicode(self.client_address))

2111

str(self.client_address))

1668

2112

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

1669

2113

self.server.child_pipe.fileno())

1670

2114

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

# no X.509 keys are added to it. Therefore, we can use it

1679

# here despite using OpenPGP certificates.

2115

session = gnutls.ClientSession(self.request)

1680

2116

1681

2117

#priority = ':'.join(("NONE", "+VERS-TLS1.1",

1682

2118

# "+AES-256-CBC", "+SHA1",

1686

2122

priority = self.server.gnutls_priority

1687

2123

if priority is None:

1688

2124

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

2125

gnutls.priority_set_direct(session._c_object, priority,

2126

None)

1692

2127

1693

2128

# Start communication using the Mandos protocol

1694

2129

# Get protocol number

1696

2131

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

1697

2132

try:

1698

2133

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

1699

raise RuntimeError

2134

raise RuntimeError(line)

1700

2135

except (ValueError, IndexError, RuntimeError) as error:

1701

2136

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

1702

2137

return

1704

2139

# Start GnuTLS connection

1705

2140

try:

1706

2141

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

2142

except gnutls.Error as error:

1708

2143

logger.warning("Handshake failed: %s", error)

1709

2144

# Do not run session.bye() here: the session is not

1710

2145

# established. Just abandon the request.

1714

2149

approval_required = False

1715

2150

try:

1716

2151

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

2152

fpr = self.fingerprint(

2153

self.peer_certificate(session))

2154

except (TypeError, gnutls.Error) as error:

1721

2155

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

1722

2156

return

1723

2157

logger.debug("Fingerprint: %s", fpr)

1736

2170

while True:

1737

2171

if not client.enabled:

1738

2172

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

1739

client.name)

2173

client.name)

1740

2174

if self.server.use_dbus:

1741

2175

# Emit D-Bus signal

1742

2176

client.Rejected("Disabled")

1751

2185

if self.server.use_dbus:

1752

2186

# Emit D-Bus signal

1753

2187

client.NeedApproval(

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2188

client.approval_delay.total_seconds()

2189

* 1000, client.approved_by_default)

1756

2190

else:

1757

2191

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

1758

2192

client.name)

1764

2198

#wait until timeout or approved

1765

2199

time = datetime.datetime.now()

1766

2200

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2201

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

1770

2202

client.changedstate.release()

1771

2203

time2 = datetime.datetime.now()

1772

2204

if (time2 - time) >= delay:

1787

2219

while sent_size < len(client.secret):

1788

2220

try:

1789

2221

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

1790

except gnutls.errors.GNUTLSError as error:

2222

except gnutls.Error as error:

1791

2223

logger.warning("gnutls send failed",

1792

2224

exc_info=error)

1793

2225

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

2226

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

2227

len(client.secret) - (sent_size

2228

+ sent))

1797

2229

sent_size += sent

1798

2230

1799

2231

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

1808

2240

client.approvals_pending -= 1

1809

2241

try:

1810

2242

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

2243

except gnutls.Error as error:

1812

2244

logger.warning("GnuTLS bye failed",

1813

2245

exc_info=error)

1814

2246

1816

2248

def peer_certificate(session):

1817

2249

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

1818

2250

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2251

if (gnutls.certificate_type_get(session._c_object)

2252

!= gnutls.CRT_OPENPGP):

2253

# ...return invalid data

2254

return b""

1824

2255

list_size = ctypes.c_uint(1)

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2256

cert_list = (gnutls.certificate_get_peers

1827

2257

(session._c_object, ctypes.byref(list_size)))

1828

2258

if not bool(cert_list) and list_size.value != 0:

1829

raise gnutls.errors.GNUTLSError("error getting peer"

1830

" certificate")

2259

raise gnutls.Error("error getting peer certificate")

1831

2260

if list_size.value == 0:

1832

2261

return None

1833

2262

cert = cert_list[0]

1837

2266

def fingerprint(openpgp):

1838

2267

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2268

# New GnuTLS "datum" with the OpenPGP public key

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2269

datum = gnutls.datum_t(

2270

ctypes.cast(ctypes.c_char_p(openpgp),

2271

ctypes.POINTER(ctypes.c_ubyte)),

2272

ctypes.c_uint(len(openpgp)))

1845

2273

# New empty GnuTLS certificate

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2274

crt = gnutls.openpgp_crt_t()

2275

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2276

# Import the OpenPGP public key into the certificate

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2277

gnutls.openpgp_crt_import(crt, ctypes.byref(datum),

2278

gnutls.OPENPGP_FMT_RAW)

1854

2279

# Verify the self signature in the key

1855

2280

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2281

gnutls.openpgp_crt_verify_self(crt, 0,

2282

ctypes.byref(crtverify))

1859

2283

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2284

gnutls.openpgp_crt_deinit(crt)

2285

raise gnutls.CertificateSecurityError("Verify failed")

1863

2286

# New buffer for the fingerprint

1864

2287

buf = ctypes.create_string_buffer(20)

1865

2288

buf_len = ctypes.c_size_t()

1866

2289

# Get the fingerprint from the certificate into the buffer

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2290

gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),

2291

ctypes.byref(buf_len))

1870

2292

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2293

gnutls.openpgp_crt_deinit(crt)

1872

2294

# Convert the buffer to a Python bytestring

1873

2295

fpr = ctypes.string_at(buf, buf_len.value)

1874

2296

# Convert the bytestring to hexadecimal notation

1878

2300

1879

2301

class MultiprocessingMixIn(object):

1880

2302

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

2303

1881

2304

def sub_process_main(self, request, address):

1882

2305

try:

1883

2306

self.finish_request(request, address)

1895

2318

1896

2319

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1897

2320

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

2321

1898

2322

def process_request(self, request, client_address):

1899

2323

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

1900

2324

1909

2333

1910

2334

def add_pipe(self, parent_pipe, proc):

1911

2335

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

1912

raise NotImplementedError

2336

raise NotImplementedError()

1913

2337

1914

2338

1915

2339

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1921

2345

interface: None or a network interface name (string)

1922

2346

use_ipv6: Boolean; to use IPv6 or not

1923

2347

"""

2348

1924

2349

def __init__(self, server_address, RequestHandlerClass,

1925

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

2350

interface=None,

2351

use_ipv6=True,

2352

socketfd=None):

1926

2353

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

1927

2354

creating a new one with socket.socket().

1928

2355

"""

1969

2396

self.interface)

1970

2397

else:

1971

2398

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

2399

self.socket.setsockopt(

2400

socket.SOL_SOCKET, SO_BINDTODEVICE,

2401

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

1975

2402

except socket.error as error:

1976

2403

if error.errno == errno.EPERM:

1977

2404

logger.error("No permission to bind to"

1995

2422

self.server_address = (any_address,

1996

2423

self.server_address[1])

1997

2424

elif not self.server_address[1]:

1998

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

1999

0)

2425

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

2000

2426

# if self.interface:

2001

2427

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

2002

2428

# 0, # port

2016

2442

2017

2443

Assumes a gobject.MainLoop event loop.

2018

2444

"""

2445

2019

2446

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

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

2447

interface=None,

2448

use_ipv6=True,

2449

clients=None,

2450

gnutls_priority=None,

2451

use_dbus=True,

2452

socketfd=None):

2022

2453

self.enabled = False

2023

2454

self.clients = clients

2024

2455

if self.clients is None:

2030

2461

interface = interface,

2031

2462

use_ipv6 = use_ipv6,

2032

2463

socketfd = socketfd)

2464

2033

2465

def server_activate(self):

2034

2466

if self.enabled:

2035

2467

return socketserver.TCPServer.server_activate(self)

2039

2471

2040

2472

def add_pipe(self, parent_pipe, proc):

2041

2473

# Call "handle_ipc" for both data and EOF events

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2474

gobject.io_add_watch(

2475

parent_pipe.fileno(),

2476

gobject.IO_IN | gobject.IO_HUP,

2477

functools.partial(self.handle_ipc,

2478

parent_pipe = parent_pipe,

2479

proc = proc))

2048

2480

2049

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

2050

proc = None, client_object=None):

2481

def handle_ipc(self, source, condition,

2482

parent_pipe=None,

2483

proc = None,

2484

client_object=None):

2051

2485

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

2052

2486

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

2053

2487

# Wait for other process to exit

2076

2510

parent_pipe.send(False)

2077

2511

return False

2078

2512

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2513

gobject.io_add_watch(

2514

parent_pipe.fileno(),

2515

gobject.IO_IN | gobject.IO_HUP,

2516

functools.partial(self.handle_ipc,

2517

parent_pipe = parent_pipe,

2518

proc = proc,

2519

client_object = client))

2087

2520

parent_pipe.send(True)

2088

2521

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

2089

2522

# same fileno

2095

2528

2096

2529

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

2097

2530

funcname)(*args,

2098

**kwargs)))

2531

**kwargs)))

2099

2532

2100

2533

if command == 'getattr':

2101

2534

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2535

if isinstance(client_object.__getattribute__(attrname),

2536

collections.Callable):

2537

parent_pipe.send(('function', ))

2104

2538

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2539

parent_pipe.send((

2540

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

2107

2541

2108

2542

if command == 'setattr':

2109

2543

attrname = request[1]

2140

2574

# avoid excessive use of external libraries.

2141

2575

2142

2576

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

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2577

Token = collections.namedtuple("Token", (

2578

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

2579

# a "group" containing digits

2580

"value", # datetime.timedelta or None

2581

"followers")) # Tokens valid after this token

2152

2582

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

2153

2583

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

2154

2584

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

2155

2585

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

2156

2586

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2587

frozenset((token_end, )))

2158

2588

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

2159

2589

datetime.timedelta(minutes=1),

2160

2590

frozenset((token_second, token_end)))

2176

2606

frozenset((token_month, token_end)))

2177

2607

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

2178

2608

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2609

frozenset((token_end, )))

2180

2610

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

2181

2611

frozenset((token_year, token_month,

2182

2612

token_day, token_time,

2183

token_week))),

2613

token_week)))

2184

2614

# Define starting values

2185

2615

value = datetime.timedelta() # Value so far

2186

2616

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2617

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

2188

2618

s = duration # String left to parse

2189

2619

# Loop until end token is found

2190

2620

while found_token is not token_end:

2207

2637

break

2208

2638

else:

2209

2639

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2640

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

2641

.format(duration))

2211

2642

# End token found

2212

2643

return value

2213

2644

2237

2668

timevalue = datetime.timedelta(0)

2238

2669

for s in interval.split():

2239

2670

try:

2240

suffix = unicode(s[-1])

2671

suffix = s[-1]

2241

2672

value = int(s[:-1])

2242

2673

if suffix == "d":

2243

2674

delta = datetime.timedelta(value)

2250

2681

elif suffix == "w":

2251

2682

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

2252

2683

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2684

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

2685

except IndexError as e:

2256

2686

raise ValueError(*(e.args))

2257

2687

timevalue += delta

2258

2688

return timevalue

2274

2704

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

2275

2705

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

2276

2706

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2707

"{} not a character device"

2278

2708

.format(os.devnull))

2279

2709

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

2280

2710

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

2290

2720

2291

2721

parser = argparse.ArgumentParser()

2292

2722

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

2293

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

2723

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

2294

2724

help="show version number and exit")

2295

2725

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

2296

2726

help="Bind to interface IF")

2329

2759

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

2330

2760

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

2331

2761

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

2762

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

2763

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

2764

default=None)

2332

2765

2333

2766

options = parser.parse_args()

2334

2767

2335

2768

if options.check:

2336

2769

import doctest

2337

doctest.testmod()

2338

sys.exit()

2770

fail_count, test_count = doctest.testmod()

2771

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

2339

2772

2340

2773

# Default values for config file for server-global settings

2341

2774

server_defaults = { "interface": "",

2343

2776

"port": "",

2344

2777

"debug": "False",

2345

2778

"priority":

2346

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

2779

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

2780

":+SIGN-DSA-SHA256",

2347

2781

"servicename": "Mandos",

2348

2782

"use_dbus": "True",

2349

2783

"use_ipv6": "True",

2352

2786

"socket": "",

2353

2787

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

2354

2788

"foreground": "False",

2355

}

2789

"zeroconf": "True",

2790

}

2356

2791

2357

2792

# Parse config file for server-global settings

2358

2793

server_config = configparser.SafeConfigParser(server_defaults)

2359

2794

del server_defaults

2360

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

2361

"mandos.conf"))

2795

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

2362

2796

# Convert the SafeConfigParser object to a dict

2363

2797

server_settings = server_config.defaults()

2364

2798

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

2382

2816

# Override the settings from the config file with command line

2383

2817

# options, if set.

2384

2818

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

2385

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

2386

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

2387

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

2819

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

2820

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

2821

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

2388

2822

value = getattr(options, option)

2389

2823

if value is not None:

2390

2824

server_settings[option] = value

2391

2825

del options

2392

2826

# Force all strings to be unicode

2393

2827

for option in server_settings.keys():

2394

if type(server_settings[option]) is str:

2395

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

2828

if isinstance(server_settings[option], bytes):

2829

server_settings[option] = (server_settings[option]

2830

.decode("utf-8"))

2396

2831

# Force all boolean options to be boolean

2397

2832

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

2398

"foreground"):

2833

"foreground", "zeroconf"):

2399

2834

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

2400

2835

# Debug implies foreground

2401

2836

if server_settings["debug"]:

2404

2839

2405

2840

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

2406

2841

2842

if (not server_settings["zeroconf"]

2843

and not (server_settings["port"]

2844

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

2845

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

2846

2407

2847

# For convenience

2408

2848

debug = server_settings["debug"]

2409

2849

debuglevel = server_settings["debuglevel"]

2412

2852

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

2413

2853

stored_state_file)

2414

2854

foreground = server_settings["foreground"]

2855

zeroconf = server_settings["zeroconf"]

2415

2856

2416

2857

if debug:

2417

2858

initlogger(debug, logging.DEBUG)

2423

2864

initlogger(debug, level)

2424

2865

2425

2866

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

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2867

syslogger.setFormatter(

2868

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

2869

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

2870

server_settings["servicename"])))

2431

2871

2432

2872

# Parse config file with clients

2433

2873

client_config = configparser.SafeConfigParser(Client

2438

2878

global mandos_dbus_service

2439

2879

mandos_dbus_service = None

2440

2880

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

2881

socketfd = None

2882

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

2883

socketfd = server_settings["socket"]

2884

tcp_server = MandosServer(

2885

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

2886

ClientHandler,

2887

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

2888

use_ipv6=use_ipv6,

2889

gnutls_priority=server_settings["priority"],

2890

use_dbus=use_dbus,

2891

socketfd=socketfd)

2452

2892

if not foreground:

2453

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

2893

pidfilename = "/run/mandos.pid"

2894

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

2895

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

2454

2896

pidfile = None

2455

2897

try:

2456

pidfile = open(pidfilename, "w")

2898

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

2457

2899

except IOError as e:

2458

2900

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

2459

2901

exc_info=e)

2473

2915

os.setuid(uid)

2474

2916

except OSError as error:

2475

2917

if error.errno != errno.EPERM:

2476

raise error

2918

raise

2477

2919

2478

2920

if debug:

2479

2921

# Enable all possible GnuTLS debugging

2480

2922

2481

2923

# "Use a log level over 10 to enable all debugging options."

2482

2924

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2925

gnutls.global_set_log_level(11)

2484

2926

2485

@gnutls.library.types.gnutls_log_func

2927

@gnutls.log_func

2486

2928

def debug_gnutls(level, string):

2487

2929

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

2488

2930

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2931

gnutls.global_set_log_function(debug_gnutls)

2491

2932

2492

2933

# Redirect stdin so all checkers get /dev/null

2493

2934

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

2513

2954

if use_dbus:

2514

2955

try:

2515

2956

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

2957

bus,

2958

do_not_queue=True)

2959

old_bus_name = dbus.service.BusName(

2960

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

2961

do_not_queue=True)

2962

except dbus.exceptions.DBusException as e:

2521

2963

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

2522

2964

use_dbus = False

2523

2965

server_settings["use_dbus"] = False

2524

2966

tcp_server.use_dbus = False

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2967

if zeroconf:

2968

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2969

service = AvahiServiceToSyslog(

2970

name = server_settings["servicename"],

2971

servicetype = "_mandos._tcp",

2972

protocol = protocol,

2973

bus = bus)

2974

if server_settings["interface"]:

2975

service.interface = if_nametoindex(

2976

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

2533

2977

2534

2978

global multiprocessing_manager

2535

2979

multiprocessing_manager = multiprocessing.Manager()

2554

2998

if server_settings["restore"]:

2555

2999

try:

2556

3000

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

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3001

clients_data, old_client_settings = pickle.load(

3002

stored_state)

2559

3003

os.remove(stored_state_path)

2560

3004

except IOError as e:

2561

3005

if e.errno == errno.ENOENT:

2562

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

2563

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

3006

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

3007

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

2564

3008

else:

2565

3009

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

2566

3010

exc_info=e)

2567

3011

raise

2568

3012

except EOFError as e:

2569

3013

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

2570

"EOFError:", exc_info=e)

3014

"EOFError:",

3015

exc_info=e)

2571

3016

2572

3017

with PGPEngine() as pgp:

2573

for client_name, client in clients_data.iteritems():

3018

for client_name, client in clients_data.items():

2574

3019

# Skip removed clients

2575

3020

if client_name not in client_settings:

2576

3021

continue

2585

3030

# For each value in new config, check if it

2586

3031

# differs from the old config value (Except for

2587

3032

# the "secret" attribute)

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3033

if (name != "secret"

3034

and (value !=

3035

old_client_settings[client_name][name])):

2591

3036

client[name] = value

2592

3037

except KeyError:

2593

3038

pass

2594

3039

2595

3040

# Clients who has passed its expire date can still be

2596

# enabled if its last checker was successful. Clients

3041

# enabled if its last checker was successful. A Client

2597

3042

# whose checker succeeded before we stored its state is

2598

3043

# assumed to have successfully run all checkers during

2599

3044

# downtime.

2601

3046

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

2602

3047

if not client["last_checked_ok"]:

2603

3048

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3049

"disabling client {} - Client never "

3050

"performed a successful checker".format(

3051

client_name))

2607

3052

client["enabled"] = False

2608

3053

elif client["last_checker_status"] != 0:

2609

3054

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3055

"disabling client {} - Client last"

3056

" checker failed with error code"

3057

" {}".format(

3058

client_name,

3059

client["last_checker_status"]))

2614

3060

client["enabled"] = False

2615

3061

else:

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3062

client["expires"] = (

3063

datetime.datetime.utcnow()

3064

+ client["timeout"])

2619

3065

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3066

" keeping {} enabled".format(

3067

client_name))

2622

3068

try:

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3069

client["secret"] = pgp.decrypt(

3070

client["encrypted_secret"],

3071

client_settings[client_name]["secret"])

2627

3072

except PGPError:

2628

3073

# If decryption fails, we use secret from new settings

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

3074

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

3075

client_name))

3076

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

3077

["secret"])

2633

3078

2634

3079

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

2635

3080

for client_name in (set(old_client_settings)

2640

3085

clients_data[client_name] = client_settings[client_name]

2641

3086

2642

3087

# Create all client objects

2643

for client_name, client in clients_data.iteritems():

3088

for client_name, client in clients_data.items():

2644

3089

tcp_server.clients[client_name] = client_class(

2645

name = client_name, settings = client,

3090

name = client_name,

3091

settings = client,

2646

3092

server_settings = server_settings)

2647

3093

2648

3094

if not tcp_server.clients:

2650

3096

2651

3097

if not foreground:

2652

3098

if pidfile is not None:

3099

pid = os.getpid()

2653

3100

try:

2654

3101

with pidfile:

2655

pid = os.getpid()

2656

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

3102

print(pid, file=pidfile)

2657

3103

except IOError:

2658

3104

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

2659

3105

pidfilename, pid)

2664

3110

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

2665

3111

2666

3112

if use_dbus:

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3113

3114

@alternate_dbus_interfaces(

3115

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

3116

class MandosDBusService(DBusObjectWithObjectManager):

2670

3117

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

3118

2671

3119

def __init__(self):

2672

3120

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

3121

2673

3122

_interface = "se.recompile.Mandos"

2674

3123

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

2681

3124

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

2682

3125

def ClientAdded(self, objpath):

2683

3126

"D-Bus signal"

2688

3131

"D-Bus signal"

2689

3132

pass

2690

3133

3134

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

3135

"true"})

2691

3136

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

2692

3137

def ClientRemoved(self, objpath, name):

2693

3138

"D-Bus signal"

2694

3139

pass

2695

3140

3141

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

3142

"true"})

2696

3143

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

2697

3144

def GetAllClients(self):

2698

3145

"D-Bus method"

2699

return dbus.Array(c.dbus_object_path

2700

for c in

3146

return dbus.Array(c.dbus_object_path for c in

2701

3147

tcp_server.clients.itervalues())

2702

3148

3149

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

3150

"true"})

2703

3151

@dbus.service.method(_interface,

2704

3152

out_signature="a{oa{sv}}")

2705

3153

def GetAllClientsWithProperties(self):

2706

3154

"D-Bus method"

2707

3155

return dbus.Dictionary(

2708

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

2709

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

3156

{ c.dbus_object_path: c.GetAll(

3157

"se.recompile.Mandos.Client")

3158

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

2710

3159

signature="oa{sv}")

2711

3160

2712

3161

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

2716

3165

if c.dbus_object_path == object_path:

2717

3166

del tcp_server.clients[c.name]

2718

3167

c.remove_from_connection()

2719

# Don't signal anything except ClientRemoved

3168

# Don't signal the disabling

2720

3169

c.disable(quiet=True)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3170

# Emit D-Bus signal for removal

3171

self.client_removed_signal(c)

2723

3172

return

2724

3173

raise KeyError(object_path)

2725

3174

2726

3175

del _interface

3176

3177

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3178

out_signature = "a{oa{sa{sv}}}")

3179

def GetManagedObjects(self):

3180

"""D-Bus method"""

3181

return dbus.Dictionary(

3182

{ client.dbus_object_path:

3183

dbus.Dictionary(

3184

{ interface: client.GetAll(interface)

3185

for interface in

3186

client._get_all_interface_names()})

3187

for client in tcp_server.clients.values()})

3188

3189

def client_added_signal(self, client):

3190

"""Send the new standard signal and the old signal"""

3191

if use_dbus:

3192

# New standard signal

3193

self.InterfacesAdded(

3194

client.dbus_object_path,

3195

dbus.Dictionary(

3196

{ interface: client.GetAll(interface)

3197

for interface in

3198

client._get_all_interface_names()}))

3199

# Old signal

3200

self.ClientAdded(client.dbus_object_path)

3201

3202

def client_removed_signal(self, client):

3203

"""Send the new standard signal and the old signal"""

3204

if use_dbus:

3205

# New standard signal

3206

self.InterfacesRemoved(

3207

client.dbus_object_path,

3208

client._get_all_interface_names())

3209

# Old signal

3210

self.ClientRemoved(client.dbus_object_path,

3211

client.name)

2727

3212

2728

3213

mandos_dbus_service = MandosDBusService()

2729

3214

2730

3215

def cleanup():

2731

3216

"Cleanup function; run on exit"

2732

service.cleanup()

3217

if zeroconf:

3218

service.cleanup()

2733

3219

2734

3220

multiprocessing.active_children()

2735

3221

wnull.close()

2749

3235

2750

3236

# A list of attributes that can not be pickled

2751

3237

# + secret.

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3238

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

3239

"checker", "server_settings" }

3240

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

3241

.Object):

2756

3242

exclude.add(name)

2757

3243

2758

3244

client_dict["encrypted_secret"] = (client

2765

3251

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

2766

3252

2767

3253

try:

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

3254

with tempfile.NamedTemporaryFile(

3255

mode='wb',

3256

suffix=".pickle",

3257

prefix='clients-',

3258

dir=os.path.dirname(stored_state_path),

3259

delete=False) as stored_state:

2772

3260

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

2773

tempname=stored_state.name

3261

tempname = stored_state.name

2774

3262

os.rename(tempname, stored_state_path)

2775

3263

except (IOError, OSError) as e:

2776

3264

if not debug:

2779

3267

except NameError:

2780

3268

pass

2781

3269

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

2782

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

3270

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

2783

3271

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

2784

3272

else:

2785

3273

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

2786

3274

exc_info=e)

2787

raise e

3275

raise

2788

3276

2789

3277

# Delete all clients, and settings from config

2790

3278

while tcp_server.clients:

2791

3279

name, client = tcp_server.clients.popitem()

2792

3280

if use_dbus:

2793

3281

client.remove_from_connection()

2794

# Don't signal anything except ClientRemoved

3282

# Don't signal the disabling

2795

3283

client.disable(quiet=True)

3284

# Emit D-Bus signal for removal

2796

3285

if use_dbus:

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3286

mandos_dbus_service.client_removed_signal(client)

2801

3287

client_settings.clear()

2802

3288

2803

3289

atexit.register(cleanup)

2804

3290

2805

3291

for client in tcp_server.clients.itervalues():

2806

3292

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3293

# Emit D-Bus signal for adding

3294

mandos_dbus_service.client_added_signal(client)

2809

3295

# Need to initiate checking of clients

2810

3296

if client.enabled:

2811

3297

client.init_checker()

2814

3300

tcp_server.server_activate()

2815

3301

2816

3302

# Find out what port we got

2817

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

3303

if zeroconf:

3304

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

2818

3305

if use_ipv6:

2819

3306

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

2820

3307

" flowinfo %d, scope_id %d",

2826

3313

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

2827

3314

2828

3315

try:

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

3316

if zeroconf:

3317

# From the Avahi example code

3318

try:

3319

service.activate()

3320

except dbus.exceptions.DBusException as error:

3321

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

3322

cleanup()

3323

sys.exit(1)

3324

# End of Avahi example code

2837

3325

2838

3326

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

2839

3327

lambda *args, **kwargs:

2854

3342

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

2855

3343

cleanup()

2856

3344

3345

2857

3346

if __name__ == '__main__':

2858

3347

main()