/mandos/trunk : revision 518.2.3

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

41

42

try:

43

import SocketServer as socketserver

44

except ImportError:

45

import socketserver

37

import SocketServer as socketserver

46

38

import socket

47

39

import argparse

48

40

import datetime

49

41

import errno

50

try:

51

import ConfigParser as configparser

52

except ImportError:

53

import configparser

42

import gnutls.crypto

43

import gnutls.connection

44

import gnutls.errors

45

import gnutls.library.functions

46

import gnutls.library.constants

47

import gnutls.library.types

48

import ConfigParser as configparser

54

49

import sys

55

50

import re

56

51

import os

65

60

import struct

66

61

import fcntl

67

62

import functools

68

try:

69

import cPickle as pickle

70

except ImportError:

71

import pickle

63

import cPickle as pickle

72

64

import multiprocessing

73

65

import types

74

66

import binascii

75

67

import tempfile

76

import itertools

77

import collections

78

import codecs

79

68

80

69

import dbus

81

70

import dbus.service

82

from gi.repository import GLib

71

import gobject

72

import avahi

83

73

from dbus.mainloop.glib import DBusGMainLoop

84

74

import ctypes

85

75

import ctypes.util

86

76

import xml.dom.minidom

87

77

import inspect

78

import GnuPGInterface

88

79

89

# Try to find the value of SO_BINDTODEVICE:

90

80

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

81

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

94

82

except AttributeError:

95

83

try:

96

# This is where SO_BINDTODEVICE was up to and including Python

97

# 2.6, and also 3.2:

98

84

from IN import SO_BINDTODEVICE

99

85

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

113

114

if sys.version_info.major == 2:

115

str = unicode

116

117

version = "1.7.9"

86

SO_BINDTODEVICE = None

87

88

89

version = "1.4.1"

118

90

stored_state_file = "clients.pickle"

119

91

120

92

logger = logging.getLogger()

121

syslogger = None

93

syslogger = (logging.handlers.SysLogHandler

94

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

95

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

122

96

123

97

try:

124

if_nametoindex = ctypes.cdll.LoadLibrary(

125

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

126

101

except (OSError, AttributeError):

127

128

102

def if_nametoindex(interface):

129

103

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

130

104

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

131

105

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

132

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

133

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

134

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

135

111

return interface_index

136

112

137

113

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

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

114

def initlogger(level=logging.WARNING):

155

115

"""init logger and add loglevel"""

156

116

157

global syslogger

158

syslogger = (logging.handlers.SysLogHandler(

159

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

160

address = "/dev/log"))

161

117

syslogger.setFormatter(logging.Formatter

162

118

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

163

119

' %(message)s'))

164

120

logger.addHandler(syslogger)

165

121

166

if debug:

167

console = logging.StreamHandler()

168

console.setFormatter(logging.Formatter('%(asctime)s %(name)s'

169

' [%(process)d]:'

170

' %(levelname)s:'

171

' %(message)s'))

172

logger.addHandler(console)

122

console = logging.StreamHandler()

123

console.setFormatter(logging.Formatter('%(asctime)s %(name)s'

124

' [%(process)d]:'

125

' %(levelname)s:'

126

' %(message)s'))

127

logger.addHandler(console)

173

128

logger.setLevel(level)

174

129

175

130

176

class PGPError(Exception):

177

"""Exception if encryption/decryption fails"""

131

class CryptoError(Exception):

178

132

pass

179

133

180

134

181

class PGPEngine(object):

135

class Crypto(object):

182

136

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

183

184

137

def __init__(self):

138

self.gnupg = GnuPGInterface.GnuPG()

185

139

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

self.gnupgargs = ['--batch',

198

'--homedir', self.tempdir,

199

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

140

self.gnupg = GnuPGInterface.GnuPG()

141

self.gnupg.options.meta_interactive = False

142

self.gnupg.options.homedir = self.tempdir

143

self.gnupg.options.extra_args.extend(['--force-mdc',

144

'--quiet'])

204

145

205

146

def __enter__(self):

206

147

return self

207

148

208

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

149

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

209

150

self._cleanup()

210

151

return False

211

152

228

169

def password_encode(self, password):

229

170

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

230

171

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

231

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

232

if len(encoded) > 2048:

233

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

234

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

235

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

236

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

237

return encoded

172

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

238

173

239

174

def encrypt(self, data, password):

240

passphrase = self.password_encode(password)

241

with tempfile.NamedTemporaryFile(

242

dir=self.tempdir) as passfile:

243

passfile.write(passphrase)

244

passfile.flush()

245

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

246

'--passphrase-file',

247

passfile.name]

248

+ self.gnupgargs,

249

stdin = subprocess.PIPE,

250

stdout = subprocess.PIPE,

251

stderr = subprocess.PIPE)

252

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

253

if proc.returncode != 0:

254

raise PGPError(err)

175

self.gnupg.passphrase = self.password_encode(password)

176

with open(os.devnull) as devnull:

177

try:

178

proc = self.gnupg.run(['--symmetric'],

179

create_fhs=['stdin', 'stdout'],

180

attach_fhs={'stderr': devnull})

181

with contextlib.closing(proc.handles['stdin']) as f:

182

f.write(data)

183

with contextlib.closing(proc.handles['stdout']) as f:

184

ciphertext = f.read()

185

proc.wait()

186

except IOError as e:

187

raise CryptoError(e)

188

self.gnupg.passphrase = None

255

189

return ciphertext

256

190

257

191

def decrypt(self, data, password):

258

passphrase = self.password_encode(password)

259

with tempfile.NamedTemporaryFile(

260

dir = self.tempdir) as passfile:

261

passfile.write(passphrase)

262

passfile.flush()

263

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

264

'--passphrase-file',

265

passfile.name]

266

+ self.gnupgargs,

267

stdin = subprocess.PIPE,

268

stdout = subprocess.PIPE,

269

stderr = subprocess.PIPE)

270

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

271

if proc.returncode != 0:

272

raise PGPError(err)

192

self.gnupg.passphrase = self.password_encode(password)

193

with open(os.devnull) as devnull:

194

try:

195

proc = self.gnupg.run(['--decrypt'],

196

create_fhs=['stdin', 'stdout'],

197

attach_fhs={'stderr': devnull})

198

with contextlib.closing(proc.handles['stdin'] ) as f:

199

f.write(data)

200

with contextlib.closing(proc.handles['stdout']) as f:

201

decrypted_plaintext = f.read()

202

proc.wait()

203

except IOError as e:

204

raise CryptoError(e)

205

self.gnupg.passphrase = None

273

206

return decrypted_plaintext

274

207

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

208

299

209

300

210

class AvahiError(Exception):

301

211

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

302

212

self.value = value

303

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

304

**kwargs)

305

213

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

214

def __unicode__(self):

215

return unicode(repr(self.value))

306

216

307

217

class AvahiServiceError(AvahiError):

308

218

pass

309

219

310

311

220

class AvahiGroupError(AvahiError):

312

221

pass

313

222

320

229

Used to optionally bind to the specified interface.

321

230

name: string; Example: 'Mandos'

322

231

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

323

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

232

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

324

233

port: integer; what port to announce

325

234

TXT: list of strings; TXT record for the service

326

235

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

332

241

server: D-Bus Server

333

242

bus: dbus.SystemBus()

334

243

"""

335

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

244

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

245

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

246

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

247

protocol = avahi.PROTO_UNSPEC, bus = None):

347

248

self.interface = interface

348

249

self.name = name

349

250

self.type = servicetype

358

259

self.server = None

359

260

self.bus = bus

360

261

self.entry_group_state_changed_match = None

361

362

def rename(self, remove=True):

262

def rename(self):

363

263

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

364

264

if self.rename_count >= self.max_renames:

365

265

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

366

266

" after %i retries, exiting.",

367

267

self.rename_count)

368

268

raise AvahiServiceError("Too many renames")

369

self.name = str(

370

self.server.GetAlternativeServiceName(self.name))

371

self.rename_count += 1

269

self.name = unicode(self.server

270

.GetAlternativeServiceName(self.name))

372

271

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

373

272

self.name)

374

if remove:

375

self.remove()

273

self.remove()

376

274

try:

377

275

self.add()

378

276

except dbus.exceptions.DBusException as error:

379

if (error.get_dbus_name()

380

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

381

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

382

return self.rename(remove=False)

383

else:

384

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

385

self.cleanup()

386

os._exit(1)

387

277

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

278

self.cleanup()

279

os._exit(1)

280

self.rename_count += 1

388

281

def remove(self):

389

282

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

390

283

if self.entry_group_state_changed_match is not None:

392

285

self.entry_group_state_changed_match = None

393

286

if self.group is not None:

394

287

self.group.Reset()

395

396

288

def add(self):

397

289

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

398

290

self.remove()

415

307

dbus.UInt16(self.port),

416

308

avahi.string_array_to_txt_array(self.TXT))

417

309

self.group.Commit()

418

419

310

def entry_group_state_changed(self, state, error):

420

311

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

421

312

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

427

318

self.rename()

428

319

elif state == avahi.ENTRY_GROUP_FAILURE:

429

320

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

430

str(error))

431

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

432

321

unicode(error))

322

raise AvahiGroupError("State changed: %s"

323

% unicode(error))

433

324

def cleanup(self):

434

325

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

435

326

if self.group is not None:

440

331

pass

441

332

self.group = None

442

333

self.remove()

443

444

334

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

445

335

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

446

336

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

}

337

bad_states = { avahi.SERVER_INVALID:

338

"Zeroconf server invalid",

339

avahi.SERVER_REGISTERING: None,

340

avahi.SERVER_COLLISION:

341

"Zeroconf server name collision",

342

avahi.SERVER_FAILURE:

343

"Zeroconf server failure" }

453

344

if state in bad_states:

454

345

if bad_states[state] is not None:

455

346

if error is None:

458

349

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

459

350

self.cleanup()

460

351

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)

352

self.add()

473

353

else:

474

354

if error is None:

475

355

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

476

356

else:

477

357

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

478

479

358

def activate(self):

480

359

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

481

360

if self.server is None:

485

364

follow_name_owner_changes=True),

486

365

avahi.DBUS_INTERFACE_SERVER)

487

366

self.server.connect_to_signal("StateChanged",

488

self.server_state_changed)

367

self.server_state_changed)

489

368

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

490

369

491

492

370

class AvahiServiceToSyslog(AvahiService):

493

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

371

def rename(self):

494

372

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

495

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

496

syslogger.setFormatter(logging.Formatter(

497

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

498

.format(self.name)))

373

ret = AvahiService.rename(self)

374

syslogger.setFormatter(logging.Formatter

375

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

376

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

377

% self.name))

499

378

return ret

500

379

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

380

def _timedelta_to_milliseconds(td):

381

"Convert a datetime.timedelta() to milliseconds"

382

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

383

+ (td.seconds * 1000)

384

+ (td.microseconds // 1000))

385

766

386

class Client(object):

767

387

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

768

388

769

389

Attributes:

770

approved: bool(); 'None' if not yet approved/disapproved

390

_approved: bool(); 'None' if not yet approved/disapproved

771

391

approval_delay: datetime.timedelta(); Time to wait for approval

772

392

approval_duration: datetime.timedelta(); Duration of one approval

773

393

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

774

394

to see if the client lives.

775

395

'None' if no process is running.

776

checker_callback_tag: a GLib event source tag, or None

396

checker_callback_tag: a gobject event source tag, or None

777

397

checker_command: string; External command which is run to check

778

398

if client lives. %() expansions are done at

779

399

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

780

400

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

781

checker_initiator_tag: a GLib event source tag, or None

401

checker_initiator_tag: a gobject event source tag, or None

782

402

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

783

403

client_structure: Object describing what attributes a client has

784

404

and is used for storing the client at exit

785

405

current_checker_command: string; current running checker_command

786

disable_initiator_tag: a GLib event source tag, or None

406

disable_initiator_tag: a gobject event source tag, or None

787

407

enabled: bool()

788

408

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

789

409

uniquely identify the client

791

411

interval: datetime.timedelta(); How often to start a new checker

792

412

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

793

413

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

414

794

415

last_checker_status: integer between 0 and 255 reflecting exit

795

416

status of last checker. -1 reflects crashed

796

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

417

checker, or None.

799

418

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

800

419

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

801

420

D-Bus identifiers

802

421

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

803

422

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

804

423

until this client is disabled

805

extended_timeout: extra long timeout when secret has been sent

424

extended_timeout: extra long timeout when password has been sent

806

425

runtime_expansions: Allowed attributes for runtime expansion.

807

426

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

808

427

disabled, or None

809

server_settings: The server_settings dict from main()

810

428

"""

811

429

812

430

runtime_expansions = ("approval_delay", "approval_duration",

813

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

814

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

815

"last_approval_request", "last_checked_ok",

431

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

432

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

816

433

"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

}

