/mandos/trunk : revision 740

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

86

80

import xml.dom.minidom

87

81

import inspect

88

82

89

# Try to find the value of SO_BINDTODEVICE:

90

83

try:

91

# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and

92

# newer, and it is also the most natural place for it:

93

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

85

except AttributeError:

95

86

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

87

from IN import SO_BINDTODEVICE

99

88

except ImportError:

100

# In Python 2.7 it seems to have been removed entirely.

101

# Try running the C preprocessor:

102

try:

103

cc = subprocess.Popen(["cc", "--language=c", "-E",

104

"/dev/stdin"],

105

stdin=subprocess.PIPE,

106

stdout=subprocess.PIPE)

107

stdout = cc.communicate(

108

"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]

109

SO_BINDTODEVICE = int(stdout.splitlines()[-1])

110

except (OSError, ValueError, IndexError):

111

# No value found

112

SO_BINDTODEVICE = None

89

SO_BINDTODEVICE = None

113

90

114

91

if sys.version_info.major == 2:

115

92

str = unicode

116

93

117

version = "1.7.9"

94

version = "1.6.9"

118

95

stored_state_file = "clients.pickle"

119

96

120

97

logger = logging.getLogger()

121

98

syslogger = None

122

99

123

100

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

126

104

except (OSError, AttributeError):

127

128

105

def if_nametoindex(interface):

129

106

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

130

107

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

135

112

return interface_index

136

113

137

114

138

def copy_function(func):

139

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

140

if sys.version_info.major == 2:

141

return types.FunctionType(func.func_code,

142

func.func_globals,

143

func.func_name,

144

func.func_defaults,

145

func.func_closure)

146

else:

147

return types.FunctionType(func.__code__,

148

func.__globals__,

149

func.__name__,

150

func.__defaults__,

151

func.__closure__)

152

153

154

115

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

155

116

"""init logger and add loglevel"""

156

117

157

118

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

160

address = "/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

161

123

syslogger.setFormatter(logging.Formatter

162

124

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

163

125

' %(message)s'))

180

142

181

143

class PGPEngine(object):

182

144

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

183

184

145

def __init__(self):

185

146

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

186

self.gpg = "gpg"

187

try:

188

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

189

for line in output.splitlines():

190

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

191

if name == "gpg":

192

self.gpg = path

193

break

194

except OSError as e:

195

if e.errno != errno.ENOENT:

196

raise

197

147

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

148

'--home', self.tempdir,

199

149

'--force-mdc',

200

'--quiet']

201

# Only GPG version 1 has the --no-use-agent option.

202

if self.gpg == "gpg" or self.gpg.endswith("/gpg"):

203

self.gnupgargs.append("--no-use-agent")

150

'--quiet',

151

'--no-use-agent']

204

152

205

153

def __enter__(self):

206

154

return self

238

186

239

187

def encrypt(self, data, password):

240

188

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

243

191

passfile.write(passphrase)

244

192

passfile.flush()

245

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

193

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

246

194

'--passphrase-file',

247

195

passfile.name]

248

196

+ self.gnupgargs,

256

204

257

205

def decrypt(self, data, password):

258

206

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir = self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

261

209

passfile.write(passphrase)

262

210

passfile.flush()

263

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

211

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

264

212

'--passphrase-file',

265

213

passfile.name]

266

214

+ self.gnupgargs,

267

215

stdin = subprocess.PIPE,

268

216

stdout = subprocess.PIPE,

269

217

stderr = subprocess.PIPE)

270

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

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

271

220

if proc.returncode != 0:

272

221

raise PGPError(err)

273

222

return decrypted_plaintext

274

223

275

# Pretend that we have an Avahi module

276

class Avahi(object):

277

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

278

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

279

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

280

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

281

PROTO_INET = 0 # avahi-common/address.h

282

PROTO_INET6 = 1 # avahi-common/address.h

283

DBUS_NAME = "org.freedesktop.Avahi"

284

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

285

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

286

DBUS_PATH_SERVER = "/"

287

def string_array_to_txt_array(self, t):

288

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

289

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

290

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

291

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

292

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

293

SERVER_INVALID = 0 # avahi-common/defs.h

294

SERVER_REGISTERING = 1 # avahi-common/defs.h

295

SERVER_RUNNING = 2 # avahi-common/defs.h

296

SERVER_COLLISION = 3 # avahi-common/defs.h

297

SERVER_FAILURE = 4 # avahi-common/defs.h

298

avahi = Avahi()

299

224

300

225

class AvahiError(Exception):

301

226

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

303

228

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

304

229

**kwargs)

305

230

306

307

231

class AvahiServiceError(AvahiError):

308

232

pass

309

233

310

311

234

class AvahiGroupError(AvahiError):

312

235

pass

313

236

333

256

bus: dbus.SystemBus()

334

257

