/mandos/trunk : revision 237.4.51

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

39

import SocketServer as socketserver

46

40

import socket

47

41

import argparse

48

42

import datetime

49

43

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

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

54

51

import sys

55

52

import re

56

53

import os

65

62

import struct

66

63

import fcntl

67

64

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

65

import cPickle as pickle

72

66

import multiprocessing

73

67

import types

74

68

import binascii

75

69

import tempfile

76

70

import itertools

77

71

import collections

78

import codecs

79

72

80

73

import dbus

81

74

import dbus.service

82

from gi.repository import GLib

75

import gobject

76

import avahi

83

77

from dbus.mainloop.glib import DBusGMainLoop

84

78

import ctypes

85

79

import ctypes.util

94

88

except ImportError:

95

89

SO_BINDTODEVICE = None

96

90

97

if sys.version_info.major == 2:

98

str = unicode

99

100

version = "1.7.6"

91

version = "1.6.7"

101

92

stored_state_file = "clients.pickle"

102

93

103

94

logger = logging.getLogger()

104

95

syslogger = None

105

96

106

97

try:

107

if_nametoindex = ctypes.cdll.LoadLibrary(

108

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

109

101

except (OSError, AttributeError):

110

111

102

def if_nametoindex(interface):

112

103

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

113

104

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

114

105

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

115

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

116

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

117

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

118

111

return interface_index

119

112

120

113

121

def copy_function(func):

122

"""Make a copy of a function"""

123

if sys.version_info.major == 2:

124

return types.FunctionType(func.func_code,

125

func.func_globals,

126

func.func_name,

127

func.func_defaults,

128

func.func_closure)

129

else:

130

return types.FunctionType(func.__code__,

131

func.__globals__,

132

func.__name__,

133

func.__defaults__,

134

func.__closure__)

135

136

137

114

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

138

115

"""init logger and add loglevel"""

139

116

140

117

global syslogger

141

syslogger = (logging.handlers.SysLogHandler(

142

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

143

address = "/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

144

122

syslogger.setFormatter(logging.Formatter

145

123

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

146

124

' %(message)s'))

163

141

164

142

class PGPEngine(object):

165

143

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

166

167

144

def __init__(self):

168

145

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

169

self.gpg = "gpg"

170

try:

171

output = subprocess.check_output(["gpgconf"])

172

for line in output.splitlines():

173

name, text, path = line.split(b":")

174

if name == "gpg":

175

self.gpg = path

176

break

177

except OSError as e:

178

if e.errno != errno.ENOENT:

179

raise

180

146

self.gnupgargs = ['--batch',

181

'--homedir', self.tempdir,

147

'--home', self.tempdir,

182

148

'--force-mdc',

183

149

'--quiet',

184

150

'--no-use-agent']

219

185

220

186

def encrypt(self, data, password):

221

187

passphrase = self.password_encode(password)

222

with tempfile.NamedTemporaryFile(

223

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

224

190

passfile.write(passphrase)

225

191

passfile.flush()

226

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

192

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

227

193

'--passphrase-file',

228

194

passfile.name]

229

195

+ self.gnupgargs,

237

203

238

204

def decrypt(self, data, password):

239

205

passphrase = self.password_encode(password)

240

with tempfile.NamedTemporaryFile(

241

dir = self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

242

208

passfile.write(passphrase)

243

209

passfile.flush()

244

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

210

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

245

211

'--passphrase-file',

246

212

passfile.name]

247

213

+ self.gnupgargs,

248

214

stdin = subprocess.PIPE,

249

215

stdout = subprocess.PIPE,

250

216

stderr = subprocess.PIPE)

251

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

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

252

219

if proc.returncode != 0:

253

220

raise PGPError(err)

254

221

return decrypted_plaintext

255

222

256

# Pretend that we have an Avahi module

257

class Avahi(object):

258

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

259

It is instantiated once, and simulates having an Avahi module."""

260

IF_UNSPEC = -1 # avahi-common/address.h

261

PROTO_UNSPEC = -1 # avahi-common/address.h

262

PROTO_INET = 0 # avahi-common/address.h

263

PROTO_INET6 = 1 # avahi-common/address.h

264

DBUS_NAME = "org.freedesktop.Avahi"

265

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

266

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

267

DBUS_PATH_SERVER = "/"

268

def string_array_to_txt_array(self, t):

269

return dbus.Array((dbus.ByteArray(s.encode("utf-8"))

270

for s in t), signature="ay")

271

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

272

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

273

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

274

SERVER_INVALID = 0 # avahi-common/defs.h

275

SERVER_REGISTERING = 1 # avahi-common/defs.h

276

SERVER_RUNNING = 2 # avahi-common/defs.h

277

SERVER_COLLISION = 3 # avahi-common/defs.h

278

SERVER_FAILURE = 4 # avahi-common/defs.h

279

avahi = Avahi()

280

223

281

224

class AvahiError(Exception):

282

225

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

283

226

self.value = value

284

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

285

**kwargs)

286

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

287

230

288

231

class AvahiServiceError(AvahiError):

289

232

pass

290

233

291

292

234

class AvahiGroupError(AvahiError):

293

235

pass

294

236

314

256

bus: dbus.SystemBus()

315

257

"""

316

258

317

def __init__(self,

318

interface = avahi.IF_UNSPEC,

319

name = None,

320

servicetype = None,

321

port = None,

322

TXT = None,

323

domain = "",

324

host = "",

325

max_renames = 32768,

326

protocol = avahi.PROTO_UNSPEC,

327

bus = None):

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

328

263

self.interface = interface

329

264

self.name = name

330

265

self.type = servicetype

340

275

self.bus = bus

341

276

self.entry_group_state_changed_match = None

342

277

343

def rename(self, remove=True):

278

def rename(self):

344

279

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

345

280

if self.rename_count >= self.max_renames:

346

281

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

347

282

" after %i retries, exiting.",

348

283

self.rename_count)

349

284

raise AvahiServiceError("Too many renames")

350

self.name = str(

351

self.server.GetAlternativeServiceName(self.name))

352

self.rename_count += 1

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

353

287

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

354

288

self.name)

355

if remove:

356

self.remove()

289

self.remove()

357

290

try:

358

291

self.add()

359

292

except dbus.exceptions.DBusException as error:

360

if (error.get_dbus_name()

361

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

362

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

363

return self.rename(remove=False)

364

else:

365

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

366

self.cleanup()

367

os._exit(1)

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

368

297

369

298

def remove(self):

370

299

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

408

337

self.rename()

409

338

elif state == avahi.ENTRY_GROUP_FAILURE:

410

339

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

411

str(error))

412

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

340

unicode(error))

341

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

342

.format(error))

413

343

414

344

def cleanup(self):

415

345

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

425

355

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

426

356

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

427

357

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

428

bad_states = {

429

avahi.SERVER_INVALID: "Zeroconf server invalid",

430

avahi.SERVER_REGISTERING: None,

431

avahi.SERVER_COLLISION: "Zeroconf server name collision",

432

avahi.SERVER_FAILURE: "Zeroconf server failure",

433

}

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

434

365

if state in bad_states:

435

366

if bad_states[state] is not None:

436

367

if error is None:

439

370

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

440

371

self.cleanup()

441

372

elif state == avahi.SERVER_RUNNING:

442

try:

443

self.add()

444

except dbus.exceptions.DBusException as error:

445

if (error.get_dbus_name()

446

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

447

logger.info("Local Zeroconf service name"

448

" collision.")

449

return self.rename(remove=False)

450

else:

451

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

452

self.cleanup()

453

os._exit(1)

373

self.add()

454

374

else:

455

375

if error is None:

456

376

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

466

386

follow_name_owner_changes=True),

467

387

avahi.DBUS_INTERFACE_SERVER)

468

388

self.server.connect_to_signal("StateChanged",

469

self.server_state_changed)

389

self.server_state_changed)

470

390

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

471

391

472

392

473

393

class AvahiServiceToSyslog(AvahiService):

474

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

394

def rename(self):

475

395

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

476

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

477

syslogger.setFormatter(logging.Formatter(

478

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

479

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

480

401

return ret

481

402

482

# Pretend that we have a GnuTLS module

483

class GnuTLS(object):

484

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

485

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

486

487

_library = ctypes.cdll.LoadLibrary(

488

ctypes.util.find_library("gnutls"))

489

_need_version = b"3.3.0"

490

def __init__(self):

491

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

492

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

493

# happens.

494

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

495

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

496

.format(self._need_version))

497

498

# Unless otherwise indicated, the constants and types below are

499

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

500

501

# Constants

502

E_SUCCESS = 0

503

E_INTERRUPTED = -52

504

E_AGAIN = -28

505

CRT_OPENPGP = 2

506

CLIENT = 2

507

SHUT_RDWR = 0

508

CRD_CERTIFICATE = 1

509

E_NO_CERTIFICATE_FOUND = -49

510

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

511

512

# Types

513

class session_int(ctypes.Structure):

514

_fields_ = []

515

session_t = ctypes.POINTER(session_int)

516

class certificate_credentials_st(ctypes.Structure):

517

_fields_ = []

518

certificate_credentials_t = ctypes.POINTER(

519

certificate_credentials_st)

520

certificate_type_t = ctypes.c_int

521

class datum_t(ctypes.Structure):

522

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

523

('size', ctypes.c_uint)]

524

class openpgp_crt_int(ctypes.Structure):

525

_fields_ = []

526

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

527

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

528

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

529

credentials_type_t = ctypes.c_int

530

transport_ptr_t = ctypes.c_void_p

531

close_request_t = ctypes.c_int

532

533

# Exceptions

534

class Error(Exception):

535

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

536

# exception might be raised from within GnuTLS.__init__,

537

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

538

# global variable has happened.

539

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

540

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

541

# code is passed, convert it to a string with

542

# gnutls.strerror()

543

self.code = code

544

if message is None and code is not None:

545

message = GnuTLS.strerror(code)

546

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

547

message, *args)

548

549

class CertificateSecurityError(Error):

550

pass

551

552

# Classes

553

class Credentials(object):

554

def __init__(self):

555

self._c_object = gnutls.certificate_credentials_t()

