/mandos/release : revision 237.7.278

1

#!/usr/bin/python

1

#!/usr/bin/python2.7

2

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

3

#

4

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

11

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

12

#

13

# Everything else is

14

15

14

15

16

#

17

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

18

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

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

97

91

if sys.version_info.major == 2:

98

92

str = unicode

99

93

100

version = "1.7.7"

94

version = "1.6.8"

101

95

stored_state_file = "clients.pickle"

102

96

103

97

logger = logging.getLogger()

104

98

syslogger = None

105

99

106

100

try:

107

if_nametoindex = ctypes.cdll.LoadLibrary(

108

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

109

104

except (OSError, AttributeError):

110

111

105

def if_nametoindex(interface):

112

106

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

113

107

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

118

112

return interface_index

119

113

120

114

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

115

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

138

116

"""init logger and add loglevel"""

139

117

140

118

global syslogger

141

syslogger = (logging.handlers.SysLogHandler(

142

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

143

address = "/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

144

123

syslogger.setFormatter(logging.Formatter

145

124

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

146

125

' %(message)s'))

163

142

164

143

class PGPEngine(object):

165

144

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

166

167

145

def __init__(self):

168

146

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

147

self.gnupgargs = ['--batch',

181

'--homedir', self.tempdir,

148

'--home', self.tempdir,

182

149

'--force-mdc',

183

150

'--quiet',

184

151

'--no-use-agent']

219

186

220

187

def encrypt(self, data, password):

221

188

passphrase = self.password_encode(password)

222

with tempfile.NamedTemporaryFile(

223

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

224

191

passfile.write(passphrase)

225

192

passfile.flush()

226

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

193

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

227

194

'--passphrase-file',

228

195

passfile.name]

229

196

+ self.gnupgargs,

237

204

238

205

def decrypt(self, data, password):

239

206

passphrase = self.password_encode(password)

240

with tempfile.NamedTemporaryFile(

241

dir = self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

242

209

passfile.write(passphrase)

243

210

passfile.flush()

244

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

211

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

245

212

'--passphrase-file',

246

213

passfile.name]

247

214

+ self.gnupgargs,

248

215

stdin = subprocess.PIPE,

249

216

stdout = subprocess.PIPE,

250

217

stderr = subprocess.PIPE)

251

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

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

252

220

if proc.returncode != 0:

253

221

raise PGPError(err)

254

222

return decrypted_plaintext

255

223

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

224

281

225

class AvahiError(Exception):

282

226

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

284

228

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

285

229

**kwargs)

286

230

287

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 = str(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"""

409

338

elif state == avahi.ENTRY_GROUP_FAILURE:

410

339

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

411

340

str(error))

412

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

341

raise AvahiGroupError("State changed: {!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 ({}) [%(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()

746

403

747

404

class Client(object):

748

405

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

754

411

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

755

412

to see if the client lives.

756

413

'None' if no process is running.

757

checker_callback_tag: a GLib event source tag, or None

414

checker_callback_tag: a gobject event source tag, or None

758

415

checker_command: string; External command which is run to check

759

416

if client lives. %() expansions are done at

760

417

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

761

418

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

762

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

763

420

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

764

421

client_structure: Object describing what attributes a client has

765

422

and is used for storing the client at exit

766

423

current_checker_command: string; current running checker_command

767

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

768

425

enabled: bool()

769

426

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

770

427

uniquely identify the client

775

432

last_checker_status: integer between 0 and 255 reflecting exit

776

433

status of last checker. -1 reflects crashed

777

434

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

435

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

781

436

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

782

437

D-Bus identifiers

795

450

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

796

451

"last_approval_request", "last_checked_ok",

797

452

"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

}

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

809

463

810

464

@staticmethod

811

465

def config_parser(config):

827

481

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

828

482

"enabled")

829

483

830

# Uppercase and remove spaces from fingerprint for later

831

# comparison purposes with return value from the

832

# fingerprint() function

833

484

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

834

485

.replace(" ", ""))

835

486

if "secret" in section:

836

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

837

.encode("utf-8"),

838

"base64")

487

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

839

488

elif "secfile" in section:

840

489

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

841

490

(section["secfile"])),

879

528

self.expires = None

880

529

881

530

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

882

534

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

883

535

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

884

536

datetime.datetime.utcnow())

891

543

self.current_checker_command = None

892

544

self.approved = None

893

545

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

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

898

551

if not attr.startswith("_")]

899

552

self.client_structure.append("client_structure")

900

553

901

for name, t in inspect.getmembers(

902

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

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

903

558

if not name.startswith("_"):

904

559

self.client_structure.append(name)

905

560

926

581

if not quiet:

927

582

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

928

583

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

929

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

930

585

self.disable_initiator_tag = None

931

586

self.expires = None

932

587

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

933

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

934

589

self.checker_initiator_tag = None

935

590

self.stop_checker()

936

591

self.enabled = False

937

592

if not quiet:

938

593

self.send_changedstate()

939

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

594

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

940

595

return False

941

596

942

597

def __del__(self):

946

601

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

947

602

# and every interval from then on.

948

603

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)

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

953

609

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

954

610

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)

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

958

616

# Also start a new checker *right now*.

959

617

self.start_checker()

960

618

961

def checker_callback(self, source, condition, connection,

962

command):

619

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

963

620

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

964

621

self.checker_callback_tag = None

965

622

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

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

973

625

if self.last_checker_status == 0:

974

626

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

975

627

vars(self))

976

628

self.checked_ok()

977

629

else:

978

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

630

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

631

vars(self))

979

632

else:

980

633

self.last_checker_status = -1

981

self.last_checker_signal = -returncode

982

634

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

983

635

vars(self))

984

return False

985

636

986

637

def checked_ok(self):

987

638

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

988

639

self.last_checked_ok = datetime.datetime.utcnow()

989

640

self.last_checker_status = 0

990

self.last_checker_signal = None

991

641

self.bump_timeout()

992

642

993

643

def bump_timeout(self, timeout=None):

995

645

if timeout is None:

996

646

timeout = self.timeout

997

647

if self.disable_initiator_tag is not None:

998

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

999

649

self.disable_initiator_tag = None

1000

650

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

1001

self.disable_initiator_tag = GLib.timeout_add(

1002

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1003

654

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

1004

655

1005

656

def need_approval(self):

1019

670

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

1020

671

# should be.

1021

672

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

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1026

687

# Start a new checker if needed

1027

688

if self.checker is None:

1028

689

# Escape attributes for the shell

1029

escaped_attrs = {

1030

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

1031

for attr in self.runtime_expansions }

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1032

693

try:

1033

694

command = self.checker_command % escaped_attrs

1034

695

except TypeError as error:

1035

696

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

1036

self.checker_command,

697

self.checker_command, exc_info=error)

698

return True # Try again later

699

self.current_checker_command = command

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

1037

721

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

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1066

742

return True

1067

743

1068

744

def stop_checker(self):

1069

745

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

1070

746

if self.checker_callback_tag:

1071

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1072

748

self.checker_callback_tag = None

1073

749

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

1074

750

return

1075

751

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

1076

self.checker.terminate()

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1077

760

self.checker = None

1078

761

1079

762

1080

def dbus_service_property(dbus_interface,

1081

signature="v",

1082

access="readwrite",

1083

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1084

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1085

766

become properties on the D-Bus.

1086

767

1096

777

if byte_arrays and signature != "ay":

1097

778

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

1098

779

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

1099

1100

780

def decorator(func):

1101

781

func._dbus_is_property = True

1102

782

func._dbus_interface = dbus_interface

1107

787

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

1108

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1109

789

return func

1110

1111

790

return decorator

1112

791

1113

792

1122

801

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

1123

802

"false"}

1124

803

"""

1125

1126

804

def decorator(func):

1127

805

func._dbus_is_interface = True

1128

806

func._dbus_interface = dbus_interface

1129

807

func._dbus_name = dbus_interface

1130

808

return func

1131

1132

809

return decorator

1133

810

1134

811

1136

813

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

1137

814

Usage:

1138

815

1139

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

1140

"org.freedesktop.DBus.Property."

1141

"EmitsChangedSignal": "false"})