"""

335

258

336

def __init__(self,

337

interface = avahi.IF_UNSPEC,

338

name = None,

339

servicetype = None,

340

port = None,

341

TXT = None,

342

domain = "",

343

host = "",

344

max_renames = 32768,

345

protocol = avahi.PROTO_UNSPEC,

346

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

347

263

self.interface = interface

348

264

self.name = name

349

265

self.type = servicetype

366

282

" after %i retries, exiting.",

367

283

self.rename_count)

368

284

raise AvahiServiceError("Too many renames")

369

self.name = str(

370

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

371

287

self.rename_count += 1

372

288

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

373

289

self.name)

428

344

elif state == avahi.ENTRY_GROUP_FAILURE:

429

345

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

430

346

str(error))

431

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

347

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

348

.format(error))

432

349

433

350

def cleanup(self):

434

351

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

444

361

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

445

362

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

446

363

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

447

bad_states = {

448

avahi.SERVER_INVALID: "Zeroconf server invalid",

449

avahi.SERVER_REGISTERING: None,

450

avahi.SERVER_COLLISION: "Zeroconf server name collision",

451

avahi.SERVER_FAILURE: "Zeroconf server failure",

452

}

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

453

371

if state in bad_states:

454

372

if bad_states[state] is not None:

455

373

if error is None:

458

376

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

459

377

self.cleanup()

460

378

elif state == avahi.SERVER_RUNNING:

461

try:

462

self.add()

463

except dbus.exceptions.DBusException as error:

464

if (error.get_dbus_name()

465

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

466

logger.info("Local Zeroconf service name"

467

" collision.")

468

return self.rename(remove=False)

469

else:

470

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

471

self.cleanup()

472

os._exit(1)

379

self.add()

473

380

else:

474

381

if error is None:

475

382

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

485

392

follow_name_owner_changes=True),

486

393

avahi.DBUS_INTERFACE_SERVER)

487

394

self.server.connect_to_signal("StateChanged",

488

self.server_state_changed)

395

self.server_state_changed)

489

396

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

490

397

491

398

493

400

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

494

401

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

495

402

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

496

syslogger.setFormatter(logging.Formatter(

497

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

498

.format(self.name)))

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

499

407

return ret

500

408

501

# Pretend that we have a GnuTLS module

502

class GnuTLS(object):

503

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

504

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

505

506

_library = ctypes.cdll.LoadLibrary(

507

ctypes.util.find_library("gnutls"))

508

_need_version = b"3.3.0"

509

def __init__(self):

510

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

511

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

512

# happens.

513

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

514

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

515

.format(self._need_version))

516

517

# Unless otherwise indicated, the constants and types below are

518

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

519

520

# Constants

521

E_SUCCESS = 0

522

E_INTERRUPTED = -52

523

E_AGAIN = -28

524

CRT_OPENPGP = 2

525

CLIENT = 2

526

SHUT_RDWR = 0

527

CRD_CERTIFICATE = 1

528

E_NO_CERTIFICATE_FOUND = -49

529

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

530

531

# Types

532

class session_int(ctypes.Structure):

533

_fields_ = []

534

session_t = ctypes.POINTER(session_int)

535

class certificate_credentials_st(ctypes.Structure):

536

_fields_ = []

537

certificate_credentials_t = ctypes.POINTER(

538

certificate_credentials_st)

539

certificate_type_t = ctypes.c_int

540

class datum_t(ctypes.Structure):

541

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

542

('size', ctypes.c_uint)]

543

class openpgp_crt_int(ctypes.Structure):

544

_fields_ = []

545

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

546

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

547

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

548

credentials_type_t = ctypes.c_int

549

transport_ptr_t = ctypes.c_void_p

550

close_request_t = ctypes.c_int

551

552

# Exceptions

553

class Error(Exception):

554

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

555

# exception might be raised from within GnuTLS.__init__,

556

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

557

# global variable has happened.

558

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

559

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

560

# code is passed, convert it to a string with

561

# gnutls.strerror()

562

self.code = code

563

if message is None and code is not None:

564

message = GnuTLS.strerror(code)

565

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

566

message, *args)

567

568

class CertificateSecurityError(Error):

569

pass

570

571

# Classes

572

class Credentials(object):

573

def __init__(self):

574

self._c_object = gnutls.certificate_credentials_t()

575

gnutls.certificate_allocate_credentials(

576

ctypes.byref(self._c_object))

577

self.type = gnutls.CRD_CERTIFICATE

578

579

def __del__(self):

580

gnutls.certificate_free_credentials(self._c_object)

581

582

class ClientSession(object):

583

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

584

self._c_object = gnutls.session_t()

585

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

586

gnutls.set_default_priority(self._c_object)

587

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

588

gnutls.handshake_set_private_extensions(self._c_object,

589

True)

590

self.socket = socket

591

if credentials is None:

592

credentials = gnutls.Credentials()

593

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

594

ctypes.cast(credentials._c_object,

595

ctypes.c_void_p))

596

self.credentials = credentials

597

598

def __del__(self):

599

gnutls.deinit(self._c_object)

600

601

def handshake(self):

602

return gnutls.handshake(self._c_object)

603

604

def send(self, data):

605

data = bytes(data)

606

data_len = len(data)

607

while data_len > 0:

608

data_len -= gnutls.record_send(self._c_object,

609

data[-data_len:],

610

data_len)

611

612

def bye(self):

613

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

614

615

# Error handling functions

616

def _error_code(result):

617

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

618

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

619

if result >= 0:

620

return result

621

if result == gnutls.E_NO_CERTIFICATE_FOUND:

622

raise gnutls.CertificateSecurityError(code = result)

623

raise gnutls.Error(code = result)

624

625

def _retry_on_error(result, func, arguments):

626

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

627

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

628

while result < 0:

629

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

630

return _error_code(result)

631

result = func(*arguments)

632

return result

633

634

# Unless otherwise indicated, the function declarations below are

635

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

636

637

# Functions

638

priority_set_direct = _library.gnutls_priority_set_direct

639

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

640

ctypes.POINTER(ctypes.c_char_p)]

641

priority_set_direct.restype = _error_code

642

643

init = _library.gnutls_init

644

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

645

init.restype = _error_code

646

647

set_default_priority = _library.gnutls_set_default_priority

648

set_default_priority.argtypes = [session_t]

649

set_default_priority.restype = _error_code

650

651

record_send = _library.gnutls_record_send

652

record_send.argtypes = [session_t, ctypes.c_void_p,

653

ctypes.c_size_t]

654

record_send.restype = ctypes.c_ssize_t

655

record_send.errcheck = _retry_on_error

656

657

certificate_allocate_credentials = (

658

_library.gnutls_certificate_allocate_credentials)

659

certificate_allocate_credentials.argtypes = [

660

ctypes.POINTER(certificate_credentials_t)]

661

certificate_allocate_credentials.restype = _error_code

662

663

certificate_free_credentials = (

664

_library.gnutls_certificate_free_credentials)

665

certificate_free_credentials.argtypes = [certificate_credentials_t]

666

certificate_free_credentials.restype = None

667

668

handshake_set_private_extensions = (

669

_library.gnutls_handshake_set_private_extensions)

670

handshake_set_private_extensions.argtypes = [session_t,

671

ctypes.c_int]

672

handshake_set_private_extensions.restype = None

673

674

credentials_set = _library.gnutls_credentials_set

675

credentials_set.argtypes = [session_t, credentials_type_t,

676

ctypes.c_void_p]

677

credentials_set.restype = _error_code

678

679

strerror = _library.gnutls_strerror

680

strerror.argtypes = [ctypes.c_int]

681

strerror.restype = ctypes.c_char_p

682

683

certificate_type_get = _library.gnutls_certificate_type_get

684

certificate_type_get.argtypes = [session_t]

685

certificate_type_get.restype = _error_code

686

687

certificate_get_peers = _library.gnutls_certificate_get_peers

688

certificate_get_peers.argtypes = [session_t,

689

ctypes.POINTER(ctypes.c_uint)]

690

certificate_get_peers.restype = ctypes.POINTER(datum_t)

691

692

global_set_log_level = _library.gnutls_global_set_log_level

693

global_set_log_level.argtypes = [ctypes.c_int]

694

global_set_log_level.restype = None

695

696

global_set_log_function = _library.gnutls_global_set_log_function

697

global_set_log_function.argtypes = [log_func]

698

global_set_log_function.restype = None

699

700

deinit = _library.gnutls_deinit

701

deinit.argtypes = [session_t]

702

deinit.restype = None

703

704

handshake = _library.gnutls_handshake

705

handshake.argtypes = [session_t]

706

handshake.restype = _error_code

707

handshake.errcheck = _retry_on_error

708

709

transport_set_ptr = _library.gnutls_transport_set_ptr

710

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

711

transport_set_ptr.restype = None

712

713

bye = _library.gnutls_bye

714

bye.argtypes = [session_t, close_request_t]

715

bye.restype = _error_code

716

bye.errcheck = _retry_on_error

717

718

check_version = _library.gnutls_check_version

719

check_version.argtypes = [ctypes.c_char_p]

720

check_version.restype = ctypes.c_char_p

721

722

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

723

724

openpgp_crt_init = _library.gnutls_openpgp_crt_init

725

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

726

openpgp_crt_init.restype = _error_code

727

728

openpgp_crt_import = _library.gnutls_openpgp_crt_import

729

openpgp_crt_import.argtypes = [openpgp_crt_t,

730

ctypes.POINTER(datum_t),

731

openpgp_crt_fmt_t]

732

openpgp_crt_import.restype = _error_code

733

734

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

735

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

736

ctypes.POINTER(ctypes.c_uint)]

737

openpgp_crt_verify_self.restype = _error_code

738

739

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

740

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

741

openpgp_crt_deinit.restype = None

742

743

openpgp_crt_get_fingerprint = (

744

_library.gnutls_openpgp_crt_get_fingerprint)

745

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

746

ctypes.c_void_p,

747

ctypes.POINTER(

748

ctypes.c_size_t)]

749

openpgp_crt_get_fingerprint.restype = _error_code

750

751

# Remove non-public functions

752

del _error_code, _retry_on_error

753

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

754

gnutls = GnuTLS()

755

756

def call_pipe(connection, # : multiprocessing.Connection

757

func, *args, **kwargs):

758

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

759

760

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

761

return value on the provided multiprocessing.Connection.

762

"""

763

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

764

connection.close()

765

409

766

410

class Client(object):

767

411

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

773

417

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

774

418

to see if the client lives.

775

419

'None' if no process is running.

776

checker_callback_tag: a GLib event source tag, or None

420

checker_callback_tag: a gobject event source tag, or None

777

421

checker_command: string; External command which is run to check

778

422

if client lives. %() expansions are done at

779

423

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

780

424

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

781

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

782

426

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

783

427

client_structure: Object describing what attributes a client has

784

428

and is used for storing the client at exit

785

429

current_checker_command: string; current running checker_command

786

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

787

431

enabled: bool()

788

432

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

789

433

uniquely identify the client

794

438

last_checker_status: integer between 0 and 255 reflecting exit

795

439

status of last checker. -1 reflects crashed

796

440

checker, -2 means no checker completed yet.

797

last_checker_signal: The signal which killed the last checker, if

798

last_checker_status is -1

799

441

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

800

442

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

801

443

D-Bus identifiers

814

456

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

815

457

"last_approval_request", "last_checked_ok",

816

458

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

817

client_defaults = {

818

"timeout": "PT5M",

819

"extended_timeout": "PT15M",

820

"interval": "PT2M",

821

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

822

"host": "",

823

"approval_delay": "PT0S",

824

"approval_duration": "PT1S",

825

"approved_by_default": "True",

826

"enabled": "True",

827

}

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

828

469

829

470

@staticmethod

830

471

def config_parser(config):

852

493

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

853

494

.replace(" ", ""))

854

495

if "secret" in section:

855

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

856

.encode("utf-8"),

857

"base64")

496

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

858

497

elif "secfile" in section:

859

498

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

860

499

(section["secfile"])),

910

549

self.current_checker_command = None

911

550

self.approved = None

912

551

self.approvals_pending = 0

913

self.changedstate = multiprocessing_manager.Condition(

914

multiprocessing_manager.Lock())

915

self.client_structure = [attr

916

for attr in self.__dict__.keys()

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

917

557

if not attr.startswith("_")]

918

558

self.client_structure.append("client_structure")

919

559

920

for name, t in inspect.getmembers(

921

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

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

922

564

if not name.startswith("_"):

923

565

self.client_structure.append(name)

924

566

945

587

if not quiet:

946

588

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

947

589

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

948

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

949

591

self.disable_initiator_tag = None

950

592

self.expires = None

951

593

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

952

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

953

595

self.checker_initiator_tag = None

954

596

self.stop_checker()

955

597

self.enabled = False

956

598

if not quiet:

957

599

self.send_changedstate()

958

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

600

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

959

601

return False

960

602

961

603

def __del__(self):

965

607

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

966

608

# and every interval from then on.

967

609

if self.checker_initiator_tag is not None:

968

GLib.source_remove(self.checker_initiator_tag)

969

self.checker_initiator_tag = GLib.timeout_add(

970

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

971

self.start_checker)

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

972

615

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

973

616

if self.disable_initiator_tag is not None:

974

GLib.source_remove(self.disable_initiator_tag)

975

self.disable_initiator_tag = GLib.timeout_add(

976

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

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

977

622

# Also start a new checker *right now*.

978

623

self.start_checker()

979

624

980

def checker_callback(self, source, condition, connection,

981

command):

625

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

982

626

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

983

627

self.checker_callback_tag = None

984

628

self.checker = None

985

# Read return code from connection (see call_pipe)

986

returncode = connection.recv()

987

connection.close()

988

989

if returncode >= 0:

990

self.last_checker_status = returncode

991

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

992

631

if self.last_checker_status == 0:

993

632

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

994

633

vars(self))

995

634

self.checked_ok()

996

635

else:

997

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

636

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

637

vars(self))