556

gnutls.certificate_allocate_credentials(

557

ctypes.byref(self._c_object))

558

self.type = gnutls.CRD_CERTIFICATE

559

560

def __del__(self):

561

gnutls.certificate_free_credentials(self._c_object)

562

563

class ClientSession(object):

564

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

565

self._c_object = gnutls.session_t()

566

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

567

gnutls.set_default_priority(self._c_object)

568

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

569

gnutls.handshake_set_private_extensions(self._c_object,

570

True)

571

self.socket = socket

572

if credentials is None:

573

credentials = gnutls.Credentials()

574

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

575

ctypes.cast(credentials._c_object,

576

ctypes.c_void_p))

577

self.credentials = credentials

578

579

def __del__(self):

580

gnutls.deinit(self._c_object)

581

582

def handshake(self):

583

return gnutls.handshake(self._c_object)

584

585

def send(self, data):

586

data = bytes(data)

587

data_len = len(data)

588

while data_len > 0:

589

data_len -= gnutls.record_send(self._c_object,

590

data[-data_len:],

591

data_len)

592

593

def bye(self):

594

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

595

596

# Error handling functions

597

def _error_code(result):

598

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

599

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

600

if result >= 0:

601

return result

602

if result == gnutls.E_NO_CERTIFICATE_FOUND:

603

raise gnutls.CertificateSecurityError(code = result)

604

raise gnutls.Error(code = result)

605

606

def _retry_on_error(result, func, arguments):

607

"""A function to retry on some errors, suitable

608

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

609

while result < 0:

610

if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):

611

return _error_code(result)

612

result = func(*arguments)

613

return result

614

615

# Unless otherwise indicated, the function declarations below are

616

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

617

618

# Functions

619

priority_set_direct = _library.gnutls_priority_set_direct

620

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

621

ctypes.POINTER(ctypes.c_char_p)]

622

priority_set_direct.restype = _error_code

623

624

init = _library.gnutls_init

625

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

626

init.restype = _error_code

627

628

set_default_priority = _library.gnutls_set_default_priority

629

set_default_priority.argtypes = [session_t]

630

set_default_priority.restype = _error_code

631

632

record_send = _library.gnutls_record_send

633

record_send.argtypes = [session_t, ctypes.c_void_p,

634

ctypes.c_size_t]

635

record_send.restype = ctypes.c_ssize_t

636

record_send.errcheck = _retry_on_error

637

638

certificate_allocate_credentials = (

639

_library.gnutls_certificate_allocate_credentials)

640

certificate_allocate_credentials.argtypes = [

641

ctypes.POINTER(certificate_credentials_t)]

642

certificate_allocate_credentials.restype = _error_code

643

644

certificate_free_credentials = (

645

_library.gnutls_certificate_free_credentials)

646

certificate_free_credentials.argtypes = [certificate_credentials_t]

647

certificate_free_credentials.restype = None

648

649

handshake_set_private_extensions = (

650

_library.gnutls_handshake_set_private_extensions)

651

handshake_set_private_extensions.argtypes = [session_t,

652

ctypes.c_int]

653

handshake_set_private_extensions.restype = None

654

655

credentials_set = _library.gnutls_credentials_set

656

credentials_set.argtypes = [session_t, credentials_type_t,

657

ctypes.c_void_p]

658

credentials_set.restype = _error_code

659

660

strerror = _library.gnutls_strerror

661

strerror.argtypes = [ctypes.c_int]

662

strerror.restype = ctypes.c_char_p

663

664

certificate_type_get = _library.gnutls_certificate_type_get

665

certificate_type_get.argtypes = [session_t]

666

certificate_type_get.restype = _error_code

667

668

certificate_get_peers = _library.gnutls_certificate_get_peers

669

certificate_get_peers.argtypes = [session_t,

670

ctypes.POINTER(ctypes.c_uint)]

671

certificate_get_peers.restype = ctypes.POINTER(datum_t)

672

673

global_set_log_level = _library.gnutls_global_set_log_level

674

global_set_log_level.argtypes = [ctypes.c_int]

675

global_set_log_level.restype = None

676

677

global_set_log_function = _library.gnutls_global_set_log_function

678

global_set_log_function.argtypes = [log_func]

679

global_set_log_function.restype = None

680

681

deinit = _library.gnutls_deinit

682

deinit.argtypes = [session_t]

683

deinit.restype = None

684

685

handshake = _library.gnutls_handshake

686

handshake.argtypes = [session_t]

687

handshake.restype = _error_code

688

handshake.errcheck = _retry_on_error

689

690

transport_set_ptr = _library.gnutls_transport_set_ptr

691

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

692

transport_set_ptr.restype = None

693

694

bye = _library.gnutls_bye

695

bye.argtypes = [session_t, close_request_t]

696

bye.restype = _error_code

697

bye.errcheck = _retry_on_error

698

699

check_version = _library.gnutls_check_version

700

check_version.argtypes = [ctypes.c_char_p]

701

check_version.restype = ctypes.c_char_p

702

703

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

704

705

openpgp_crt_init = _library.gnutls_openpgp_crt_init

706

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

707

openpgp_crt_init.restype = _error_code

708

709

openpgp_crt_import = _library.gnutls_openpgp_crt_import

710

openpgp_crt_import.argtypes = [openpgp_crt_t,

711

ctypes.POINTER(datum_t),

712

openpgp_crt_fmt_t]

713

openpgp_crt_import.restype = _error_code

714

715

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

716

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

717

ctypes.POINTER(ctypes.c_uint)]

718

openpgp_crt_verify_self.restype = _error_code

719

720

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

721

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

722

openpgp_crt_deinit.restype = None

723

724

openpgp_crt_get_fingerprint = (

725

_library.gnutls_openpgp_crt_get_fingerprint)

726

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

727

ctypes.c_void_p,

728

ctypes.POINTER(

729

ctypes.c_size_t)]

730

openpgp_crt_get_fingerprint.restype = _error_code

731

732

# Remove non-public functions

733

del _error_code, _retry_on_error

734

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

735

gnutls = GnuTLS()

736

737

def call_pipe(connection, # : multiprocessing.Connection

738

func, *args, **kwargs):

739

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

740

741

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

742

return value on the provided multiprocessing.Connection.

743

"""

744

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

745

connection.close()

403

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

746

410

747

411

class Client(object):

748

412

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

754

418

checker: subprocess.Popen(); a running checker process used

755

419

to see if the client lives.

756

420

'None' if no process is running.

757

checker_callback_tag: a GLib event source tag, or None

421

checker_callback_tag: a gobject event source tag, or None

758

422

checker_command: string; External command which is run to check

759

423

if client lives. %() expansions are done at

760

424

runtime with vars(self) as dict, so that for

761

425

instance %(name)s can be used in the command.

762

checker_initiator_tag: a GLib event source tag, or None

426

checker_initiator_tag: a gobject event source tag, or None

763

427

created: datetime.datetime(); (UTC) object creation

764

428

client_structure: Object describing what attributes a client has

765

429

and is used for storing the client at exit

766

430

current_checker_command: string; current running checker_command

767

disable_initiator_tag: a GLib event source tag, or None

431

disable_initiator_tag: a gobject event source tag, or None

768

432

enabled: bool()

769

433

fingerprint: string (40 or 32 hexadecimal digits); used to

770

434

uniquely identify the client

775

439

last_checker_status: integer between 0 and 255 reflecting exit

776

440

status of last checker. -1 reflects crashed

777

441

checker, -2 means no checker completed yet.

778

last_checker_signal: The signal which killed the last checker, if

779

last_checker_status is -1

780

442

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

781

443

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

782

444

D-Bus identifiers

795

457

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

796

458

"last_approval_request", "last_checked_ok",

797

459

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

798

client_defaults = {

799

"timeout": "PT5M",

800

"extended_timeout": "PT15M",

801

"interval": "PT2M",

802

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

803

"host": "",

804

"approval_delay": "PT0S",

805

"approval_duration": "PT1S",

806

"approved_by_default": "True",

807

"enabled": "True",

808

}

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

809

485

810

486

@staticmethod

811

487

def config_parser(config):

827

503

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

828

504

"enabled")

829

505

830

# Uppercase and remove spaces from fingerprint for later

831

# comparison purposes with return value from the

832

# fingerprint() function

833

506

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

834

507

.replace(" ", ""))

835

508

if "secret" in section:

836

client["secret"] = codecs.decode(section["secret"]

837

.encode("utf-8"),

838

"base64")

509

client["secret"] = section["secret"].decode("base64")

839

510

elif "secfile" in section:

840

511

with open(os.path.expanduser(os.path.expandvars

841

512

(section["secfile"])),

842

513

"rb") as secfile:

843

514

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

844

515

else:

845

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

516

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

846

517

.format(section))

847

518

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

848

519

client["extended_timeout"] = string_to_delta(

865

536

server_settings = {}

866

537

self.server_settings = server_settings

867

538

# adding all client settings

868

for setting, value in settings.items():

539

for setting, value in settings.iteritems():

869

540

setattr(self, setting, value)

870

541

871

542

if self.enabled:

879

550

self.expires = None

880

551

881

552

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

882

556

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

883

557

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

884

558

datetime.datetime.utcnow())

891

565

self.current_checker_command = None

892

566

self.approved = None

893

567

self.approvals_pending = 0

894

self.changedstate = multiprocessing_manager.Condition(

895

multiprocessing_manager.Lock())

896

self.client_structure = [attr

897

for attr in self.__dict__.keys()

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

898

573

if not attr.startswith("_")]

899

574

self.client_structure.append("client_structure")

900

575

901