1142

816

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

1143

817

access="r")

818

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

819

"org.freedesktop.DBus.Property."

820

"EmitsChangedSignal": "false"})

1144

821

def Property_dbus_property(self):

1145

822

return dbus.Boolean(False)

1146

1147

See also the DBusObjectWithAnnotations class.

1148

823

"""

1149

1150

824

def decorator(func):

1151

825

func._dbus_annotations = annotations

1152

826

return func

1153

1154

827

return decorator

1155

828

1156

829

1159

832

"""

1160

833

pass

1161

834

1162

1163

835

class DBusPropertyAccessException(DBusPropertyException):

1164

836

"""A property's access permissions disallows an operation.

1165

837

"""

1172

844

pass

1173

845

1174

846

1175

class DBusObjectWithAnnotations(dbus.service.Object):

1176

"""A D-Bus object with annotations.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

1177

849

1178

Classes inheriting from this can use the dbus_annotations

1179

decorator to add annotations to methods or signals.

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1180

853

"""

1181

854

1182

855

@staticmethod

1192

865

def _get_all_dbus_things(self, thing):

1193

866

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

1194

867

"""

1195

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

868

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

869

name),

1196

870

athing.__get__(self))

1197

871

for cls in self.__class__.__mro__

1198

872

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

"""

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

1271

875

1272

876

def _get_dbus_property(self, interface_name, property_name):

1273

877

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

1274

878

property with the specified name and interface.

1275

879

"""

1276

for cls in self.__class__.__mro__:

1277

for name, value in inspect.getmembers(

1278

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1279

884

if (value._dbus_name == property_name

1280

885

and value._dbus_interface == interface_name):

1281

886

return value.__get__(self)

1282

887

1283

888

# 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",

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1298

894

out_signature="v")

1299

895

def Get(self, interface_name, property_name):

1300

896

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

1325

921

for byte in value))

1326

922

prop(value)

1327

923

1328

@dbus.service.method(dbus.PROPERTIES_IFACE,

1329

in_signature="s",

924

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

1330

925

out_signature="a{sv}")

1331

926

def GetAll(self, interface_name):

1332

927

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

1347

942

if not hasattr(value, "variant_level"):

1348

943

properties[name] = value

1349

944

continue

1350

properties[name] = type(value)(

1351

value, variant_level = value.variant_level + 1)

945

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

946

value.variant_level+1)

1352

947

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

1353

948

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

949

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

950

out_signature="s",

1364

951

path_keyword='object_path',

1368

955

1369

956

Inserts property tags and interface annotation tags.

1370

957

"""

1371

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1372

object_path,

1373

connection)

958

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

959

connection)

1374

960

try:

1375

961

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

1376

1377

962

def make_tag(document, name, prop):

1378

963

e = document.createElement("property")

1379

964

e.setAttribute("name", name)

1380

965

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

1381

966

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

1382

967

return e

1383

1384

968

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

1385

969

# Add property tags

1386

970

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

1389

973

if prop._dbus_interface

1390

974

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

1391

975

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)

976

# Add annotation tags

977

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

978

for tag in if_tag.getElementsByTagName(typ):

979

annots = dict()

980

for name, prop in (self.

981

_get_all_dbus_things(typ)):

982

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

983

and prop._dbus_interface

984

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

985

annots.update(getattr

986

(prop,

987

"_dbus_annotations",

988

{}))

989

for name, value in annots.items():

990

ann_tag = document.createElement(

991

"annotation")

992

ann_tag.setAttribute("name", name)

993

ann_tag.setAttribute("value", value)

994

tag.appendChild(ann_tag)

995

# Add interface annotation tags

996

for annotation, value in dict(

997

itertools.chain.from_iterable(

998

annotations().items()

999

for name, annotations in

1000

self._get_all_dbus_things("interface")

1001

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

1002

)).items():

1003

ann_tag = document.createElement("annotation")

1004

ann_tag.setAttribute("name", annotation)

1005

ann_tag.setAttribute("value", value)

1006

if_tag.appendChild(ann_tag)

1408

1007

# Add the names to the return values for the

1409

1008

# "org.freedesktop.DBus.Properties" methods

1410

1009

if (if_tag.getAttribute("name")

1428

1027

exc_info=error)

1429

1028

return xmlstring

1430

1029

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

1030

1500

1031

def datetime_to_dbus(dt, variant_level=0):

1501

1032

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

1502

1033

if dt is None:

1503

1034

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

1504

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

1035

return dbus.String(dt.isoformat(),

1036

variant_level=variant_level)

1505

1037

1506

1038

1507

1039

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1527

1059

(from DBusObjectWithProperties) and interfaces (from the

1528

1060

dbus_interface_annotations decorator).

1529

1061