828

829

@staticmethod

830

def config_parser(config):

831

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

832

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

833

with exceptions for any special settings as defined above.

834

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

835

value given the same arguments.

836

"""

837

settings = {}

838

for client_name in config.sections():

839

section = dict(config.items(client_name))

840

client = settings[client_name] = {}

841

842

client["host"] = section["host"]

843

# Reformat values from string types to Python types

844

client["approved_by_default"] = config.getboolean(

845

client_name, "approved_by_default")

846

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

847

"enabled")

848

849

# Uppercase and remove spaces from fingerprint for later

850

# comparison purposes with return value from the

851

# fingerprint() function

852

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

853

.replace(" ", ""))

854

if "secret" in section:

855

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

856

.encode("utf-8"),

857

"base64")

858

elif "secfile" in section:

859

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

860

(section["secfile"])),

861

"rb") as secfile:

862

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

863

else:

864

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

865

.format(section))

866

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

867

client["extended_timeout"] = string_to_delta(

868

section["extended_timeout"])

869

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

870

client["approval_delay"] = string_to_delta(

871

section["approval_delay"])

872

client["approval_duration"] = string_to_delta(

873

section["approval_duration"])

874

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

875

client["last_approval_request"] = None

876

client["last_checked_ok"] = None

877

client["last_checker_status"] = -2

878

879

return settings

880

881

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

434

435

def timeout_milliseconds(self):

436

"Return the 'timeout' attribute in milliseconds"

437

return _timedelta_to_milliseconds(self.timeout)

438

439

def extended_timeout_milliseconds(self):

440

"Return the 'extended_timeout' attribute in milliseconds"

441

return _timedelta_to_milliseconds(self.extended_timeout)

442

443

def interval_milliseconds(self):

444

"Return the 'interval' attribute in milliseconds"

445

return _timedelta_to_milliseconds(self.interval)

446

447

def approval_delay_milliseconds(self):

448

return _timedelta_to_milliseconds(self.approval_delay)

449

450

def __init__(self, name = None, config=None):

451

"""Note: the 'checker' key in 'config' sets the

452

'checker_command' attribute and *not* the 'checker'

453

attribute."""

882

454

self.name = name

883

if server_settings is None:

884

server_settings = {}

885

self.server_settings = server_settings

886

# adding all client settings

887

for setting, value in settings.items():

888

setattr(self, setting, value)

889

890

if self.enabled:

891

if not hasattr(self, "last_enabled"):

892

self.last_enabled = datetime.datetime.utcnow()

893

if not hasattr(self, "expires"):

894

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

895

+ self.timeout)

896

else:

897

self.last_enabled = None

898

self.expires = None

899

455

if config is None:

456

config = {}

900

457

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

458

# Uppercase and remove spaces from fingerprint for later

459

# comparison purposes with return value from the fingerprint()

460

# function

461

self.fingerprint = (config["fingerprint"].upper()

462

.replace(" ", ""))

901

463

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

902

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

903

datetime.datetime.utcnow())

904

905

# attributes specific for this server instance

464

if "secret" in config:

465

self.secret = config["secret"].decode("base64")

466

elif "secfile" in config:

467

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

468

(config["secfile"])),

469

"rb") as secfile:

470

self.secret = secfile.read()

471

else:

472

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

473

% self.name)

474

self.host = config.get("host", "")

475

self.created = datetime.datetime.utcnow()

476

self.enabled = config.get("enabled", True)

477

self.last_approval_request = None

478

if self.enabled:

479

self.last_enabled = datetime.datetime.utcnow()

480

else:

481

self.last_enabled = None

482

self.last_checked_ok = None

483

self.last_checker_status = None

484

self.timeout = string_to_delta(config["timeout"])

485

self.extended_timeout = string_to_delta(config

486

["extended_timeout"])

487

self.interval = string_to_delta(config["interval"])

906

488

self.checker = None

907

489

self.checker_initiator_tag = None

908

490

self.disable_initiator_tag = None

491

if self.enabled:

492

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

493

else:

494

self.expires = None

909

495

self.checker_callback_tag = None

496

self.checker_command = config["checker"]

910

497

self.current_checker_command = None

911

self.approved = None

498

self._approved = None

499

self.approved_by_default = config.get("approved_by_default",

500

True)

912

501

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

502

self.approval_delay = string_to_delta(

503

config["approval_delay"])

504

self.approval_duration = string_to_delta(

505

config["approval_duration"])

506

self.changedstate = (multiprocessing_manager

507

.Condition(multiprocessing_manager

508

.Lock()))

509

self.client_structure = [attr for attr in

510

self.__dict__.iterkeys()

917

511

if not attr.startswith("_")]

918

512

self.client_structure.append("client_structure")

919

513

920

for name, t in inspect.getmembers(

921

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

514

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

515

lambda obj:

516

isinstance(obj,

517

property)):

922

518

if not name.startswith("_"):

923

519

self.client_structure.append(name)

924

520

932

528

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

933

529

# Already enabled

934

530

return

531

self.send_changedstate()

935

532

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

936

533

self.enabled = True

937

534

self.last_enabled = datetime.datetime.utcnow()

938

535

self.init_checker()

939

self.send_changedstate()

940

536

941

537

def disable(self, quiet=True):

942

538

"""Disable this client."""

943

539

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

944

540

return False

945

541

if not quiet:

542

self.send_changedstate()

543

if not quiet:

946

544

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

947

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

948

GLib.source_remove(self.disable_initiator_tag)

545

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

546

gobject.source_remove(self.disable_initiator_tag)

949

547

self.disable_initiator_tag = None

950

548

self.expires = None

951

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

952

GLib.source_remove(self.checker_initiator_tag)

549

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

550

gobject.source_remove(self.checker_initiator_tag)

953

551

self.checker_initiator_tag = None

954

552

self.stop_checker()

955

553

self.enabled = False

956

if not quiet:

957

self.send_changedstate()

958

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

554

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

959

555

return False

960

556

961

557

def __del__(self):

964

560

def init_checker(self):

965

561

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

966

562

# and every interval from then on.

967

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)

563

self.checker_initiator_tag = (gobject.timeout_add

564

(self.interval_milliseconds(),

565

self.start_checker))

972

566

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

973

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)

567

self.disable_initiator_tag = (gobject.timeout_add

568

(self.timeout_milliseconds(),

569

self.disable))

977

570

# Also start a new checker *right now*.

978

571

self.start_checker()

979

572

980

def checker_callback(self, source, condition, connection,

981

command):

573

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

982

574

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

983

575

self.checker_callback_tag = None

984

576

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

577

if os.WIFEXITED(condition):

578

self.last_checker_status = os.WEXITSTATUS(condition)

992

579

if self.last_checker_status == 0:

993

580

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

994

581

vars(self))

995

582

self.checked_ok()

996

583

else:

997

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

584

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

585

vars(self))

998

586

else:

999

587

self.last_checker_status = -1

1000

self.last_checker_signal = -returncode

1001

588

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

1002

589

vars(self))

1003

return False

1004

1005

def checked_ok(self):

1006

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

1007

self.last_checked_ok = datetime.datetime.utcnow()

1008

self.last_checker_status = 0

1009

self.last_checker_signal = None

1010

self.bump_timeout()

1011

1012

def bump_timeout(self, timeout=None):

1013

"""Bump up the timeout for this client."""

590

591

def checked_ok(self, timeout=None):

592

"""Bump up the timeout for this client.

593

594

This should only be called when the client has been seen,

595

alive and well.

596

"""

1014

597

if timeout is None:

1015

598

timeout = self.timeout

599

self.last_checked_ok = datetime.datetime.utcnow()

1016

600

if self.disable_initiator_tag is not None:

1017

GLib.source_remove(self.disable_initiator_tag)

1018

self.disable_initiator_tag = None

601

gobject.source_remove(self.disable_initiator_tag)

1019

602

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

1020

self.disable_initiator_tag = GLib.timeout_add(

1021

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

603

self.disable_initiator_tag = (gobject.timeout_add

604

(_timedelta_to_milliseconds

605

(timeout), self.disable))

1022

606

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

1023

607

1024

608

def need_approval(self):

1030

614

If a checker already exists, leave it running and do

1031

615

nothing."""

1032

616

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

1033

# did that, and if a checker (for some reason) started running

1034

# slowly and taking more than 'interval' time, then the client

1035

# would inevitably timeout, since no checker would get a

1036

# chance to run to completion. If we instead leave running

617

# did that, then if a checker (for some reason) started

618

# running slowly and taking more than 'interval' time, the

619

# client would inevitably timeout, since no checker would get

620

# a chance to run to completion. If we instead leave running

1037

621

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

1038

622

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

1039

623

# should be.

1040

624

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

625

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

626

try:

627

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

628

except (AttributeError, OSError) as error:

629

if (isinstance(error, OSError)

630

and error.errno != errno.ECHILD):

631

raise error

632

else:

633

if pid:

634

logger.warning("Checker was a zombie")

635

gobject.source_remove(self.checker_callback_tag)

636

self.checker_callback(pid, status,

637

self.current_checker_command)

1045

638

# Start a new checker if needed

1046

639

if self.checker is None:

1047

# Escape attributes for the shell

1048

escaped_attrs = {

1049

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

1050

for attr in self.runtime_expansions }

1051

640

try:

1052

command = self.checker_command % escaped_attrs

1053

except TypeError as error:

1054

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

1055

self.checker_command,

1056

exc_info=error)

1057

return True # Try again later

641

# In case checker_command has exactly one % operator

642

command = self.checker_command % self.host

643

except TypeError:

644

# Escape attributes for the shell

645

escaped_attrs = dict(

646

(attr,

647

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

648

errors=

649

'replace')))

650

for attr in

651

self.runtime_expansions)

652

653

try:

654

command = self.checker_command % escaped_attrs

655

except TypeError as error:

656

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

657

' %s', self.checker_command, error)

658

return True # Try again later

1058

659

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

660

try:

661

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

662

command, self.name)

663

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

664

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

665

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

666

# always replaced by /dev/null.)

667

self.checker = subprocess.Popen(command,

668

close_fds=True,

669

shell=True, cwd="/")

670

self.checker_callback_tag = (gobject.child_watch_add

671

(self.checker.pid,

672

self.checker_callback,

673

data=command))

674

# The checker may have completed before the gobject

675

# watch was added. Check for this.

676

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

677

if pid:

678

gobject.source_remove(self.checker_callback_tag)

679

self.checker_callback(pid, status, command)

680

except OSError as error:

681

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

682

error)

683

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

1085

684

return True

1086

685

1087

686

def stop_checker(self):

1088

687

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

1089

688

if self.checker_callback_tag:

1090

GLib.source_remove(self.checker_callback_tag)

689

gobject.source_remove(self.checker_callback_tag)

1091

690

self.checker_callback_tag = None

1092

691

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

1093

692

return

1094

693

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

1095

self.checker.terminate()

694

try:

695

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

696

#time.sleep(0.5)

697

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

698

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

699

except OSError as error:

700

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

701

raise

1096

702

self.checker = None

1097

703

1098

704

1099

def dbus_service_property(dbus_interface,

1100

signature="v",

1101

access="readwrite",

1102

byte_arrays=False):

705

def dbus_service_property(dbus_interface, signature="v",

706

access="readwrite", byte_arrays=False):

1103

707

"""Decorators for marking methods of a DBusObjectWithProperties to

1104

708

become properties on the D-Bus.

1105

709

1114

718

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

1115

719

if byte_arrays and signature != "ay":

1116

720

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

1117

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

1118

721

" signature %r" % signature)

1119

722

def decorator(func):

1120

723

func._dbus_is_property = True

1121

724

func._dbus_interface = dbus_interface

1126

729

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

1127

730

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1128

731

return func

1129

1130

return decorator

1131

1132

1133

def dbus_interface_annotations(dbus_interface):

1134

"""Decorator for marking functions returning interface annotations

1135

1136

Usage:

1137

1138

@dbus_interface_annotations("org.example.Interface")

1139

def _foo(self): # Function name does not matter

1140

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

1141

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

1142

"false"}

1143

"""

1144

1145

def decorator(func):

1146

func._dbus_is_interface = True

1147

func._dbus_interface = dbus_interface

1148

func._dbus_name = dbus_interface

1149

return func

1150

1151

return decorator

1152

1153

1154

def dbus_annotations(annotations):

1155

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

1156

Usage:

1157

1158

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

1159

"org.freedesktop.DBus.Property."

1160

"EmitsChangedSignal": "false"})

1161

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

1162

access="r")

1163

def Property_dbus_property(self):

1164

return dbus.Boolean(False)

1165

1166

See also the DBusObjectWithAnnotations class.

1167

"""

1168

1169

def decorator(func):

1170

func._dbus_annotations = annotations

1171

return func

1172

1173

732

return decorator

1174

733

1175

734

1176