for name, t in inspect.getmembers(

902

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

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

903

580

if not name.startswith("_"):

904

581

self.client_structure.append(name)

905

582

926

603

if not quiet:

927

604

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

928

605

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

929

GLib.source_remove(self.disable_initiator_tag)

606

gobject.source_remove(self.disable_initiator_tag)

930

607

self.disable_initiator_tag = None

931

608

self.expires = None

932

609

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

933

GLib.source_remove(self.checker_initiator_tag)

610

gobject.source_remove(self.checker_initiator_tag)

934

611

self.checker_initiator_tag = None

935

612

self.stop_checker()

936

613

self.enabled = False

937

614

if not quiet:

938

615

self.send_changedstate()

939

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

616

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

940

617

return False

941

618

942

619

def __del__(self):

946

623

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

947

624

# and every interval from then on.

948

625

if self.checker_initiator_tag is not None:

949

GLib.source_remove(self.checker_initiator_tag)

950

self.checker_initiator_tag = GLib.timeout_add(

951

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

952

self.start_checker)

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

953

630

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

954

631

if self.disable_initiator_tag is not None:

955

GLib.source_remove(self.disable_initiator_tag)

956

self.disable_initiator_tag = GLib.timeout_add(

957

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

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

958

636

# Also start a new checker *right now*.

959

637

self.start_checker()

960

638

961

def checker_callback(self, source, condition, connection,

962

command):

639

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

963

640

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

964

641

self.checker_callback_tag = None

965

642

self.checker = None

966

# Read return code from connection (see call_pipe)

967

returncode = connection.recv()

968

connection.close()

969

970

if returncode >= 0:

971

self.last_checker_status = returncode

972

self.last_checker_signal = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

973

645

if self.last_checker_status == 0:

974

646

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

975

647

vars(self))

976

648

self.checked_ok()

977

649

else:

978

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

650

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

651

vars(self))

979

652

else:

980

653

self.last_checker_status = -1

981

self.last_checker_signal = -returncode

982

654

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

983

655

vars(self))

984

return False

985

656

986

657

def checked_ok(self):

987

658

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

988

659

self.last_checked_ok = datetime.datetime.utcnow()

989

660

self.last_checker_status = 0

990

self.last_checker_signal = None

991

661

self.bump_timeout()

992

662

993

663

def bump_timeout(self, timeout=None):

995

665

if timeout is None:

996

666

timeout = self.timeout

997

667

if self.disable_initiator_tag is not None:

998

GLib.source_remove(self.disable_initiator_tag)

668

gobject.source_remove(self.disable_initiator_tag)

999

669

self.disable_initiator_tag = None

1000

670

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

1001

self.disable_initiator_tag = GLib.timeout_add(

1002

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1003

674

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

1004

675

1005

676

def need_approval(self):

1019

690

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

1020

691

# should be.

1021

692

1022

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

1023

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

1024

self.checker.join()

1025

self.checker = None

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1026

707

# Start a new checker if needed

1027

708

if self.checker is None:

1028

709

# Escape attributes for the shell

1029

escaped_attrs = {

1030

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

1031

for attr in self.runtime_expansions }

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1032

714

try:

1033

715

command = self.checker_command % escaped_attrs

1034

716

except TypeError as error:

1035

717

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

1036

self.checker_command,

718

self.checker_command, exc_info=error)

719

return True # Try again later

720

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

1037

742

exc_info=error)

1038

return True # Try again later

1039

self.current_checker_command = command

1040

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

1041

self.name)

1042

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

1043

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

1044

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

1045

# always replaced by /dev/null.)

1046

# The exception is when not debugging but nevertheless

1047

# running in the foreground; use the previously

1048

# created wnull.

1049

popen_args = { "close_fds": True,

1050

"shell": True,

1051

"cwd": "/" }

1052

if (not self.server_settings["debug"]

1053

and self.server_settings["foreground"]):

1054

popen_args.update({"stdout": wnull,

1055

"stderr": wnull })

1056

pipe = multiprocessing.Pipe(duplex = False)

1057

self.checker = multiprocessing.Process(

1058

target = call_pipe,

1059

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

1060

kwargs = popen_args)

1061

self.checker.start()

1062

self.checker_callback_tag = GLib.io_add_watch(

1063

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

1064

self.checker_callback, pipe[0], command)

1065

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

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1066

763

return True

1067

764

1068

765

def stop_checker(self):

1069

766

"""Force the checker process, if any, to stop."""

1070

767

if self.checker_callback_tag:

1071

GLib.source_remove(self.checker_callback_tag)

768

gobject.source_remove(self.checker_callback_tag)

1072

769

self.checker_callback_tag = None

1073

770

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

1074

771

return

1075

772

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

1076

self.checker.terminate()

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1077

781

self.checker = None

1078

782

1079

783

1080

def dbus_service_property(dbus_interface,

1081

signature="v",

1082

access="readwrite",

1083

byte_arrays=False):

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1084

786

"""Decorators for marking methods of a DBusObjectWithProperties to

1085

787

become properties on the D-Bus.

1086

788

1095

797

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

1096

798

if byte_arrays and signature != "ay":

1097

799

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

1098

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

1099

800

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

1100

801

def decorator(func):

1101

802

func._dbus_is_property = True

1102

803

func._dbus_interface = dbus_interface

1107

808

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

1108

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1109

810

return func

1110

1111

811

return decorator

1112

812

1113

813

1122

822

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

1123

823

"false"}

1124

824

"""

1125

1126

825

def decorator(func):

1127

826

func._dbus_is_interface = True

1128

827

func._dbus_interface = dbus_interface

1129

828

func._dbus_name = dbus_interface

1130

829

return func

1131

1132

830

return decorator

1133

831

1134

832

1136

834

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

1137

835

Usage:

1138

836

1139

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

1140

"org.freedesktop.DBus.Property."

1141

"EmitsChangedSignal": "false"})

1142

837

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

1143

838

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

1144

842

def Property_dbus_property(self):

1145

843

return dbus.Boolean(False)

1146

1147

See also the DBusObjectWithAnnotations class.

1148

844

"""

1149

1150

845

def decorator(func):

1151

846

func._dbus_annotations = annotations

1152

847

return func

1153

1154

848

return decorator

1155

849

1156

850

1157

851

class DBusPropertyException(dbus.exceptions.DBusException):

1158

852

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

1159

853

"""

1160

pass

854

def __unicode__(self):

855

return unicode(str(self))

1161

856

1162

857

1163

858

class DBusPropertyAccessException(DBusPropertyException):

1172

867

pass

1173

868

1174

869

1175

class DBusObjectWithAnnotations(dbus.service.Object):

1176

"""A D-Bus object with annotations.

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

1177

872

1178

Classes inheriting from this can use the dbus_annotations

1179

decorator to add annotations to methods or signals.

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1180

876

"""

1181

877

1182

878

@staticmethod

1186

882

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

1187

883

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

1188

884

"""

1189

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

885

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

1190

886

False)

1191

887

1192

888

def _get_all_dbus_things(self, thing):

1193

889

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

1194

890

"""

1195

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

891

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

892

name),

1196

893

athing.__get__(self))

1197

894

for cls in self.__class__.__mro__

1198

895

for name, athing in

1199

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

1200

1201

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1202

out_signature = "s",

1203

path_keyword = 'object_path',

1204

connection_keyword = 'connection')

1205

def Introspect(self, object_path, connection):

1206

"""Overloading of standard D-Bus method.

1207

1208

Inserts annotation tags on methods and signals.

1209

"""

1210

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

1211

connection)

1212

try:

1213

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

1214

1215

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

1216

# Add annotation tags

1217

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

1218

for tag in if_tag.getElementsByTagName(typ):

1219

annots = dict()

1220

for name, prop in (self.

1221

_get_all_dbus_things(typ)):

1222

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

1223

and prop._dbus_interface

1224

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

1225

annots.update(getattr(

1226

prop, "_dbus_annotations", {}))

1227

for name, value in annots.items():

1228

ann_tag = document.createElement(

1229

"annotation")

1230

ann_tag.setAttribute("name", name)

1231

ann_tag.setAttribute("value", value)

1232

tag.appendChild(ann_tag)

1233

# Add interface annotation tags

1234

for annotation, value in dict(

1235

itertools.chain.from_iterable(

1236

annotations().items()

1237

for name, annotations

1238

in self._get_all_dbus_things("interface")

1239

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

1240

)).items():

1241

ann_tag = document.createElement("annotation")

1242

ann_tag.setAttribute("name", annotation)

1243

ann_tag.setAttribute("value", value)

1244

if_tag.appendChild(ann_tag)

1245

# Fix argument name for the Introspect method itself

1246

if (if_tag.getAttribute("name")

1247

== dbus.INTROSPECTABLE_IFACE):

1248

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

1249

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

1250

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

1251

if (arg.getAttribute("direction")

1252

== "out"):

1253

arg.setAttribute("name",

1254

"xml_data")

1255

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

1256

document.unlink()

1257

except (AttributeError, xml.dom.DOMException,

1258

xml.parsers.expat.ExpatError) as error:

1259

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

1260

exc_info=error)

1261

return xmlstring

1262

1263

1264

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1265

"""A D-Bus object with properties.

1266

1267

Classes inheriting from this can use the dbus_service_property

1268

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

1269

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

1270

"""

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

1271

898

1272

899

def _get_dbus_property(self, interface_name, property_name):

1273

900

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

1274

901

property with the specified name and interface.

1275

902

"""

1276

for cls in self.__class__.__mro__:

1277

for name, value in inspect.getmembers(

1278

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

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1279

907

if (value._dbus_name == property_name

1280

908

and value._dbus_interface == interface_name):

1281

909

return value.__get__(self)

1282

910

1283

911

# No such property

1284

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

1285

self.dbus_object_path, interface_name, property_name))

1286

1287

@classmethod

1288

def _get_all_interface_names(cls):

1289

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

1290

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

1291

"_dbus_interface", None)

1292

for x in (inspect.getmro(cls))

1293

for attr in dir(x))

1294

if name is not None)

1295

1296

@dbus.service.method(dbus.PROPERTIES_IFACE,

1297

in_signature="ss",

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1298

917

out_signature="v")

1299

918

def Get(self, interface_name, property_name):

1300

919

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

1319

938

# signatures other than "ay".

1320

939

if prop._dbus_signature != "ay":

1321

940

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

1322

"'ay' signature {!r}"

941

"'ay' signature {0!r}"

1323

942

.format(prop._dbus_signature))

1324

943

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

1325

944

for byte in value))

1326

945

prop(value)

1327

946

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="s",

947

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

1330

948

out_signature="a{sv}")

1331

949

def GetAll(self, interface_name):

1332

950

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

1347

965

if not hasattr(value, "variant_level"):

1348

966

properties[name] = value

1349

967

continue

1350

properties[name] = type(value)(

1351

value, variant_level = value.variant_level + 1)

968

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

969

value.variant_level+1)

1352

970

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

1353

971

1354

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

1355

def PropertiesChanged(self, interface_name, changed_properties,

1356

invalidated_properties):

1357

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

1358

standard.

1359

"""