998

638

else:

999

639

self.last_checker_status = -1

1000

self.last_checker_signal = -returncode

1001

640

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

1002

641

vars(self))

1003

return False

1004

642

1005

643

def checked_ok(self):

1006

644

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

1007

645

self.last_checked_ok = datetime.datetime.utcnow()

1008

646

self.last_checker_status = 0

1009

self.last_checker_signal = None

1010

647

self.bump_timeout()

1011

648

1012

649

def bump_timeout(self, timeout=None):

1014

651

if timeout is None:

1015

652

timeout = self.timeout

1016

653

if self.disable_initiator_tag is not None:

1017

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1018

655

self.disable_initiator_tag = None

1019

656

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

1020

self.disable_initiator_tag = GLib.timeout_add(

1021

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1022

660

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

1023

661

1024

662

def need_approval(self):

1038

676

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

1039

677

# should be.

1040

678

1041

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

1042

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

1043

self.checker.join()

1044

self.checker = None

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1045

693

# Start a new checker if needed

1046

694

if self.checker is None:

1047

695

# Escape attributes for the shell

1048

escaped_attrs = {

1049

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

1050

for attr in self.runtime_expansions }

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1051

699

try:

1052

700

command = self.checker_command % escaped_attrs

1053

701

except TypeError as error:

1054

702

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

1055

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

1056

727

exc_info=error)

1057

return True # Try again later

1058

self.current_checker_command = command

1059

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

1060

self.name)

1061

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

1062

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

1063

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

1064

# always replaced by /dev/null.)

1065

# The exception is when not debugging but nevertheless

1066

# running in the foreground; use the previously

1067

# created wnull.

1068

popen_args = { "close_fds": True,

1069

"shell": True,

1070

"cwd": "/" }

1071

if (not self.server_settings["debug"]

1072

and self.server_settings["foreground"]):

1073

popen_args.update({"stdout": wnull,

1074

"stderr": wnull })

1075

pipe = multiprocessing.Pipe(duplex = False)

1076

self.checker = multiprocessing.Process(

1077

target = call_pipe,

1078

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

1079

kwargs = popen_args)

1080

self.checker.start()

1081

self.checker_callback_tag = GLib.io_add_watch(

1082

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

1083

self.checker_callback, pipe[0], command)

1084

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

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1085

748

return True

1086

749

1087

750

def stop_checker(self):

1088

751

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

1089

752

if self.checker_callback_tag:

1090

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1091

754

self.checker_callback_tag = None

1092

755

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

1093

756

return

1094

757

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

1095

self.checker.terminate()

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1096

766

self.checker = None

1097

767

1098

768

1099

def dbus_service_property(dbus_interface,

1100

signature="v",

1101

access="readwrite",

1102

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1103

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1104

772

become properties on the D-Bus.

1105

773

1115

783

if byte_arrays and signature != "ay":

1116

784

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

1117

785

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

1118

1119

786

def decorator(func):

1120

787

func._dbus_is_property = True

1121

788

func._dbus_interface = dbus_interface

1126

793

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

1127

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1128

795

return func

1129

1130

796

return decorator

1131

797

1132

798

1141

807

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

1142

808

"false"}

1143

809

"""

1144

1145

810

def decorator(func):

1146

811

func._dbus_is_interface = True

1147

812

func._dbus_interface = dbus_interface

1148

813

func._dbus_name = dbus_interface

1149

814

return func

1150

1151

815

return decorator

1152

816

1153

817

1162

826

access="r")

1163

827

def Property_dbus_property(self):

1164

828

return dbus.Boolean(False)

1165

1166

See also the DBusObjectWithAnnotations class.

1167

829

"""

1168

1169

830

def decorator(func):

1170

831

func._dbus_annotations = annotations

1171

832

return func

1172

1173

833

return decorator

1174

834

1175

835

1178

838

"""

1179

839

pass

1180

840

1181

1182

841

class DBusPropertyAccessException(DBusPropertyException):

1183

842

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

1184

843

"""

1191

850

pass

1192

851

1193

852

1194

class DBusObjectWithAnnotations(dbus.service.Object):

1195

"""A D-Bus object with annotations.

853

class DBusObjectWithProperties(dbus.service.Object):

854

"""A D-Bus object with properties.

1196

855

1197

Classes inheriting from this can use the dbus_annotations

1198

decorator to add annotations to methods or signals.

856

Classes inheriting from this can use the dbus_service_property

857

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

858

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

1199

859

"""

1200

860

1201

861

@staticmethod

1211

871

def _get_all_dbus_things(self, thing):

1212

872

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

1213

873

"""

1214

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

874

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

875

name),

1215

876

athing.__get__(self))

1216

877

for cls in self.__class__.__mro__

1217

878

for name, athing in

1218

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

1219

1220

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1221

out_signature = "s",

1222

path_keyword = 'object_path',

1223

connection_keyword = 'connection')

1224

def Introspect(self, object_path, connection):

1225

"""Overloading of standard D-Bus method.

1226

1227

Inserts annotation tags on methods and signals.

1228

"""

1229

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

1230

connection)

1231

try:

1232

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

1233

1234

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

1235

# Add annotation tags

1236

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

1237

for tag in if_tag.getElementsByTagName(typ):

1238

annots = dict()

1239

for name, prop in (self.

1240

_get_all_dbus_things(typ)):

1241

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

1242

and prop._dbus_interface

1243

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

1244

annots.update(getattr(

1245

prop, "_dbus_annotations", {}))

1246

for name, value in annots.items():

1247

ann_tag = document.createElement(

1248

"annotation")

1249

ann_tag.setAttribute("name", name)

1250

ann_tag.setAttribute("value", value)

1251

tag.appendChild(ann_tag)

1252

# Add interface annotation tags

1253

for annotation, value in dict(

1254

itertools.chain.from_iterable(

1255

annotations().items()

1256

for name, annotations

1257

in self._get_all_dbus_things("interface")

1258

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

1259

)).items():

1260

ann_tag = document.createElement("annotation")

1261

ann_tag.setAttribute("name", annotation)

1262

ann_tag.setAttribute("value", value)

1263

if_tag.appendChild(ann_tag)

1264

# Fix argument name for the Introspect method itself

1265

if (if_tag.getAttribute("name")

1266

== dbus.INTROSPECTABLE_IFACE):

1267

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

1268

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

1269

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

1270

if (arg.getAttribute("direction")

1271

== "out"):

1272

arg.setAttribute("name",

1273

"xml_data")

1274

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

1275

document.unlink()

1276

except (AttributeError, xml.dom.DOMException,

1277

xml.parsers.expat.ExpatError) as error:

1278

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

1279

exc_info=error)

1280

return xmlstring

1281

1282

1283

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1284

"""A D-Bus object with properties.

1285

1286

Classes inheriting from this can use the dbus_service_property

1287

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

1288

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

1289

"""

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

1290

881

1291

882

def _get_dbus_property(self, interface_name, property_name):

1292

883

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

1293

884

property with the specified name and interface.

1294

885

"""

1295

for cls in self.__class__.__mro__:

1296

for name, value in inspect.getmembers(

1297

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

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1298

890

if (value._dbus_name == property_name

1299

891

and value._dbus_interface == interface_name):

1300

892

return value.__get__(self)

1301

893

1302

894

# No such property

1303

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

1304

self.dbus_object_path, interface_name, property_name))

1305

1306

@classmethod

1307

def _get_all_interface_names(cls):

1308

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

1309

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

1310

"_dbus_interface", None)

1311

for x in (inspect.getmro(cls))

1312

for attr in dir(x))

1313

if name is not None)

1314

1315

@dbus.service.method(dbus.PROPERTIES_IFACE,

1316

in_signature="ss",

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1317

900

out_signature="v")

1318

901

def Get(self, interface_name, property_name):

1319

902

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

1344

927

for byte in value))

1345

928

prop(value)

1346

929

1347

@dbus.service.method(dbus.PROPERTIES_IFACE,

1348

in_signature="s",

930

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

1349

931

out_signature="a{sv}")

1350

932

def GetAll(self, interface_name):

1351

933

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

1366

948

if not hasattr(value, "variant_level"):

1367

949

properties[name] = value

1368

950

continue

1369

properties[name] = type(value)(

1370

value, variant_level = value.variant_level + 1)

951

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

952

value.variant_level+1)

1371

953

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

1372

954

1373

955

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

1387

969

1388

970

Inserts property tags and interface annotation tags.

1389

971

"""