735

class DBusPropertyException(dbus.exceptions.DBusException):

1177

736

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

1178

737

"""

1179

pass

738

def __unicode__(self):

739

return unicode(str(self))

1180

740

1181

741

1182

742

class DBusPropertyAccessException(DBusPropertyException):

1191

751

pass

1192

752

1193

753

1194

class DBusObjectWithAnnotations(dbus.service.Object):

1195

"""A D-Bus object with annotations.

1196

1197

Classes inheriting from this can use the dbus_annotations

1198

decorator to add annotations to methods or signals.

1199

"""

1200

1201

@staticmethod

1202

def _is_dbus_thing(thing):

1203

"""Returns a function testing if an attribute is a D-Bus thing

1204

1205

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

1206

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

1207

"""

1208

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

1209

False)

1210

1211

def _get_all_dbus_things(self, thing):

1212

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

1213

"""

1214

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

1215

athing.__get__(self))

1216

for cls in self.__class__.__mro__

1217

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

754

class DBusObjectWithProperties(dbus.service.Object):

1284

755

"""A D-Bus object with properties.

1285

756

1286

757

Classes inheriting from this can use the dbus_service_property

1288

759

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

1289

760

"""

1290

761

762

@staticmethod

763

def _is_dbus_property(obj):

764

return getattr(obj, "_dbus_is_property", False)

765

766

def _get_all_dbus_properties(self):

767

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

768

"""

769

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

770

for cls in self.__class__.__mro__

771

for name, prop in

772

inspect.getmembers(cls, self._is_dbus_property))

773

1291

774

def _get_dbus_property(self, interface_name, property_name):

1292

775

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

1293

776

property with the specified name and interface.

1294

777

"""

1295

for cls in self.__class__.__mro__:

1296

for name, value in inspect.getmembers(

1297

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

778

for cls in self.__class__.__mro__:

779

for name, value in (inspect.getmembers

780

(cls, self._is_dbus_property)):

1298

781

if (value._dbus_name == property_name

1299

782

and value._dbus_interface == interface_name):

1300

783

return value.__get__(self)

1301

784

1302

785

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

786

raise DBusPropertyNotFound(self.dbus_object_path + ":"

787

+ interface_name + "."

788

+ property_name)

789

790

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

1317

791

out_signature="v")

1318

792

def Get(self, interface_name, property_name):

1319

793

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

1337

811

# The byte_arrays option is not supported yet on

1338

812

# signatures other than "ay".

1339

813

if prop._dbus_signature != "ay":

1340

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

1341

"'ay' signature {!r}"

1342

.format(prop._dbus_signature))

1343

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

1344

for byte in value))

814

raise ValueError

815

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

816

for byte in value))

1345

817

prop(value)

1346

818

1347

@dbus.service.method(dbus.PROPERTIES_IFACE,

1348

in_signature="s",

819

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

1349

820

out_signature="a{sv}")

1350

821

def GetAll(self, interface_name):

1351

822

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

1354

825

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

1355

826

"""

1356

827

properties = {}

1357

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

828

for name, prop in self._get_all_dbus_properties():

1358

829

if (interface_name

1359

830

and interface_name != prop._dbus_interface):

1360

831

# Interface non-empty but did not match

1366

837

if not hasattr(value, "variant_level"):

1367

838

properties[name] = value

1368

839

continue

1369

properties[name] = type(value)(

1370

value, variant_level = value.variant_level + 1)

840

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

841

value.variant_level+1)

1371

842

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

1372

843

1373

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

1374

def PropertiesChanged(self, interface_name, changed_properties,

1375

invalidated_properties):

1376

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

1377

standard.

1378

"""

1379

pass

1380

1381

844

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1382

845

out_signature="s",

1383

846

path_keyword='object_path',

1384

847

connection_keyword='connection')

1385

848

def Introspect(self, object_path, connection):

1386

"""Overloading of standard D-Bus method.

1387

1388

Inserts property tags and interface annotation tags.

849

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

1389

850

"""

1390

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1391

object_path,

1392

connection)

851

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

852

connection)

1393

853

try:

1394

854

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

1395

1396

855

def make_tag(document, name, prop):

1397

856

e = document.createElement("property")

1398

857

e.setAttribute("name", name)

1399

858

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

1400

859

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

1401

860

return e

1402

1403

861

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

1404

# Add property tags

1405

862

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

1406

863

for name, prop

1407

in self._get_all_dbus_things("property")

864

in self._get_all_dbus_properties()

1408

865

if prop._dbus_interface

1409

866

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

1410

867

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)

1427

868

# Add the names to the return values for the

1428

869

# "org.freedesktop.DBus.Properties" methods

1429

870

if (if_tag.getAttribute("name")

1444

885

except (AttributeError, xml.dom.DOMException,

1445

886

xml.parsers.expat.ExpatError) as error:

1446

887

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

1447

exc_info=error)

1448

return xmlstring

1449

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

1519

def datetime_to_dbus(dt, variant_level=0):

888

error)

889

return xmlstring

890

891

892

def datetime_to_dbus (dt, variant_level=0):

1520

893

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

1521

894

if dt is None:

1522

895

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

1523

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

1524

1525

1526

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1527

"""A class decorator; applied to a subclass of

1528

dbus.service.Object, it will add alternate D-Bus attributes with

1529

interface names according to the "alt_interface_names" mapping.

1530

Usage:

1531

1532

@alternate_dbus_interfaces({"org.example.Interface":

1533

"net.example.AlternateInterface"})

1534

class SampleDBusObject(dbus.service.Object):

1535

@dbus.service.method("org.example.Interface")

1536

def SampleDBusMethod():

1537

pass

1538

1539

The above "SampleDBusMethod" on "SampleDBusObject" will be

1540

reachable via two interfaces: "org.example.Interface" and

1541

"net.example.AlternateInterface", the latter of which will have

1542

its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to

1543

"true", unless "deprecate" is passed with a False value.

1544

1545

This works for methods and signals, and also for D-Bus properties

1546

(from DBusObjectWithProperties) and interfaces (from the

1547

dbus_interface_annotations decorator).

896

return dbus.String(dt.isoformat(),

897

variant_level=variant_level)

898

899

900

class AlternateDBusNamesMetaclass(DBusObjectWithProperties

901

.__metaclass__):

902

"""Applied to an empty subclass of a D-Bus object, this metaclass

903

will add additional D-Bus attributes matching a certain pattern.

1548

904

"""

1549

1550

def wrapper(cls):

1551

for orig_interface_name, alt_interface_name in (

1552

alt_interface_names.items()):

1553

attr = {}

1554

interface_names = set()

1555

# Go though all attributes of the class

1556

for attrname, attribute in inspect.getmembers(cls):

905

def __new__(mcs, name, bases, attr):

906

# Go through all the base classes which could have D-Bus

907

# methods, signals, or properties in them

908

for base in (b for b in bases

909

if issubclass(b, dbus.service.Object)):

910

# Go though all attributes of the base class

911

for attrname, attribute in inspect.getmembers(base):

1557

912

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

1558

913

# with the wrong interface name

1559

914

if (not hasattr(attribute, "_dbus_interface")

1560

or not attribute._dbus_interface.startswith(

1561

orig_interface_name)):

915

or not attribute._dbus_interface

916

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

1562

917

continue

1563

918

# Create an alternate D-Bus interface name based on

1564

919

# the current name

1565

alt_interface = attribute._dbus_interface.replace(

1566

orig_interface_name, alt_interface_name)

1567

interface_names.add(alt_interface)

920

alt_interface = (attribute._dbus_interface

921

.replace("se.recompile.Mandos",

922

"se.bsnet.fukt.Mandos"))

1568

923

# Is this a D-Bus signal?

1569

924

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

1570

# Extract the original non-method undecorated

1571

# function by black magic

1572

if sys.version_info.major == 2:

1573

nonmethod_func = (dict(

925

# Extract the original non-method function by

926

# black magic

927

nonmethod_func = (dict(

1574

928

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)

929

attribute.__closure__))["func"]

930

.cell_contents)

1582

931

# Create a new, but exactly alike, function

1583

932

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

1584

933

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

1589

# Copy annotations, if any

1590

try:

1591

new_function._dbus_annotations = dict(

1592

attribute._dbus_annotations)

1593

except AttributeError:

1594

pass

934

new_function = (dbus.service.signal

935

(alt_interface,

936

attribute._dbus_signature)

937

(types.FunctionType(

938

nonmethod_func.func_code,

939

nonmethod_func.func_globals,

940

nonmethod_func.func_name,

941

nonmethod_func.func_defaults,

942

nonmethod_func.func_closure)))

1595

943

# Define a creator of a function to call both the

1596

# original and alternate functions, so both the

1597

# original and alternate signals gets sent when

1598

# the function is called

944

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

945

# signals gets sent when the function is called

1599

946

def fixscope(func1, func2):

1600

947

"""This function is a scope container to pass

1601

948

func1 and func2 to the "call_both" function

1602

949

outside of its arguments"""

1603

1604

@functools.wraps(func2)

1605

950

def call_both(*args, **kwargs):

1606

951

"""This function will emit two D-Bus

1607

952

signals by calling func1 and func2"""

1608

953

func1(*args, **kwargs)

1609

954

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

955

return call_both

1616

956

# Create the "call_both" function and add it to

1617

957

# the class

1618

attr[attrname] = fixscope(attribute, new_function)

958

attr[attrname] = fixscope(attribute,

959

new_function)

1619

960

# Is this a D-Bus method?

1620

961

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

1621

962

# Create a new, but exactly alike, function

1622

963

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

1623

964

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

1624

965

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

1631

# Copy annotations, if any

1632

try:

1633

attr[attrname]._dbus_annotations = dict(

1634

attribute._dbus_annotations)

1635

except AttributeError:

1636

pass

966

attr[attrname] = (dbus.service.method

967

(alt_interface,

968

attribute._dbus_in_signature,

969

attribute._dbus_out_signature)

970

(types.FunctionType

971

(attribute.func_code,

972

attribute.func_globals,

973

attribute.func_name,

974

attribute.func_defaults,

975

attribute.func_closure)))

1637

976

# Is this a D-Bus property?

1638

977

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

1639

978

# Create a new, but exactly alike, function

1640

979

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

1641

980

# property with the alternate D-Bus interface

1642

981

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

1649

# Copy annotations, if any

1650

try:

1651

attr[attrname]._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1653

except AttributeError:

1654

pass

1655

# Is this a D-Bus interface?

1656

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

1657

# Create a new, but exactly alike, function

1658

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

1659

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

1660

# to the class.

1661

attr[attrname] = (

1662

dbus_interface_annotations(alt_interface)

1663

(copy_function(attribute)))

1664

if deprecate:

1665

# Deprecate all alternate interfaces

1666

iname="_AlternateDBusNames_interface_annotation{}"

1667

for interface_name in interface_names:

1668

1669

@dbus_interface_annotations(interface_name)

1670

def func(self):

1671

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

1672

"true" }

1673

# Find an unused name

1674

for aname in (iname.format(i)

1675

for i in itertools.count()):

1676

if aname not in attr:

1677

attr[aname] = func

1678

break

1679

if interface_names:

1680

# Replace the class with a new subclass of it with

1681

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

1688

return cls

1689

1690

return wrapper

1691

1692

1693

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

1694

"se.bsnet.fukt.Mandos"})

982

attr[attrname] = (dbus_service_property

983

(alt_interface,

984

attribute._dbus_signature,

985

attribute._dbus_access,

986

attribute

987

._dbus_get_args_options

988

["byte_arrays"])

989

(types.FunctionType

990

(attribute.func_code,

991

attribute.func_globals,

992

attribute.func_name,

993

attribute.func_defaults,

994

attribute.func_closure)))

995

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

996

997

1695

998

class ClientDBus(Client, DBusObjectWithProperties):

1696

999

"""A Client class using D-Bus

1697

1000

1701

1004

"""

1702

1005

1703

1006

runtime_expansions = (Client.runtime_expansions

1704

+ ("dbus_object_path", ))

1705

1706

_interface = "se.recompile.Mandos.Client"

1007

+ ("dbus_object_path",))

1707

1008

1708

1009

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

1709

1010

1710

1011

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

1711

1012

self.bus = bus

1712

1013

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

1014

1015

self._approvals_pending = 0

1713

1016

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

1714

1017

# the D-Bus

1715

client_object_name = str(self.name).translate(

1018

client_object_name = unicode(self.name).translate(

1716

1019

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

1717

1020

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

1718

self.dbus_object_path = dbus.ObjectPath(

1719

"/clients/" + client_object_name)

1021

self.dbus_object_path = (dbus.ObjectPath

1022

("/clients/" + client_object_name))

1720

1023

DBusObjectWithProperties.__init__(self, self.bus,

1721

1024

self.dbus_object_path)

1722

1723

def notifychangeproperty(transform_func, dbus_name,

1724

type_func=lambda x: x,

1725

variant_level=1,

1726

invalidate_only=False,

1727

_interface=_interface):

1025

1026

def notifychangeproperty(transform_func,

1027

dbus_name, type_func=lambda x: x,

1028

variant_level=1):

1728

1029

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

1729

1030

its changes to DBus.

1730

1031

1735

1036

to the D-Bus. Default: no transform

1736

1037

variant_level: D-Bus variant level. Default: 1

1737

1038

"""