1360

pass

1361

1362

972

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

973

out_signature="s",

1364

974

path_keyword='object_path',

1368

978

1369

979

Inserts property tags and interface annotation tags.

1370

980

"""

1371

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1372

object_path,

1373

connection)

981

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

982

connection)

1374

983

try:

1375

984

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

1376

1377

985

def make_tag(document, name, prop):

1378

986

e = document.createElement("property")

1379

987

e.setAttribute("name", name)

1380

988

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

1381

989

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

1382

990

return e

1383

1384

991

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

1385

992

# Add property tags

1386

993

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

1389

996

if prop._dbus_interface

1390

997

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

1391

998

if_tag.appendChild(tag)

1392

# Add annotation tags for properties

1393

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

1394

annots = dict()

1395

for name, prop in self._get_all_dbus_things(

1396

"property"):

1397

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

1398

and prop._dbus_interface

1399

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

1400

annots.update(getattr(

1401

prop, "_dbus_annotations", {}))

1402

for name, value in annots.items():

1403

ann_tag = document.createElement(

1404

"annotation")

1405

ann_tag.setAttribute("name", name)

1406

ann_tag.setAttribute("value", value)

1407

tag.appendChild(ann_tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1408

1030

# Add the names to the return values for the

1409

1031

# "org.freedesktop.DBus.Properties" methods

1410

1032

if (if_tag.getAttribute("name")

1428

1050

exc_info=error)

1429

1051

return xmlstring

1430

1052

1431

try:

1432

dbus.OBJECT_MANAGER_IFACE

1433

except AttributeError:

1434

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

1435

1436

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1437

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

1438

1439

Classes inheriting from this exposes the standard

1440

GetManagedObjects call and the InterfacesAdded and

1441

InterfacesRemoved signals on the standard

1442

"org.freedesktop.DBus.ObjectManager" interface.

1443

1444

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

1445

manually.

1446

"""

1447

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1448

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

1449

def GetManagedObjects(self):

1450

"""This function must be overridden"""

1451

raise NotImplementedError()

1452

1453

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1454

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

1455

def InterfacesAdded(self, object_path, interfaces_and_properties):

1456

pass

1457

1458

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

1459

def InterfacesRemoved(self, object_path, interfaces):

1460

pass

1461

1462

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1463

out_signature = "s",

1464

path_keyword = 'object_path',

1465

connection_keyword = 'connection')

1466

def Introspect(self, object_path, connection):

1467

"""Overloading of standard D-Bus method.

1468

1469

Override return argument name of GetManagedObjects to be

1470

"objpath_interfaces_and_properties"

1471

"""

1472

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1473

object_path,

1474

connection)

1475

try:

1476

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

1477

1478

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

1479

# Fix argument name for the GetManagedObjects method

1480

if (if_tag.getAttribute("name")

1481

== dbus.OBJECT_MANAGER_IFACE):

1482

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

1483

if (cn.getAttribute("name")

1484

== "GetManagedObjects"):

1485

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

1486

if (arg.getAttribute("direction")

1487

== "out"):

1488

arg.setAttribute(

1489

"name",

1490

"objpath_interfaces"

1491

"_and_properties")

1492

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

1493

document.unlink()

1494

except (AttributeError, xml.dom.DOMException,

1495

xml.parsers.expat.ExpatError) as error:

1496

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

1497

exc_info = error)

1498

return xmlstring

1499

1053

1500

1054

def datetime_to_dbus(dt, variant_level=0):

1501

1055

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

1502

1056

if dt is None:

1503

1057

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

1504

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1505

1060

1506

1061

1507

1062

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1527

1082

(from DBusObjectWithProperties) and interfaces (from the

1528

1083

dbus_interface_annotations decorator).

1529

1084

"""

1530

1531

1085

def wrapper(cls):

1532

1086

for orig_interface_name, alt_interface_name in (

1533

alt_interface_names.items()):

1087

alt_interface_names.iteritems()):

1534

1088

attr = {}

1535

1089

interface_names = set()

1536

1090

# Go though all attributes of the class

1538

1092

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

1539

1093

# with the wrong interface name

1540

1094

if (not hasattr(attribute, "_dbus_interface")

1541

or not attribute._dbus_interface.startswith(

1542

orig_interface_name)):

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1543

1097

continue

1544

1098

# Create an alternate D-Bus interface name based on

1545

1099

# the current name

1546

alt_interface = attribute._dbus_interface.replace(

1547

orig_interface_name, alt_interface_name)

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1548

1103

interface_names.add(alt_interface)

1549

1104

# Is this a D-Bus signal?

1550

1105

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

1551

1106

# Extract the original non-method undecorated

1552

1107

# function by black magic

1553

if sys.version_info.major == 2:

1554

nonmethod_func = (dict(

1108

nonmethod_func = (dict(

1555

1109

zip(attribute.func_code.co_freevars,

1556

attribute.__closure__))

1557

["func"].cell_contents)

1558

else:

1559

nonmethod_func = (dict(

1560

zip(attribute.__code__.co_freevars,

1561

attribute.__closure__))

1562

["func"].cell_contents)

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1563

1112

# Create a new, but exactly alike, function

1564

1113

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

1565

1114

# with the alternate D-Bus interface name

1566

new_function = copy_function(nonmethod_func)

1567

new_function = (dbus.service.signal(

1568

alt_interface,

1569

attribute._dbus_signature)(new_function))

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1570

1124

# Copy annotations, if any

1571

1125

try:

1572

new_function._dbus_annotations = dict(

1573

attribute._dbus_annotations)

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1574

1128

except AttributeError:

1575

1129

pass

1576

1130

# Define a creator of a function to call both the

1581

1135

"""This function is a scope container to pass

1582

1136

func1 and func2 to the "call_both" function

1583

1137

outside of its arguments"""

1584

1585

@functools.wraps(func2)

1586

1138

def call_both(*args, **kwargs):

1587

1139

"""This function will emit two D-Bus

1588

1140

signals by calling func1 and func2"""

1589

1141

func1(*args, **kwargs)

1590

1142

func2(*args, **kwargs)

1591

# Make wrapper function look like a D-Bus signal

1592

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

1593

if name.startswith("_dbus_"):

1594

setattr(call_both, name, attr)

1595

1596

1143

return call_both

1597

1144

# Create the "call_both" function and add it to

1598

1145

# the class

1603

1150

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

1604

1151

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

1605

1152

# to the class.

1606

attr[attrname] = (

1607

dbus.service.method(

1608

alt_interface,

1609

attribute._dbus_in_signature,

1610

attribute._dbus_out_signature)

1611

(copy_function(attribute)))

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1612

1163

# Copy annotations, if any

1613

1164

try:

1614

attr[attrname]._dbus_annotations = dict(

1615

attribute._dbus_annotations)

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1616

1167

except AttributeError:

1617

1168

pass

1618

1169

# Is this a D-Bus property?

1621

1172

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

1622

1173

# property with the alternate D-Bus interface

1623

1174

# name. Add it to the class.

1624

attr[attrname] = (dbus_service_property(

1625

alt_interface, attribute._dbus_signature,

1626

attribute._dbus_access,

1627

attribute._dbus_get_args_options

1628

["byte_arrays"])

1629

(copy_function(attribute)))

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1630

1188

# Copy annotations, if any

1631

1189

try:

1632

attr[attrname]._dbus_annotations = dict(

1633

attribute._dbus_annotations)

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1634

1192

except AttributeError:

1635

1193

pass

1636

1194

# Is this a D-Bus interface?

1639

1197

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

1640

1198

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

1641

1199

# to the class.

1642

attr[attrname] = (

1643

dbus_interface_annotations(alt_interface)

1644

(copy_function(attribute)))

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1645

1208

if deprecate:

1646

1209

# Deprecate all alternate interfaces

1647

iname="_AlternateDBusNames_interface_annotation{}"

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1648

1211

for interface_name in interface_names:

1649

1650

1212

@dbus_interface_annotations(interface_name)

1651

1213

def func(self):

1652

1214

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

1653

"true" }

1215

"true" }

1654

1216

# Find an unused name

1655

1217

for aname in (iname.format(i)

1656

1218

for i in itertools.count()):

1660

1222

if interface_names:

1661

1223

# Replace the class with a new subclass of it with

1662

1224

# methods, signals, etc. as created above.

1663

if sys.version_info.major == 2:

1664

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

1665

(cls, ), attr)

1666

else:

1667

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

1668

(cls, ), attr)

1225

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

1226

(cls,), attr)

1669

1227

return cls

1670

1671

1228

return wrapper

1672

1229

1673

1230

1674

1231

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

1675

"se.bsnet.fukt.Mandos"})

1232

"se.bsnet.fukt.Mandos"})

1676

1233

class ClientDBus(Client, DBusObjectWithProperties):

1677

1234

"""A Client class using D-Bus

1678

1235

1682

1239

"""

1683

1240

1684

1241

runtime_expansions = (Client.runtime_expansions

1685

+ ("dbus_object_path", ))

1686

1687

_interface = "se.recompile.Mandos.Client"

1242

+ ("dbus_object_path",))

1688

1243

1689

1244

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

1690

1245

1693

1248

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

1694

1249

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

1695

1250

# the D-Bus

1696

client_object_name = str(self.name).translate(

1251

client_object_name = unicode(self.name).translate(

1697

1252

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

1698

1253

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

1699

self.dbus_object_path = dbus.ObjectPath(

1700

"/clients/" + client_object_name)

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1701

1256

DBusObjectWithProperties.__init__(self, self.bus,

1702

1257

self.dbus_object_path)

1703

1258

1704

def notifychangeproperty(transform_func, dbus_name,

1705

type_func=lambda x: x,

1706

variant_level=1,

1707

invalidate_only=False,

1708

_interface=_interface):

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1709

1262

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

1710

1263

its changes to DBus.

1711

1264

1716

1269

to the D-Bus. Default: no transform

1717

1270

variant_level: D-Bus variant level. Default: 1

1718

1271

"""