1390

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1391

object_path,

1392

connection)

972

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

973

connection)

1393

974

try:

1394

975

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

1395

1396

976

def make_tag(document, name, prop):

1397

977

e = document.createElement("property")

1398

978

e.setAttribute("name", name)

1399

979

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

1400

980

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

1401

981

return e

1402

1403

982

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

1404

983

# Add property tags

1405

984

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

1408

987

if prop._dbus_interface

1409

988

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

1410

989

if_tag.appendChild(tag)

1411

# Add annotation tags for properties

1412

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

1413

annots = dict()

1414

for name, prop in self._get_all_dbus_things(

1415

"property"):

1416

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

1417

and prop._dbus_interface

1418

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

1419

annots.update(getattr(

1420

prop, "_dbus_annotations", {}))

1421

for name, value in annots.items():

1422

ann_tag = document.createElement(

1423

"annotation")

1424

ann_tag.setAttribute("name", name)

1425

ann_tag.setAttribute("value", value)

1426

tag.appendChild(ann_tag)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1427

1021

# Add the names to the return values for the

1428

1022

# "org.freedesktop.DBus.Properties" methods

1429

1023

if (if_tag.getAttribute("name")

1447

1041

exc_info=error)

1448

1042

return xmlstring

1449

1043

1450

try:

1451

dbus.OBJECT_MANAGER_IFACE

1452

except AttributeError:

1453

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

1454

1455

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1456

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

1457

1458

Classes inheriting from this exposes the standard

1459

GetManagedObjects call and the InterfacesAdded and

1460

InterfacesRemoved signals on the standard

1461

"org.freedesktop.DBus.ObjectManager" interface.

1462

1463

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

1464

manually.

1465

"""

1466

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1467

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

1468

def GetManagedObjects(self):

1469

"""This function must be overridden"""

1470

raise NotImplementedError()

1471

1472

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1473

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

1474

def InterfacesAdded(self, object_path, interfaces_and_properties):

1475

pass

1476

1477

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

1478

def InterfacesRemoved(self, object_path, interfaces):

1479

pass

1480

1481

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1482

out_signature = "s",

1483

path_keyword = 'object_path',

1484

connection_keyword = 'connection')

1485

def Introspect(self, object_path, connection):

1486

"""Overloading of standard D-Bus method.

1487

1488

Override return argument name of GetManagedObjects to be

1489

"objpath_interfaces_and_properties"

1490

"""

1491

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1492

object_path,

1493

connection)

1494

try:

1495

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

1496

1497

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

1498

# Fix argument name for the GetManagedObjects method

1499

if (if_tag.getAttribute("name")

1500

== dbus.OBJECT_MANAGER_IFACE):

1501

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

1502

if (cn.getAttribute("name")

1503

== "GetManagedObjects"):

1504

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

1505

if (arg.getAttribute("direction")

1506

== "out"):

1507

arg.setAttribute(

1508

"name",

1509

"objpath_interfaces"

1510

"_and_properties")

1511

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

1512

document.unlink()

1513

except (AttributeError, xml.dom.DOMException,

1514

xml.parsers.expat.ExpatError) as error:

1515

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

1516

exc_info = error)

1517

return xmlstring

1518

1044

1519

1045

def datetime_to_dbus(dt, variant_level=0):

1520

1046

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

1521

1047

if dt is None:

1522

1048

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

1523

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1524

1051

1525

1052

1526

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1546

1073

(from DBusObjectWithProperties) and interfaces (from the

1547

1074

dbus_interface_annotations decorator).

1548

1075

"""

1549

1550

1076

def wrapper(cls):

1551

1077

for orig_interface_name, alt_interface_name in (

1552

alt_interface_names.items()):

1078

alt_interface_names.items()):

1553

1079

attr = {}

1554

1080

interface_names = set()

1555

1081

# Go though all attributes of the class

1557

1083

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

1558

1084

# with the wrong interface name

1559

1085

if (not hasattr(attribute, "_dbus_interface")

1560

or not attribute._dbus_interface.startswith(

1561

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1562

1088

continue

1563

1089

# Create an alternate D-Bus interface name based on

1564

1090

# the current name

1565

alt_interface = attribute._dbus_interface.replace(

1566

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1567

1094

interface_names.add(alt_interface)

1568

1095

# Is this a D-Bus signal?

1569

1096

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

1570

1097

# Extract the original non-method undecorated

1571

1098

# function by black magic

1572

if sys.version_info.major == 2:

1573

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1574

1100

zip(attribute.func_code.co_freevars,

1575

attribute.__closure__))

1576

["func"].cell_contents)

1577

else:

1578

nonmethod_func = (dict(

1579

zip(attribute.__code__.co_freevars,

1580

attribute.__closure__))

1581

["func"].cell_contents)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1582

1103

# Create a new, but exactly alike, function

1583

1104

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

1584

1105

# with the alternate D-Bus interface name

1585

new_function = copy_function(nonmethod_func)

1586

new_function = (dbus.service.signal(

1587

alt_interface,

1588

attribute._dbus_signature)(new_function))

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1589

1115

# Copy annotations, if any

1590

1116

try:

1591

new_function._dbus_annotations = dict(

1592

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1593

1119

except AttributeError:

1594

1120

pass

1595

1121

# Define a creator of a function to call both the

1600

1126

"""This function is a scope container to pass

1601

1127

func1 and func2 to the "call_both" function

1602

1128

outside of its arguments"""

1603

1604

@functools.wraps(func2)

1605

1129

def call_both(*args, **kwargs):

1606

1130

"""This function will emit two D-Bus

1607

1131

signals by calling func1 and func2"""

1608

1132

func1(*args, **kwargs)

1609

1133

func2(*args, **kwargs)

1610

# Make wrapper function look like a D-Bus signal

1611

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

1612

if name.startswith("_dbus_"):

1613

setattr(call_both, name, attr)

1614

1615

1134

return call_both

1616

1135

# Create the "call_both" function and add it to

1617

1136

# the class

1622

1141

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

1623

1142

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

1624

1143

# to the class.

1625

attr[attrname] = (

1626

dbus.service.method(

1627

alt_interface,

1628

attribute._dbus_in_signature,

1629

attribute._dbus_out_signature)

1630

(copy_function(attribute)))

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1631

1154

# Copy annotations, if any

1632

1155

try:

1633

attr[attrname]._dbus_annotations = dict(

1634

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1635

1158

except AttributeError:

1636

1159

pass

1637

1160

# Is this a D-Bus property?

1640

1163

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

1641

1164

# property with the alternate D-Bus interface

1642

1165

# name. Add it to the class.

1643

attr[attrname] = (dbus_service_property(

1644

alt_interface, attribute._dbus_signature,

1645

attribute._dbus_access,

1646

attribute._dbus_get_args_options

1647

["byte_arrays"])

1648

(copy_function(attribute)))

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1649

1179

# Copy annotations, if any

1650

1180

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1653

1183

except AttributeError:

1654

1184

pass

1655

1185

# Is this a D-Bus interface?

1658

1188

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

1659

1189

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

1660

1190

# to the class.

1661

attr[attrname] = (

1662

dbus_interface_annotations(alt_interface)

1663

(copy_function(attribute)))

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1664

1199

if deprecate:

1665

1200

# Deprecate all alternate interfaces

1666

1201

iname="_AlternateDBusNames_interface_annotation{}"

1667

1202

for interface_name in interface_names:

1668

1669

1203

@dbus_interface_annotations(interface_name)

1670

1204

def func(self):

1671

1205

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

1672

"true" }

1206

"true" }

1673

1207

# Find an unused name

1674

1208

for aname in (iname.format(i)

1675

1209

for i in itertools.count()):

1679

1213

if interface_names:

1680

1214

# Replace the class with a new subclass of it with

1681

1215

# methods, signals, etc. as created above.

1682

if sys.version_info.major == 2:

1683

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

1684

(cls, ), attr)

1685

else:

1686

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

1687

(cls, ), attr)

1216

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

1217

(cls,), attr)

1688

1218

return cls

1689

1690

1219

return wrapper

1691

1220

1692

1221

1693

1222

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

1694

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1695

1224

class ClientDBus(Client, DBusObjectWithProperties):

1696

1225

"""A Client class using D-Bus

1697

1226

1701

1230

"""

1702

1231

1703

1232

runtime_expansions = (Client.runtime_expansions

1704

+ ("dbus_object_path", ))

1233

+ ("dbus_object_path",))

1705

1234

1706

1235

_interface = "se.recompile.Mandos.Client"

1707

1236

1715

1244