1738

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

1739

1039

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

1740

1040

def setter(self, value):

1741

1041

if hasattr(self, "dbus_object_path"):

1742

1042

if (not hasattr(self, attrname) or

1743

1043

type_func(getattr(self, attrname, None))

1744

1044

!= type_func(value)):

1745

if invalidate_only:

1746

self.PropertiesChanged(

1747

_interface, dbus.Dictionary(),

1748

dbus.Array((dbus_name, )))

1749

else:

1750

dbus_value = transform_func(

1751

type_func(value),

1752

variant_level = variant_level)

1753

self.PropertyChanged(dbus.String(dbus_name),

1754

dbus_value)

1755

self.PropertiesChanged(

1756

_interface,

1757

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

1758

dbus_value }),

1759

dbus.Array())

1045

dbus_value = transform_func(type_func(value),

1046

variant_level

1047

=variant_level)

1048

self.PropertyChanged(dbus.String(dbus_name),

1049

dbus_value)

1760

1050

setattr(self, attrname, value)

1761

1051

1762

1052

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

1763

1053

1054

1764

1055

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1765

1056

approvals_pending = notifychangeproperty(dbus.Boolean,

1766

1057

"ApprovalPending",

1768

1059

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

1769

1060

last_enabled = notifychangeproperty(datetime_to_dbus,

1770

1061

"LastEnabled")

1771

checker = notifychangeproperty(

1772

dbus.Boolean, "CheckerRunning",

1773

type_func = lambda checker: checker is not None)

1062

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

1063

type_func = lambda checker:

1064

checker is not None)

1774

1065

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1775

1066

"LastCheckedOK")

1776

last_checker_status = notifychangeproperty(dbus.Int16,

1777

"LastCheckerStatus")

1778

1067

last_approval_request = notifychangeproperty(

1779

1068

datetime_to_dbus, "LastApprovalRequest")

1780

1069

approved_by_default = notifychangeproperty(dbus.Boolean,

1781

1070

"ApprovedByDefault")

1782

approval_delay = notifychangeproperty(

1783

dbus.UInt64, "ApprovalDelay",

1784

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

1071

approval_delay = notifychangeproperty(dbus.UInt16,

1072

"ApprovalDelay",

1073

type_func =

1074

_timedelta_to_milliseconds)

1785

1075

approval_duration = notifychangeproperty(

1786

dbus.UInt64, "ApprovalDuration",

1787

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

1076

dbus.UInt16, "ApprovalDuration",

1077

type_func = _timedelta_to_milliseconds)

1788

1078

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

1789

timeout = notifychangeproperty(

1790

dbus.UInt64, "Timeout",

1791

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

1079

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

1080

type_func =

1081

_timedelta_to_milliseconds)

1792

1082

extended_timeout = notifychangeproperty(

1793

dbus.UInt64, "ExtendedTimeout",

1794

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

1795

interval = notifychangeproperty(

1796

dbus.UInt64, "Interval",

1797

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

1083

dbus.UInt16, "ExtendedTimeout",

1084

type_func = _timedelta_to_milliseconds)

1085

interval = notifychangeproperty(dbus.UInt16,

1086

"Interval",

1087

type_func =

1088

_timedelta_to_milliseconds)

1798

1089

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

1799

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

1800

invalidate_only=True)

1801

1090

1802

1091

del notifychangeproperty

1803

1092

1810

1099

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

1811

1100

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

1812

1101

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:

1102

def checker_callback(self, pid, condition, command,

1103

*args, **kwargs):

1104

self.checker_callback_tag = None

1105

self.checker = None

1106

if os.WIFEXITED(condition):

1107

exitstatus = os.WEXITSTATUS(condition)

1820

1108

# Emit D-Bus signal

1821

1109

self.CheckerCompleted(dbus.Int16(exitstatus),

1822

# This is specific to GNU libC

1823

dbus.Int64(exitstatus << 8),

1110

dbus.Int64(condition),

1824

1111

dbus.String(command))

1825

1112

else:

1826

1113

# Emit D-Bus signal

1827

1114

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

1828

dbus.Int64(

1829

# This is specific to GNU libC

1830

(exitstatus << 8)

1831

| self.last_checker_signal),

1115

dbus.Int64(condition),

1832

1116

dbus.String(command))

1833

return ret

1117

1118

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

1119

*args, **kwargs)

1834

1120

1835

1121

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

1836

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

1122

old_checker = self.checker

1123

if self.checker is not None:

1124

old_checker_pid = self.checker.pid

1125

else:

1126

old_checker_pid = None

1837

1127

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

1838

1128

# Only if new checker process was started

1839

1129

if (self.checker is not None

1843

1133

return r

1844

1134

1845

1135

def _reset_approved(self):

1846

self.approved = None

1136

self._approved = None

1847

1137

return False

1848

1138

1849

1139

def approve(self, value=True):

1850

self.approved = value

1851

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

1852

* 1000), self._reset_approved)

1853

1140

self.send_changedstate()

1141

self._approved = value

1142

gobject.timeout_add(_timedelta_to_milliseconds

1143

(self.approval_duration),

1144

self._reset_approved)

1145

1854

1146

1855

1147

## D-Bus methods, signals & properties

1856

1857

## Interfaces

1148

_interface = "se.recompile.Mandos.Client"

1858

1149

1859

1150

## Signals

1860

1151

1871

1162

pass

1872

1163

1873

1164

# PropertyChanged - signal

1874

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

1875

1165

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

1876

1166

def PropertyChanged(self, property, value):

1877

1167

"D-Bus signal"

1898

1188

"D-Bus signal"

1899

1189

return self.need_approval()

1900

1190

1191

# NeRwequest - signal

1192

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

1193

def NewRequest(self, ip):

1194

"""D-Bus signal

1195

Is sent after a client request a password.

1196

"""

1197

pass

1198

1901

1199

## Methods

1902

1200

1903

1201

# Approve - method

1911

1209

self.checked_ok()

1912

1210

1913

1211

# Enable - method

1914

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

1915

1212

@dbus.service.method(_interface)

1916

1213

def Enable(self):

1917

1214

"D-Bus method"

1918

1215

self.enable()

1919

1216

1920

1217

# StartChecker - method

1921

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

1922

1218

@dbus.service.method(_interface)

1923

1219

def StartChecker(self):

1924

1220

"D-Bus method"

1925

1221

self.start_checker()

1926

1222

1927

1223

# Disable - method

1928

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

1929

1224

@dbus.service.method(_interface)

1930

1225

def Disable(self):

1931

1226

"D-Bus method"

1932

1227

self.disable()

1933

1228

1934

1229

# StopChecker - method

1935

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

1936

1230

@dbus.service.method(_interface)

1937

1231

def StopChecker(self):

1938

1232

self.stop_checker()

1945

1239

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

1946

1240

1947

1241

# ApprovedByDefault - property

1948