1719

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

1720

1272

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

1721

1273

def setter(self, value):

1722

1274

if hasattr(self, "dbus_object_path"):

1723

1275

if (not hasattr(self, attrname) or

1724

1276

type_func(getattr(self, attrname, None))

1725

1277

!= type_func(value)):

1726

if invalidate_only:

1727

self.PropertiesChanged(

1728

_interface, dbus.Dictionary(),

1729

dbus.Array((dbus_name, )))

1730

else:

1731

dbus_value = transform_func(

1732

type_func(value),

1733

variant_level = variant_level)

1734

self.PropertyChanged(dbus.String(dbus_name),

1735

dbus_value)

1736

self.PropertiesChanged(

1737

_interface,

1738

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

1739

dbus_value }),

1740

dbus.Array())

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1741

1283

setattr(self, attrname, value)

1742

1284

1743

1285

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

1749

1291

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

1750

1292

last_enabled = notifychangeproperty(datetime_to_dbus,

1751

1293

"LastEnabled")

1752

checker = notifychangeproperty(

1753

dbus.Boolean, "CheckerRunning",

1754

type_func = lambda checker: checker is not None)

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1755

1297

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1756

1298

"LastCheckedOK")

1757

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1760

1302

datetime_to_dbus, "LastApprovalRequest")

1761

1303

approved_by_default = notifychangeproperty(dbus.Boolean,

1762

1304

"ApprovedByDefault")

1763

approval_delay = notifychangeproperty(

1764

dbus.UInt64, "ApprovalDelay",

1765

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

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1766

1309

approval_duration = notifychangeproperty(

1767

1310

dbus.UInt64, "ApprovalDuration",

1768

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

1311

type_func = timedelta_to_milliseconds)

1769

1312

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

1770

timeout = notifychangeproperty(

1771

dbus.UInt64, "Timeout",

1772

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1773

1316

extended_timeout = notifychangeproperty(

1774

1317

dbus.UInt64, "ExtendedTimeout",

1775

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

1776

interval = notifychangeproperty(

1777

dbus.UInt64, "Interval",

1778

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

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1779

1323

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

1780

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

1781

invalidate_only=True)

1782

1324

1783

1325

del notifychangeproperty

1784

1326

1791

1333

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

1792

1334

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

1793

1335

1794

def checker_callback(self, source, condition,

1795

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

1796

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

1797

connection, command, *args,

1798

**kwargs)

1799

exitstatus = self.last_checker_status

1800

if exitstatus >= 0:

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1801

1342

# Emit D-Bus signal

1802

1343

self.CheckerCompleted(dbus.Int16(exitstatus),

1803

# This is specific to GNU libC

1804

dbus.Int64(exitstatus << 8),

1344

dbus.Int64(condition),

1805

1345

dbus.String(command))

1806

1346

else:

1807

1347

# Emit D-Bus signal

1808

1348

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

1809

dbus.Int64(

1810

# This is specific to GNU libC

1811

(exitstatus << 8)

1812

| self.last_checker_signal),

1349

dbus.Int64(condition),

1813

1350

dbus.String(command))

1814

return ret

1351

1352

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

1353

*args, **kwargs)

1815

1354

1816

1355

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

1817

1356

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

1829

1368

1830

1369

def approve(self, value=True):

1831

1370

self.approved = value

1832

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

1833

* 1000), self._reset_approved)

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1834

1374

self.send_changedstate()

1835

1375

1836

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1837

1378

1838

1379

## Interfaces

1839

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1840

1386

## Signals

1841

1387

1842

1388

# CheckerCompleted - signal

1852

1398

pass

1853

1399

1854

1400

# PropertyChanged - signal

1855

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

1856

1401

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

1857

1402

def PropertyChanged(self, property, value):

1858

1403

"D-Bus signal"

1892

1437

self.checked_ok()

1893

1438

1894

1439

# Enable - method

1895

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

1896

1440

@dbus.service.method(_interface)

1897

1441

def Enable(self):

1898

1442

"D-Bus method"

1899

1443

self.enable()

1900

1444

1901

1445

# StartChecker - method

1902

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

1903

1446

@dbus.service.method(_interface)

1904

1447

def StartChecker(self):

1905

1448

"D-Bus method"

1906

1449

self.start_checker()

1907

1450

1908

1451

# Disable - method

1909

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

1910

1452

@dbus.service.method(_interface)

1911

1453

def Disable(self):

1912

1454

"D-Bus method"

1913

1455

self.disable()

1914

1456

1915

1457

# StopChecker - method

1916

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

1917

1458

@dbus.service.method(_interface)

1918

1459

def StopChecker(self):

1919

1460

self.stop_checker()

1926

1467

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

1927

1468

1928

1469

# ApprovedByDefault - property

1929