"""

1530

1531

1062

def wrapper(cls):

1532

1063

for orig_interface_name, alt_interface_name in (

1533

alt_interface_names.items()):

1064

alt_interface_names.items()):

1534

1065

attr = {}

1535

1066

interface_names = set()

1536

1067

# Go though all attributes of the class

1538

1069

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

1539

1070

# with the wrong interface name

1540

1071

if (not hasattr(attribute, "_dbus_interface")

1541

or not attribute._dbus_interface.startswith(

1542

orig_interface_name)):

1072

or not attribute._dbus_interface

1073

.startswith(orig_interface_name)):

1543

1074

continue

1544

1075

# Create an alternate D-Bus interface name based on

1545

1076

# the current name

1546

alt_interface = attribute._dbus_interface.replace(

1547

orig_interface_name, alt_interface_name)

1077

alt_interface = (attribute._dbus_interface

1078

.replace(orig_interface_name,

1079

alt_interface_name))

1548

1080

interface_names.add(alt_interface)

1549

1081

# Is this a D-Bus signal?

1550

1082

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

1551

1083

# Extract the original non-method undecorated

1552

1084

# function by black magic

1553

if sys.version_info.major == 2:

1554

nonmethod_func = (dict(

1085

nonmethod_func = (dict(

1555

1086

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)

1087

attribute.__closure__))["func"]

1088

.cell_contents)

1563

1089

# Create a new, but exactly alike, function

1564

1090

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

1565

1091

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

1092

new_function = (dbus.service.signal

1093

(alt_interface,

1094

attribute._dbus_signature)

1095

(types.FunctionType(

1096

nonmethod_func.func_code,

1097

nonmethod_func.func_globals,

1098

nonmethod_func.func_name,

1099

nonmethod_func.func_defaults,

1100

nonmethod_func.func_closure)))

1570

1101

# Copy annotations, if any

1571

1102

try:

1572

new_function._dbus_annotations = dict(

1573

attribute._dbus_annotations)

1103

new_function._dbus_annotations = (

1104

dict(attribute._dbus_annotations))

1574

1105

except AttributeError:

1575

1106

pass

1576

1107

# Define a creator of a function to call both the

1581

1112

"""This function is a scope container to pass

1582

1113

func1 and func2 to the "call_both" function

1583

1114

outside of its arguments"""

1584

1585

@functools.wraps(func2)

1586

1115

def call_both(*args, **kwargs):

1587

1116

"""This function will emit two D-Bus

1588

1117

signals by calling func1 and func2"""

1589

1118

func1(*args, **kwargs)

1590

1119

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

1120

return call_both

1597

1121

# Create the "call_both" function and add it to

1598

1122

# the class

1603

1127

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

1604

1128

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

1605

1129

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

1130

attr[attrname] = (dbus.service.method

1131

(alt_interface,

1132

attribute._dbus_in_signature,

1133

attribute._dbus_out_signature)

1134

(types.FunctionType

1135

(attribute.func_code,

1136

attribute.func_globals,

1137

attribute.func_name,

1138

attribute.func_defaults,

1139

attribute.func_closure)))

1612

1140

# Copy annotations, if any

1613

1141

try:

1614

attr[attrname]._dbus_annotations = dict(

1615

attribute._dbus_annotations)

1142

attr[attrname]._dbus_annotations = (

1143

dict(attribute._dbus_annotations))

1616

1144

except AttributeError:

1617

1145

pass

1618

1146

# Is this a D-Bus property?

1621

1149

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

1622

1150

# property with the alternate D-Bus interface

1623

1151

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

1152

attr[attrname] = (dbus_service_property

1153

(alt_interface,

1154

attribute._dbus_signature,

1155

attribute._dbus_access,

1156

attribute

1157

._dbus_get_args_options

1158

["byte_arrays"])

1159

(types.FunctionType

1160

(attribute.func_code,

1161

attribute.func_globals,

1162

attribute.func_name,

1163

attribute.func_defaults,

1164

attribute.func_closure)))

1630

1165

# Copy annotations, if any

1631

1166

try:

1632

attr[attrname]._dbus_annotations = dict(

1633

attribute._dbus_annotations)

1167

attr[attrname]._dbus_annotations = (

1168

dict(attribute._dbus_annotations))

1634

1169

except AttributeError:

1635

1170

pass

1636

1171

# Is this a D-Bus interface?

1639

1174

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

1640

1175

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

1641

1176

# to the class.

1642

attr[attrname] = (

1643

dbus_interface_annotations(alt_interface)

1644

(copy_function(attribute)))

1177

attr[attrname] = (dbus_interface_annotations

1178

(alt_interface)

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1645

1185

if deprecate:

1646

1186

# Deprecate all alternate interfaces

1647

1187

iname="_AlternateDBusNames_interface_annotation{}"

1648

1188

for interface_name in interface_names:

1649

1650

1189

@dbus_interface_annotations(interface_name)

1651

1190

def func(self):

1652

1191

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

1653

"true" }

1192

"true" }

1654

1193

# Find an unused name

1655

1194

for aname in (iname.format(i)

1656

1195

for i in itertools.count()):

1660

1199

if interface_names:

1661

1200

# Replace the class with a new subclass of it with

1662

1201

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

1202

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

1203

(cls,), attr)

1669

1204

return cls

1670

1671

1205

return wrapper

1672

1206

1673

1207

1674

1208

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

1675

"se.bsnet.fukt.Mandos"})

1209

"se.bsnet.fukt.Mandos"})

1676

1210

class ClientDBus(Client, DBusObjectWithProperties):

1677

1211

"""A Client class using D-Bus

1678

1212

1682

1216

"""

1683

1217

1684

1218

runtime_expansions = (Client.runtime_expansions

1685

+ ("dbus_object_path", ))

1686

1687

_interface = "se.recompile.Mandos.Client"

1219

+ ("dbus_object_path",))

1688

1220

1689

1221

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

1690

1222

1696

1228

client_object_name = str(self.name).translate(

1697

1229

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

1698

1230

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

1699

self.dbus_object_path = dbus.ObjectPath(

1700

"/clients/" + client_object_name)

1231

self.dbus_object_path = (dbus.ObjectPath

1232

("/clients/" + client_object_name))

1701

1233

DBusObjectWithProperties.__init__(self, self.bus,

1702

1234

self.dbus_object_path)

1703

1235

1704

def notifychangeproperty(transform_func, dbus_name,

1705

type_func=lambda x: x,

1706

variant_level=1,

1707

invalidate_only=False,

1708

_interface=_interface):

1236

def notifychangeproperty(transform_func,

1237

dbus_name, type_func=lambda x: x,

1238

variant_level=1):

1709

1239

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

1710

1240

its changes to DBus.

1711

1241

1717

1247

variant_level: D-Bus variant level. Default: 1

1718

1248

"""

1719

1249

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

1720

1721

1250

def setter(self, value):

1722

1251

if hasattr(self, "dbus_object_path"):

1723

1252

if (not hasattr(self, attrname) or

1724

1253

type_func(getattr(self, attrname, None))

1725

1254

!= 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())

1255

dbus_value = transform_func(type_func(value),

1256

variant_level

1257

=variant_level)

1258

self.PropertyChanged(dbus.String(dbus_name),

1259

dbus_value)

1741

1260

setattr(self, attrname, value)

1742

1261

1743

1262

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

1749

1268

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

1750

1269

last_enabled = notifychangeproperty(datetime_to_dbus,

1751

1270

"LastEnabled")

1752