client_object_name = str(self.name).translate(

1716

1245

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

1717

1246

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

1718

self.dbus_object_path = dbus.ObjectPath(

1719

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1720

1249

DBusObjectWithProperties.__init__(self, self.bus,

1721

1250

self.dbus_object_path)

1722

1251

1723

def notifychangeproperty(transform_func, dbus_name,

1724

type_func=lambda x: x,

1725

variant_level=1,

1726

invalidate_only=False,

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1727

1255

_interface=_interface):

1728

1256

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

1729

1257

its changes to DBus.

1736

1264

variant_level: D-Bus variant level. Default: 1

1737

1265

"""

1738

1266

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

1739

1740

1267

def setter(self, value):

1741

1268

if hasattr(self, "dbus_object_path"):

1742

1269

if (not hasattr(self, attrname) or

1743

1270

type_func(getattr(self, attrname, None))

1744

1271

!= type_func(value)):

1745

1272

if invalidate_only:

1746

self.PropertiesChanged(

1747

_interface, dbus.Dictionary(),

1748

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1749

1277

else:

1750

dbus_value = transform_func(

1751

type_func(value),

1752

variant_level = variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1753

1281

self.PropertyChanged(dbus.String(dbus_name),

1754

1282

dbus_value)

1755

self.PropertiesChanged(

1756

_interface,

1757

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

1758

dbus_value }),

1759

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1760

1287

setattr(self, attrname, value)

1761

1288

1762

1289

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

1768

1295

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

1769

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1770

1297

"LastEnabled")

1771

checker = notifychangeproperty(

1772

dbus.Boolean, "CheckerRunning",

1773

type_func = lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1774

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1775

1302

"LastCheckedOK")

1776

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1779

1306

datetime_to_dbus, "LastApprovalRequest")

1780

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1781

1308

"ApprovedByDefault")

1782

approval_delay = notifychangeproperty(

1783

dbus.UInt64, "ApprovalDelay",

1784

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

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1785

1314

approval_duration = notifychangeproperty(

1786

1315

dbus.UInt64, "ApprovalDuration",

1787

1316

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

1788

1317

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

1789

timeout = notifychangeproperty(

1790

dbus.UInt64, "Timeout",

1791

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1792

1321

extended_timeout = notifychangeproperty(

1793

1322

dbus.UInt64, "ExtendedTimeout",

1794

1323

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

1795

interval = notifychangeproperty(

1796

dbus.UInt64, "Interval",

1797

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1798

1329

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

1799

1330

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

1800

1331

invalidate_only=True)

1810

1341

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

1811

1342

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

1812

1343

1813

def checker_callback(self, source, condition,

1814

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

1815

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

1816

connection, command, *args,

1817

**kwargs)

1818

exitstatus = self.last_checker_status

1819

if exitstatus >= 0:

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1820

1350

# Emit D-Bus signal

1821

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1822

# This is specific to GNU libC

1823

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1824

1353

dbus.String(command))

1825

1354

else:

1826

1355

# Emit D-Bus signal

1827

1356

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

1828

dbus.Int64(

1829

# This is specific to GNU libC

1830

(exitstatus << 8)

1831

| self.last_checker_signal),

1357

dbus.Int64(condition),

1832

1358

dbus.String(command))

1833

return ret

1359

1360

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

1361

*args, **kwargs)

1834

1362

1835

1363

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

1836

1364

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

1848

1376

1849

1377

def approve(self, value=True):

1850

1378

self.approved = value

1851

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

1852

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

1853

1381

self.send_changedstate()

1854

1382

1855

1383

## D-Bus methods, signals & properties

1911

1439

self.checked_ok()

1912

1440

1913

1441

# Enable - method

1914

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

1915

1442

@dbus.service.method(_interface)

1916

1443

def Enable(self):

1917

1444

"D-Bus method"

1918

1445

self.enable()

1919

1446

1920

1447

# StartChecker - method

1921

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

1922

1448

@dbus.service.method(_interface)

1923

1449

def StartChecker(self):

1924

1450

"D-Bus method"

1925

1451

self.start_checker()

1926

1452

1927

1453

# Disable - method

1928

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

1929

1454

@dbus.service.method(_interface)

1930

1455

def Disable(self):

1931

1456

"D-Bus method"

1932

1457

self.disable()

1933

1458

1934

1459

# StopChecker - method

1935

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

1936

1460

@dbus.service.method(_interface)

1937

1461

def StopChecker(self):

1938

1462

self.stop_checker()

1945

1469

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

1946

1470

1947

1471

# ApprovedByDefault - property

1948

@dbus_service_property(_interface,

1949

signature="b",

1472

@dbus_service_property(_interface, signature="b",

1950

1473

access="readwrite")

1951

1474

def ApprovedByDefault_dbus_property(self, value=None):

1952

1475

if value is None: # get

1954

1477

self.approved_by_default = bool(value)

1955

1478

1956

1479

# ApprovalDelay - property

1957

@dbus_service_property(_interface,

1958

signature="t",

1480

@dbus_service_property(_interface, signature="t",

1959

1481

access="readwrite")

1960

1482

def ApprovalDelay_dbus_property(self, value=None):

1961

1483

if value is None: # get

1964

1486

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

1965

1487

1966

1488

# ApprovalDuration - property

1967

@dbus_service_property(_interface,

1968

signature="t",

1489

@dbus_service_property(_interface, signature="t",

1969

1490

access="readwrite")

1970

1491

def ApprovalDuration_dbus_property(self, value=None):

1971

1492

if value is None: # get

1974

1495

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

1975

1496

1976

1497

# Name - property

1977

@dbus_annotations(

1978

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

1979

1498

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

1980

1499

def Name_dbus_property(self):

1981

1500

return dbus.String(self.name)

1982

1501

1983

1502

# Fingerprint - property

1984

@dbus_annotations(

1985

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

1986

1503

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

1987

1504

def Fingerprint_dbus_property(self):

1988

1505

return dbus.String(self.fingerprint)

1989

1506

1990

1507

# Host - property

1991

@dbus_service_property(_interface,

1992

signature="s",

1508

@dbus_service_property(_interface, signature="s",

1993

1509

access="readwrite")

1994

1510

def Host_dbus_property(self, value=None):

1995

1511

if value is None: # get

1997

1513

self.host = str(value)

1998

1514

1999

1515

# Created - property

2000

@dbus_annotations(

2001

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

2002

1516

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

2003

1517

def Created_dbus_property(self):

2004

1518

return datetime_to_dbus(self.created)

2009

1523

return datetime_to_dbus(self.last_enabled)

2010

1524

2011

1525

# Enabled - property

2012

@dbus_service_property(_interface,

2013

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2014

1527

access="readwrite")

2015

1528

def Enabled_dbus_property(self, value=None):

2016

1529

if value is None: # get

2021

1534

self.disable()

2022

1535

2023

1536

# LastCheckedOK - property

2024

@dbus_service_property(_interface,

2025

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2026

1538

access="readwrite")

2027

1539

def LastCheckedOK_dbus_property(self, value=None):

2028

1540

if value is not None:

2031

1543

return datetime_to_dbus(self.last_checked_ok)

2032

1544

2033

1545

# LastCheckerStatus - property

2034

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2035

1548

def LastCheckerStatus_dbus_property(self):

2036

1549

return dbus.Int16(self.last_checker_status)

2037

1550

2046

1559

return datetime_to_dbus(self.last_approval_request)

2047

1560

2048

1561

# Timeout - property

2049

@dbus_service_property(_interface,

2050

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2051

1563

access="readwrite")

2052

1564

def Timeout_dbus_property(self, value=None):

2053

1565

if value is None: # get

2065

1577

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

2066

1578

is None):

2067

1579

return

2068

GLib.source_remove(self.disable_initiator_tag)

2069

self.disable_initiator_tag = GLib.timeout_add(

2070

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

2071

self.disable)

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

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

1584

* 1000), self.disable))

2072

1585

2073

1586

# ExtendedTimeout - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2076

1588

access="readwrite")

2077

1589

def ExtendedTimeout_dbus_property(self, value=None):

2078

1590

if value is None: # get

2081

1593

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

2082

1594

2083

1595

# Interval - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2086

1597

access="readwrite")

2087

1598

def Interval_dbus_property(self, value=None):

2088

1599

if value is None: # get

2092

1603

return

2093

1604

if self.enabled:

2094

1605

# Reschedule checker run

2095

GLib.source_remove(self.checker_initiator_tag)

2096

self.checker_initiator_tag = GLib.timeout_add(

2097

value, self.start_checker)

2098

self.start_checker() # Start one now, too

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

2099

1610

2100

1611

# Checker - property

2101

@dbus_service_property(_interface,

2102

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2103

1613

access="readwrite")

2104

1614

def Checker_dbus_property(self, value=None):

2105

1615

if value is None: # get

2107

1617

self.checker_command = str(value)

2108

1618

2109

1619

# CheckerRunning - property

2110

@dbus_service_property(_interface,

2111

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2112

1621

access="readwrite")

2113

1622

def CheckerRunning_dbus_property(self, value=None):

2114

1623

if value is None: # get

2119

1628

self.stop_checker()

2120

1629

2121

1630

# ObjectPath - property

2122

@dbus_annotations(

2123

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

2124

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

2125

1631

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

2126

1632

def ObjectPath_dbus_property(self):

2127

1633

return self.dbus_object_path # is already a dbus.ObjectPath

2128

1634

2129

1635

# Secret = property

2130

@dbus_annotations(

2131

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

2132

"invalidates"})

2133

@dbus_service_property(_interface,

2134

signature="ay",

2135

access="write",

2136

byte_arrays=True)

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2137

1638

def Secret_dbus_property(self, value):

2138

1639

self.secret = bytes(value)

2139

1640

2145

1646

self._pipe = child_pipe

2146

1647

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

2147

1648

if not self._pipe.recv():

2148

raise KeyError(fpr)

1649

raise KeyError()

2149

1650

2150

1651

def __getattribute__(self, name):

2151

1652

if name == '_pipe':

2155

1656

if data[0] == 'data':

2156

1657

return data[1]

2157

1658

if data[0] == 'function':

2158

2159

1659

def func(*args, **kwargs):

2160

1660

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

2161

1661

return self._pipe.recv()[1]

2162

2163

1662

return func

2164

1663

2165

1664

def __setattr__(self, name, value):

2181

1680

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

2182

1681

self.server.child_pipe.fileno())

2183

1682

2184

session = gnutls.ClientSession(self.request)

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

2185

1692

2186

1693

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

2187

1694

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

2191

1698

priority = self.server.gnutls_priority

2192

1699

if priority is None:

2193

1700

priority = "NORMAL"

2194

gnutls.priority_set_direct(session._c_object,

2195

priority.encode("utf-8"),

2196

None)

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

2197

1704

2198

1705

# Start communication using the Mandos protocol

2199

1706

# Get protocol number

2209

1716

# Start GnuTLS connection

2210

1717

try:

2211

1718

session.handshake()

2212

except gnutls.Error as error:

1719

except gnutls.errors.GNUTLSError as error:

2213

1720

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

2214

1721

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

2215

1722

# established. Just abandon the request.

2219

1726

approval_required = False

2220

1727

try:

2221

1728

try:

2222

fpr = self.fingerprint(

2223

self.peer_certificate(session))

2224

except (TypeError, gnutls.Error) as error:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

2225

1733

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

2226

1734

return

2227

1735

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

2240

1748

while True:

2241

1749

if not client.enabled:

2242

1750

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

2243

client.name)

1751

client.name)

2244

1752

if self.server.use_dbus:

2245

1753

# Emit D-Bus signal

2246

1754

client.Rejected("Disabled")

2285

1793

else:

2286

1794

delay -= time2 - time

2287

1795

2288

try:

2289

session.send(client.secret)

2290

except gnutls.Error as error:

2291

logger.warning("gnutls send failed",

2292

exc_info = error)

2293

return

1796

sent_size = 0

1797

while sent_size < len(client.secret):

1798

try:

1799

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

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1803

return

1804

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

1805

sent, len(client.secret)

1806

- (sent_size + sent))

1807

sent_size += sent

2294

1808

2295

1809

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

2296

1810

# bump the timeout using extended_timeout

2304

1818

client.approvals_pending -= 1

2305

1819

try:

2306

1820

session.bye()

2307

except gnutls.Error as error:

1821

except gnutls.errors.GNUTLSError as error:

2308

1822

logger.warning("GnuTLS bye failed",

2309

1823

exc_info=error)

2310

1824

2312

1826

def peer_certificate(session):

2313

1827

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

2314

1828

# If not an OpenPGP certificate...

2315

if (gnutls.certificate_type_get(session._c_object)

2316

!= gnutls.CRT_OPENPGP):

2317

# ...return invalid data

2318

return b""

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2319

1834

list_size = ctypes.c_uint(1)

2320

cert_list = (gnutls.certificate_get_peers

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

2321

1837

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

2322

1838

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

2323

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

1839

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

1840

" certificate")

2324

1841

if list_size.value == 0:

2325

1842

return None

2326

1843

cert = cert_list[0]

2330

1847

def fingerprint(openpgp):

2331

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2332

1849

# New GnuTLS "datum" with the OpenPGP public key

2333

datum = gnutls.datum_t(

2334

ctypes.cast(ctypes.c_char_p(openpgp),

2335

ctypes.POINTER(ctypes.c_ubyte)),

2336

ctypes.c_uint(len(openpgp)))

1850

datum = (gnutls.library.types

1851

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

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2337

1855

# New empty GnuTLS certificate

2338

crt = gnutls.openpgp_crt_t()

2339

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2340

1859

# Import the OpenPGP public key into the certificate

2341

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

2342

gnutls.OPENPGP_FMT_RAW)

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2343

1864

# Verify the self signature in the key

2344

1865

crtverify = ctypes.c_uint()

2345

gnutls.openpgp_crt_verify_self(crt, 0,

2346

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2347

1869

if crtverify.value != 0:

2348

gnutls.openpgp_crt_deinit(crt)

2349

raise gnutls.CertificateSecurityError("Verify failed")

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2350

1873

# New buffer for the fingerprint

2351

1874

buf = ctypes.create_string_buffer(20)

2352

1875

buf_len = ctypes.c_size_t()

2353

1876

# Get the fingerprint from the certificate into the buffer

2354

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

2355

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2356

1880

# Deinit the certificate

2357

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2358

1882

# Convert the buffer to a Python bytestring

2359

1883

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

2360

1884

# Convert the bytestring to hexadecimal notation

2364

1888

2365

1889

class MultiprocessingMixIn(object):

2366

1890

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

2367

2368

1891

def sub_process_main(self, request, address):

2369

1892

try:

2370

1893

self.finish_request(request, address)

2382

1905

2383

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2384

1907

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

2385

2386

1908

def process_request(self, request, client_address):

2387

1909

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

2388

1910

2409

1931

interface: None or a network interface name (string)

2410

1932

use_ipv6: Boolean; to use IPv6 or not

2411

1933

"""

2412

2413

1934

def __init__(self, server_address, RequestHandlerClass,

2414

interface=None,

2415

use_ipv6=True,

2416

socketfd=None):

1935

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

2417

1936

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

2418

1937

creating a new one with socket.socket().

2419

1938

"""

2455

1974

bind to an address or port if they were not specified."""

2456

1975

if self.interface is not None:

2457

1976

if SO_BINDTODEVICE is None:

2458

# Fall back to a hard-coded value which seems to be

2459

# common enough.

2460

logger.warning("SO_BINDTODEVICE not found, trying 25")

2461

SO_BINDTODEVICE = 25

2462

try:

2463

self.socket.setsockopt(

2464

socket.SOL_SOCKET, SO_BINDTODEVICE,

2465

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

2466

except socket.error as error:

2467

if error.errno == errno.EPERM:

2468

logger.error("No permission to bind to"

2469

" interface %s", self.interface)

2470

elif error.errno == errno.ENOPROTOOPT:

2471

logger.error("SO_BINDTODEVICE not available;"

2472

" cannot bind to interface %s",

2473

self.interface)

2474

elif error.errno == errno.ENODEV:

2475

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

2476

" cannot bind", self.interface)

2477

else:

2478

raise

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2479

1999

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

2480

2000

if self.server_address[0] or self.server_address[1]:

2481

2001

if not self.server_address[0]:

2486

2006

self.server_address = (any_address,

2487

2007

self.server_address[1])

2488

2008

elif not self.server_address[1]:

2489

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

2009

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

2010

0)

2490

2011

# if self.interface:

2491

2012

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

2492

2013

# 0, # port

2504

2025

gnutls_priority GnuTLS priority string

2505

2026

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

2506

2027

2507

Assumes a GLib.MainLoop event loop.

2028

Assumes a gobject.MainLoop event loop.

2508

2029

"""

2509

2510

2030

def __init__(self, server_address, RequestHandlerClass,

2511

interface=None,

2512

use_ipv6=True,

2513

clients=None,

2514

gnutls_priority=None,

2515

use_dbus=True,

2516

socketfd=None):

2031

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

2032

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

2517

2033

self.enabled = False

2518

2034

self.clients = clients

2519

2035

if self.clients is None:

2525

2041

interface = interface,

2526

2042

use_ipv6 = use_ipv6,

2527

2043

socketfd = socketfd)

2528

2529

2044

def server_activate(self):

2530

2045

if self.enabled:

2531

2046

return socketserver.TCPServer.server_activate(self)

2535

2050

2536

2051

def add_pipe(self, parent_pipe, proc):

2537

2052

# Call "handle_ipc" for both data and EOF events

2538

GLib.io_add_watch(

2539

parent_pipe.fileno(),

2540

GLib.IO_IN | GLib.IO_HUP,

2541

functools.partial(self.handle_ipc,

2542

parent_pipe = parent_pipe,

2543

proc = proc))

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2544

2059

2545

def handle_ipc(self, source, condition,

2546

parent_pipe=None,

2547

proc = None,

2548

client_object=None):

2060

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

2061

proc = None, client_object=None):

2549

2062

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

2550

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

2063

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

2551

2064

# Wait for other process to exit

2552

2065

proc.join()

2553

2066

return False

2560

2073

fpr = request[1]

2561

2074

address = request[2]

2562

2075

2563

for c in self.clients.values():

2076

for c in self.clients.itervalues():

2564

2077

if c.fingerprint == fpr:

2565

2078

client = c

2566

2079

break

2574

2087

parent_pipe.send(False)

2575

2088

return False

2576

2089

2577

GLib.io_add_watch(

2578

parent_pipe.fileno(),

2579

GLib.IO_IN | GLib.IO_HUP,

2580

functools.partial(self.handle_ipc,

2581

parent_pipe = parent_pipe,

2582

proc = proc,

2583

client_object = client))

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2584

2098

parent_pipe.send(True)

2585

2099

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

2586

2100

# same fileno

2592

2106

2593

2107

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

2594

2108

funcname)(*args,

2595

**kwargs)))

2109

**kwargs)))

2596

2110

2597

2111

if command == 'getattr':

2598

2112

attrname = request[1]

2599

if isinstance(client_object.__getattribute__(attrname),

2600

collections.Callable):

2601

parent_pipe.send(('function', ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2602

2115

else:

2603

parent_pipe.send((

2604

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

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2605

2118

2606

2119

if command == 'setattr':

2607

2120

attrname = request[1]

2638

2151

# avoid excessive use of external libraries.

2639

2152

2640

2153

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

2641

Token = collections.namedtuple("Token", (

2642

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

2643

# a "group" containing digits

2644

"value", # datetime.timedelta or None

2645

"followers")) # Tokens valid after this token

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2646

2163

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

2647

2164

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

2648

2165

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

2649

2166

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

2650

2167

datetime.timedelta(seconds=1),

2651

frozenset((token_end, )))

2168

frozenset((token_end,)))

2652

2169

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

2653

2170

datetime.timedelta(minutes=1),

2654

2171

frozenset((token_second, token_end)))

2670

2187

frozenset((token_month, token_end)))

2671

2188

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

2672

2189

datetime.timedelta(weeks=1),

2673

frozenset((token_end, )))

2190

frozenset((token_end,)))

2674

2191

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

2675

2192

frozenset((token_year, token_month,

2676

2193

token_day, token_time,

2678

2195

# Define starting values

2679

2196

value = datetime.timedelta() # Value so far

2680

2197

found_token = None

2681

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

2198

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

2682

2199

s = duration # String left to parse

2683

2200

# Loop until end token is found

2684

2201

while found_token is not token_end:

2701

2218

break

2702

2219

else:

2703

2220

# No currently valid tokens were found

2704

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

2705

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2706

2222

# End token found

2707

2223

return value

2708

2224

2745

2261

elif suffix == "w":

2746

2262

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

2747

2263

else:

2748

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2749

2266

except IndexError as e:

2750

2267

raise ValueError(*(e.args))

2751

2268

timevalue += delta

2767

2284

# Close all standard open file descriptors

2768

2285

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

2769

2286

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

2770

raise OSError(errno.ENODEV,

2771

"{} not a character device"

2287

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

2772

2288

.format(os.devnull))

2773

2289

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

2774

2290

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

2840

2356

"port": "",

2841

2357

"debug": "False",

2842

2358

"priority":

2843

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

2844

":+SIGN-DSA-SHA256",

2359

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

2845

2360

"servicename": "Mandos",

2846

2361

"use_dbus": "True",

2847

2362

"use_ipv6": "True",

2851

2366

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

2852

2367

"foreground": "False",

2853

2368

"zeroconf": "True",

2854

}

2369

}

2855

2370

2856

2371

# Parse config file for server-global settings

2857

2372

server_config = configparser.SafeConfigParser(server_defaults)

2858

2373

del server_defaults

2859

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

2374

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

2375

"mandos.conf"))

2860

2376

# Convert the SafeConfigParser object to a dict

2861

2377

server_settings = server_config.defaults()

2862

2378

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

2880

2396

# Override the settings from the config file with command line

2881

2397

# options, if set.

2882

2398

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

2883

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

2884

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

2885

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

2399

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

2400

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

2401

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

2886

2402

value = getattr(options, option)

2887

2403

if value is not None:

2888

2404

server_settings[option] = value

2903

2419

2904

2420

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

2905

2421

2906

if (not server_settings["zeroconf"]

2907

and not (server_settings["port"]

2908

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

2909

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

2422

if (not server_settings["zeroconf"] and

2423

not (server_settings["port"]

2424

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

2425

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

2426

" Zeroconf")

2910

2427

2911

2428

# For convenience

2912

2429

debug = server_settings["debug"]

2928

2445

initlogger(debug, level)

2929

2446

2930

2447

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

2931

syslogger.setFormatter(

2932

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

2933

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

2934

server_settings["servicename"])))

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2935

2453

2936

2454

# Parse config file with clients

2937

2455

client_config = configparser.SafeConfigParser(Client

2945

2463

socketfd = None

2946

2464

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

2947

2465

socketfd = server_settings["socket"]

2948

tcp_server = MandosServer(

2949

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

2950

ClientHandler,

2951

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

2952

use_ipv6=use_ipv6,

2953

gnutls_priority=server_settings["priority"],

2954

use_dbus=use_dbus,

2955

socketfd=socketfd)

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

2956

2476

if not foreground:

2957

2477

pidfilename = "/run/mandos.pid"

2958

2478

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

2959

2479

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

2960

2480

pidfile = None

2961

2481

try:

2962

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

2482

pidfile = open(pidfilename, "w")

2963

2483

except IOError as e:

2964

2484

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

2965

2485

exc_info=e)

2966

2486

2967

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

2968

("mandos", "mandos"),

2969

("nobody", "nogroup")):

2487

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

2970

2488

try:

2971

2489

uid = pwd.getpwnam(name).pw_uid

2972

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

2973

2491

break

2974

2492

except KeyError:

2975

2493

continue

2979

2497

try:

2980

2498

os.setgid(gid)

2981

2499

os.setuid(uid)

2982

if debug:

2983

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

2984

gid))

2985

2500

except OSError as error:

2986

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

2987

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

2988

2501

if error.errno != errno.EPERM:

2989

2502

raise

2990

2503

2993

2506

2994

2507

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

2995

2508

# - GnuTLS manual

2996

gnutls.global_set_log_level(11)

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2997

2510

2998

@gnutls.log_func

2511

@gnutls.library.types.gnutls_log_func

2999

2512

def debug_gnutls(level, string):

3000

2513

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

3001

2514

3002

gnutls.global_set_log_function(debug_gnutls)

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

3003

2517

3004

2518

# Redirect stdin so all checkers get /dev/null

3005

2519

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

3012

2526

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

3013

2527

daemon()

3014

2528

3015

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

3016

# to inform GLib that threads will be used.

3017

GLib.threads_init()

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

3018

2532

3019

2533

global main_loop

3020

2534

# From the Avahi example code

3021

2535

DBusGMainLoop(set_as_default=True)

3022

main_loop = GLib.MainLoop()

2536

main_loop = gobject.MainLoop()

3023

2537

bus = dbus.SystemBus()

3024

2538

# End of Avahi example code

3025

2539

if use_dbus:

3026

2540

try:

3027

2541

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

3028

bus,

3029

do_not_queue=True)

3030

old_bus_name = dbus.service.BusName(

3031

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

3032

do_not_queue=True)

3033

except dbus.exceptions.DBusException as e:

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

3034

2547

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

3035

2548

use_dbus = False

3036

2549

server_settings["use_dbus"] = False

3037

2550

tcp_server.use_dbus = False

3038

2551

if zeroconf:

3039

2552

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3040

service = AvahiServiceToSyslog(

3041

name = server_settings["servicename"],

3042

servicetype = "_mandos._tcp",

3043

protocol = protocol,

3044

bus = bus)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3045

2557

if server_settings["interface"]:

3046

service.interface = if_nametoindex(

3047

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

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

3048

2561

3049

2562

global multiprocessing_manager

3050

2563

multiprocessing_manager = multiprocessing.Manager()

3069

2582

if server_settings["restore"]:

3070

2583

try:

3071

2584

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

3072

if sys.version_info.major == 2:

3073

clients_data, old_client_settings = pickle.load(

3074

stored_state)

3075

else:

3076

bytes_clients_data, bytes_old_client_settings = (

3077

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

3078

### Fix bytes to strings

3079

## clients_data

3080

# .keys()

3081

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

3082

if isinstance(key, bytes)

3083

else key): value

3084

for key, value in

3085

bytes_clients_data.items() }

3086

del bytes_clients_data

3087

for key in clients_data:

3088

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

3089

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

3090

for k, v in

3091

clients_data[key].items() }

3092

clients_data[key] = value

3093

# .client_structure

3094

value["client_structure"] = [

3095

(s.decode("utf-8")

3096

if isinstance(s, bytes)

3097

else s) for s in

3098

value["client_structure"] ]

3099

# .name & .host

3100

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

3101

if isinstance(value[k], bytes):

3102

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

3103

## old_client_settings

3104

# .keys()

3105

old_client_settings = {

3106

(key.decode("utf-8")

3107

if isinstance(key, bytes)

3108

else key): value

3109

for key, value in

3110

bytes_old_client_settings.items() }

3111

del bytes_old_client_settings

3112

# .host

3113

for value in old_client_settings.values():

3114

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

3115

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

3116

.decode("utf-8"))

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3117

2587

os.remove(stored_state_path)

3118

2588

except IOError as e:

3119

2589

if e.errno == errno.ENOENT:

3120

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

3121

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

2590

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

2591

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

3122

2592

else:

3123

2593

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

3124

2594

exc_info=e)

3125

2595

raise

3126

2596

except EOFError as e:

3127

2597

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

3128

"EOFError:",

3129

exc_info=e)

2598

"EOFError:", exc_info=e)

3130

2599

3131

2600

with PGPEngine() as pgp:

3132

2601

for client_name, client in clients_data.items():

3144

2613

# For each value in new config, check if it

3145

2614

# differs from the old config value (Except for

3146

2615

# the "secret" attribute)

3147

if (name != "secret"

3148

and (value !=

3149

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3150

2619

client[name] = value

3151

2620

except KeyError:

3152

2621

pass

3153

2622

3154

2623

# Clients who has passed its expire date can still be

3155

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3156

2625

# whose checker succeeded before we stored its state is

3157

2626

# assumed to have successfully run all checkers during

3158

2627

# downtime.

3161

2630

if not client["last_checked_ok"]:

3162

2631

logger.warning(

3163

2632

"disabling client {} - Client never "

3164

"performed a successful checker".format(

3165

client_name))

2633

"performed a successful checker"

2634

.format(client_name))

3166

2635

client["enabled"] = False

3167

2636

elif client["last_checker_status"] != 0:

3168

2637

logger.warning(

3169

2638

"disabling client {} - Client last"

3170

" checker failed with error code"

3171

" {}".format(

3172

client_name,

3173

client["last_checker_status"]))

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3174

2642

client["enabled"] = False

3175

2643

else:

3176

client["expires"] = (

3177

datetime.datetime.utcnow()

3178

+ client["timeout"])

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

3179

2647

logger.debug("Last checker succeeded,"

3180

" keeping {} enabled".format(

3181

client_name))

2648

" keeping {} enabled"

2649

.format(client_name))

3182

2650

try:

3183

client["secret"] = pgp.decrypt(

3184

client["encrypted_secret"],

3185

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3186

2655

except PGPError:

3187

2656

# If decryption fails, we use secret from new settings

3188

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

3189

client_name))

3190

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

3191

["secret"])

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

3192

2661

3193

2662

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

3194

2663

for client_name in (set(old_client_settings)

3201

2670

# Create all client objects

3202

2671

for client_name, client in clients_data.items():

3203

2672

tcp_server.clients[client_name] = client_class(

3204

name = client_name,

3205

settings = client,

2673

name = client_name, settings = client,

3206

2674

server_settings = server_settings)

3207

2675

3208

2676

if not tcp_server.clients:

3210

2678

3211

2679

if not foreground:

3212

2680

if pidfile is not None:

3213

pid = os.getpid()

3214

2681

try:

3215

2682

with pidfile:

3216

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3217

2685

except IOError:

3218

2686

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

3219

2687

pidfilename, pid)

3220

2688

del pidfile

3221

2689

del pidfilename

3222

2690

3223

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

3224

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3225

lambda: main_loop.quit() and False)

2691

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

2692

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

3226

2693

3227

2694

if use_dbus:

3228

3229

@alternate_dbus_interfaces(

3230

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

3231

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3232

2698

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

3233

3234

2699

def __init__(self):

3235

2700

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

3236

3237

2701

_interface = "se.recompile.Mandos"

3238

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3239

2709

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

3240

2710

def ClientAdded(self, objpath):

3241

2711

"D-Bus signal"

3246

2716

"D-Bus signal"

3247

2717

pass

3248

2718

3249

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

3250

"true"})

3251

2719

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

3252

2720

def ClientRemoved(self, objpath, name):

3253

2721

"D-Bus signal"

3254

2722

pass

3255

2723

3256

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

3257

"true"})

3258

2724

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

3259

2725

def GetAllClients(self):

3260

2726

"D-Bus method"

3261

return dbus.Array(c.dbus_object_path for c in

3262

tcp_server.clients.values())

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

3263

2730

3264

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

3265

"true"})

3266

2731

@dbus.service.method(_interface,

3267

2732

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

3268

2733

def GetAllClientsWithProperties(self):

3269

2734

"D-Bus method"

3270

2735

return dbus.Dictionary(

3271

{ c.dbus_object_path: c.GetAll(

3272

"se.recompile.Mandos.Client")

3273

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

2736

{ c.dbus_object_path: c.GetAll("")

2737

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

3274

2738

signature="oa{sv}")

3275

2739

3276

2740

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

3277

2741

def RemoveClient(self, object_path):

3278

2742

"D-Bus method"

3279

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3280

2744

if c.dbus_object_path == object_path:

3281

2745

del tcp_server.clients[c.name]

3282

2746

c.remove_from_connection()

3283

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3284

2748

c.disable(quiet=True)

3285

# Emit D-Bus signal for removal

3286

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3287

2751

return

3288

2752

raise KeyError(object_path)

3289

2753

3290

2754

del _interface

3291

3292

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3293

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

3294

def GetManagedObjects(self):

3295

"""D-Bus method"""

3296

return dbus.Dictionary(

3297

{ client.dbus_object_path:

3298

dbus.Dictionary(

3299

{ interface: client.GetAll(interface)

3300

for interface in

3301

client._get_all_interface_names()})

3302

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

3303

3304

def client_added_signal(self, client):

3305

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

3306

if use_dbus:

3307

# New standard signal

3308

self.InterfacesAdded(

3309

client.dbus_object_path,

3310

dbus.Dictionary(

3311

{ interface: client.GetAll(interface)

3312

for interface in

3313

client._get_all_interface_names()}))

3314

# Old signal

3315

self.ClientAdded(client.dbus_object_path)

3316

3317

def client_removed_signal(self, client):

3318

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

3319

if use_dbus:

3320

# New standard signal

3321

self.InterfacesRemoved(

3322

client.dbus_object_path,

3323

client._get_all_interface_names())

3324

# Old signal

3325

self.ClientRemoved(client.dbus_object_path,

3326

client.name)

3327

2755

3328

2756

mandos_dbus_service = MandosDBusService()

3329

2757

3330

# Save modules to variables to exempt the modules from being

3331

# unloaded before the function registered with atexit() is run.

3332

mp = multiprocessing

3333

wn = wnull

3334

2758

def cleanup():

3335

2759

"Cleanup function; run on exit"

3336

2760

if zeroconf:

3337

2761

service.cleanup()

3338

2762

3339

mp.active_children()

3340

wn.close()

2763

multiprocessing.active_children()

2764

wnull.close()

3341

2765

if not (tcp_server.clients or client_settings):

3342

2766

return

3343

2767

3346

2770

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

3347

2771

clients = {}

3348

2772

with PGPEngine() as pgp:

3349

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3350

2774

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

3351

2775

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

3352

2776

key)

3356

2780

# + secret.

3357

2781

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

3358

2782

"checker", "server_settings" }

3359

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

3360

.Object):

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3361

2785

exclude.add(name)

3362

2786

3363

2787

client_dict["encrypted_secret"] = (client

3370

2794

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

3371

2795

3372

2796

try:

3373

with tempfile.NamedTemporaryFile(

3374

mode='wb',

3375

suffix=".pickle",

3376

prefix='clients-',

3377

dir=os.path.dirname(stored_state_path),

3378

delete=False) as stored_state:

3379

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

3380

protocol = 2)

3381

tempname = stored_state.name

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3382

2803

os.rename(tempname, stored_state_path)

3383

2804

except (IOError, OSError) as e:

3384

2805

if not debug:

3399

2820

name, client = tcp_server.clients.popitem()

3400

2821

if use_dbus:

3401

2822

client.remove_from_connection()

3402

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3403

2824

client.disable(quiet=True)

3404

# Emit D-Bus signal for removal

3405

2825

if use_dbus:

3406

mandos_dbus_service.client_removed_signal(client)

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3407

2830

client_settings.clear()

3408

2831

3409

2832

atexit.register(cleanup)

3410

2833

3411

for client in tcp_server.clients.values():

2834

for client in tcp_server.clients.itervalues():

3412

2835

if use_dbus:

3413

# Emit D-Bus signal for adding

3414

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3415

2838

# Need to initiate checking of clients

3416

2839

if client.enabled:

3417

2840

client.init_checker()

3443

2866

sys.exit(1)

3444

2867

# End of Avahi example code

3445

2868

3446

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

3447

lambda *args, **kwargs:

3448

(tcp_server.handle_request

3449

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

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

3450

2873

3451

2874

logger.debug("Starting main loop")

3452

2875

main_loop.run()

3462

2885

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

3463

2886

cleanup()

3464

2887

3465

3466

2888

if __name__ == '__main__':

3467

2889

main()