@dbus_service_property(_interface,

1930

signature="b",

1470

@dbus_service_property(_interface, signature="b",

1931

1471

access="readwrite")

1932

1472

def ApprovedByDefault_dbus_property(self, value=None):

1933

1473

if value is None: # get

1935

1475

self.approved_by_default = bool(value)

1936

1476

1937

1477

# ApprovalDelay - property

1938

@dbus_service_property(_interface,

1939

signature="t",

1478

@dbus_service_property(_interface, signature="t",

1940

1479

access="readwrite")

1941

1480

def ApprovalDelay_dbus_property(self, value=None):

1942

1481

if value is None: # get

1943

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

1944

* 1000)

1482

return dbus.UInt64(self.approval_delay_milliseconds())

1945

1483

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

1946

1484

1947

1485

# ApprovalDuration - property

1948

@dbus_service_property(_interface,

1949

signature="t",

1486

@dbus_service_property(_interface, signature="t",

1950

1487

access="readwrite")

1951

1488

def ApprovalDuration_dbus_property(self, value=None):

1952

1489

if value is None: # get

1953

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

1954

* 1000)

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

1955

1492

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

1956

1493

1957

1494

# Name - property

1958

@dbus_annotations(

1959

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

1960

1495

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

1961

1496

def Name_dbus_property(self):

1962

1497

return dbus.String(self.name)

1963

1498

1964

1499

# Fingerprint - property

1965

@dbus_annotations(

1966

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

1967

1500

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

1968

1501

def Fingerprint_dbus_property(self):

1969

1502

return dbus.String(self.fingerprint)

1970

1503

1971

1504

# Host - property

1972

@dbus_service_property(_interface,

1973

signature="s",

1505

@dbus_service_property(_interface, signature="s",

1974

1506

access="readwrite")

1975

1507

def Host_dbus_property(self, value=None):

1976

1508

if value is None: # get

1977

1509

return dbus.String(self.host)

1978

self.host = str(value)

1510

self.host = unicode(value)

1979

1511

1980

1512

# Created - property

1981

@dbus_annotations(

1982

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

1983

1513

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

1984

1514

def Created_dbus_property(self):

1985

1515

return datetime_to_dbus(self.created)

1990

1520

return datetime_to_dbus(self.last_enabled)

1991

1521

1992

1522

# Enabled - property

1993

@dbus_service_property(_interface,

1994

signature="b",

1523

@dbus_service_property(_interface, signature="b",

1995

1524

access="readwrite")

1996

1525

def Enabled_dbus_property(self, value=None):

1997

1526

if value is None: # get

2002

1531

self.disable()

2003

1532

2004

1533

# LastCheckedOK - property

2005

@dbus_service_property(_interface,

2006

signature="s",

1534

@dbus_service_property(_interface, signature="s",

2007

1535

access="readwrite")

2008

1536

def LastCheckedOK_dbus_property(self, value=None):

2009

1537

if value is not None:

2012

1540

return datetime_to_dbus(self.last_checked_ok)

2013

1541

2014

1542

# LastCheckerStatus - property

2015

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

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2016

1545

def LastCheckerStatus_dbus_property(self):

2017

1546

return dbus.Int16(self.last_checker_status)

2018

1547

2027

1556

return datetime_to_dbus(self.last_approval_request)

2028

1557

2029

1558

# Timeout - property

2030

@dbus_service_property(_interface,

2031

signature="t",

1559

@dbus_service_property(_interface, signature="t",

2032

1560

access="readwrite")

2033

1561

def Timeout_dbus_property(self, value=None):

2034

1562

if value is None: # get

2035

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

1563

return dbus.UInt64(self.timeout_milliseconds())

2036

1564

old_timeout = self.timeout

2037

1565

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

2038

1566

# Reschedule disabling

2046

1574

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

2047

1575

is None):

2048

1576

return

2049

GLib.source_remove(self.disable_initiator_tag)

2050

self.disable_initiator_tag = GLib.timeout_add(

2051

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

2052

self.disable)

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

2053

1582

2054

1583

# ExtendedTimeout - property

2055

@dbus_service_property(_interface,

2056

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2057

1585

access="readwrite")

2058

1586

def ExtendedTimeout_dbus_property(self, value=None):

2059

1587

if value is None: # get

2060

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

2061

* 1000)

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2062

1589

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

2063

1590

2064

1591

# Interval - property

2065

@dbus_service_property(_interface,

2066

signature="t",

1592

@dbus_service_property(_interface, signature="t",

2067

1593

access="readwrite")

2068

1594

def Interval_dbus_property(self, value=None):

2069

1595

if value is None: # get

2070

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

1596

return dbus.UInt64(self.interval_milliseconds())

2071

1597

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

2072

1598

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

2073

1599

return

2074

1600

if self.enabled:

2075

1601

# Reschedule checker run

2076

GLib.source_remove(self.checker_initiator_tag)

2077

self.checker_initiator_tag = GLib.timeout_add(

2078

value, self.start_checker)

2079

self.start_checker() # Start one now, too

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

2080

1606

2081

1607

# Checker - property

2082

@dbus_service_property(_interface,

2083

signature="s",

1608

@dbus_service_property(_interface, signature="s",

2084

1609

access="readwrite")

2085

1610

def Checker_dbus_property(self, value=None):

2086

1611

if value is None: # get

2087

1612

return dbus.String(self.checker_command)

2088

self.checker_command = str(value)

1613

self.checker_command = unicode(value)

2089

1614

2090

1615

# CheckerRunning - property

2091

@dbus_service_property(_interface,

2092

signature="b",

1616

@dbus_service_property(_interface, signature="b",

2093

1617

access="readwrite")

2094

1618

def CheckerRunning_dbus_property(self, value=None):

2095

1619

if value is None: # get

2100

1624

self.stop_checker()

2101

1625

2102

1626

# ObjectPath - property

2103

@dbus_annotations(

2104

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

2105

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

2106

1627

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

2107

1628

def ObjectPath_dbus_property(self):

2108

1629

return self.dbus_object_path # is already a dbus.ObjectPath

2109

1630

2110

1631

# Secret = property

2111

@dbus_annotations(

2112

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

2113

"invalidates"})

2114

@dbus_service_property(_interface,

2115

signature="ay",

2116

access="write",

2117

byte_arrays=True)

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2118

1634

def Secret_dbus_property(self, value):

2119

self.secret = bytes(value)

1635

self.secret = str(value)

2120

1636

2121

1637

del _interface

2122

1638

2126

1642

self._pipe = child_pipe

2127

1643

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

2128

1644

if not self._pipe.recv():

2129

raise KeyError(fpr)

1645

raise KeyError()

2130

1646

2131

1647

def __getattribute__(self, name):

2132

1648

if name == '_pipe':

2136

1652

if data[0] == 'data':

2137

1653

return data[1]

2138

1654

if data[0] == 'function':

2139

2140

1655

def func(*args, **kwargs):

2141

1656

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

2142

1657

return self._pipe.recv()[1]

2143

2144

1658

return func

2145

1659

2146

1660

def __setattr__(self, name, value):

2158

1672

def handle(self):

2159

1673

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

2160

1674

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

2161

str(self.client_address))

1675

unicode(self.client_address))

2162

1676

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

2163

1677

self.server.child_pipe.fileno())

2164

1678

2165

session = gnutls.ClientSession(self.request)

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

2166

1688

2167

1689

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

2168

1690

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

2172

1694

priority = self.server.gnutls_priority

2173

1695

if priority is None:

2174

1696

priority = "NORMAL"

2175

gnutls.priority_set_direct(session._c_object, priority,

2176

None)

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

2177

1700

2178

1701

# Start communication using the Mandos protocol

2179

1702

# Get protocol number

2189

1712

# Start GnuTLS connection

2190

1713

try:

2191

1714

session.handshake()

2192

except gnutls.Error as error:

1715

except gnutls.errors.GNUTLSError as error:

2193

1716

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

2194

1717

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

2195

1718

# established. Just abandon the request.

2199

1722

approval_required = False

2200

1723

try:

2201

1724

try:

2202

fpr = self.fingerprint(

2203

self.peer_certificate(session))

2204

except (TypeError, gnutls.Error) as error:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

2205

1729

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

2206

1730

return

2207

1731

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

2220

1744

while True:

2221

1745

if not client.enabled:

2222

1746

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

2223

client.name)

1747

client.name)

2224

1748

if self.server.use_dbus:

2225

1749

# Emit D-Bus signal

2226

1750

client.Rejected("Disabled")

2235

1759

if self.server.use_dbus:

2236

1760

# Emit D-Bus signal

2237

1761

client.NeedApproval(

2238

client.approval_delay.total_seconds()

2239

* 1000, client.approved_by_default)

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2240

1764

else:

2241

1765

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

2242

1766

client.name)

2248

1772

#wait until timeout or approved

2249

1773

time = datetime.datetime.now()

2250

1774

client.changedstate.acquire()

2251

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

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2252

1778

client.changedstate.release()

2253

1779

time2 = datetime.datetime.now()

2254

1780

if (time2 - time) >= delay:

2265

1791

else:

2266

1792

delay -= time2 - time

2267

1793

2268

try:

2269

session.send(client.secret)

2270

except gnutls.Error as error:

2271

logger.warning("gnutls send failed",

2272

exc_info = error)

2273

return

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

2274

1806

2275

1807

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

2276

1808

# bump the timeout using extended_timeout

2284

1816

client.approvals_pending -= 1

2285

1817

try:

2286

1818

session.bye()

2287

except gnutls.Error as error:

1819

except gnutls.errors.GNUTLSError as error:

2288

1820

logger.warning("GnuTLS bye failed",

2289

1821

exc_info=error)

2290

1822

2292

1824

def peer_certificate(session):

2293

1825

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

2294

1826

# If not an OpenPGP certificate...

2295

if (gnutls.certificate_type_get(session._c_object)

2296

!= gnutls.CRT_OPENPGP):

2297

# ...return invalid data

2298

return b""

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2299

1832

list_size = ctypes.c_uint(1)

2300

cert_list = (gnutls.certificate_get_peers

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2301

1835

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

2302

1836

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

2303

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

1837

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

1838

" certificate")

2304

1839

if list_size.value == 0:

2305

1840

return None

2306

1841

cert = cert_list[0]

2310

1845

def fingerprint(openpgp):

2311

1846

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2312

1847

# New GnuTLS "datum" with the OpenPGP public key

2313

datum = gnutls.datum_t(

2314

ctypes.cast(ctypes.c_char_p(openpgp),

2315

ctypes.POINTER(ctypes.c_ubyte)),

2316

ctypes.c_uint(len(openpgp)))

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2317

1853

# New empty GnuTLS certificate

2318

crt = gnutls.openpgp_crt_t()

2319

gnutls.openpgp_crt_init(ctypes.byref(crt))

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2320

1857

# Import the OpenPGP public key into the certificate

2321

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

2322

gnutls.OPENPGP_FMT_RAW)

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2323

1862

# Verify the self signature in the key

2324

1863

crtverify = ctypes.c_uint()

2325

gnutls.openpgp_crt_verify_self(crt, 0,

2326

ctypes.byref(crtverify))

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2327

1867

if crtverify.value != 0:

2328

gnutls.openpgp_crt_deinit(crt)

2329

raise gnutls.CertificateSecurityError("Verify failed")

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2330

1871

# New buffer for the fingerprint

2331

1872

buf = ctypes.create_string_buffer(20)

2332

1873

buf_len = ctypes.c_size_t()

2333

1874

# Get the fingerprint from the certificate into the buffer

2334

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

2335

ctypes.byref(buf_len))

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2336

1878

# Deinit the certificate

2337

gnutls.openpgp_crt_deinit(crt)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2338

1880

# Convert the buffer to a Python bytestring

2339

1881

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

2340

1882

# Convert the bytestring to hexadecimal notation

2344

1886

2345

1887

class MultiprocessingMixIn(object):

2346

1888

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

2347

2348

1889

def sub_process_main(self, request, address):

2349

1890

try:

2350

1891

self.finish_request(request, address)

2362

1903

2363

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2364

1905

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

2365

2366

1906

def process_request(self, request, client_address):

2367

1907

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

2368

1908

2389

1929

interface: None or a network interface name (string)

2390

1930

use_ipv6: Boolean; to use IPv6 or not

2391

1931

"""

2392

2393

1932

def __init__(self, server_address, RequestHandlerClass,

2394

interface=None,

2395

use_ipv6=True,

2396

socketfd=None):

1933

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

2397

1934

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

2398

1935

creating a new one with socket.socket().

2399

1936

"""

2440

1977

self.interface)

2441

1978

else:

2442

1979

try:

2443