checker = notifychangeproperty(

1753

dbus.Boolean, "CheckerRunning",

1754

type_func = lambda checker: checker is not None)

1271

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

1272

type_func = lambda checker:

1273

checker is not None)

1755

1274

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1756

1275

"LastCheckedOK")

1757

1276

last_checker_status = notifychangeproperty(dbus.Int16,

1760

1279

datetime_to_dbus, "LastApprovalRequest")

1761

1280

approved_by_default = notifychangeproperty(dbus.Boolean,

1762

1281

"ApprovedByDefault")

1763

approval_delay = notifychangeproperty(

1764

dbus.UInt64, "ApprovalDelay",

1765

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

1282

approval_delay = notifychangeproperty(dbus.UInt64,

1283

"ApprovalDelay",

1284

type_func =

1285

lambda td: td.total_seconds()

1286

* 1000)

1766

1287

approval_duration = notifychangeproperty(

1767

1288

dbus.UInt64, "ApprovalDuration",

1768

1289

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

1769

1290

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

1770

timeout = notifychangeproperty(

1771

dbus.UInt64, "Timeout",

1772

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

1291

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

1292

type_func = lambda td:

1293

td.total_seconds() * 1000)

1773

1294

extended_timeout = notifychangeproperty(

1774

1295

dbus.UInt64, "ExtendedTimeout",

1775

1296

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

1776

interval = notifychangeproperty(

1777

dbus.UInt64, "Interval",

1778

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

1297

interval = notifychangeproperty(dbus.UInt64,

1298

"Interval",

1299

type_func =

1300

lambda td: td.total_seconds()

1301

* 1000)

1779

1302

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

1780

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

1781

invalidate_only=True)

1782

1303

1783

1304

del notifychangeproperty

1784

1305

1791

1312

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

1792

1313

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

1793

1314

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:

1315

def checker_callback(self, pid, condition, command,

1316

*args, **kwargs):

1317

self.checker_callback_tag = None

1318

self.checker = None

1319

if os.WIFEXITED(condition):

1320

exitstatus = os.WEXITSTATUS(condition)

1801

1321

# Emit D-Bus signal

1802

1322

self.CheckerCompleted(dbus.Int16(exitstatus),

1803

# This is specific to GNU libC

1804

dbus.Int64(exitstatus << 8),

1323

dbus.Int64(condition),

1805

1324

dbus.String(command))

1806

1325

else:

1807

1326

# Emit D-Bus signal

1808

1327

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

1809

dbus.Int64(

1810

# This is specific to GNU libC

1811

(exitstatus << 8)

1812

| self.last_checker_signal),

1328

dbus.Int64(condition),

1813

1329

dbus.String(command))

1814

return ret

1330

1331

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

1332

*args, **kwargs)

1815

1333

1816

1334

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

1817

1335

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

1829

1347

1830

1348

def approve(self, value=True):

1831

1349

self.approved = value

1832

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

1833

* 1000), self._reset_approved)

1350

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

1351

* 1000), self._reset_approved)

1834

1352

self.send_changedstate()

1835

1353

1836

1354

## D-Bus methods, signals & properties

1355

_interface = "se.recompile.Mandos.Client"

1837

1356

1838

1357

## Interfaces

1839

1358

1359

@dbus_interface_annotations(_interface)

1360

def _foo(self):

1361

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

1362

"false"}

1363

1840

1364

## Signals

1841

1365

1842

1366

# CheckerCompleted - signal

1852

1376

pass

1853

1377

1854

1378

# PropertyChanged - signal

1855

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

1856

1379

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

1857

1380

def PropertyChanged(self, property, value):

1858

1381

"D-Bus signal"

1892

1415

self.checked_ok()

1893

1416

1894

1417

# Enable - method

1895

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

1896

1418

@dbus.service.method(_interface)

1897

1419

def Enable(self):

1898

1420

"D-Bus method"

1899

1421

self.enable()

1900

1422

1901

1423

# StartChecker - method

1902

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

1903

1424

@dbus.service.method(_interface)

1904

1425

def StartChecker(self):

1905

1426

"D-Bus method"

1906

1427

self.start_checker()

1907

1428

1908

1429

# Disable - method

1909

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

1910

1430

@dbus.service.method(_interface)

1911

1431

def Disable(self):

1912

1432

"D-Bus method"

1913

1433

self.disable()

1914

1434

1915

1435

# StopChecker - method

1916

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

1917

1436

@dbus.service.method(_interface)

1918

1437

def StopChecker(self):

1919

1438

self.stop_checker()

1926

1445

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

1927

1446

1928

1447

# ApprovedByDefault - property

1929