@dbus_service_property(_interface,

1949

signature="b",

1242

@dbus_service_property(_interface, signature="b",

1950

1243

access="readwrite")

1951

1244

def ApprovedByDefault_dbus_property(self, value=None):

1952

1245

if value is None: # get

1954

1247

self.approved_by_default = bool(value)

1955

1248

1956

1249

# ApprovalDelay - property

1957

@dbus_service_property(_interface,

1958

signature="t",

1250

@dbus_service_property(_interface, signature="t",

1959

1251

access="readwrite")

1960

1252

def ApprovalDelay_dbus_property(self, value=None):

1961

1253

if value is None: # get

1962

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

1963

* 1000)

1254

return dbus.UInt64(self.approval_delay_milliseconds())

1964

1255

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

1965

1256

1966

1257

# ApprovalDuration - property

1967

@dbus_service_property(_interface,

1968

signature="t",

1258

@dbus_service_property(_interface, signature="t",

1969

1259

access="readwrite")

1970

1260

def ApprovalDuration_dbus_property(self, value=None):

1971

1261

if value is None: # get

1972

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

1973

* 1000)

1262

return dbus.UInt64(_timedelta_to_milliseconds(

1263

self.approval_duration))

1974

1264

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

1975

1265

1976

1266

# Name - property

1977

@dbus_annotations(

1978

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

1979

1267

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

1980

1268

def Name_dbus_property(self):

1981

1269

return dbus.String(self.name)

1982

1270

1983

1271

# Fingerprint - property

1984

@dbus_annotations(

1985

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

1986

1272

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

1987

1273

def Fingerprint_dbus_property(self):

1988

1274

return dbus.String(self.fingerprint)

1989

1275

1990

1276

# Host - property

1991

@dbus_service_property(_interface,

1992

signature="s",

1277

@dbus_service_property(_interface, signature="s",

1993

1278

access="readwrite")

1994

1279

def Host_dbus_property(self, value=None):

1995

1280

if value is None: # get

1996

1281

return dbus.String(self.host)

1997

self.host = str(value)

1282

self.host = value

1998

1283

1999

1284

# Created - property

2000

@dbus_annotations(

2001

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

2002

1285

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

2003

1286

def Created_dbus_property(self):

2004

1287

return datetime_to_dbus(self.created)

2009

1292

return datetime_to_dbus(self.last_enabled)

2010

1293

2011

1294

# Enabled - property

2012

@dbus_service_property(_interface,

2013

signature="b",

1295

@dbus_service_property(_interface, signature="b",

2014

1296

access="readwrite")

2015

1297

def Enabled_dbus_property(self, value=None):

2016

1298

if value is None: # get

2021

1303

self.disable()

2022

1304

2023

1305

# LastCheckedOK - property

2024

@dbus_service_property(_interface,

2025

signature="s",

1306

@dbus_service_property(_interface, signature="s",

2026

1307

access="readwrite")

2027

1308

def LastCheckedOK_dbus_property(self, value=None):

2028

1309

if value is not None:

2030

1311

return

2031

1312

return datetime_to_dbus(self.last_checked_ok)

2032

1313

2033

# LastCheckerStatus - property

2034

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

2035

def LastCheckerStatus_dbus_property(self):

2036

return dbus.Int16(self.last_checker_status)

2037

2038

1314

# Expires - property

2039

1315

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

2040

1316

def Expires_dbus_property(self):

2046

1322

return datetime_to_dbus(self.last_approval_request)

2047

1323

2048

1324

# Timeout - property

2049

@dbus_service_property(_interface,

2050

signature="t",

1325

@dbus_service_property(_interface, signature="t",

2051

1326

access="readwrite")

2052

1327

def Timeout_dbus_property(self, value=None):

2053

1328

if value is None: # get

2054

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

2055

old_timeout = self.timeout

1329

return dbus.UInt64(self.timeout_milliseconds())

2056

1330

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

2057

# Reschedule disabling

2058

if self.enabled:

2059

now = datetime.datetime.utcnow()

2060

self.expires += self.timeout - old_timeout

2061

if self.expires <= now:

2062

# The timeout has passed

2063

self.disable()

2064

else:

2065

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

2066

is None):

2067

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)

1331

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

1332

return

1333

# Reschedule timeout

1334

gobject.source_remove(self.disable_initiator_tag)

1335

self.disable_initiator_tag = None

1336

self.expires = None

1337

time_to_die = _timedelta_to_milliseconds((self

1338

.last_checked_ok

1339

+ self.timeout)

1340

- datetime.datetime

1341

.utcnow())

1342

if time_to_die <= 0:

1343

# The timeout has passed

1344

self.disable()

1345

else:

1346

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

1347

+ datetime.timedelta(milliseconds =

1348

time_to_die))

1349

self.disable_initiator_tag = (gobject.timeout_add

1350

(time_to_die, self.disable))

2072

1351

2073

1352

# ExtendedTimeout - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1353

@dbus_service_property(_interface, signature="t",

2076

1354

access="readwrite")

2077

1355

def ExtendedTimeout_dbus_property(self, value=None):

2078

1356

if value is None: # get

2079

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

2080

* 1000)

1357

return dbus.UInt64(self.extended_timeout_milliseconds())

2081

1358

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

2082

1359

2083

1360

# Interval - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1361

@dbus_service_property(_interface, signature="t",

2086

1362

access="readwrite")

2087

1363

def Interval_dbus_property(self, value=None):

2088

1364

if value is None: # get

2089

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

1365

return dbus.UInt64(self.interval_milliseconds())

2090

1366

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

2091

1367

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

2092

1368

return

2093

1369

if self.enabled:

2094

1370

# 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

1371

gobject.source_remove(self.checker_initiator_tag)

1372

self.checker_initiator_tag = (gobject.timeout_add

1373

(value, self.start_checker))

1374

self.start_checker() # Start one now, too

2099

1375

2100

1376

# Checker - property

2101

@dbus_service_property(_interface,

2102

signature="s",

1377

@dbus_service_property(_interface, signature="s",

2103

1378

access="readwrite")

2104

1379

def Checker_dbus_property(self, value=None):

2105

1380

if value is None: # get

2106

1381

return dbus.String(self.checker_command)

2107

self.checker_command = str(value)

1382

self.checker_command = value

2108

1383

2109

1384

# CheckerRunning - property

2110

@dbus_service_property(_interface,

2111

signature="b",

1385

@dbus_service_property(_interface, signature="b",

2112

1386

access="readwrite")

2113

1387

def CheckerRunning_dbus_property(self, value=None):

2114

1388

if value is None: # get

2119

1393

self.stop_checker()

2120

1394

2121

1395

# ObjectPath - property

2122

@dbus_annotations(

2123

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

2124

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

2125

1396

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

2126

1397

def ObjectPath_dbus_property(self):

2127

1398

return self.dbus_object_path # is already a dbus.ObjectPath

2128

1399

2129

1400

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

1401

@dbus_service_property(_interface, signature="ay",

1402

access="write", byte_arrays=True)

2137

1403

def Secret_dbus_property(self, value):

2138

self.secret = bytes(value)

1404

self.secret = str(value)

2139

1405

2140

1406

del _interface

2141

1407

2145

1411

self._pipe = child_pipe

2146

1412

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

2147

1413

if not self._pipe.recv():

2148

raise KeyError(fpr)

1414

raise KeyError()

2149

1415

2150

1416

def __getattribute__(self, name):

2151

if name == '_pipe':

1417

if(name == '_pipe'):

2152

1418

return super(ProxyClient, self).__getattribute__(name)

2153

1419

self._pipe.send(('getattr', name))

2154

1420

data = self._pipe.recv()

2155

1421

if data[0] == 'data':

2156

1422

return data[1]

2157

1423

if data[0] == 'function':

2158

2159

1424

def func(*args, **kwargs):

2160

1425

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

2161

1426

return self._pipe.recv()[1]

2162

2163

1427

return func

2164

1428

2165

1429

def __setattr__(self, name, value):

2166

if name == '_pipe':

1430

if(name == '_pipe'):

2167

1431

return super(ProxyClient, self).__setattr__(name, value)

2168

1432

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

2169

1433

2170

1434

1435

class ClientDBusTransitional(ClientDBus):

1436

__metaclass__ = AlternateDBusNamesMetaclass

1437

1438

2171

1439

class ClientHandler(socketserver.BaseRequestHandler, object):

2172

1440

"""A class to handle client connections.

2173

1441

2177

1445

def handle(self):

2178

1446

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

2179

1447

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

2180

str(self.client_address))

1448

unicode(self.client_address))

2181

1449

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

2182

1450

self.server.child_pipe.fileno())

2183

1451

2184

session = gnutls.ClientSession(self.request)

1452

session = (gnutls.connection

1453

.ClientSession(self.request,

1454

gnutls.connection

1455

.X509Credentials()))

1456

1457

# Note: gnutls.connection.X509Credentials is really a

1458

# generic GnuTLS certificate credentials object so long as

1459

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

1460

# here despite using OpenPGP certificates.

2185

1461

2186

1462

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

2187

1463

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

2191

1467

priority = self.server.gnutls_priority

2192

1468

if priority is None:

2193

1469

priority = "NORMAL"

2194

gnutls.priority_set_direct(session._c_object,

2195

priority.encode("utf-8"),

2196

None)

1470

(gnutls.library.functions

1471

.gnutls_priority_set_direct(session._c_object,

1472

priority, None))

2197

1473

2198

1474

# Start communication using the Mandos protocol

2199

1475

# Get protocol number

2201

1477

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

2202

1478

try:

2203

1479

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

2204

raise RuntimeError(line)

1480

raise RuntimeError

2205

1481

except (ValueError, IndexError, RuntimeError) as error:

2206

1482

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

2207

1483

return

2209

1485

# Start GnuTLS connection

2210

1486

try:

2211

1487

session.handshake()

2212

except gnutls.Error as error:

1488

except gnutls.errors.GNUTLSError as error:

2213

1489

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

2214

1490

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

2215

1491

# established. Just abandon the request.

2219

1495

approval_required = False

2220

1496

try:

2221

1497

try:

2222

fpr = self.fingerprint(

2223

self.peer_certificate(session))

2224

except (TypeError, gnutls.Error) as error:

1498

fpr = self.fingerprint(self.peer_certificate

1499

(session))

1500

except (TypeError,

1501

gnutls.errors.GNUTLSError) as error:

2225

1502

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

2226

1503

return

2227

1504

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

1505

if self.server.use_dbus:

1506

# Emit D-Bus signal

1507

client.NewRequest(str(self.client_address))

2228

1508

2229

1509

try:

2230

1510

client = ProxyClient(child_pipe, fpr,

2240

1520

while True:

2241

1521

if not client.enabled:

2242

1522

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

2243

client.name)

1523

client.name)

2244

1524

if self.server.use_dbus:

2245

1525

# Emit D-Bus signal

2246

1526

client.Rejected("Disabled")

2247

1527

return

2248

1528

2249

if client.approved or not client.approval_delay:

1529

if client._approved or not client.approval_delay:

2250

1530

#We are approved or approval is disabled

2251

1531

break

2252

elif client.approved is None:

1532

elif client._approved is None:

2253

1533

logger.info("Client %s needs approval",

2254

1534

client.name)

2255

1535

if self.server.use_dbus:

2256

1536

# Emit D-Bus signal

2257

1537

client.NeedApproval(

2258

client.approval_delay.total_seconds()

2259

* 1000, client.approved_by_default)

1538

client.approval_delay_milliseconds(),

1539

client.approved_by_default)

2260

1540

else:

2261

1541

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

2262

1542

client.name)

2268

1548

#wait until timeout or approved

2269

1549

time = datetime.datetime.now()

2270

1550

client.changedstate.acquire()

2271

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

1551

(client.changedstate.wait

1552

(float(client._timedelta_to_milliseconds(delay)

1553

/ 1000)))

2272

1554

client.changedstate.release()

2273

1555

time2 = datetime.datetime.now()

2274

1556

if (time2 - time) >= delay:

2285

1567

else:

2286

1568

delay -= time2 - time

2287

1569

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

1570

sent_size = 0

1571

while sent_size < len(client.secret):

1572

try:

1573

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

1574

except gnutls.errors.GNUTLSError as error:

1575

logger.warning("gnutls send failed")

1576

return

1577

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

1578

sent, len(client.secret)

1579

- (sent_size + sent))

1580

sent_size += sent

2294

1581

2295

1582

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

2296

1583

# bump the timeout using extended_timeout

2297

client.bump_timeout(client.extended_timeout)

1584

client.checked_ok(client.extended_timeout)

2298

1585

if self.server.use_dbus:

2299

1586

# Emit D-Bus signal

2300

1587

client.GotSecret()

2304

1591

client.approvals_pending -= 1

2305

1592

try:

2306

1593

session.bye()

2307

except gnutls.Error as error:

2308

logger.warning("GnuTLS bye failed",

2309

exc_info=error)

1594

except gnutls.errors.GNUTLSError as error:

1595

logger.warning("GnuTLS bye failed")

2310

1596

2311

1597

@staticmethod

2312

1598

def peer_certificate(session):

2313

1599

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

2314

1600

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

1601

if (gnutls.library.functions

1602

.gnutls_certificate_type_get(session._c_object)

1603

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1604

# ...do the normal thing

1605

return session.peer_certificate

2319

1606

list_size = ctypes.c_uint(1)

2320

cert_list = (gnutls.certificate_get_peers

1607

cert_list = (gnutls.library.functions

1608

.gnutls_certificate_get_peers

2321

1609

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

2322

1610

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

2323

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

1611

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

1612

" certificate")

2324

1613

if list_size.value == 0:

2325

1614

return None

2326

1615

cert = cert_list[0]

2330

1619

def fingerprint(openpgp):

2331

1620

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2332

1621

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

1622

datum = (gnutls.library.types

1623

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

1624

ctypes.POINTER

1625

(ctypes.c_ubyte)),

1626

ctypes.c_uint(len(openpgp))))

2337

1627

# New empty GnuTLS certificate

2338

crt = gnutls.openpgp_crt_t()

2339

gnutls.openpgp_crt_init(ctypes.byref(crt))

1628

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1629

(gnutls.library.functions

1630

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2340

1631

# Import the OpenPGP public key into the certificate

2341

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

2342

gnutls.OPENPGP_FMT_RAW)

1632

(gnutls.library.functions

1633

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

1634

gnutls.library.constants

1635

.GNUTLS_OPENPGP_FMT_RAW))

2343

1636

# Verify the self signature in the key

2344

1637

crtverify = ctypes.c_uint()

2345

gnutls.openpgp_crt_verify_self(crt, 0,

2346

ctypes.byref(crtverify))

1638

(gnutls.library.functions

1639

.gnutls_openpgp_crt_verify_self(crt, 0,

1640

ctypes.byref(crtverify)))

2347

1641

if crtverify.value != 0:

2348

gnutls.openpgp_crt_deinit(crt)

2349

raise gnutls.CertificateSecurityError("Verify failed")

1642

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1643

raise (gnutls.errors.CertificateSecurityError

1644

("Verify failed"))

2350

1645

# New buffer for the fingerprint

2351

1646

buf = ctypes.create_string_buffer(20)

2352

1647

buf_len = ctypes.c_size_t()

2353

1648

# Get the fingerprint from the certificate into the buffer

2354

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

2355

ctypes.byref(buf_len))

1649

(gnutls.library.functions

1650

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

1651

ctypes.byref(buf_len)))

2356

1652

# Deinit the certificate

2357

gnutls.openpgp_crt_deinit(crt)

1653

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2358

1654

# Convert the buffer to a Python bytestring

2359

1655

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

2360

1656

# Convert the bytestring to hexadecimal notation

2364

1660

2365

1661

class MultiprocessingMixIn(object):

2366

1662

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

2367

2368

1663

def sub_process_main(self, request, address):

2369

1664

try:

2370

1665

self.finish_request(request, address)

2371

except Exception:

1666

except:

2372

1667

self.handle_error(request, address)

2373

1668

self.close_request(request)

2374

1669

2375

1670

def process_request(self, request, address):

2376

1671

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

2377

1672

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

2378

args = (request, address))

1673

args = (request,

1674

address))

2379

1675

proc.start()

2380

1676

return proc

2381

1677

2382

1678

2383

1679

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2384

1680

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

2385

2386

1681

def process_request(self, request, client_address):

2387

1682

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

2388

1683

2397

1692

2398

1693

def add_pipe(self, parent_pipe, proc):

2399

1694

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

2400

raise NotImplementedError()

1695

raise NotImplementedError

2401

1696

2402

1697

2403

1698

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2409

1704

interface: None or a network interface name (string)

2410

1705

use_ipv6: Boolean; to use IPv6 or not

2411

1706

"""

2412

2413

1707

def __init__(self, server_address, RequestHandlerClass,

2414

interface=None,

2415

use_ipv6=True,

2416

socketfd=None):

2417

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

2418

creating a new one with socket.socket().

2419

"""

1708

interface=None, use_ipv6=True):

2420

1709

self.interface = interface

2421

1710

if use_ipv6:

2422

1711

self.address_family = socket.AF_INET6

2423

if socketfd is not None:

2424

# Save the file descriptor

2425

self.socketfd = socketfd

2426

# Save the original socket.socket() function

2427

self.socket_socket = socket.socket

2428

# To implement --socket, we monkey patch socket.socket.

2429

#

2430

# (When socketserver.TCPServer is a new-style class, we

2431

# could make self.socket into a property instead of monkey

2432

# patching socket.socket.)

2433

#

2434

# Create a one-time-only replacement for socket.socket()

2435

@functools.wraps(socket.socket)

2436

def socket_wrapper(*args, **kwargs):

2437

# Restore original function so subsequent calls are

2438

# not affected.

2439

socket.socket = self.socket_socket

2440

del self.socket_socket

2441

# This time only, return a new socket object from the

2442

# saved file descriptor.

2443

return socket.fromfd(self.socketfd, *args, **kwargs)

2444

# Replace socket.socket() function with wrapper

2445

socket.socket = socket_wrapper

2446

# The socketserver.TCPServer.__init__ will call

2447

# socket.socket(), which might be our replacement,

2448

# socket_wrapper(), if socketfd was set.

2449

1712

socketserver.TCPServer.__init__(self, server_address,

2450

1713

RequestHandlerClass)

2451

2452

1714

def server_bind(self):

2453

1715

"""This overrides the normal server_bind() function

2454

1716

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

2455

1717

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

2456

global SO_BINDTODEVICE

2457

1718

if self.interface is not None:

2458

1719

if SO_BINDTODEVICE is None:

2459

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

2460

# common enough.

2461

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

2462

SO_BINDTODEVICE = 25

2463

try:

2464

self.socket.setsockopt(

2465

socket.SOL_SOCKET, SO_BINDTODEVICE,

2466

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

2467

except socket.error as error:

2468

if error.errno == errno.EPERM:

2469

logger.error("No permission to bind to"

2470

" interface %s", self.interface)

2471

elif error.errno == errno.ENOPROTOOPT:

2472

logger.error("SO_BINDTODEVICE not available;"

2473

" cannot bind to interface %s",

2474

self.interface)

2475

elif error.errno == errno.ENODEV:

2476

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

2477

" cannot bind", self.interface)

2478

else:

2479

raise

1720

logger.error("SO_BINDTODEVICE does not exist;"

1721

" cannot bind to interface %s",

1722

self.interface)

1723

else:

1724

try:

1725

self.socket.setsockopt(socket.SOL_SOCKET,

1726

SO_BINDTODEVICE,

1727

str(self.interface

1728

+ '\0'))

1729

except socket.error as error:

1730

if error[0] == errno.EPERM:

1731

logger.error("No permission to"

1732

" bind to interface %s",

1733

self.interface)

1734

elif error[0] == errno.ENOPROTOOPT:

1735

logger.error("SO_BINDTODEVICE not available;"

1736

" cannot bind to interface %s",

1737

self.interface)

1738

else:

1739

raise

2480

1740

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

2481

1741

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

2482

1742

if not self.server_address[0]:

2483

1743

if self.address_family == socket.AF_INET6:

2484

1744

any_address = "::" # in6addr_any

2485

1745

else:

2486

any_address = "0.0.0.0" # INADDR_ANY

1746

any_address = socket.INADDR_ANY

2487

1747

self.server_address = (any_address,

2488

1748

self.server_address[1])

2489

1749

elif not self.server_address[1]:

2490

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

1750

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

1751

0)

2491

1752

# if self.interface:

2492

1753

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

2493

1754

# 0, # port

2505

1766

gnutls_priority GnuTLS priority string

2506

1767

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

2507

1768

2508

Assumes a GLib.MainLoop event loop.

1769

Assumes a gobject.MainLoop event loop.

2509

1770

"""

2510

2511

1771

def __init__(self, server_address, RequestHandlerClass,

2512

interface=None,

2513

use_ipv6=True,

2514

clients=None,

2515

gnutls_priority=None,

2516

use_dbus=True,

2517

socketfd=None):

1772

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

1773

gnutls_priority=None, use_dbus=True):

2518

1774

self.enabled = False

2519

1775

self.clients = clients

2520

1776

if self.clients is None:

2524

1780

IPv6_TCPServer.__init__(self, server_address,

2525

1781

RequestHandlerClass,

2526

1782

interface = interface,

2527

use_ipv6 = use_ipv6,

2528

socketfd = socketfd)

2529

1783

use_ipv6 = use_ipv6)

2530

1784

def server_activate(self):

2531

1785

if self.enabled:

2532

1786

return socketserver.TCPServer.server_activate(self)

2536

1790

2537

1791

def add_pipe(self, parent_pipe, proc):

2538

1792

# Call "handle_ipc" for both data and EOF events

2539

GLib.io_add_watch(

2540

parent_pipe.fileno(),

2541

GLib.IO_IN | GLib.IO_HUP,

2542

functools.partial(self.handle_ipc,

2543

parent_pipe = parent_pipe,

2544

proc = proc))

1793

gobject.io_add_watch(parent_pipe.fileno(),

1794

gobject.IO_IN | gobject.IO_HUP,

1795

functools.partial(self.handle_ipc,

1796

parent_pipe =

1797

parent_pipe,

1798

proc = proc))

2545

1799

2546

def handle_ipc(self, source, condition,

2547

parent_pipe=None,

2548

proc = None,

2549

client_object=None):

1800

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

1801

proc = None, client_object=None):

1802

condition_names = {

1803

gobject.IO_IN: "IN", # There is data to read.

1804

gobject.IO_OUT: "OUT", # Data can be written (without

1805

# blocking).

1806

gobject.IO_PRI: "PRI", # There is urgent data to read.

1807

gobject.IO_ERR: "ERR", # Error condition.

1808

gobject.IO_HUP: "HUP" # Hung up (the connection has been

1809

# broken, usually for pipes and

1810

# sockets).

1811

}

1812

conditions_string = ' | '.join(name

1813

for cond, name in

1814

condition_names.iteritems()

1815

if cond & condition)

2550

1816

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

2551

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

1817

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

2552

1818

# Wait for other process to exit

2553

1819

proc.join()

2554

1820

return False

2561

1827

fpr = request[1]

2562

1828

address = request[2]

2563

1829

2564

for c in self.clients.values():

1830

for c in self.clients.itervalues():

2565

1831

if c.fingerprint == fpr:

2566

1832

client = c

2567

1833

break

2575

1841

parent_pipe.send(False)

2576

1842

return False

2577

1843

2578

GLib.io_add_watch(

2579

parent_pipe.fileno(),

2580

GLib.IO_IN | GLib.IO_HUP,

2581

functools.partial(self.handle_ipc,

2582

parent_pipe = parent_pipe,

2583

proc = proc,

2584

client_object = client))

1844

gobject.io_add_watch(parent_pipe.fileno(),

1845

gobject.IO_IN | gobject.IO_HUP,

1846

functools.partial(self.handle_ipc,

1847

parent_pipe =

1848

parent_pipe,

1849

proc = proc,

1850

client_object =

1851

client))

2585

1852

parent_pipe.send(True)

2586

1853

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

2587

1854

# same fileno

2593

1860

2594

1861

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

2595

1862

funcname)(*args,

2596

**kwargs)))

1863

**kwargs)))

2597

1864

2598

1865

if command == 'getattr':

2599

1866

attrname = request[1]

2600

if isinstance(client_object.__getattribute__(attrname),

2601

collections.Callable):

2602

parent_pipe.send(('function', ))

1867

if callable(client_object.__getattribute__(attrname)):

1868

parent_pipe.send(('function',))

2603

1869

else:

2604

parent_pipe.send((

2605

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

1870

parent_pipe.send(('data', client_object

1871

.__getattribute__(attrname)))

2606

1872

2607

1873

if command == 'setattr':

2608

1874

attrname = request[1]

2612

1878

return True

2613

1879

2614

1880

2615

def rfc3339_duration_to_delta(duration):

2616

"""Parse an RFC 3339 "duration" and return a datetime.timedelta

2617

2618

>>> rfc3339_duration_to_delta("P7D")

2619

datetime.timedelta(7)

2620

>>> rfc3339_duration_to_delta("PT60S")

2621

datetime.timedelta(0, 60)

2622

>>> rfc3339_duration_to_delta("PT60M")

2623

datetime.timedelta(0, 3600)

2624

>>> rfc3339_duration_to_delta("PT24H")

2625

datetime.timedelta(1)

2626

>>> rfc3339_duration_to_delta("P1W")

2627

datetime.timedelta(7)

2628

>>> rfc3339_duration_to_delta("PT5M30S")

2629

datetime.timedelta(0, 330)

2630

>>> rfc3339_duration_to_delta("P1DT3M20S")

2631

datetime.timedelta(1, 200)

2632

"""

2633

2634

# Parsing an RFC 3339 duration with regular expressions is not

2635

# possible - there would have to be multiple places for the same

2636

# values, like seconds. The current code, while more esoteric, is

2637

# cleaner without depending on a parsing library. If Python had a

2638

# built-in library for parsing we would use it, but we'd like to

2639

# avoid excessive use of external libraries.

2640

2641

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

2642

Token = collections.namedtuple("Token", (

2643

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

2644

# a "group" containing digits

2645

"value", # datetime.timedelta or None

2646

"followers")) # Tokens valid after this token

2647

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

2648

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

2649

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

2650

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

2651

datetime.timedelta(seconds=1),

2652

frozenset((token_end, )))

2653

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

2654

datetime.timedelta(minutes=1),

2655

frozenset((token_second, token_end)))

2656

token_hour = Token(re.compile(r"(\d+)H"),

2657

datetime.timedelta(hours=1),

2658

frozenset((token_minute, token_end)))

2659

token_time = Token(re.compile(r"T"),

2660

None,

2661

frozenset((token_hour, token_minute,

2662

token_second)))

2663

token_day = Token(re.compile(r"(\d+)D"),

2664

datetime.timedelta(days=1),

2665

frozenset((token_time, token_end)))

2666

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

2667

datetime.timedelta(weeks=4),

2668

frozenset((token_day, token_end)))

2669

token_year = Token(re.compile(r"(\d+)Y"),

2670

datetime.timedelta(weeks=52),

2671

frozenset((token_month, token_end)))

2672

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

2673

datetime.timedelta(weeks=1),

2674

frozenset((token_end, )))

2675

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

2676

frozenset((token_year, token_month,

2677

token_day, token_time,

2678

token_week)))

2679

# Define starting values

2680

value = datetime.timedelta() # Value so far

2681

found_token = None

2682

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

2683

s = duration # String left to parse

2684

# Loop until end token is found

2685

while found_token is not token_end:

2686

# Search for any currently valid tokens

2687

for token in followers:

2688

match = token.regexp.match(s)

2689

if match is not None:

2690

# Token found

2691

if token.value is not None:

2692

# Value found, parse digits

2693

factor = int(match.group(1), 10)

2694

# Add to value so far

2695

value += factor * token.value

2696

# Strip token from string

2697

s = token.regexp.sub("", s, 1)

2698

# Go to found token

2699

found_token = token

2700

# Set valid next tokens

2701

followers = found_token.followers

2702

break

2703

else:

2704

# No currently valid tokens were found

2705

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

2706

.format(duration))

2707

# End token found

2708

return value

2709

2710

2711

1881

def string_to_delta(interval):

2712

1882

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

2713

1883

2724

1894

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

2725

1895

datetime.timedelta(0, 330)

2726

1896

"""

2727

2728

try:

2729

return rfc3339_duration_to_delta(interval)

2730

except ValueError:

2731

pass

2732

2733

1897

timevalue = datetime.timedelta(0)

2734

1898

for s in interval.split():

2735

1899

try:

2736

suffix = s[-1]

1900

suffix = unicode(s[-1])

2737

1901

value = int(s[:-1])

2738

1902

if suffix == "d":

2739

1903

delta = datetime.timedelta(value)

2746

1910

elif suffix == "w":

2747

1911

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

2748

1912

else:

2749

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

2750

except IndexError as e:

1913

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

1914

except (ValueError, IndexError) as e:

2751

1915

raise ValueError(*(e.args))

2752

1916

timevalue += delta

2753

1917

return timevalue

2766

1930

sys.exit()

2767

1931

if not noclose:

2768

1932

# Close all standard open file descriptors

2769

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

1933

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

2770

1934

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

2771

1935

raise OSError(errno.ENODEV,

2772

"{} not a character device"

2773

.format(os.devnull))

1936

"%s not a character device"

1937

% os.path.devnull)

2774

1938

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

2775

1939

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

2776

1940

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

2785

1949

2786

1950

parser = argparse.ArgumentParser()

2787

1951

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

2788

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

1952

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

2789

1953

help="show version number and exit")

2790

1954

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

2791

1955

help="Bind to interface IF")

2797

1961

help="Run self-test")

2798

1962

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

2799

1963

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

2800

" to terminal", default=None)

1964

" to terminal")