self.socket.setsockopt(

2444

socket.SOL_SOCKET, SO_BINDTODEVICE,

2445

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

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

2446

1983

except socket.error as error:

2447

1984

if error.errno == errno.EPERM:

2448

1985

logger.error("No permission to bind to"

2466

2003

self.server_address = (any_address,

2467

2004

self.server_address[1])

2468

2005

elif not self.server_address[1]:

2469

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

2006

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

2007

0)

2470

2008

# if self.interface:

2471

2009

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

2472

2010

# 0, # port

2484

2022

gnutls_priority GnuTLS priority string

2485

2023

use_dbus: Boolean; to emit D-Bus signals or not

2486

2024

2487

Assumes a GLib.MainLoop event loop.

2025

Assumes a gobject.MainLoop event loop.

2488

2026

"""

2489

2490

2027

def __init__(self, server_address, RequestHandlerClass,

2491

interface=None,

2492

use_ipv6=True,

2493

clients=None,

2494

gnutls_priority=None,

2495

use_dbus=True,

2496

socketfd=None):

2028

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

2029

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

2497

2030

self.enabled = False

2498

2031

self.clients = clients

2499

2032

if self.clients is None:

2505

2038

interface = interface,

2506

2039

use_ipv6 = use_ipv6,

2507

2040

socketfd = socketfd)

2508

2509

2041

def server_activate(self):

2510

2042

if self.enabled:

2511

2043

return socketserver.TCPServer.server_activate(self)

2515

2047

2516

2048

def add_pipe(self, parent_pipe, proc):

2517

2049

# Call "handle_ipc" for both data and EOF events

2518

GLib.io_add_watch(

2519

parent_pipe.fileno(),

2520

GLib.IO_IN | GLib.IO_HUP,

2521

functools.partial(self.handle_ipc,

2522

parent_pipe = parent_pipe,

2523

proc = proc))

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2524

2056

2525

def handle_ipc(self, source, condition,

2526

parent_pipe=None,

2527

proc = None,

2528

client_object=None):

2057

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

2058

proc = None, client_object=None):

2529

2059

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

2530

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

2060

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

2531

2061

# Wait for other process to exit

2532

2062

proc.join()

2533

2063

return False

2540

2070

fpr = request[1]

2541

2071

address = request[2]

2542

2072

2543

for c in self.clients.values():

2073

for c in self.clients.itervalues():

2544

2074

if c.fingerprint == fpr:

2545

2075

client = c

2546

2076

break

2554

2084

parent_pipe.send(False)

2555

2085

return False

2556

2086

2557

GLib.io_add_watch(

2558

parent_pipe.fileno(),

2559

GLib.IO_IN | GLib.IO_HUP,

2560

functools.partial(self.handle_ipc,

2561

parent_pipe = parent_pipe,

2562

proc = proc,

2563

client_object = client))

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2564

2095

parent_pipe.send(True)

2565

2096

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

2566

2097

# same fileno

2572

2103

2573

2104

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

2574

2105

funcname)(*args,

2575

**kwargs)))

2106

**kwargs)))

2576

2107

2577

2108

if command == 'getattr':

2578

2109

attrname = request[1]

2579

if isinstance(client_object.__getattribute__(attrname),

2580

collections.Callable):

2581

parent_pipe.send(('function', ))

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2582

2112

else:

2583

parent_pipe.send((

2584

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

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2585

2115

2586

2116

if command == 'setattr':

2587

2117

attrname = request[1]

2618

2148

# avoid excessive use of external libraries.

2619

2149

2620

2150

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

2621

Token = collections.namedtuple("Token", (

2622

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

2623

# a "group" containing digits

2624

"value", # datetime.timedelta or None

2625

"followers")) # Tokens valid after this token

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2626

2160

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

2627

2161

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

2628

2162

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

2629

2163

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

2630

2164

datetime.timedelta(seconds=1),

2631

frozenset((token_end, )))

2165

frozenset((token_end,)))

2632

2166

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

2633

2167

datetime.timedelta(minutes=1),

2634

2168

frozenset((token_second, token_end)))

2650

2184

frozenset((token_month, token_end)))

2651

2185

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

2652

2186

datetime.timedelta(weeks=1),

2653

frozenset((token_end, )))

2187

frozenset((token_end,)))

2654

2188

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

2655

2189

frozenset((token_year, token_month,

2656

2190

token_day, token_time,

2657

token_week)))

2191

token_week))),

2658

2192

# Define starting values

2659

2193

value = datetime.timedelta() # Value so far

2660

2194

found_token = None

2661

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

2195

followers = frozenset(token_duration,) # Following valid tokens

2662

2196

s = duration # String left to parse

2663

2197

# Loop until end token is found

2664

2198

while found_token is not token_end:

2681

2215

break

2682

2216

else:

2683

2217

# No currently valid tokens were found

2684

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

2685

.format(duration))

2218

raise ValueError("Invalid RFC 3339 duration")

2686

2219

# End token found

2687

2220

return value

2688

2221

2712

2245

timevalue = datetime.timedelta(0)

2713

2246

for s in interval.split():

2714

2247

try:

2715

suffix = s[-1]

2248

suffix = unicode(s[-1])

2716

2249

value = int(s[:-1])

2717

2250

if suffix == "d":

2718

2251

delta = datetime.timedelta(value)

2725

2258

elif suffix == "w":

2726

2259

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

2727

2260

else:

2728

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

2261

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

2262

.format(suffix))

2729

2263

except IndexError as e:

2730

2264

raise ValueError(*(e.args))

2731

2265

timevalue += delta

2748

2282

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

2749

2283

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

2750

2284

raise OSError(errno.ENODEV,

2751

"{} not a character device"

2285

"{0} not a character device"

2752

2286

.format(os.devnull))

2753

2287

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

2754

2288

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

2764

2298

2765

2299

parser = argparse.ArgumentParser()

2766

2300

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

2767

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

2301

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

2768

2302

help="show version number and exit")

2769

2303

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

2770

2304

help="Bind to interface IF")

2820

2354

"port": "",

2821

2355

"debug": "False",

2822

2356

"priority":

2823

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

2824

":+SIGN-DSA-SHA256",

2357

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

2825

2358

"servicename": "Mandos",

2826

2359

"use_dbus": "True",

2827

2360

"use_ipv6": "True",

2831

2364

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

2832

2365

"foreground": "False",

2833

2366

"zeroconf": "True",

2834

}

2367

}

2835

2368

2836

2369

# Parse config file for server-global settings

2837

2370

server_config = configparser.SafeConfigParser(server_defaults)

2838

2371

del server_defaults

2839

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

2372

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

2373

"mandos.conf"))

2840

2374

# Convert the SafeConfigParser object to a dict

2841

2375

server_settings = server_config.defaults()

2842

2376

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

2860

2394

# Override the settings from the config file with command line

2861

2395

# options, if set.

2862

2396

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

2863

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

2864

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

2865

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

2397

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

2398

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

2399

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

2866

2400

value = getattr(options, option)

2867

2401

if value is not None:

2868

2402

server_settings[option] = value

2869

2403

del options

2870

2404

# Force all strings to be unicode

2871

2405

for option in server_settings.keys():

2872

if isinstance(server_settings[option], bytes):

2873

server_settings[option] = (server_settings[option]

2874

.decode("utf-8"))

2406

if type(server_settings[option]) is str:

2407

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

2875

2408

# Force all boolean options to be boolean

2876

2409

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

2877

2410

"foreground", "zeroconf"):

2883

2416

2884

2417

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

2885

2418

2886

if (not server_settings["zeroconf"]

2887

and not (server_settings["port"]

2888

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

2889

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

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2890

2424

2891

2425

# For convenience

2892

2426

debug = server_settings["debug"]

2908

2442

initlogger(debug, level)

2909

2443

2910

2444

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

2911

syslogger.setFormatter(

2912

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

2913

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

2914

server_settings["servicename"])))

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2915

2450

2916

2451

# Parse config file with clients

2917

2452

client_config = configparser.SafeConfigParser(Client

2925

2460

socketfd = None

2926

2461

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

2927

2462

socketfd = server_settings["socket"]

2928

tcp_server = MandosServer(

2929

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

2930

ClientHandler,

2931

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

2932

use_ipv6=use_ipv6,

2933

gnutls_priority=server_settings["priority"],

2934

use_dbus=use_dbus,

2935

socketfd=socketfd)

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

2936

2473

if not foreground:

2937

2474

pidfilename = "/run/mandos.pid"

2938

2475

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

2939

2476

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

2940

2477

pidfile = None

2941

2478

try:

2942

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

2479

pidfile = open(pidfilename, "w")

2943

2480

except IOError as e:

2944

2481

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

2945

2482

exc_info=e)

2946

2483

2947

for name, group in (("_mandos", "_mandos"),

2948

("mandos", "mandos"),

2949

("nobody", "nogroup")):

2484

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

2950

2485

try:

2951

2486

uid = pwd.getpwnam(name).pw_uid

2952

gid = pwd.getpwnam(group).pw_gid

2487

gid = pwd.getpwnam(name).pw_gid

2953

2488

break

2954

2489

except KeyError:

2955

2490

continue

2959

2494

try:

2960

2495

os.setgid(gid)

2961

2496

os.setuid(uid)

2962

if debug:

2963

logger.debug("Did setuid/setgid to {}:{}".format(uid,

2964

gid))

2965

2497

except OSError as error:

2966

logger.warning("Failed to setuid/setgid to {}:{}: {}"

2967

.format(uid, gid, os.strerror(error.errno)))

2968

2498

if error.errno != errno.EPERM:

2969

2499

raise

2970

2500

2973

2503

2974

2504

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

2975

2505

# - GnuTLS manual

2976

gnutls.global_set_log_level(11)

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2977

2507

2978

@gnutls.log_func

2508

@gnutls.library.types.gnutls_log_func

2979

2509

def debug_gnutls(level, string):

2980

2510

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

2981

2511

2982

gnutls.global_set_log_function(debug_gnutls)

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2983

2514

2984

2515

# Redirect stdin so all checkers get /dev/null

2985

2516

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

2992

2523

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

2993

2524

daemon()

2994

2525

2995

# multiprocessing will use threads, so before we use GLib we need

2996

# to inform GLib that threads will be used.

2997

GLib.threads_init()

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2998

2529

2999

2530

global main_loop

3000

2531

# From the Avahi example code

3001

2532

DBusGMainLoop(set_as_default=True)

3002

main_loop = GLib.MainLoop()

2533

main_loop = gobject.MainLoop()

3003

2534

bus = dbus.SystemBus()

3004

2535

# End of Avahi example code

3005

2536

if use_dbus:

3006

2537

try:

3007

2538

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

3008

bus,

3009

do_not_queue=True)

3010

old_bus_name = dbus.service.BusName(

3011

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

3012

do_not_queue=True)

3013

except dbus.exceptions.DBusException as e:

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3014

2544

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

3015

2545

use_dbus = False

3016

2546

server_settings["use_dbus"] = False

3017

2547

tcp_server.use_dbus = False

3018

2548

if zeroconf:

3019

2549

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3020

service = AvahiServiceToSyslog(

3021

name = server_settings["servicename"],

3022

servicetype = "_mandos._tcp",

3023

protocol = protocol,

3024

bus = bus)

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3025

2554

if server_settings["interface"]:

3026

service.interface = if_nametoindex(

3027

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

2555

service.interface = (if_nametoindex

2556

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

3028

2557

3029

2558

global multiprocessing_manager

3030

2559

multiprocessing_manager = multiprocessing.Manager()

3049

2578

if server_settings["restore"]:

3050

2579

try:

3051

2580

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

3052

if sys.version_info.major == 2:

3053

clients_data, old_client_settings = pickle.load(

3054

stored_state)

3055

else:

3056

bytes_clients_data, bytes_old_client_settings = (

3057

pickle.load(stored_state, encoding = "bytes"))

3058

### Fix bytes to strings

3059

## clients_data

3060

# .keys()

3061

clients_data = { (key.decode("utf-8")

3062

if isinstance(key, bytes)

3063

else key): value

3064

for key, value in

3065

bytes_clients_data.items() }

3066

del bytes_clients_data

3067

for key in clients_data:

3068

value = { (k.decode("utf-8")

3069

if isinstance(k, bytes) else k): v

3070

for k, v in

3071

clients_data[key].items() }

3072

clients_data[key] = value

3073

# .client_structure

3074

value["client_structure"] = [

3075

(s.decode("utf-8")

3076

if isinstance(s, bytes)

3077

else s) for s in

3078

value["client_structure"] ]

3079

# .name & .host

3080

for k in ("name", "host"):

3081

if isinstance(value[k], bytes):

3082

value[k] = value[k].decode("utf-8")

3083

## old_client_settings

3084

# .keys()

3085

old_client_settings = {

3086

(key.decode("utf-8")

3087

if isinstance(key, bytes)

3088

else key): value

3089

for key, value in

3090

bytes_old_client_settings.items() }

3091

del bytes_old_client_settings

3092

# .host

3093

for value in old_client_settings.values():

3094

if isinstance(value["host"], bytes):

3095

value["host"] = (value["host"]

3096

.decode("utf-8"))

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3097

2583

os.remove(stored_state_path)

3098

2584

except IOError as e:

3099

2585

if e.errno == errno.ENOENT:

3100

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

3101

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

2586

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

2587

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

3102

2588

else:

3103

2589

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

3104

2590

exc_info=e)

3105

2591

raise

3106

2592

except EOFError as e:

3107

2593

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

3108

"EOFError:",

3109

exc_info=e)

2594

"EOFError:", exc_info=e)

3110

2595

3111

2596

with PGPEngine() as pgp:

3112

for client_name, client in clients_data.items():

2597

for client_name, client in clients_data.iteritems():

3113

2598

# Skip removed clients

3114

2599

if client_name not in client_settings:

3115

2600

continue

3124

2609

# For each value in new config, check if it

3125

2610

# differs from the old config value (Except for

3126

2611

# the "secret" attribute)

3127

if (name != "secret"

3128

and (value !=

3129

old_client_settings[client_name][name])):

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3130

2615

client[name] = value

3131

2616

except KeyError:

3132

2617

pass

3133

2618

3134

2619

# Clients who has passed its expire date can still be

3135

# enabled if its last checker was successful. A Client

2620

# enabled if its last checker was successful. Clients

3136

2621

# whose checker succeeded before we stored its state is

3137

2622

# assumed to have successfully run all checkers during

3138

2623

# downtime.

3140

2625

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

3141

2626

if not client["last_checked_ok"]:

3142

2627

logger.warning(

3143

"disabling client {} - Client never "

3144

"performed a successful checker".format(

3145

client_name))

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3146

2631

client["enabled"] = False

3147

2632

elif client["last_checker_status"] != 0:

3148

2633

logger.warning(

3149

"disabling client {} - Client last"

3150

" checker failed with error code"

3151

" {}".format(

3152

client_name,

3153

client["last_checker_status"]))

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3154

2638

client["enabled"] = False

3155

2639

else:

3156

client["expires"] = (

3157

datetime.datetime.utcnow()

3158

+ client["timeout"])

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3159

2643

logger.debug("Last checker succeeded,"

3160

" keeping {} enabled".format(

3161

client_name))

2644

" keeping {0} enabled"

2645

.format(client_name))

3162

2646

try:

3163

client["secret"] = pgp.decrypt(

3164

client["encrypted_secret"],

3165

client_settings[client_name]["secret"])

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3166

2651

except PGPError:

3167

2652

# If decryption fails, we use secret from new settings

3168

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

3169

client_name))

3170

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

3171

["secret"])

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

3172

2657

3173

2658

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

3174

2659

for client_name in (set(old_client_settings)

3179

2664

clients_data[client_name] = client_settings[client_name]

3180

2665

3181

2666

# Create all client objects

3182

for client_name, client in clients_data.items():

2667

for client_name, client in clients_data.iteritems():

3183

2668

tcp_server.clients[client_name] = client_class(

3184

name = client_name,

3185

settings = client,

2669

name = client_name, settings = client,

3186

2670

server_settings = server_settings)

3187

2671

3188

2672

if not tcp_server.clients:

3190

2674

3191

2675

if not foreground:

3192

2676

if pidfile is not None:

3193

pid = os.getpid()

3194

2677

try:

3195

2678

with pidfile:

3196

print(pid, file=pidfile)

2679

pid = os.getpid()

2680

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

3197

2681

except IOError:

3198

2682

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

3199

2683

pidfilename, pid)

3200

2684

del pidfile

3201

2685

del pidfilename

3202

2686

3203

for termsig in (signal.SIGHUP, signal.SIGTERM):

3204

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3205

lambda: main_loop.quit() and False)

2687

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

2688

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

3206

2689

3207

2690

if use_dbus:

3208

3209

@alternate_dbus_interfaces(

3210

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

3211

class MandosDBusService(DBusObjectWithObjectManager):

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3212

2694

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

3213

3214

2695

def __init__(self):

3215

2696

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

3216

3217

2697

_interface = "se.recompile.Mandos"

3218

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3219

2705

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

3220

2706

def ClientAdded(self, objpath):

3221

2707

"D-Bus signal"

3226

2712

"D-Bus signal"

3227

2713

pass

3228

2714

3229

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

3230

"true"})

3231

2715

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

3232

2716

def ClientRemoved(self, objpath, name):

3233

2717

"D-Bus signal"

3234

2718

pass

3235

2719

3236

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

3237

"true"})

3238

2720

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

3239

2721

def GetAllClients(self):

3240

2722

"D-Bus method"

3241

return dbus.Array(c.dbus_object_path for c in

3242

tcp_server.clients.values())

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

3243

2726

3244

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

3245

"true"})

3246

2727

@dbus.service.method(_interface,

3247

2728

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

3248

2729

def GetAllClientsWithProperties(self):

3249

2730

"D-Bus method"

3250

2731

return dbus.Dictionary(

3251

{ c.dbus_object_path: c.GetAll(

3252

"se.recompile.Mandos.Client")

3253

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

2732

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

2733

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

3254

2734

signature="oa{sv}")

3255

2735

3256

2736

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

3257

2737

def RemoveClient(self, object_path):

3258

2738

"D-Bus method"

3259

for c in tcp_server.clients.values():

2739

for c in tcp_server.clients.itervalues():

3260

2740

if c.dbus_object_path == object_path:

3261

2741

del tcp_server.clients[c.name]

3262

2742

c.remove_from_connection()

3263

# Don't signal the disabling

2743

# Don't signal anything except ClientRemoved

3264

2744

c.disable(quiet=True)

3265

# Emit D-Bus signal for removal

3266

self.client_removed_signal(c)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3267

2747

return

3268

2748

raise KeyError(object_path)

3269

2749

3270

2750

del _interface

3271

3272

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3273

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

3274

def GetManagedObjects(self):

3275

"""D-Bus method"""

3276

return dbus.Dictionary(

3277

{ client.dbus_object_path:

3278

dbus.Dictionary(

3279

{ interface: client.GetAll(interface)

3280

for interface in

3281

client._get_all_interface_names()})

3282

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

3283

3284

def client_added_signal(self, client):

3285

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

3286

if use_dbus:

3287

# New standard signal

3288

self.InterfacesAdded(

3289

client.dbus_object_path,

3290

dbus.Dictionary(

3291

{ interface: client.GetAll(interface)

3292

for interface in

3293

client._get_all_interface_names()}))

3294

# Old signal

3295

self.ClientAdded(client.dbus_object_path)

3296

3297

def client_removed_signal(self, client):

3298

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

3299

if use_dbus:

3300

# New standard signal

3301

self.InterfacesRemoved(

3302

client.dbus_object_path,

3303

client._get_all_interface_names())

3304

# Old signal

3305

self.ClientRemoved(client.dbus_object_path,

3306

client.name)

3307

2751

3308

2752

mandos_dbus_service = MandosDBusService()

3309

2753

3322

2766

# removed/edited, old secret will thus be unrecovable.

3323

2767

clients = {}

3324

2768

with PGPEngine() as pgp:

3325

for client in tcp_server.clients.values():

2769

for client in tcp_server.clients.itervalues():

3326

2770

key = client_settings[client.name]["secret"]

3327

2771

client.encrypted_secret = pgp.encrypt(client.secret,

3328

2772

key)

3330

2774

3331

2775

# A list of attributes that can not be pickled

3332

2776

# + secret.

3333

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

3334

"checker", "server_settings" }

3335

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

3336

.Object):

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3337

2781

exclude.add(name)

3338

2782

3339

2783

client_dict["encrypted_secret"] = (client

3346

2790

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

3347

2791

3348

2792

try:

3349

with tempfile.NamedTemporaryFile(

3350

mode='wb',

3351

suffix=".pickle",

3352

prefix='clients-',

3353

dir=os.path.dirname(stored_state_path),

3354

delete=False) as stored_state:

3355

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

3356

protocol = 2)

3357

tempname = stored_state.name

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3358

2799

os.rename(tempname, stored_state_path)

3359

2800

except (IOError, OSError) as e:

3360

2801

if not debug:

3363

2804

except NameError:

3364

2805

pass

3365

2806

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

3366

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

2807

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

3367

2808

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

3368

2809

else:

3369

2810

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

3375

2816

name, client = tcp_server.clients.popitem()

3376

2817

if use_dbus:

3377

2818

client.remove_from_connection()

3378

# Don't signal the disabling

2819

# Don't signal anything except ClientRemoved

3379

2820

client.disable(quiet=True)

3380

# Emit D-Bus signal for removal

3381

2821

if use_dbus:

3382

mandos_dbus_service.client_removed_signal(client)

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3383

2826

client_settings.clear()

3384

2827

3385

2828

atexit.register(cleanup)

3386

2829

3387

for client in tcp_server.clients.values():

2830

for client in tcp_server.clients.itervalues():

3388

2831

if use_dbus:

3389

# Emit D-Bus signal for adding

3390

mandos_dbus_service.client_added_signal(client)

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3391

2834

# Need to initiate checking of clients

3392

2835

if client.enabled:

3393

2836

client.init_checker()

3419

2862

sys.exit(1)

3420

2863

# End of Avahi example code

3421

2864

3422

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

3423

lambda *args, **kwargs:

3424

(tcp_server.handle_request

3425

(*args[2:], **kwargs) or True))

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

(*args[2:], **kwargs) or True))

3426

2869

3427

2870

logger.debug("Starting main loop")

3428

2871

main_loop.run()

3438

2881

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

3439

2882

cleanup()

3440

2883

3441

3442

2884

if __name__ == '__main__':

3443

2885

main()