@dbus_service_property(_interface,

1930

signature="b",

1448

@dbus_service_property(_interface, signature="b",

1931

1449

access="readwrite")

1932

1450

def ApprovedByDefault_dbus_property(self, value=None):

1933

1451

if value is None: # get

1935

1453

self.approved_by_default = bool(value)

1936

1454

1937

1455

# ApprovalDelay - property

1938

@dbus_service_property(_interface,

1939

signature="t",

1456

@dbus_service_property(_interface, signature="t",

1940

1457

access="readwrite")

1941

1458

def ApprovalDelay_dbus_property(self, value=None):

1942

1459

if value is None: # get

1945

1462

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

1946

1463

1947

1464

# ApprovalDuration - property

1948

@dbus_service_property(_interface,

1949

signature="t",

1465

@dbus_service_property(_interface, signature="t",

1950

1466

access="readwrite")

1951

1467

def ApprovalDuration_dbus_property(self, value=None):

1952

1468

if value is None: # get

1955

1471

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

1956

1472

1957

1473

# Name - property

1958

@dbus_annotations(

1959

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

1960

1474

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

1961

1475

def Name_dbus_property(self):

1962

1476

return dbus.String(self.name)

1963

1477

1964

1478

# Fingerprint - property

1965

@dbus_annotations(

1966

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

1967

1479

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

1968

1480

def Fingerprint_dbus_property(self):

1969

1481

return dbus.String(self.fingerprint)

1970

1482

1971

1483

# Host - property

1972

@dbus_service_property(_interface,

1973

signature="s",

1484

@dbus_service_property(_interface, signature="s",

1974

1485

access="readwrite")

1975

1486

def Host_dbus_property(self, value=None):

1976

1487

if value is None: # get

1978

1489

self.host = str(value)

1979

1490

1980

1491

# Created - property

1981

@dbus_annotations(

1982

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

1983

1492

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

1984

1493

def Created_dbus_property(self):

1985

1494

return datetime_to_dbus(self.created)

1990

1499

return datetime_to_dbus(self.last_enabled)

1991

1500

1992

1501

# Enabled - property

1993

@dbus_service_property(_interface,

1994

signature="b",

1502

@dbus_service_property(_interface, signature="b",

1995

1503

access="readwrite")

1996

1504

def Enabled_dbus_property(self, value=None):

1997

1505

if value is None: # get

2002

1510

self.disable()

2003

1511

2004

1512

# LastCheckedOK - property

2005

@dbus_service_property(_interface,

2006

signature="s",

1513

@dbus_service_property(_interface, signature="s",

2007

1514

access="readwrite")

2008

1515

def LastCheckedOK_dbus_property(self, value=None):

2009

1516

if value is not None:

2012

1519

return datetime_to_dbus(self.last_checked_ok)

2013

1520

2014

1521

# LastCheckerStatus - property

2015

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

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2016

1524

def LastCheckerStatus_dbus_property(self):

2017

1525

return dbus.Int16(self.last_checker_status)

2018

1526

2027

1535

return datetime_to_dbus(self.last_approval_request)

2028

1536

2029

1537

# Timeout - property

2030

@dbus_service_property(_interface,

2031

signature="t",

1538

@dbus_service_property(_interface, signature="t",

2032

1539

access="readwrite")

2033

1540

def Timeout_dbus_property(self, value=None):

2034

1541

if value is None: # get

2046

1553

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

2047

1554

is None):

2048

1555

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)

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

int((self.expires - now).total_seconds()

1560

* 1000), self.disable))

2053

1561

2054

1562

# ExtendedTimeout - property

2055

@dbus_service_property(_interface,

2056

signature="t",

1563

@dbus_service_property(_interface, signature="t",

2057

1564

access="readwrite")

2058

1565

def ExtendedTimeout_dbus_property(self, value=None):

2059

1566

if value is None: # get

2062

1569

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

2063

1570

2064

1571

# Interval - property

2065

@dbus_service_property(_interface,

2066

signature="t",

1572

@dbus_service_property(_interface, signature="t",

2067

1573

access="readwrite")

2068

1574

def Interval_dbus_property(self, value=None):

2069

1575

if value is None: # get

2073

1579

return

2074

1580

if self.enabled:

2075

1581

# 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

1582

gobject.source_remove(self.checker_initiator_tag)

1583

self.checker_initiator_tag = (gobject.timeout_add

1584

(value, self.start_checker))

1585

self.start_checker() # Start one now, too

2080

1586

2081

1587

# Checker - property

2082

@dbus_service_property(_interface,

2083

signature="s",

1588

@dbus_service_property(_interface, signature="s",

2084

1589

access="readwrite")

2085

1590

def Checker_dbus_property(self, value=None):

2086

1591

if value is None: # get

2088

1593

self.checker_command = str(value)

2089

1594

2090

1595

# CheckerRunning - property

2091

@dbus_service_property(_interface,

2092

signature="b",

1596

@dbus_service_property(_interface, signature="b",

2093

1597

access="readwrite")

2094

1598

def CheckerRunning_dbus_property(self, value=None):

2095

1599

if value is None: # get

2100

1604

self.stop_checker()

2101

1605

2102

1606

# ObjectPath - property

2103

@dbus_annotations(

2104

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

2105

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

2106

1607

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

2107

1608

def ObjectPath_dbus_property(self):

2108

1609

return self.dbus_object_path # is already a dbus.ObjectPath

2109

1610

2110

1611

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

1612

@dbus_service_property(_interface, signature="ay",

1613

access="write", byte_arrays=True)

2118

1614

def Secret_dbus_property(self, value):

2119

1615

self.secret = bytes(value)

2120

1616

2126

1622

self._pipe = child_pipe

2127

1623

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

2128

1624

if not self._pipe.recv():

2129

raise KeyError(fpr)

1625

raise KeyError()

2130

1626

2131

1627

def __getattribute__(self, name):

2132

1628

if name == '_pipe':

2136

1632

if data[0] == 'data':

2137

1633

return data[1]

2138

1634

if data[0] == 'function':

2139

2140

1635

def func(*args, **kwargs):

2141

1636

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

2142

1637

return self._pipe.recv()[1]

2143

2144

1638

return func

2145

1639

2146

1640

def __setattr__(self, name, value):

2162

1656

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

2163

1657

self.server.child_pipe.fileno())

2164

1658

2165

session = gnutls.ClientSession(self.request)

1659

session = (gnutls.connection

1660

.ClientSession(self.request,

1661

gnutls.connection

1662

.X509Credentials()))

1663

1664

# Note: gnutls.connection.X509Credentials is really a

1665

# generic GnuTLS certificate credentials object so long as

1666

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

1667

# here despite using OpenPGP certificates.

2166

1668

2167

1669

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

2168

1670

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

2172

1674

priority = self.server.gnutls_priority

2173

1675

if priority is None:

2174

1676

priority = "NORMAL"

2175

gnutls.priority_set_direct(session._c_object, priority,

2176

None)

1677

(gnutls.library.functions

1678

.gnutls_priority_set_direct(session._c_object,

1679

priority, None))

2177

1680

2178

1681

# Start communication using the Mandos protocol

2179

1682

# Get protocol number

2189

1692

# Start GnuTLS connection

2190

1693

try:

2191

1694

session.handshake()

2192

except gnutls.Error as error:

1695

except gnutls.errors.GNUTLSError as error:

2193

1696

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

2194

1697

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

2195

1698

# established. Just abandon the request.

2199

1702

approval_required = False

2200

1703

try:

2201

1704

try:

2202

fpr = self.fingerprint(

2203

self.peer_certificate(session))

2204

except (TypeError, gnutls.Error) as error:

1705

fpr = self.fingerprint(self.peer_certificate

1706

(session))

1707

except (TypeError,

1708

gnutls.errors.GNUTLSError) as error:

2205

1709

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

2206

1710

return

2207

1711

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

2220

1724

while True:

2221

1725

if not client.enabled:

2222

1726

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

2223

client.name)

1727

client.name)

2224

1728

if self.server.use_dbus:

2225

1729

# Emit D-Bus signal

2226

1730

client.Rejected("Disabled")

2265

1769

else:

2266

1770

delay -= time2 - time

2267

1771

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

1772

sent_size = 0

1773

while sent_size < len(client.secret):

1774

try:

1775

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

1776

except gnutls.errors.GNUTLSError as error:

1777

logger.warning("gnutls send failed",

1778

exc_info=error)

1779

return

1780

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

1781

sent, len(client.secret)

1782

- (sent_size + sent))

1783

sent_size += sent

2274

1784

2275

1785

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

2276

1786

# bump the timeout using extended_timeout

2284

1794

client.approvals_pending -= 1

2285

1795

try:

2286

1796

session.bye()

2287

except gnutls.Error as error:

1797

except gnutls.errors.GNUTLSError as error:

2288

1798

logger.warning("GnuTLS bye failed",

2289

1799

exc_info=error)

2290

1800

2292

1802

def peer_certificate(session):

2293

1803

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

2294

1804

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

1805

if (gnutls.library.functions

1806

.gnutls_certificate_type_get(session._c_object)

1807

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1808

# ...do the normal thing

1809

return session.peer_certificate

2299

1810

list_size = ctypes.c_uint(1)

2300

cert_list = (gnutls.certificate_get_peers

1811

cert_list = (gnutls.library.functions

1812

.gnutls_certificate_get_peers

2301

1813

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

2302

1814

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

2303

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

1815

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

1816

" certificate")

2304

1817

if list_size.value == 0:

2305

1818

return None

2306

1819

cert = cert_list[0]

2310

1823

def fingerprint(openpgp):

2311

1824

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2312

1825

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

1826

datum = (gnutls.library.types

1827

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

1828

ctypes.POINTER

1829

(ctypes.c_ubyte)),

1830

ctypes.c_uint(len(openpgp))))

2317

1831

# New empty GnuTLS certificate

2318

crt = gnutls.openpgp_crt_t()

2319

gnutls.openpgp_crt_init(ctypes.byref(crt))

1832

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2320

1835

# Import the OpenPGP public key into the certificate

2321

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

2322

gnutls.OPENPGP_FMT_RAW)

1836

(gnutls.library.functions

1837

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

1838

gnutls.library.constants

1839

.GNUTLS_OPENPGP_FMT_RAW))

2323

1840

# Verify the self signature in the key

2324

1841

crtverify = ctypes.c_uint()

2325

gnutls.openpgp_crt_verify_self(crt, 0,

2326

ctypes.byref(crtverify))

1842

(gnutls.library.functions

1843

.gnutls_openpgp_crt_verify_self(crt, 0,

1844

ctypes.byref(crtverify)))

2327

1845

if crtverify.value != 0:

2328

gnutls.openpgp_crt_deinit(crt)

2329

raise gnutls.CertificateSecurityError("Verify failed")

1846

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1847

raise (gnutls.errors.CertificateSecurityError

1848

("Verify failed"))

2330

1849

# New buffer for the fingerprint

2331

1850

buf = ctypes.create_string_buffer(20)

2332

1851

buf_len = ctypes.c_size_t()

2333

1852

# Get the fingerprint from the certificate into the buffer

2334

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

2335

ctypes.byref(buf_len))

1853

(gnutls.library.functions

1854

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

1855

ctypes.byref(buf_len)))

2336

1856

# Deinit the certificate

2337

gnutls.openpgp_crt_deinit(crt)

1857

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2338

1858

# Convert the buffer to a Python bytestring

2339

1859

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

2340

1860

# Convert the bytestring to hexadecimal notation

2344

1864

2345

1865

class MultiprocessingMixIn(object):

2346

1866

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

2347

2348

1867

def sub_process_main(self, request, address):

2349

1868

try:

2350

1869

self.finish_request(request, address)

2362

1881

2363

1882

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2364

1883

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

2365

2366

1884

def process_request(self, request, client_address):

2367

1885

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

2368

1886

2389

1907

interface: None or a network interface name (string)

2390

1908

use_ipv6: Boolean; to use IPv6 or not

2391

1909

"""

2392

2393

1910

def __init__(self, server_address, RequestHandlerClass,

2394

interface=None,

2395

use_ipv6=True,

2396

socketfd=None):

1911

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

2397

1912

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

2398

1913

creating a new one with socket.socket().

2399

1914

"""

2440

1955

self.interface)

2441

1956

else:

2442

1957

try:

2443

self.socket.setsockopt(

2444

socket.SOL_SOCKET, SO_BINDTODEVICE,

2445

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

1958

self.socket.setsockopt(socket.SOL_SOCKET,

1959

SO_BINDTODEVICE,

1960

(self.interface + "\0")

1961

.encode("utf-8"))

2446

1962

except socket.error as error:

2447

1963

if error.errno == errno.EPERM:

2448

1964

logger.error("No permission to bind to"

2466

1982

self.server_address = (any_address,

2467

1983

self.server_address[1])

2468

1984

elif not self.server_address[1]:

2469

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

1985

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

1986

0)

2470

1987

# if self.interface:

2471

1988

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

2472

1989

# 0, # port

2484

2001

gnutls_priority GnuTLS priority string

2485

2002

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

2486

2003

2487

Assumes a GLib.MainLoop event loop.

2004

Assumes a gobject.MainLoop event loop.

2488

2005

"""

2489

2490

2006

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

2007

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

2008

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

2497

2009

self.enabled = False

2498

2010

self.clients = clients

2499

2011

if self.clients is None:

2505

2017

interface = interface,

2506

2018

use_ipv6 = use_ipv6,

2507

2019

socketfd = socketfd)

2508

2509

2020

def server_activate(self):

2510

2021

if self.enabled:

2511

2022

return socketserver.TCPServer.server_activate(self)

2515

2026

2516

2027

def add_pipe(self, parent_pipe, proc):

2517

2028

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

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2524

2035

2525

def handle_ipc(self, source, condition,

2526

parent_pipe=None,

2527

proc = None,

2528

client_object=None):

2036

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

2037

proc = None, client_object=None):

2529

2038

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

2530

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

2039

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

2531

2040

# Wait for other process to exit

2532

2041

proc.join()

2533

2042

return False

2540

2049

fpr = request[1]

2541

2050

address = request[2]

2542

2051

2543

for c in self.clients.values():

2052

for c in self.clients.itervalues():

2544

2053

if c.fingerprint == fpr:

2545

2054

client = c

2546

2055

break

2554

2063

parent_pipe.send(False)

2555

2064

return False

2556

2065

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

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2564

2074

parent_pipe.send(True)

2565

2075

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

2566

2076

# same fileno

2572

2082

2573

2083

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

2574

2084

funcname)(*args,

2575

**kwargs)))

2085

**kwargs)))

2576

2086

2577

2087

if command == 'getattr':

2578

2088

attrname = request[1]

2579

if isinstance(client_object.__getattribute__(attrname),

2580

collections.Callable):

2581

parent_pipe.send(('function', ))

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2582

2091

else:

2583

parent_pipe.send((

2584

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

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2585

2094

2586

2095

if command == 'setattr':

2587

2096

attrname = request[1]

2618

2127

# avoid excessive use of external libraries.

2619

2128

2620

2129

# 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

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2626

2139

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

2627

2140

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

2628

2141

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

2629

2142

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

2630

2143

datetime.timedelta(seconds=1),

2631

frozenset((token_end, )))

2144

frozenset((token_end,)))

2632

2145

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

2633

2146

datetime.timedelta(minutes=1),

2634

2147

frozenset((token_second, token_end)))

2650

2163

frozenset((token_month, token_end)))

2651

2164

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

2652

2165

datetime.timedelta(weeks=1),

2653

frozenset((token_end, )))

2166

frozenset((token_end,)))

2654

2167

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

2655

2168

frozenset((token_year, token_month,

2656

2169

token_day, token_time,

2658

2171

# Define starting values

2659

2172

value = datetime.timedelta() # Value so far

2660

2173

found_token = None

2661

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

2174

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

2662

2175

s = duration # String left to parse

2663

2176

# Loop until end token is found

2664

2177

while found_token is not token_end:

2681

2194

break

2682

2195

else:

2683

2196

# No currently valid tokens were found

2684

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

2685

.format(duration))

2197

raise ValueError("Invalid RFC 3339 duration")

2686

2198

# End token found

2687

2199

return value

2688

2200

2725

2237

elif suffix == "w":

2726

2238

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

2727

2239

else:

2728

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

2240

raise ValueError("Unknown suffix {!r}"

2241

.format(suffix))

2729

2242

except IndexError as e:

2730

2243

raise ValueError(*(e.args))

2731

2244

timevalue += delta

2747

2260

# Close all standard open file descriptors

2748

2261

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

2749

2262

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

2750

raise OSError(errno.ENODEV,

2751

"{} not a character device"

2263

raise OSError(errno.ENODEV, "{} not a character device"

2752

2264

.format(os.devnull))

2753

2265

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

2754

2266

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

2820

2332

"port": "",

2821

2333

"debug": "False",

2822

2334

"priority":

2823

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

2824

":+SIGN-DSA-SHA256",

2335

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

2825

2336

"servicename": "Mandos",

2826

2337

"use_dbus": "True",

2827

2338

"use_ipv6": "True",

2831

2342

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

2832

2343

"foreground": "False",

2833

2344

"zeroconf": "True",

2834

}

2345

}

2835

2346

2836

2347

# Parse config file for server-global settings

2837

2348

server_config = configparser.SafeConfigParser(server_defaults)

2838

2349

del server_defaults

2839

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

2350

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

2351

"mandos.conf"))

2840

2352

# Convert the SafeConfigParser object to a dict

2841

2353

server_settings = server_config.defaults()

2842

2354

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

2860

2372

# Override the settings from the config file with command line

2861

2373

# options, if set.

2862

2374

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

2863

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

2864

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

2865

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

2375

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

2376

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

2377

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

2866

2378

value = getattr(options, option)

2867

2379

if value is not None:

2868

2380

server_settings[option] = value

2883

2395

2884

2396

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

2885

2397

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

2398

if (not server_settings["zeroconf"] and

2399

not (server_settings["port"]

2400

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

2401

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

2402

" Zeroconf")

2890

2403

2891

2404

# For convenience

2892

2405

debug = server_settings["debug"]

2908

2421

initlogger(debug, level)

2909

2422

2910

2423

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

2911

syslogger.setFormatter(

2912

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

2913

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

2914

server_settings["servicename"])))

2424

syslogger.setFormatter(logging.Formatter

2425

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

2426

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

2427

.format(server_settings

2428

["servicename"])))

2915

2429

2916

2430

# Parse config file with clients

2917

2431

client_config = configparser.SafeConfigParser(Client

2925

2439

socketfd = None

2926

2440

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

2927

2441

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)

2442

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

2443

server_settings["port"]),

2444

ClientHandler,

2445

interface=(server_settings["interface"]

2446

or None),

2447

use_ipv6=use_ipv6,

2448

gnutls_priority=

2449

server_settings["priority"],

2450

use_dbus=use_dbus,

2451

socketfd=socketfd)

2936

2452

if not foreground:

2937

2453

pidfilename = "/run/mandos.pid"

2938

2454

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

2939

2455

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

2940

2456

pidfile = None

2941

2457

try:

2942

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

2458

pidfile = open(pidfilename, "w")

2943

2459

except IOError as e:

2944

2460

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

2945

2461

exc_info=e)

2946

2462

2947

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

2948

("mandos", "mandos"),

2949

("nobody", "nogroup")):

2463

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

2950

2464

try:

2951

2465

uid = pwd.getpwnam(name).pw_uid

2952

gid = pwd.getpwnam(group).pw_gid

2466

gid = pwd.getpwnam(name).pw_gid

2953

2467

break

2954

2468

except KeyError:

2955

2469

continue

2959

2473

try:

2960

2474

os.setgid(gid)

2961

2475

os.setuid(uid)

2962

if debug:

2963

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

2964

gid))

2965

2476

except OSError as error:

2966

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

2967

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

2968

2477

if error.errno != errno.EPERM:

2969

2478

raise

2970

2479

2973

2482

2974

2483

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

2975

2484

# - GnuTLS manual

2976

gnutls.global_set_log_level(11)

2485

gnutls.library.functions.gnutls_global_set_log_level(11)

2977

2486

2978

@gnutls.log_func

2487

@gnutls.library.types.gnutls_log_func

2979

2488

def debug_gnutls(level, string):

2980

2489

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

2981

2490

2982

gnutls.global_set_log_function(debug_gnutls)

2491

(gnutls.library.functions

2492

.gnutls_global_set_log_function(debug_gnutls))

2983

2493

2984

2494

# Redirect stdin so all checkers get /dev/null

2985

2495

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

2992

2502

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

2993

2503

daemon()

2994

2504

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

2505

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

2506

# need to inform gobject that threads will be used.

2507

gobject.threads_init()

2998

2508

2999

2509

global main_loop

3000

2510

# From the Avahi example code

3001

2511

DBusGMainLoop(set_as_default=True)

3002

main_loop = GLib.MainLoop()

2512

main_loop = gobject.MainLoop()

3003

2513

bus = dbus.SystemBus()

3004

2514

# End of Avahi example code

3005

2515

if use_dbus:

3006

2516

try:

3007

2517

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:

2518

bus, do_not_queue=True)

2519

old_bus_name = (dbus.service.BusName

2520

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

2521

do_not_queue=True))

2522

except dbus.exceptions.NameExistsException as e:

3014

2523

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

3015

2524

use_dbus = False

3016

2525

server_settings["use_dbus"] = False

3017

2526

tcp_server.use_dbus = False

3018

2527

if zeroconf:

3019

2528

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)

2529

service = AvahiServiceToSyslog(name =

2530

server_settings["servicename"],

2531

servicetype = "_mandos._tcp",

2532

protocol = protocol, bus = bus)

3025

2533

if server_settings["interface"]:

3026

service.interface = if_nametoindex(

3027

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

2534

service.interface = (if_nametoindex

2535

(server_settings["interface"]

2536

.encode("utf-8")))

3028

2537

3029

2538

global multiprocessing_manager

3030

2539

multiprocessing_manager = multiprocessing.Manager()

3049

2558

if server_settings["restore"]:

3050

2559

try:

3051

2560

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

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3097

2563

os.remove(stored_state_path)

3098

2564

except IOError as e:

3099

2565

if e.errno == errno.ENOENT:

3100

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

3101

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

2566

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

2567

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

3102

2568

else:

3103

2569

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

3104

2570

exc_info=e)

3105

2571

raise

3106

2572

except EOFError as e:

3107

2573

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

3108

"EOFError:",

3109

exc_info=e)

2574

"EOFError:", exc_info=e)

3110

2575

3111

2576

with PGPEngine() as pgp:

3112

2577

for client_name, client in clients_data.items():

3124

2589

# For each value in new config, check if it

3125

2590

# differs from the old config value (Except for

3126

2591

# the "secret" attribute)

3127

if (name != "secret"

3128

and (value !=

3129

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3130

2595

client[name] = value

3131

2596

except KeyError:

3132

2597

pass

3133

2598

3134

2599

# Clients who has passed its expire date can still be

3135

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3136

2601

# whose checker succeeded before we stored its state is

3137

2602

# assumed to have successfully run all checkers during

3138

2603

# downtime.

3141

2606

if not client["last_checked_ok"]:

3142

2607

logger.warning(

3143

2608

"disabling client {} - Client never "

3144

"performed a successful checker".format(

3145

client_name))

2609

"performed a successful checker"

2610

.format(client_name))

3146

2611

client["enabled"] = False

3147

2612

elif client["last_checker_status"] != 0:

3148

2613

logger.warning(

3149

2614

"disabling client {} - Client last"

3150

" checker failed with error code"

3151

" {}".format(

3152

client_name,

3153

client["last_checker_status"]))

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3154

2618

client["enabled"] = False

3155

2619

else:

3156

client["expires"] = (

3157

datetime.datetime.utcnow()

3158

+ client["timeout"])

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

3159

2623

logger.debug("Last checker succeeded,"

3160

" keeping {} enabled".format(

3161

client_name))

2624

" keeping {} enabled"

2625

.format(client_name))

3162

2626

try:

3163

client["secret"] = pgp.decrypt(

3164

client["encrypted_secret"],

3165

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3166

2631

except PGPError:

3167

2632

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

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

3172

2637

3173

2638

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

3174

2639

for client_name in (set(old_client_settings)

3181

2646

# Create all client objects

3182

2647

for client_name, client in clients_data.items():

3183

2648

tcp_server.clients[client_name] = client_class(

3184

name = client_name,

3185

settings = client,

2649

name = client_name, settings = client,

3186

2650

server_settings = server_settings)

3187

2651

3188

2652

if not tcp_server.clients:

3190

2654

3191

2655

if not foreground:

3192

2656

if pidfile is not None:

3193

pid = os.getpid()

3194

2657

try:

3195

2658

with pidfile:

3196

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

pidfile.write("{}\n".format(pid).encode("utf-8"))

3197

2661

except IOError:

3198

2662

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

3199

2663

pidfilename, pid)

3200

2664

del pidfile

3201

2665

del pidfilename

3202

2666

3203

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

3204

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3205

lambda: main_loop.quit() and False)

2667

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

2668

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

3206

2669

3207

2670

if use_dbus:

3208

3209

@alternate_dbus_interfaces(

3210

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

3211

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3212

2674

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

3213

3214

2675

def __init__(self):

3215

2676

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

3216

3217

2677

_interface = "se.recompile.Mandos"

3218

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3219

2685

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

3220

2686

def ClientAdded(self, objpath):

3221

2687

"D-Bus signal"

3226

2692

"D-Bus signal"

3227

2693

pass

3228

2694

3229

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

3230

"true"})

3231

2695

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

3232

2696

def ClientRemoved(self, objpath, name):

3233

2697

"D-Bus signal"

3234

2698

pass

3235

2699

3236

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

3237

"true"})

3238

2700

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

3239

2701

def GetAllClients(self):

3240

2702

"D-Bus method"

3241

return dbus.Array(c.dbus_object_path for c in

3242

tcp_server.clients.values())

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

3243

2706

3244

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

3245

"true"})

3246

2707

@dbus.service.method(_interface,

3247

2708

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

3248

2709

def GetAllClientsWithProperties(self):

3249

2710

"D-Bus method"

3250

2711

return dbus.Dictionary(

3251

{ c.dbus_object_path: c.GetAll(

3252

"se.recompile.Mandos.Client")

3253

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

2712

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

2713

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

3254

2714

signature="oa{sv}")

3255

2715

3256

2716

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

3257

2717

def RemoveClient(self, object_path):

3258

2718

"D-Bus method"

3259

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3260

2720

if c.dbus_object_path == object_path:

3261

2721

del tcp_server.clients[c.name]

3262

2722

c.remove_from_connection()

3263

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3264

2724

c.disable(quiet=True)

3265

# Emit D-Bus signal for removal

3266

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3267

2727

return

3268

2728

raise KeyError(object_path)

3269

2729

3270

2730

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

2731

3308

2732

mandos_dbus_service = MandosDBusService()

3309

2733

3322

2746

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

3323

2747

clients = {}

3324

2748

with PGPEngine() as pgp:

3325

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3326

2750

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

3327

2751

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

3328

2752

key)

3332

2756

# + secret.

3333

2757

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

3334

2758

"checker", "server_settings" }

3335

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

3336

.Object):

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3337

2761

exclude.add(name)

3338

2762

3339

2763

client_dict["encrypted_secret"] = (client

3346

2770

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

3347

2771

3348

2772

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

2773

with (tempfile.NamedTemporaryFile

2774

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

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3358

2779

os.rename(tempname, stored_state_path)

3359

2780

except (IOError, OSError) as e:

3360

2781

if not debug:

3375

2796

name, client = tcp_server.clients.popitem()

3376

2797

if use_dbus:

3377

2798

client.remove_from_connection()

3378

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3379

2800

client.disable(quiet=True)

3380

# Emit D-Bus signal for removal

3381

2801

if use_dbus:

3382

mandos_dbus_service.client_removed_signal(client)

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3383

2806

client_settings.clear()

3384

2807

3385

2808

atexit.register(cleanup)

3386

2809

3387

for client in tcp_server.clients.values():

2810

for client in tcp_server.clients.itervalues():

3388

2811

if use_dbus:

3389

# Emit D-Bus signal for adding

3390

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3391

2814

# Need to initiate checking of clients

3392

2815

if client.enabled:

3393

2816

client.init_checker()

3419

2842

sys.exit(1)

3420

2843

# End of Avahi example code

3421

2844

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

2845

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

2846

lambda *args, **kwargs:

2847

(tcp_server.handle_request

2848

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

3426

2849

3427

2850

logger.debug("Starting main loop")

3428

2851

main_loop.run()

3438

2861

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

3439

2862

cleanup()

3440

2863

3441

3442

2864

if __name__ == '__main__':

3443

2865

main()