2801

1965

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

2802

1966

help="Debug level for stdout output")

2803

1967

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

2810

1974

" files")

2811

1975

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

2812

1976

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

2813

" system bus interface", default=None)

1977

" system bus interface")

2814

1978

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

2815

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

2816

default=None)

1979

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

2817

1980

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

2818

1981

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

2819

" state", default=None)

2820

parser.add_argument("--socket", type=int,

2821

help="Specify a file descriptor to a network"

2822

" socket to use instead of creating one")

1982

" state")

2823

1983

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

2824

1984

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

2825

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

2826

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

2827

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

2828

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

2829

default=None)

2830

1985

2831

1986

options = parser.parse_args()

2832

1987

2833

1988

if options.check:

2834

1989

import doctest

2835

fail_count, test_count = doctest.testmod()

2836

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

1990

doctest.testmod()

1991

sys.exit()

2837

1992

2838

1993

# Default values for config file for server-global settings

2839

1994

server_defaults = { "interface": "",

2841

1996

"port": "",

2842

1997

"debug": "False",

2843

1998

"priority":

2844

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

2845

":+SIGN-DSA-SHA256",

1999

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

2846

2000

"servicename": "Mandos",

2847

2001

"use_dbus": "True",

2848

2002

"use_ipv6": "True",

2849

2003

"debuglevel": "",

2850

2004

"restore": "True",

2851

"socket": "",

2852

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

2853

"foreground": "False",

2854

"zeroconf": "True",

2855

}

2005

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

2006

}

2856

2007

2857

2008

# Parse config file for server-global settings

2858

2009

server_config = configparser.SafeConfigParser(server_defaults)

2859

2010

del server_defaults

2860

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

2011

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

2012

"mandos.conf"))

2861

2013

# Convert the SafeConfigParser object to a dict

2862

2014

server_settings = server_config.defaults()

2863

2015

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

2864

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

2016

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

2865

2017

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

2866

2018

option)

2867

2019

if server_settings["port"]:

2868

2020

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

2869

2021

"port")

2870

if server_settings["socket"]:

2871

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

2872

"socket")

2873

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

2874

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

2875

# happen with a supplied network socket.

2876

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

2877

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

2878

["socket"])

2879

2022

del server_config

2880

2023

2881

2024

# Override the settings from the config file with command line

2882

2025

# options, if set.

2883

2026

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

2884

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

2885

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

2886

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

2027

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

2028

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

2029

"statedir"):

2887

2030

value = getattr(options, option)

2888

2031

if value is not None:

2889

2032

server_settings[option] = value

2890

2033

del options

2891

2034

# Force all strings to be unicode

2892

2035

for option in server_settings.keys():

2893

if isinstance(server_settings[option], bytes):

2894

server_settings[option] = (server_settings[option]

2895

.decode("utf-8"))

2896

# Force all boolean options to be boolean

2897

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

2898

"foreground", "zeroconf"):

2899

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

2900

# Debug implies foreground

2901

if server_settings["debug"]:

2902

server_settings["foreground"] = True

2036

if type(server_settings[option]) is str:

2037

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

2903

2038

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

2904

2039

2905

2040

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

2906

2041

2907

if (not server_settings["zeroconf"]

2908

and not (server_settings["port"]

2909

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

2910

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

2911

2912

2042

# For convenience

2913

2043

debug = server_settings["debug"]

2914

2044

debuglevel = server_settings["debuglevel"]

2916

2046

use_ipv6 = server_settings["use_ipv6"]

2917

2047

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

2918

2048

stored_state_file)

2919

foreground = server_settings["foreground"]

2920

zeroconf = server_settings["zeroconf"]

2921

2049

2922

2050

if debug:

2923

initlogger(debug, logging.DEBUG)

2051

initlogger(logging.DEBUG)

2924

2052

else:

2925

2053

if not debuglevel:

2926

initlogger(debug)

2054

initlogger()

2927

2055

else:

2928

2056

level = getattr(logging, debuglevel.upper())

2929

initlogger(debug, level)

2057

initlogger(level)

2930

2058

2931

2059

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

2932

syslogger.setFormatter(

2933

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

2934

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

2935

server_settings["servicename"])))

2060

syslogger.setFormatter(logging.Formatter

2061

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

2062

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

2063

% server_settings["servicename"]))

2936

2064

2937

2065

# Parse config file with clients

2938

client_config = configparser.SafeConfigParser(Client

2939

.client_defaults)

2066

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

2067

"extended_timeout": "15m",

2068

"interval": "2m",

2069

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

2070

"host": "",

2071

"approval_delay": "0s",

2072

"approval_duration": "1s",

2073

}

2074

client_config = configparser.SafeConfigParser(client_defaults)

2940

2075

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

2941

2076

"clients.conf"))

2942

2077

2943

2078

global mandos_dbus_service

2944

2079

mandos_dbus_service = None

2945

2080

2946

socketfd = None

2947

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

2948

socketfd = server_settings["socket"]

2949

tcp_server = MandosServer(

2950

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

2951

ClientHandler,

2952

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

2953

use_ipv6=use_ipv6,

2954

gnutls_priority=server_settings["priority"],

2955

use_dbus=use_dbus,

2956

socketfd=socketfd)

2957

if not foreground:

2958

pidfilename = "/run/mandos.pid"

2959

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

2960

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

2961

pidfile = None

2081

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

2082

server_settings["port"]),

2083

ClientHandler,

2084

interface=(server_settings["interface"]

2085

or None),

2086

use_ipv6=use_ipv6,

2087

gnutls_priority=

2088

server_settings["priority"],

2089

use_dbus=use_dbus)

2090

if not debug:

2091

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

2962

2092

try:

2963

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

2964

except IOError as e:

2965

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

2966

exc_info=e)

2093

pidfile = open(pidfilename, "w")

2094

except IOError:

2095

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

2967

2096

2968

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

2969

("mandos", "mandos"),

2970

("nobody", "nogroup")):

2097

try:

2098

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

2099

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

2100

except KeyError:

2971

2101

try:

2972

uid = pwd.getpwnam(name).pw_uid

2973

gid = pwd.getpwnam(group).pw_gid

2974

break

2102

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

2103

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

2975

2104

except KeyError:

2976

continue

2977

else:

2978

uid = 65534

2979

gid = 65534

2105

try:

2106

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

2107

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

2108

except KeyError:

2109

uid = 65534

2110

gid = 65534

2980

2111

try:

2981

2112

os.setgid(gid)

2982

2113

os.setuid(uid)

2983

if debug:

2984

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

2985

gid))

2986

2114

except OSError as error:

2987

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

2988

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

2989

if error.errno != errno.EPERM:

2990

raise

2115

if error[0] != errno.EPERM:

2116

raise error

2991

2117

2992

2118

if debug:

2993

2119

# Enable all possible GnuTLS debugging

2994

2120

2995

2121

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

2996

2122

# - GnuTLS manual

2997

gnutls.global_set_log_level(11)

2123

gnutls.library.functions.gnutls_global_set_log_level(11)

2998

2124

2999

@gnutls.log_func

2125

@gnutls.library.types.gnutls_log_func

3000

2126

def debug_gnutls(level, string):

3001

2127

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

3002

2128

3003

gnutls.global_set_log_function(debug_gnutls)

2129

(gnutls.library.functions

2130

.gnutls_global_set_log_function(debug_gnutls))

3004

2131

3005

2132

# Redirect stdin so all checkers get /dev/null

3006

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

2133

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

3007

2134

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

3008

2135

if null > 2:

3009

2136

os.close(null)

2137

else:

2138

# No console logging

2139

logger.removeHandler(console)

3010

2140

3011

2141

# Need to fork before connecting to D-Bus

3012

if not foreground:

2142

if not debug:

3013

2143

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

3014

2144

daemon()

3015

2145

3016

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

3017

# to inform GLib that threads will be used.

3018

GLib.threads_init()

3019

3020

2146

global main_loop

3021

2147

# From the Avahi example code

3022

DBusGMainLoop(set_as_default=True)

3023

main_loop = GLib.MainLoop()

2148

DBusGMainLoop(set_as_default=True )

2149

main_loop = gobject.MainLoop()

3024

2150

bus = dbus.SystemBus()

3025

2151

# End of Avahi example code

3026

2152

if use_dbus:

3027

2153

try:

3028

2154

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

3029

bus,

3030

do_not_queue=True)

3031

old_bus_name = dbus.service.BusName(

3032

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

3033

do_not_queue=True)

3034

except dbus.exceptions.DBusException as e:

3035

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

2155

bus, do_not_queue=True)

2156

old_bus_name = (dbus.service.BusName

2157

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

2158

do_not_queue=True))

2159

except dbus.exceptions.NameExistsException as e:

2160

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

3036

2161

use_dbus = False

3037

2162

server_settings["use_dbus"] = False

3038

2163

tcp_server.use_dbus = False

3039

if zeroconf:

3040

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3041

service = AvahiServiceToSyslog(

3042

name = server_settings["servicename"],

3043

servicetype = "_mandos._tcp",

3044

protocol = protocol,

3045

bus = bus)

3046

if server_settings["interface"]:

3047

service.interface = if_nametoindex(

3048

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

2164

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2165

service = AvahiServiceToSyslog(name =

2166

server_settings["servicename"],

2167

servicetype = "_mandos._tcp",

2168

protocol = protocol, bus = bus)

2169

if server_settings["interface"]:

2170

service.interface = (if_nametoindex

2171

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

3049

2172

3050

2173

global multiprocessing_manager

3051

2174

multiprocessing_manager = multiprocessing.Manager()

3052

2175

3053

2176

client_class = Client

3054

2177

if use_dbus:

3055

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

3056

3057

client_settings = Client.config_parser(client_config)

2178

client_class = functools.partial(ClientDBusTransitional,

2179

bus = bus)

2180

2181

special_settings = {

2182

# Some settings need to be accessd by special methods;

2183

# booleans need .getboolean(), etc. Here is a list of them:

2184

"approved_by_default":

2185

lambda section:

2186

client_config.getboolean(section, "approved_by_default"),

2187

"enabled":

2188

lambda section:

2189

client_config.getboolean(section, "enabled"),

2190

}

2191

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

2192

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

2193

# with exceptions for any special settings as defined above

2194

client_settings = dict((clientname,

2195

dict((setting,

2196

(value

2197

if setting not in special_settings

2198

else special_settings[setting]

2199

(clientname)))

2200

for setting, value in

2201

client_config.items(clientname)))

2202

for clientname in client_config.sections())

2203

3058

2204

old_client_settings = {}

3059

clients_data = {}

3060

3061

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

3062

global wnull

3063

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

3064

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

3065

# mode

3066

if debug or not foreground:

3067

wnull.close()

2205

clients_data = []

3068

2206

3069

2207

# Get client data and settings from last running state.

3070

2208

if server_settings["restore"]:

3071

2209

try:

3072

2210

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

3073

if sys.version_info.major == 2:

3074

clients_data, old_client_settings = pickle.load(

3075

stored_state)

3076

else:

3077

bytes_clients_data, bytes_old_client_settings = (

3078

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

3079

### Fix bytes to strings

3080

## clients_data

3081

# .keys()

3082

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

3083

if isinstance(key, bytes)

3084

else key): value

3085

for key, value in

3086

bytes_clients_data.items() }

3087

del bytes_clients_data

3088

for key in clients_data:

3089

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

3090

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

3091

for k, v in

3092

clients_data[key].items() }

3093

clients_data[key] = value

3094

# .client_structure

3095

value["client_structure"] = [

3096

(s.decode("utf-8")

3097

if isinstance(s, bytes)

3098

else s) for s in

3099

value["client_structure"] ]

3100

# .name & .host

3101

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

3102

if isinstance(value[k], bytes):

3103

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

3104

## old_client_settings

3105

# .keys()

3106

old_client_settings = {

3107

(key.decode("utf-8")

3108

if isinstance(key, bytes)

3109

else key): value

3110

for key, value in

3111

bytes_old_client_settings.items() }

3112

del bytes_old_client_settings

3113

# .host

3114

for value in old_client_settings.values():

3115

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

3116

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

3117

.decode("utf-8"))

2211

clients_data, old_client_settings = (pickle.load

2212

(stored_state))

3118

2213

os.remove(stored_state_path)

3119

2214

except IOError as e:

3120

if e.errno == errno.ENOENT:

3121

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

3122

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

3123

else:

3124

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

3125

exc_info=e)

2215

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

2216

.format(e))

2217

if e.errno != errno.ENOENT:

3126

2218

raise

3127

except EOFError as e:

3128

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

3129

"EOFError:",

3130

exc_info=e)

3131

2219

3132

with PGPEngine() as pgp:

3133

for client_name, client in clients_data.items():

3134

# Skip removed clients

3135

if client_name not in client_settings:

3136

continue

2220

with Crypto() as crypt:

2221

for client in clients_data:

2222

client_name = client["name"]

3137

2223

3138

2224

# Decide which value to use after restoring saved state.

3139

2225

# We have three different values: Old config file,

3145

2231

# For each value in new config, check if it

3146

2232

# differs from the old config value (Except for

3147

2233

# the "secret" attribute)

3148

if (name != "secret"

3149

and (value !=

3150

old_client_settings[client_name][name])):

3151

client[name] = value

2234

if (name != "secret" and

2235

value != old_client_settings[client_name]

2236

[name]):

2237

setattr(client, name, value)

3152

2238

except KeyError:

3153

2239

pass

3154

2240

3155

2241

# Clients who has passed its expire date can still be

3156

# enabled if its last checker was successful. A Client

3157

# whose checker succeeded before we stored its state is

3158

# assumed to have successfully run all checkers during

3159

# downtime.

3160

if client["enabled"]:

3161

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

3162

if not client["last_checked_ok"]:

3163

logger.warning(

3164

"disabling client {} - Client never "

3165

"performed a successful checker".format(

3166

client_name))

3167

client["enabled"] = False

3168

elif client["last_checker_status"] != 0:

3169

logger.warning(

3170

"disabling client {} - Client last"

3171

" checker failed with error code"

3172

" {}".format(

3173

client_name,

3174

client["last_checker_status"]))

2242

# enabled if its last checker was sucessful. Clients

2243

# whose checker failed before we stored its state is

2244

# assumed to have failed all checkers during downtime.

2245

if client["enabled"] and client["last_checked_ok"]:

2246

if ((datetime.datetime.utcnow()

2247

- client["last_checked_ok"])

2248

> client["interval"]):

2249

if client["last_checker_status"] != 0:

3175

2250

client["enabled"] = False

3176

2251

else:

3177

client["expires"] = (

3178

datetime.datetime.utcnow()

3179

+ client["timeout"])

3180

logger.debug("Last checker succeeded,"

3181

" keeping {} enabled".format(

3182

client_name))

2252

client["expires"] = (datetime.datetime

2253

.utcnow()

2254

+ client["timeout"])

2255

2256

client["changedstate"] = (multiprocessing_manager

2257

.Condition

2258

(multiprocessing_manager

2259

.Lock()))

2260

if use_dbus:

2261

new_client = (ClientDBusTransitional.__new__

2262

(ClientDBusTransitional))

2263

tcp_server.clients[client_name] = new_client

2264

new_client.bus = bus

2265

for name, value in client.iteritems():

2266

setattr(new_client, name, value)

2267

client_object_name = unicode(client_name).translate(

2268

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

2269

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

2270

new_client.dbus_object_path = (dbus.ObjectPath

2271

("/clients/"

2272

+ client_object_name))

2273

DBusObjectWithProperties.__init__(new_client,

2274

new_client.bus,

2275

new_client

2276

.dbus_object_path)

2277

else:

2278

tcp_server.clients[client_name] = (Client.__new__

2279

(Client))

2280

for name, value in client.iteritems():

2281

setattr(tcp_server.clients[client_name],

2282

name, value)

2283

3183

2284

try:

3184

client["secret"] = pgp.decrypt(

3185

client["encrypted_secret"],

2285

tcp_server.clients[client_name].secret = (

2286

crypt.decrypt(tcp_server.clients[client_name]

2287

.encrypted_secret,

2288

client_settings[client_name]

2289

["secret"]))

2290

except CryptoError:

2291

# If decryption fails, we use secret from new settings

2292

tcp_server.clients[client_name].secret = (

3186

2293

client_settings[client_name]["secret"])

3187

except PGPError:

3188

# If decryption fails, we use secret from new settings

3189

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

3190

client_name))

3191

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

3192

["secret"])

3193

3194

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

3195

for client_name in (set(old_client_settings)

3196

- set(client_settings)):

3197

del clients_data[client_name]

3198

for client_name in (set(client_settings)

3199

- set(old_client_settings)):

3200

clients_data[client_name] = client_settings[client_name]

3201

3202

# Create all client objects

3203

for client_name, client in clients_data.items():

3204

tcp_server.clients[client_name] = client_class(

3205

name = client_name,

3206

settings = client,

3207

server_settings = server_settings)

2294

2295

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

2296

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

2297

del tcp_server.clients[clientname]

2298

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

2299

tcp_server.clients[clientname] = (client_class(name

2300

= clientname,

2301

config =

2302

client_settings

2303

[clientname]))

3208

2304

3209

2305

if not tcp_server.clients:

3210

2306

logger.warning("No clients defined")

3211

3212

if not foreground:

3213

if pidfile is not None:

3214

pid = os.getpid()

3215

try:

3216

with pidfile:

3217

print(pid, file=pidfile)

3218

except IOError:

3219

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

3220

pidfilename, pid)

3221

del pidfile

2307

2308

if not debug:

2309

try:

2310

with pidfile:

2311

pid = os.getpid()

2312

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

2313

del pidfile

2314

except IOError:

2315

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

2316

pidfilename, pid)

2317

except NameError:

2318

# "pidfile" was never created

2319

pass

3222

2320

del pidfilename

2321

2322

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

3223

2323

3224

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

3225

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3226

lambda: main_loop.quit() and False)

2324

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

2325

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

3227

2326

3228

2327

if use_dbus:

3229

3230

@alternate_dbus_interfaces(

3231

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

3232

class MandosDBusService(DBusObjectWithObjectManager):

2328

class MandosDBusService(dbus.service.Object):

3233

2329

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

3234

3235

2330

def __init__(self):

3236

2331

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

3237

3238

2332

_interface = "se.recompile.Mandos"

3239

2333

3240

2334

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

3247

2341

"D-Bus signal"

3248

2342

pass

3249

2343

3250

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

3251

"true"})

3252

2344

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

3253

2345

def ClientRemoved(self, objpath, name):

3254

2346

"D-Bus signal"

3255

2347

pass

3256

2348

3257

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

3258

"true"})

3259

2349

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

3260

2350

def GetAllClients(self):

3261

2351

"D-Bus method"

3262

return dbus.Array(c.dbus_object_path for c in

3263

tcp_server.clients.values())

2352

return dbus.Array(c.dbus_object_path

2353

for c in

2354

tcp_server.clients.itervalues())

3264

2355

3265

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

3266

"true"})

3267

2356

@dbus.service.method(_interface,

3268

2357

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

3269

2358

def GetAllClientsWithProperties(self):

3270

2359

"D-Bus method"

3271

2360

return dbus.Dictionary(

3272

{ c.dbus_object_path: c.GetAll(

3273

"se.recompile.Mandos.Client")

3274

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

2361

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

2362

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

3275

2363

signature="oa{sv}")

3276

2364

3277

2365

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

3278

2366

def RemoveClient(self, object_path):

3279

2367

"D-Bus method"

3280

for c in tcp_server.clients.values():

2368

for c in tcp_server.clients.itervalues():

3281

2369

if c.dbus_object_path == object_path:

3282

2370

del tcp_server.clients[c.name]

3283

2371

c.remove_from_connection()

3284

# Don't signal the disabling

2372

# Don't signal anything except ClientRemoved

3285

2373

c.disable(quiet=True)

3286

# Emit D-Bus signal for removal

3287

self.client_removed_signal(c)

2374

# Emit D-Bus signal

2375

self.ClientRemoved(object_path, c.name)

3288

2376

return

3289

2377

raise KeyError(object_path)

3290

2378

3291

2379

del _interface

3292

3293

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3294

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

3295

def GetManagedObjects(self):

3296

"""D-Bus method"""

3297

return dbus.Dictionary(

3298

{ client.dbus_object_path:

3299

dbus.Dictionary(

3300

{ interface: client.GetAll(interface)

3301

for interface in

3302

client._get_all_interface_names()})

3303

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

3304

3305

def client_added_signal(self, client):

3306

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

3307

if use_dbus:

3308

# New standard signal

3309

self.InterfacesAdded(

3310

client.dbus_object_path,

3311

dbus.Dictionary(

3312

{ interface: client.GetAll(interface)

3313

for interface in

3314

client._get_all_interface_names()}))

3315

# Old signal

3316

self.ClientAdded(client.dbus_object_path)

3317

3318

def client_removed_signal(self, client):

3319

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

3320

if use_dbus:

3321

# New standard signal

3322

self.InterfacesRemoved(

3323

client.dbus_object_path,

3324

client._get_all_interface_names())

3325

# Old signal

3326

self.ClientRemoved(client.dbus_object_path,

3327

client.name)

3328

2380

3329

mandos_dbus_service = MandosDBusService()

2381

class MandosDBusServiceTransitional(MandosDBusService):

2382

__metaclass__ = AlternateDBusNamesMetaclass

2383

mandos_dbus_service = MandosDBusServiceTransitional()

3330

2384

3331

# Save modules to variables to exempt the modules from being

3332

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

3333

mp = multiprocessing

3334

wn = wnull

3335

2385

def cleanup():

3336

2386

"Cleanup function; run on exit"

3337

if zeroconf:

3338

service.cleanup()

2387

service.cleanup()

3339

2388

3340

mp.active_children()

3341

wn.close()

2389

multiprocessing.active_children()

3342

2390

if not (tcp_server.clients or client_settings):

3343

2391

return

3344

2392

3345

2393

# Store client before exiting. Secrets are encrypted with key

3346

2394

# based on what config file has. If config file is

3347

2395

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

3348

clients = {}

3349

with PGPEngine() as pgp:

3350

for client in tcp_server.clients.values():

2396

clients = []

2397

with Crypto() as crypt:

2398

for client in tcp_server.clients.itervalues():

3351

2399

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

3352

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

3353

key)

2400

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

2401

key)

3354

2402

client_dict = {}

3355

2403

3356

# A list of attributes that can not be pickled

3357

# + secret.

3358

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

3359

"checker", "server_settings" }

3360

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

3361

.Object):

2404

# A list of attributes that will not be stored when

2405

# shutting down.

2406

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

2407

for name, typ in (inspect.getmembers

2408

(dbus.service.Object)):

3362

2409

exclude.add(name)

3363

2410

3364

2411

client_dict["encrypted_secret"] = (client

3367

2414

if attr not in exclude:

3368

2415

client_dict[attr] = getattr(client, attr)

3369

2416

3370

clients[client.name] = client_dict

2417

clients.append(client_dict)

3371

2418

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

3372

2419

3373

2420

try:

3374

with tempfile.NamedTemporaryFile(

3375

mode='wb',

3376

suffix=".pickle",

3377

prefix='clients-',

3378

dir=os.path.dirname(stored_state_path),

3379

delete=False) as stored_state:

3380

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

3381

protocol = 2)

3382

tempname = stored_state.name

3383

os.rename(tempname, stored_state_path)

2421

with os.fdopen(os.open(stored_state_path,

2422

os.O_CREAT|os.O_WRONLY|os.O_TRUNC,

2423

0600), "wb") as stored_state:

2424

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

3384

2425

except (IOError, OSError) as e:

3385

if not debug:

3386

try:

3387

os.remove(tempname)

3388

except NameError:

3389

pass

3390

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

3391

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

3392

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

3393

else:

3394

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

3395

exc_info=e)

2426

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

2427

.format(e))

2428

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

3396

2429

raise

3397

2430

3398

2431

# Delete all clients, and settings from config

3400

2433

name, client = tcp_server.clients.popitem()

3401

2434

if use_dbus:

3402

2435

client.remove_from_connection()

3403

# Don't signal the disabling

2436

# Don't signal anything except ClientRemoved

3404

2437

client.disable(quiet=True)

3405

# Emit D-Bus signal for removal

3406

2438

if use_dbus:

3407

mandos_dbus_service.client_removed_signal(client)

2439

# Emit D-Bus signal

2440

mandos_dbus_service.ClientRemoved(client

2441

.dbus_object_path,

2442

client.name)

3408

2443

client_settings.clear()

3409

2444

3410

2445

atexit.register(cleanup)

3411

2446

3412

for client in tcp_server.clients.values():

2447

for client in tcp_server.clients.itervalues():

3413

2448

if use_dbus:

3414

# Emit D-Bus signal for adding

3415

mandos_dbus_service.client_added_signal(client)

2449

# Emit D-Bus signal

2450

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3416

2451

# Need to initiate checking of clients

3417

2452

if client.enabled:

3418

2453

client.init_checker()

3421

2456

tcp_server.server_activate()

3422

2457

3423

2458

# Find out what port we got

3424

if zeroconf:

3425

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

2459

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

3426

2460

if use_ipv6:

3427

2461

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

3428

" flowinfo %d, scope_id %d",

3429

*tcp_server.socket.getsockname())

2462

" flowinfo %d, scope_id %d"

2463

% tcp_server.socket.getsockname())

3430

2464

else: # IPv4

3431

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

3432

*tcp_server.socket.getsockname())

2465

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

2466

% tcp_server.socket.getsockname())

3433

2467

3434

2468

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

3435

2469

3436

2470

try:

3437

if zeroconf:

3438

# From the Avahi example code

3439

try:

3440

service.activate()

3441

except dbus.exceptions.DBusException as error:

3442

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

3443

cleanup()

3444

sys.exit(1)

3445

# End of Avahi example code

2471

# From the Avahi example code

2472

try:

2473

service.activate()

2474

except dbus.exceptions.DBusException as error:

2475

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

2476

cleanup()

2477

sys.exit(1)

2478

# End of Avahi example code

3446

2479

3447

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

3448

lambda *args, **kwargs:

3449

(tcp_server.handle_request

3450

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

2480

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

2481

lambda *args, **kwargs:

2482

(tcp_server.handle_request

2483

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

3451

2484

3452

2485

logger.debug("Starting main loop")

3453

2486

main_loop.run()

3454

2487

except AvahiError as error:

3455

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

2488

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

3456

2489

cleanup()

3457

2490

sys.exit(1)

3458

2491

except KeyboardInterrupt: