/mandos/trunk : revision 1264

1

#!/usr/bin/python2.7

2

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

3

#

1

#!/usr/bin/python3 -bI

2

# -*- coding: utf-8; lexical-binding: t -*-

3

#

4

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

5

#

5

#

6

# This program is partly derived from an example program for an Avahi

7

# service publisher, downloaded from

8

# <http://avahi.org/wiki/PythonPublishExample>. This includes the

9

# methods "add", "remove", "server_state_changed",

10

# "entry_group_state_changed", "cleanup", and "activate" in the

11

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

12

#

12

#

13

# Everything else is

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

# the Free Software Foundation, either version 3 of the License, or

20

22

# (at your option) any later version.

21

23

#

22

# This program is distributed in the hope that it will be useful,

23

# but WITHOUT ANY WARRANTY; without even the implied warranty of

24

# Mandos is distributed in the hope that it will be useful, but

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

# You should have received a copy of the GNU General Public License

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

30

# along with Mandos. If not, see <http://www.gnu.org/licenses/>.

31

#

31

32

# Contact the authors at <mandos@recompile.se>.

32

#

33

#

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

39

import SocketServer as socketserver

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

40

51

import socket

41

import argparse

42

52

import datetime

43

53

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

52

58

import re

53

import os

54

59

import signal

55

60

import subprocess

56

61

import atexit

57

62

import stat

58

import logging

59

63

import logging.handlers

60

64

import pwd

61

65

import contextlib

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import random

81

import shlex

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

76

import avahi

85

import gi

86

from gi.repository import GLib

77

87

from dbus.mainloop.glib import DBusGMainLoop

78

88

import ctypes

79

89

import ctypes.util

80

90

import xml.dom.minidom

81

91

import inspect

82

92

83

try:

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

# Add collections.abc.Callable if it does not exist

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.15"

92

147

stored_state_file = "clients.pickle"

93

148

94

logger = logging.getLogger()

149

log = logging.getLogger(os.path.basename(sys.argv[0]))

150

logging.captureWarnings(True) # Show warnings via the logging system

95

151

syslogger = None

96

152

97

153

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

156

except (OSError, AttributeError):

157

102

158

def if_nametoindex(interface):

103

159

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

104

160

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

105

161

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

106

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

163

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

164

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

111

165

return interface_index

112

166

113

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

114

184

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

115

185

"""init logger and add loglevel"""

116

186

117

187

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

122

191

syslogger.setFormatter(logging.Formatter

123

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

124

' %(message)s'))

125

logger.addHandler(syslogger)

126

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

127

196

if debug:

128

197

console = logging.StreamHandler()

129

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

130

' [%(process)d]:'

131

' %(levelname)s:'

132

' %(message)s'))

133

logger.addHandler(console)

134

logger.setLevel(level)

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

135

204

136

205

137

206

class PGPError(Exception):

139

208

pass

140

209

141

210

142

class PGPEngine(object):

211

class PGPEngine:

143

212

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

213

144

214

def __init__(self):

145

215

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

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

152

235

def __enter__(self):

153

236

return self

154

237

155

238

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

156

239

self._cleanup()

157

240

return False

158

241

159

242

def __del__(self):

160

243

self._cleanup()

161

244

162

245

def _cleanup(self):

163

246

if self.tempdir is not None:

164

247

# Delete contents of tempdir

165

248

for root, dirs, files in os.walk(self.tempdir,

166

topdown = False):

249

topdown=False):

167

250

for filename in files:

168

251

os.remove(os.path.join(root, filename))

169

252

for dirname in dirs:

171

254

# Remove tempdir

172

255

os.rmdir(self.tempdir)

173

256

self.tempdir = None

174

257

175

258

def password_encode(self, password):

176

259

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

177

260

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

182

265

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

183

266

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

184

267

return encoded

185

268

186

269

def encrypt(self, data, password):

187

270

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

190

273

passfile.write(passphrase)

191

274

passfile.flush()

192

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

193

'--passphrase-file',

275

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

276

"--passphrase-file",

194

277

passfile.name]

195

278

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

200

283

if proc.returncode != 0:

201

284

raise PGPError(err)

202

285

return ciphertext

203

286

204

287

def decrypt(self, data, password):

205

288

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

208

291

passfile.write(passphrase)

209

292

passfile.flush()

210

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

211

'--passphrase-file',

293

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

294

"--passphrase-file",

212

295

passfile.name]

213

296

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

219

301

if proc.returncode != 0:

220

302

raise PGPError(err)

221

303

return decrypted_plaintext

222

304

223

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

224

332

class AvahiError(Exception):

225

333

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

226

334

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

335

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

336

**kwargs)

337

230

338

231

339

class AvahiServiceError(AvahiError):

232

340

pass

233

341

342

234

343

class AvahiGroupError(AvahiError):

235

344

pass

236

345

237

346

238

class AvahiService(object):

347

class AvahiService:

239

348

"""An Avahi (Zeroconf) service.

240

349

241

350

Attributes:

242

351

interface: integer; avahi.IF_UNSPEC or an interface index.

243

352

Used to optionally bind to the specified interface.

244

245

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

353

354

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

246

355

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

247

356

port: integer; what port to announce

248

357

TXT: list of strings; TXT record for the service

255

364

server: D-Bus Server

256

365

bus: dbus.SystemBus()

257

366

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

263

379

self.interface = interface

264

380

self.name = name

265

381

self.type = servicetype

274

390

self.server = None

275

391

self.bus = bus

276

392

self.entry_group_state_changed_match = None

277

278

def rename(self):

393

394

def rename(self, remove=True):

279

395

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

280

396

if self.rename_count >= self.max_renames:

281

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

282

" after %i retries, exiting.",

283

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

284

400

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

287

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

288

self.name)

289

self.remove()

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

404

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

405

self.name)

406

if remove:

407

self.remove()

290

408

try:

291

409

self.add()

292

410

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

298

420

def remove(self):

299

421

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

300

422

if self.entry_group_state_changed_match is not None:

302

424

self.entry_group_state_changed_match = None

303

425

if self.group is not None:

304

426

self.group.Reset()

305

427

306

428

def add(self):

307

429

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

308

430

self.remove()

313

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

314

436

self.entry_group_state_changed_match = (

315

437

self.group.connect_to_signal(

316

'StateChanged', self.entry_group_state_changed))

317

logger.debug("Adding Zeroconf service '%s' of type '%s' ...",

318

self.name, self.type)

438

"StateChanged", self.entry_group_state_changed))

439

log.debug("Adding Zeroconf service '%s' of type '%s' ...",

440

self.name, self.type)

319

441

self.group.AddService(

320

442

self.interface,

321

443

self.protocol,

325

447

dbus.UInt16(self.port),

326

448

avahi.string_array_to_txt_array(self.TXT))

327

449

self.group.Commit()

328

450

329

451

def entry_group_state_changed(self, state, error):

330

452

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

331

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

332

453

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

454

333

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

335

457

elif state == avahi.ENTRY_GROUP_COLLISION:

336

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

458

log.info("Zeroconf service name collision.")

337

459

self.rename()

338

460

elif state == avahi.ENTRY_GROUP_FAILURE:

339

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

340

unicode(error))

341

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

342

.format(error))

343

461

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

462

str(error))

463

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

464

344

465

def cleanup(self):

345

466

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

346

467

if self.group is not None:

351

472

pass

352

473

self.group = None

353

474

self.remove()

354

475

355

476

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

356

477

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

357

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

478

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

365

485

if state in bad_states:

366

486

if bad_states[state] is not None:

367

487

if error is None:

368

logger.error(bad_states[state])

488

log.error(bad_states[state])

369

489

else:

370

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

490

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

371

491

self.cleanup()

372

492

elif state == avahi.SERVER_RUNNING:

373

self.add()

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

374

504

else:

375

505

if error is None:

376

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

506

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

377

507

else:

378

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

379

508

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

509

380

510

def activate(self):

381

511

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

382

512

if self.server is None:

386

516

follow_name_owner_changes=True),

387

517

avahi.DBUS_INTERFACE_SERVER)

388

518

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

519

self.server_state_changed)

390

520

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

391

521

392

522

393

523

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

524

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

395

525

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

526

ret = super(AvahiServiceToSyslog, self).rename(*args,

527

**kwargs)

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

401

531

return ret

402

532

403

533

404

class Client(object):

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

library = ctypes.util.find_library("gnutls")

539

if library is None:

540

library = ctypes.util.find_library("gnutls-deb0")

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

"utf-8", errors="replace")

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

raise TypeError("Not of type {}: {!r}"

611

.format(self.cls.__name__, obj))

612

return ctypes.byref(obj.from_param(obj))

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

raise TypeError("Not of type {}: {!r}"

621

.format(self.cls.__name__, obj))

622

return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

data_len -= gnutls.record_send(self, data[-data_len:],

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

init.argtypes = [PointerTo(ClientSession), ctypes.c_int]

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

405

875

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

406

876

407

877

Attributes:

408

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

878

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

409

879

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

410

880

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

411

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

412

to see if the client lives.

413

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

881

checker: multiprocessing.Process(); a running checker process used

882

to see if the client lives. None if no process is

883

running.

884

checker_callback_tag: a GLib event source tag, or None

415

885

checker_command: string; External command which is run to check

416

886

if client lives. %() expansions are done at

417

887

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

418

888

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

419

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

420

890

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

421

891

client_structure: Object describing what attributes a client has

422

892

and is used for storing the client at exit

423

893

current_checker_command: string; current running checker_command

424

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

425

895

enabled: bool()

426

896

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

427

uniquely identify the client

897

uniquely identify an OpenPGP client

898

key_id: string (64 hexadecimal digits); used to uniquely identify

899

a client using raw public keys

428

900

host: string; available for use by the checker command

429

901

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

430

902

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

432

904

last_checker_status: integer between 0 and 255 reflecting exit

433

905

status of last checker. -1 reflects crashed

434

906

checker, -2 means no checker completed yet.

907

last_checker_signal: The signal which killed the last checker, if

908

last_checker_status is -1

435

909

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

436

910

437

911

D-Bus identifiers

444

918

disabled, or None

445

919

server_settings: The server_settings dict from main()

446

920

"""

447

921

448

922

runtime_expansions = ("approval_delay", "approval_duration",

449

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

923

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

450

924

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

451

925

"last_approval_request", "last_checked_ok",

452

926

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

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

927

client_defaults = {

928

"timeout": "PT5M",

929

"extended_timeout": "PT15M",

930

"interval": "PT2M",

931

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

932

"host": "",

933

"approval_delay": "PT0S",

934

"approval_duration": "PT1S",

935

"approved_by_default": "True",

936

"enabled": "True",

937

}

938

464

939

@staticmethod

465

940

def config_parser(config):

466

941

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

473

948

for client_name in config.sections():

474

949

section = dict(config.items(client_name))

475

950

client = settings[client_name] = {}

476

951

477

952

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

478

953

# Reformat values from string types to Python types

479

954

client["approved_by_default"] = config.getboolean(

480

955

client_name, "approved_by_default")

481

956

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

482

957

"enabled")

483

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

client["key_id"] = (section.get("key_id", "").upper()

963

.replace(" ", ""))

484

964

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

485

965

.replace(" ", ""))

486

966

if "secret" in section:

487

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

967

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

968

.encode("utf-8"),

969

"base64")

488

970

elif "secfile" in section:

489

971

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

490

972

(section["secfile"])),

505

987

client["last_approval_request"] = None

506

988

client["last_checked_ok"] = None

507

989

client["last_checker_status"] = -2

508

990

509

991

return settings

510

511

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

992

993

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

512

994

self.name = name

513

995

if server_settings is None:

514

996

server_settings = {}

516

998

# adding all client settings

517

999

for setting, value in settings.items():

518

1000

setattr(self, setting, value)

519

1001

520

1002

if self.enabled:

521

1003

if not hasattr(self, "last_enabled"):

522

1004

self.last_enabled = datetime.datetime.utcnow()

526

1008

else:

527

1009

self.last_enabled = None

528

1010

self.expires = None

529

530

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

534

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

1011

1012

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

1013

log.debug(" Key ID: %s", self.key_id)

1014

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

535

1015

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

536

1016

datetime.datetime.utcnow())

537

1017

538

1018

# attributes specific for this server instance

539

1019

self.checker = None

540

1020

self.checker_initiator_tag = None

543

1023

self.current_checker_command = None

544

1024

self.approved = None

545

1025

self.approvals_pending = 0

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

551

1030

if not attr.startswith("_")]

552

1031

self.client_structure.append("client_structure")

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

1032

1033

for name, t in inspect.getmembers(

1034

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

558

1035

if not name.startswith("_"):

559

1036

self.client_structure.append(name)

560

1037

561

1038

# Send notice to process children that client state has changed

562

1039

def send_changedstate(self):

563

1040

with self.changedstate:

564

1041

self.changedstate.notify_all()

565

1042

566

1043

def enable(self):

567

1044

"""Start this client's checker and timeout hooks"""

568

1045

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

573

1050

self.last_enabled = datetime.datetime.utcnow()

574

1051

self.init_checker()

575

1052

self.send_changedstate()

576

1053

577

1054

def disable(self, quiet=True):

578

1055

"""Disable this client."""

579

1056

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

580

1057

return False

581

1058

if not quiet:

582

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

1059

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

583

1060

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

584

gobject.source_remove(self.disable_initiator_tag)

1061

GLib.source_remove(self.disable_initiator_tag)

585

1062

self.disable_initiator_tag = None

586

1063

self.expires = None

587

1064

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

588

gobject.source_remove(self.checker_initiator_tag)

1065

GLib.source_remove(self.checker_initiator_tag)

589

1066

self.checker_initiator_tag = None

590

1067

self.stop_checker()

591

1068

self.enabled = False

592

1069

if not quiet:

593

1070

self.send_changedstate()

594

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

1071

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

595

1072

return False

596

1073

597

1074

def __del__(self):

598

1075

self.disable()

599

1076

600

1077

def init_checker(self):

601

1078

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

602

1079

# and every interval from then on.

603

1080

if self.checker_initiator_tag is not None:

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

1081

GLib.source_remove(self.checker_initiator_tag)

1082

self.checker_initiator_tag = GLib.timeout_add(

1083

random.randrange(int(self.interval.total_seconds() * 1000

1084

+ 1)),

1085

self.start_checker)

609

1086

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

610

1087

if self.disable_initiator_tag is not None:

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

1090

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

616

1091

# Also start a new checker *right now*.

617

1092

self.start_checker()

618

619

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

1093

1094

def checker_callback(self, source, condition, connection,

1095

command):

620

1096

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

1097

# Read return code from connection (see call_pipe)

1098

returncode = connection.recv()

1099

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

621

1102

self.checker_callback_tag = None

622

1103

self.checker = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1104

1105

if returncode >= 0:

1106

self.last_checker_status = returncode

1107

self.last_checker_signal = None

625

1108

if self.last_checker_status == 0:

626

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

627

vars(self))

1109

log.info("Checker for %(name)s succeeded", vars(self))

628

1110

self.checked_ok()

629

1111

else:

630

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

631

vars(self))

1112

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

632

1113

else:

633

1114

self.last_checker_status = -1

634

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

635

vars(self))

636

1115

self.last_checker_signal = -returncode

1116

log.warning("Checker for %(name)s crashed?", vars(self))

1117

return False

1118

637

1119

def checked_ok(self):

638

1120

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

639

1121

self.last_checked_ok = datetime.datetime.utcnow()

640

1122

self.last_checker_status = 0

1123

self.last_checker_signal = None

641

1124

self.bump_timeout()

642

1125

643

1126

def bump_timeout(self, timeout=None):

644

1127

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

645

1128

if timeout is None:

646

1129

timeout = self.timeout

647

1130

if self.disable_initiator_tag is not None:

648

gobject.source_remove(self.disable_initiator_tag)

1131

GLib.source_remove(self.disable_initiator_tag)

649

1132

self.disable_initiator_tag = None

650

1133

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1134

self.disable_initiator_tag = GLib.timeout_add(

1135

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

654

1136

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

655

1137

656

1138

def need_approval(self):

657

1139

self.last_approval_request = datetime.datetime.utcnow()

658

1140

659

1141

def start_checker(self):

660

1142

"""Start a new checker subprocess if one is not running.

661

1143

662

1144

If a checker already exists, leave it running and do

663

1145

nothing."""

664

1146

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

669

1151

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

670

1152

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

671

1153

# should be.

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1154

1155

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

1156

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

1157

self.checker.join()

1158

self.checker = None

687

1159

# Start a new checker if needed

688

1160

if self.checker is None:

689

1161

# Escape attributes for the shell

690

escaped_attrs = { attr:

691

re.escape(unicode(getattr(self,

692

attr)))

693

for attr in self.runtime_expansions }

1162

escaped_attrs = {

1163

attr: shlex.quote(str(getattr(self, attr)))

1164

for attr in self.runtime_expansions}

694

1165

try:

695

1166

command = self.checker_command % escaped_attrs

696

1167

except TypeError as error:

697

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

698

self.checker_command, exc_info=error)

699

return True # Try again later

1168

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

1169

self.checker_command, exc_info=error)

1170

return True # Try again later

700

1171

self.current_checker_command = command

701

try:

702

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

703

command, self.name)

704

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

705

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

706

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

707

# always replaced by /dev/null.)

708

# The exception is when not debugging but nevertheless

709

# running in the foreground; use the previously

710

# created wnull.

711

popen_args = {}

712

if (not self.server_settings["debug"]

713

and self.server_settings["foreground"]):

714

popen_args.update({"stdout": wnull,

715

"stderr": wnull })

716

self.checker = subprocess.Popen(command,

717

close_fds=True,

718

shell=True, cwd="/",

719

**popen_args)

720

except OSError as error:

721

logger.error("Failed to start subprocess",

722

exc_info=error)

723

return True

724

self.checker_callback_tag = (gobject.child_watch_add

725

(self.checker.pid,

726

self.checker_callback,

727

data=command))

728

# The checker may have completed before the gobject

729

# watch was added. Check for this.

730

try:

731

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

732

except OSError as error:

733

if error.errno == errno.ECHILD:

734

# This should never happen

735

logger.error("Child process vanished",

736

exc_info=error)

737

return True

738

raise

739

if pid:

740

gobject.source_remove(self.checker_callback_tag)

741

self.checker_callback(pid, status, command)

742

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

1172

log.info("Starting checker %r for %s", command, self.name)

1173

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

1174

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

1175

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

1176

# always replaced by /dev/null.)

1177

# The exception is when not debugging but nevertheless

1178

# running in the foreground; use the previously

1179

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

1183

if (not self.server_settings["debug"]

1184

and self.server_settings["foreground"]):

1185

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

1188

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

1192

self.checker.start()

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

GLib.IOChannel.unix_new(pipe[0].fileno()),

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1196

self.checker_callback, pipe[0], command)

1197

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

743

1198

return True

744

1199

745

1200

def stop_checker(self):

746

1201

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

747

1202

if self.checker_callback_tag:

748

gobject.source_remove(self.checker_callback_tag)

1203

GLib.source_remove(self.checker_callback_tag)

749

1204

self.checker_callback_tag = None

750

1205

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

751

1206

return

752

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

753

try:

754

self.checker.terminate()

755

#time.sleep(0.5)

756

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

757

# self.checker.kill()

758

except OSError as error:

759

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

760

raise

1207

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

1208

self.checker.terminate()

761

1209

self.checker = None

762

1210

763

1211

764

def dbus_service_property(dbus_interface, signature="v",

765

access="readwrite", byte_arrays=False):

1212

def dbus_service_property(dbus_interface,

1213

signature="v",

1214

access="readwrite",

1215

byte_arrays=False):

766

1216

"""Decorators for marking methods of a DBusObjectWithProperties to

767

1217

become properties on the D-Bus.

768

1218

769

1219

The decorated method will be called with no arguments by "Get"

770

1220

and with one argument by "Set".

771

1221

772

1222

The parameters, where they are supported, are the same as

773

1223

dbus.service.method, except there is only "signature", since the

774

1224

type from Get() and the type sent to Set() is the same.

778

1228

if byte_arrays and signature != "ay":

779

1229

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

780

1230

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

1231

781

1232

def decorator(func):

782

1233

func._dbus_is_property = True

783

1234

func._dbus_interface = dbus_interface

786

1237

func._dbus_name = func.__name__

787

1238

if func._dbus_name.endswith("_dbus_property"):

788

1239

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

789

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

790

1241

return func

1242

791

1243

return decorator

792

1244

793

1245

794

1246

def dbus_interface_annotations(dbus_interface):

795

1247

"""Decorator for marking functions returning interface annotations

796

1248

797

1249

Usage:

798

1250

799

1251

@dbus_interface_annotations("org.example.Interface")

800

1252

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

801

1253

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

802

1254

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

803

1255

"false"}

804

1256

"""

1257

805

1258

def decorator(func):

806

1259

func._dbus_is_interface = True

807

1260

func._dbus_interface = dbus_interface

808

1261

func._dbus_name = dbus_interface

809

1262

return func

1263

810

1264

return decorator

811

1265

812

1266

813

1267

def dbus_annotations(annotations):

814

1268

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

815

1269

Usage:

816

1270

1271

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

1272

"org.freedesktop.DBus.Property."

1273

"EmitsChangedSignal": "false"})

817

1274

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

818

1275

access="r")

819

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

820

"org.freedesktop.DBus.Property."

821

"EmitsChangedSignal": "false"})

822

1276

def Property_dbus_property(self):

823

1277

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

824

1280

"""

1281

825

1282

def decorator(func):

826

1283

func._dbus_annotations = annotations

827

1284

return func

1285

828

1286

return decorator

829

1287

830

1288

831

1289

class DBusPropertyException(dbus.exceptions.DBusException):

832

1290

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

833

1291

"""

834

def __unicode__(self):

835

return unicode(str(self))

1292

pass

836

1293

837

1294

838

1295

class DBusPropertyAccessException(DBusPropertyException):

847

1304

pass

848

1305

849

1306

850

class DBusObjectWithProperties(dbus.service.Object):

851

"""A D-Bus object with properties.

852

853

Classes inheriting from this can use the dbus_service_property

854

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

855

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

1307

class DBusObjectWithAnnotations(dbus.service.Object):

1308

"""A D-Bus object with annotations.

1309

1310

Classes inheriting from this can use the dbus_annotations

1311

decorator to add annotations to methods or signals.

856

1312

"""

857

1313

858

1314

@staticmethod

859

1315

def _is_dbus_thing(thing):

860

1316

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

861

1317

862

1318

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

863

1319

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

864

1320

"""

865

1321

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

866

1322

False)

867

1323

868

1324

def _get_all_dbus_things(self, thing):

869

1325

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

870

1326

"""

871

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

872

name),

1327

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

873

1328

athing.__get__(self))

874

1329

for cls in self.__class__.__mro__

875

1330

for name, athing in

876

inspect.getmembers(cls,

877

self._is_dbus_thing(thing)))

878

1331

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

1332

1333

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1337

def Introspect(self, object_path, connection):

1338

"""Overloading of standard D-Bus method.

1339

1340

Inserts annotation tags on methods and signals.

1341

"""

1342

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

1343

connection)

1344

try:

1345

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

1346

1347

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

1348

# Add annotation tags

1349

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

1350

for tag in if_tag.getElementsByTagName(typ):

1351

annots = dict()

1352

for name, prop in (self.

1353

_get_all_dbus_things(typ)):

1354

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

1355

and prop._dbus_interface

1356

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

1357

annots.update(getattr(

1358

prop, "_dbus_annotations", {}))

1359

for name, value in annots.items():

1360

ann_tag = document.createElement(

1361

"annotation")

1362

ann_tag.setAttribute("name", name)

1363

ann_tag.setAttribute("value", value)

1364

tag.appendChild(ann_tag)

1365

# Add interface annotation tags

1366

for annotation, value in dict(

1367

itertools.chain.from_iterable(

1368

annotations().items()

1369

for name, annotations

1370

in self._get_all_dbus_things("interface")

1371

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

1372

)).items():

1373

ann_tag = document.createElement("annotation")

1374

ann_tag.setAttribute("name", annotation)

1375

ann_tag.setAttribute("value", value)

1376

if_tag.appendChild(ann_tag)

1377

# Fix argument name for the Introspect method itself

1378

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1380

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

1381

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

1382

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

1383

if (arg.getAttribute("direction")

1384

== "out"):

1385

arg.setAttribute("name",

1386

"xml_data")

1387

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

1388

document.unlink()

1389

except (AttributeError, xml.dom.DOMException,

1390

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1393

return xmlstring

1394

1395

1396

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

"""A D-Bus object with properties.

1398

1399

Classes inheriting from this can use the dbus_service_property

1400

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

1401

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

1402

"""

1403

879

1404

def _get_dbus_property(self, interface_name, property_name):

880

1405

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

881

1406

property with the specified name and interface.

882

1407

"""

883

for cls in self.__class__.__mro__:

884

for name, value in (inspect.getmembers

885

(cls,

886

self._is_dbus_thing("property"))):

1408

for cls in self.__class__.__mro__:

1409

for name, value in inspect.getmembers(

1410

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

887

1411

if (value._dbus_name == property_name

888

1412

and value._dbus_interface == interface_name):

889

1413

return value.__get__(self)

890

1414

891

1415

# No such property

892

raise DBusPropertyNotFound(self.dbus_object_path + ":"

893

+ interface_name + "."

894

+ property_name)

895

896

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

1416

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

1417

self.dbus_object_path, interface_name, property_name))

1418

1419

@classmethod

1420

def _get_all_interface_names(cls):

1421

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

1422

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

1423

"_dbus_interface", None)

1424

for x in (inspect.getmro(cls))

1425

for attr in dir(x))

1426

if name is not None)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="ss",

897

1430

out_signature="v")

898

1431

def Get(self, interface_name, property_name):

899

1432

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

905

1438

if not hasattr(value, "variant_level"):

906

1439

return value

907

1440

return type(value)(value, variant_level=value.variant_level+1)

908

1441

909

1442

@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")

910

1443

def Set(self, interface_name, property_name, value):

911

1444

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

920

1453

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

921

1454

"'ay' signature {!r}"

922

1455

.format(prop._dbus_signature))

923

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

924

for byte in value))

1456

value = dbus.ByteArray(bytes(value))

925

1457

prop(value)

926

927

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

1458

1459

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

in_signature="s",

928

1461

out_signature="a{sv}")

929

1462

def GetAll(self, interface_name):

930

1463

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

931

1464

standard.

932

1465

933

1466

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

934

1467

"""

935

1468

properties = {}

945

1478

if not hasattr(value, "variant_level"):

946

1479

properties[name] = value

947

1480

continue

948

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

949

value.variant_level+1)

1481

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

950

1483

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

951

1484

1485

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

1486

def PropertiesChanged(self, interface_name, changed_properties,

1487

invalidated_properties):

1488

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

1489

standard.

1490

"""

1491

pass

1492

952

1493

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

953

1494

out_signature="s",

954

path_keyword='object_path',

955

connection_keyword='connection')

1495

path_keyword="object_path",

1496

connection_keyword="connection")

956

1497

def Introspect(self, object_path, connection):

957

1498

"""Overloading of standard D-Bus method.

958

1499

959

1500

Inserts property tags and interface annotation tags.

960

1501

"""

961

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

962

connection)

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

963

1505

try:

964

1506

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

1507

965

1508

def make_tag(document, name, prop):

966

1509

e = document.createElement("property")

967

1510

e.setAttribute("name", name)

968

1511

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

969

1512

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

970

1513

return e

1514

971

1515

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

972

1516

# Add property tags

973

1517

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

976

1520

if prop._dbus_interface

977

1521

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

978

1522

if_tag.appendChild(tag)

979

# Add annotation tags

980

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

981

for tag in if_tag.getElementsByTagName(typ):

982

annots = dict()

983

for name, prop in (self.

984

_get_all_dbus_things(typ)):

985

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

986

and prop._dbus_interface

987

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

988

annots.update(getattr

989

(prop,

990

"_dbus_annotations",

991

{}))

992

for name, value in annots.items():

993

ann_tag = document.createElement(

994

"annotation")

995

ann_tag.setAttribute("name", name)

996

ann_tag.setAttribute("value", value)

997

tag.appendChild(ann_tag)

998

# Add interface annotation tags

999

for annotation, value in dict(

1000

itertools.chain.from_iterable(

1001

annotations().items()

1002

for name, annotations in

1003

self._get_all_dbus_things("interface")

1004

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

1005

)).items():

1006

ann_tag = document.createElement("annotation")

1007

ann_tag.setAttribute("name", annotation)

1008

ann_tag.setAttribute("value", value)

1009

if_tag.appendChild(ann_tag)

1523

# Add annotation tags for properties

1524

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

1525

annots = dict()

1526

for name, prop in self._get_all_dbus_things(

1527

"property"):

1528

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

1529

and prop._dbus_interface

1530

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

1531

annots.update(getattr(

1532

prop, "_dbus_annotations", {}))

1533

for name, value in annots.items():

1534

ann_tag = document.createElement(

1535

"annotation")

1536

ann_tag.setAttribute("name", name)

1537

ann_tag.setAttribute("value", value)

1538

tag.appendChild(ann_tag)

1010

1539

# Add the names to the return values for the

1011

1540

# "org.freedesktop.DBus.Properties" methods

1012

1541

if (if_tag.getAttribute("name")

1026

1555

document.unlink()

1027

1556

except (AttributeError, xml.dom.DOMException,

1028

1557

xml.parsers.expat.ExpatError) as error:

1029

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

1030

exc_info=error)

1558

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

1559

exc_info=error)

1560

return xmlstring

1561

1562

1563

try:

1564

dbus.OBJECT_MANAGER_IFACE

1565

except AttributeError:

1566

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

1567

1568

1569

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

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

1571

1572

Classes inheriting from this exposes the standard

1573

GetManagedObjects call and the InterfacesAdded and

1574

InterfacesRemoved signals on the standard

1575

"org.freedesktop.DBus.ObjectManager" interface.

1576

1577

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

1578

manually.

1579

"""

1580

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1582

def GetManagedObjects(self):

1583

"""This function must be overridden"""

1584

raise NotImplementedError()

1585

1586

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1588

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

pass

1590

1591

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

1592

def InterfacesRemoved(self, object_path, interfaces):

1593

pass

1594

1595

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1599

def Introspect(self, object_path, connection):

1600

"""Overloading of standard D-Bus method.

1601

1602

Override return argument name of GetManagedObjects to be

1603

"objpath_interfaces_and_properties"

1604

"""

1605

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1606

object_path,

1607

connection)

1608

try:

1609

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

1610

1611

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

1612

# Fix argument name for the GetManagedObjects method

1613

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1615

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

1616

if (cn.getAttribute("name")

1617

== "GetManagedObjects"):

1618

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

1619

if (arg.getAttribute("direction")

1620

== "out"):

1621

arg.setAttribute(

1622

"name",

1623

"objpath_interfaces"

1624

"_and_properties")

1625

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

1626

document.unlink()

1627

except (AttributeError, xml.dom.DOMException,

1628

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1031

1631

return xmlstring

1032

1632

1033

1633

1034

1634

def datetime_to_dbus(dt, variant_level=0):

1035

1635

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

1036

1636

if dt is None:

1037

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

1038

return dbus.String(dt.isoformat(),

1039

variant_level=variant_level)

1637

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

1638

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

1040

1639

1041

1640

1042

1641

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1044

1643

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

1045

1644

interface names according to the "alt_interface_names" mapping.

1046

1645

Usage:

1047

1646

1048

1647

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

1049

1648

"net.example.AlternateInterface"})

1050

1649

class SampleDBusObject(dbus.service.Object):

1051

1650

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

1052

1651

def SampleDBusMethod():

1053

1652

pass

1054

1653

1055

1654

The above "SampleDBusMethod" on "SampleDBusObject" will be

1056

1655

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

1057

1656

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

1058

1657

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

1059

1658

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

1060

1659

1061

1660

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

1062

1661

(from DBusObjectWithProperties) and interfaces (from the

1063

1662

dbus_interface_annotations decorator).

1064

1663

"""

1664

1065

1665

def wrapper(cls):

1066

1666

for orig_interface_name, alt_interface_name in (

1067

alt_interface_names.items()):

1667

alt_interface_names.items()):

1068

1668

attr = {}

1069

1669

interface_names = set()

1070

1670

# Go though all attributes of the class

1072

1672

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

1073

1673

# with the wrong interface name

1074

1674

if (not hasattr(attribute, "_dbus_interface")

1075

or not attribute._dbus_interface

1076

.startswith(orig_interface_name)):

1675

or not attribute._dbus_interface.startswith(

1676

orig_interface_name)):

1077

1677

continue

1078

1678

# Create an alternate D-Bus interface name based on

1079

1679

# the current name

1080

alt_interface = (attribute._dbus_interface

1081

.replace(orig_interface_name,

1082

alt_interface_name))

1680

alt_interface = attribute._dbus_interface.replace(

1681

orig_interface_name, alt_interface_name)

1083

1682

interface_names.add(alt_interface)

1084

1683

# Is this a D-Bus signal?

1085

1684

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

1086

1685

# Extract the original non-method undecorated

1087

1686

# function by black magic

1088

nonmethod_func = (dict(

1687

if sys.version_info.major == 2:

1688

nonmethod_func = (dict(

1089

1689

zip(attribute.func_code.co_freevars,

1090

attribute.__closure__))["func"]

1091

.cell_contents)

1690

attribute.__closure__))

1691

["func"].cell_contents)

1692

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1092

1697

# Create a new, but exactly alike, function

1093

1698

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

1094

1699

# with the alternate D-Bus interface name

1095

new_function = (dbus.service.signal

1096

(alt_interface,

1097

attribute._dbus_signature)

1098

(types.FunctionType(

1099

nonmethod_func.func_code,

1100

nonmethod_func.func_globals,

1101

nonmethod_func.func_name,

1102

nonmethod_func.func_defaults,

1103

nonmethod_func.func_closure)))

1700

new_function = copy_function(nonmethod_func)

1701

new_function = (dbus.service.signal(

1702

alt_interface,

1703

attribute._dbus_signature)(new_function))

1104

1704

# Copy annotations, if any

1105

1705

try:

1106

new_function._dbus_annotations = (

1107

dict(attribute._dbus_annotations))

1706

new_function._dbus_annotations = dict(

1707

attribute._dbus_annotations)

1108

1708

except AttributeError:

1109

1709

pass

1710

1110

1711

# Define a creator of a function to call both the

1111

1712

# original and alternate functions, so both the

1112

1713

# original and alternate signals gets sent when

1115

1716

"""This function is a scope container to pass

1116

1717

func1 and func2 to the "call_both" function

1117

1718

outside of its arguments"""

1719

1720

@functools.wraps(func2)

1118

1721

def call_both(*args, **kwargs):

1119

1722

"""This function will emit two D-Bus

1120

1723

signals by calling func1 and func2"""

1121

1724

func1(*args, **kwargs)

1122

1725

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1728

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

1729

if name.startswith("_dbus_"):

1730

setattr(call_both, name, attr)

1731

1123

1732

return call_both

1124

1733

# Create the "call_both" function and add it to

1125

1734

# the class

1130

1739

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

1131

1740

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

1132

1741

# to the class.

1133

attr[attrname] = (dbus.service.method

1134

(alt_interface,

1135

attribute._dbus_in_signature,

1136

attribute._dbus_out_signature)

1137

(types.FunctionType

1138

(attribute.func_code,

1139

attribute.func_globals,

1140

attribute.func_name,

1141

attribute.func_defaults,

1142

attribute.func_closure)))

1742

attr[attrname] = (

1743

dbus.service.method(

1744

alt_interface,

1745

attribute._dbus_in_signature,

1746

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1143

1748

# Copy annotations, if any

1144

1749

try:

1145

attr[attrname]._dbus_annotations = (

1146

dict(attribute._dbus_annotations))

1750

attr[attrname]._dbus_annotations = dict(

1751

attribute._dbus_annotations)

1147

1752

except AttributeError:

1148

1753

pass

1149

1754

# Is this a D-Bus property?

1152

1757

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

1153

1758

# property with the alternate D-Bus interface

1154

1759

# name. Add it to the class.

1155

attr[attrname] = (dbus_service_property

1156

(alt_interface,

1157

attribute._dbus_signature,

1158

attribute._dbus_access,

1159

attribute

1160

._dbus_get_args_options

1161

["byte_arrays"])

1162

(types.FunctionType

1163

(attribute.func_code,

1164

attribute.func_globals,

1165

attribute.func_name,

1166

attribute.func_defaults,

1167

attribute.func_closure)))

1760

attr[attrname] = (dbus_service_property(

1761

alt_interface, attribute._dbus_signature,

1762

attribute._dbus_access,

1763

attribute._dbus_get_args_options

1764

["byte_arrays"])

1765

(copy_function(attribute)))

1168

1766

# Copy annotations, if any

1169

1767

try:

1170

attr[attrname]._dbus_annotations = (

1171

dict(attribute._dbus_annotations))

1768

attr[attrname]._dbus_annotations = dict(

1769

attribute._dbus_annotations)

1172

1770

except AttributeError:

1173

1771

pass

1174

1772

# Is this a D-Bus interface?

1177

1775

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

1178

1776

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

1179

1777

# to the class.

1180

attr[attrname] = (dbus_interface_annotations

1181

(alt_interface)

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1778

attr[attrname] = (

1779

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1188

1781

if deprecate:

1189

1782

# Deprecate all alternate interfaces

1190

iname="_AlternateDBusNames_interface_annotation{}"

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1191

1784

for interface_name in interface_names:

1785

1192

1786

@dbus_interface_annotations(interface_name)

1193

1787

def func(self):

1194

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

1195

"true" }

1788

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

1789

"true"}

1196

1790

# Find an unused name

1197

1791

for aname in (iname.format(i)

1198

1792

for i in itertools.count()):

1202

1796

if interface_names:

1203

1797

# Replace the class with a new subclass of it with

1204

1798

# methods, signals, etc. as created above.

1205

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

1206

(cls,), attr)

1799

if sys.version_info.major == 2:

1800

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

1801

(cls, ), attr)

1802

else:

1803

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

1804

(cls, ), attr)

1207

1805

return cls

1806

1208

1807

return wrapper

1209

1808

1210

1809

1211

1810

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

1212

"se.bsnet.fukt.Mandos"})

1811

"se.bsnet.fukt.Mandos"})

1213

1812

class ClientDBus(Client, DBusObjectWithProperties):

1214

1813

"""A Client class using D-Bus

1215

1814

1216

1815

Attributes:

1217

1816

dbus_object_path: dbus.ObjectPath

1218

1817

bus: dbus.SystemBus()

1219

1818

"""

1220

1819

1221

1820

runtime_expansions = (Client.runtime_expansions

1222

+ ("dbus_object_path",))

1223

1821

+ ("dbus_object_path", ))

1822

1823

_interface = "se.recompile.Mandos.Client"

1824

1224

1825

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

1225

1226

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

1826

1827

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

1227

1828

self.bus = bus

1228

1829

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

1229

1830

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

1230

1831

# the D-Bus

1231

client_object_name = unicode(self.name).translate(

1832

client_object_name = str(self.name).translate(

1232

1833

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

1233

1834

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

1234

self.dbus_object_path = (dbus.ObjectPath

1235

("/clients/" + client_object_name))

1835

self.dbus_object_path = dbus.ObjectPath(

1836

"/clients/" + client_object_name)

1236

1837

DBusObjectWithProperties.__init__(self, self.bus,

1237

1838

self.dbus_object_path)

1238

1239

def notifychangeproperty(transform_func,

1240

dbus_name, type_func=lambda x: x,

1241

variant_level=1):

1839

1840

def notifychangeproperty(transform_func, dbus_name,

1841

type_func=lambda x: x,

1842

variant_level=1,

1843

invalidate_only=False,

1844

_interface=_interface):

1242

1845

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

1243

1846

its changes to DBus.

1244

1847

1245

1848

transform_fun: Function that takes a value and a variant_level

1246

1849

and transforms it to a D-Bus type.

1247

1850

dbus_name: D-Bus name of the variable

1250

1853

variant_level: D-Bus variant level. Default: 1

1251

1854

"""

1252

1855

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

1856

1253

1857

def setter(self, value):

1254

1858

if hasattr(self, "dbus_object_path"):

1255

1859

if (not hasattr(self, attrname) or

1256

1860

type_func(getattr(self, attrname, None))

1257

1861

!= type_func(value)):

1258

dbus_value = transform_func(type_func(value),

1259

variant_level

1260

=variant_level)

1261

self.PropertyChanged(dbus.String(dbus_name),

1262

dbus_value)

1862

if invalidate_only:

1863

self.PropertiesChanged(

1864

_interface, dbus.Dictionary(),

1865

dbus.Array((dbus_name, )))

1866

else:

1867

dbus_value = transform_func(

1868

type_func(value),

1869

variant_level=variant_level)

1870

self.PropertyChanged(dbus.String(dbus_name),

1871

dbus_value)

1872

self.PropertiesChanged(

1873

_interface,

1874

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

1875

dbus_value}),

1876

dbus.Array())

1263

1877

setattr(self, attrname, value)

1264

1878

1265

1879

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

1266

1880

1267

1881

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1268

1882

approvals_pending = notifychangeproperty(dbus.Boolean,

1269

1883

"ApprovalPending",

1270

type_func = bool)

1884

type_func=bool)

1271

1885

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

1272

1886

last_enabled = notifychangeproperty(datetime_to_dbus,

1273

1887

"LastEnabled")

1274

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

1275

type_func = lambda checker:

1276

checker is not None)

1888

checker = notifychangeproperty(

1889

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1277

1891

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1278

1892

"LastCheckedOK")

1279

1893

last_checker_status = notifychangeproperty(dbus.Int16,

1282

1896

datetime_to_dbus, "LastApprovalRequest")

1283

1897

approved_by_default = notifychangeproperty(dbus.Boolean,

1284

1898

"ApprovedByDefault")

1285

approval_delay = notifychangeproperty(dbus.UInt64,

1286

"ApprovalDelay",

1287

type_func =

1288

lambda td: td.total_seconds()

1289

* 1000)

1899

approval_delay = notifychangeproperty(

1900

dbus.UInt64, "ApprovalDelay",

1901

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

1290

1902

approval_duration = notifychangeproperty(

1291

1903

dbus.UInt64, "ApprovalDuration",

1292

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

1904

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

1293

1905

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

1294

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

1295

type_func = lambda td:

1296

td.total_seconds() * 1000)

1906

timeout = notifychangeproperty(

1907

dbus.UInt64, "Timeout",

1908

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

1297

1909

extended_timeout = notifychangeproperty(

1298

1910

dbus.UInt64, "ExtendedTimeout",

1299

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

1300

interval = notifychangeproperty(dbus.UInt64,

1301

"Interval",

1302

type_func =

1303

lambda td: td.total_seconds()

1304

* 1000)

1911

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

1912

interval = notifychangeproperty(

1913

dbus.UInt64, "Interval",

1914

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

1305

1915

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

1306

1916

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

1917

invalidate_only=True)

1918

1307

1919

del notifychangeproperty

1308

1920

1309

1921

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

1310

1922

try:

1311

1923

self.remove_from_connection()

1314

1926

if hasattr(DBusObjectWithProperties, "__del__"):

1315

1927

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

1316

1928

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

1317

1318

def checker_callback(self, pid, condition, command,

1319

*args, **kwargs):

1320

self.checker_callback_tag = None

1321

self.checker = None

1322

if os.WIFEXITED(condition):

1323

exitstatus = os.WEXITSTATUS(condition)

1929

1930

def checker_callback(self, source, condition,

1931

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

1932

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

1933

connection, command, *args,

1934

**kwargs)

1935

exitstatus = self.last_checker_status

1936

if exitstatus >= 0:

1324

1937

# Emit D-Bus signal

1325

1938

self.CheckerCompleted(dbus.Int16(exitstatus),

1326

dbus.Int64(condition),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1327

1941

dbus.String(command))

1328

1942

else:

1329

1943

# Emit D-Bus signal

1330

1944

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

1331

dbus.Int64(condition),

1945

dbus.Int64(

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1332

1949

dbus.String(command))

1333

1334

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

1335

*args, **kwargs)

1336

1950

return ret

1951

1337

1952

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

1338

1953

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

1339

1954

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

1343

1958

# Emit D-Bus signal

1344

1959

self.CheckerStarted(self.current_checker_command)

1345

1960

return r

1346

1961

1347

1962

def _reset_approved(self):

1348

1963

self.approved = None

1349

1964

return False

1350

1965

1351

1966

def approve(self, value=True):

1352

1967

self.approved = value

1353

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

1354

* 1000), self._reset_approved)

1968

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

1969

* 1000), self._reset_approved)

1355

1970

self.send_changedstate()

1356

1357

## D-Bus methods, signals & properties

1358

_interface = "se.recompile.Mandos.Client"

1359

1360

## Interfaces

1361

1362

@dbus_interface_annotations(_interface)

1363

def _foo(self):

1364

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

1365

"false"}

1366

1367

## Signals

1368

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1369

1978

# CheckerCompleted - signal

1370

1979

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

1371

1980

def CheckerCompleted(self, exitcode, waitstatus, command):

1372

1981

"D-Bus signal"

1373

1982

pass

1374

1983

1375

1984

# CheckerStarted - signal

1376

1985

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

1377

1986

def CheckerStarted(self, command):

1378

1987

"D-Bus signal"

1379

1988

pass

1380

1989

1381

1990

# PropertyChanged - signal

1991

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

1382

1992

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

1383

1993

def PropertyChanged(self, property, value):

1384

1994

"D-Bus signal"

1385

1995

pass

1386

1996

1387

1997

# GotSecret - signal

1388

1998

@dbus.service.signal(_interface)

1389

1999

def GotSecret(self):

1392

2002

server to mandos-client

1393

2003

"""

1394

2004

pass

1395

2005

1396

2006

# Rejected - signal

1397

2007

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

1398

2008

def Rejected(self, reason):

1399

2009

"D-Bus signal"

1400

2010

pass

1401

2011

1402

2012

# NeedApproval - signal

1403

2013

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

1404

2014

def NeedApproval(self, timeout, default):

1405

2015

"D-Bus signal"

1406

2016

return self.need_approval()

1407

1408

## Methods

1409

2017

2018

# Methods

2019

1410

2020

# Approve - method

1411

2021

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

1412

2022

def Approve(self, value):

1413

2023

self.approve(value)

1414

2024

1415

2025

# CheckedOK - method

1416

2026

@dbus.service.method(_interface)

1417

2027

def CheckedOK(self):

1418

2028

self.checked_ok()

1419

2029

1420

2030

# Enable - method

2031

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

1421

2032

@dbus.service.method(_interface)

1422

2033

def Enable(self):

1423

2034

"D-Bus method"

1424

2035

self.enable()

1425

2036

1426

2037

# StartChecker - method

2038

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

1427

2039

@dbus.service.method(_interface)

1428

2040

def StartChecker(self):

1429

2041

"D-Bus method"

1430

2042

self.start_checker()

1431

2043

1432

2044

# Disable - method

2045

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

1433

2046

@dbus.service.method(_interface)

1434

2047

def Disable(self):

1435

2048

"D-Bus method"

1436

2049

self.disable()

1437

2050

1438

2051

# StopChecker - method

2052

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

1439

2053

@dbus.service.method(_interface)

1440

2054

def StopChecker(self):

1441

2055

self.stop_checker()

1442

1443

## Properties

1444

2056

2057

# Properties

2058

1445

2059

# ApprovalPending - property

1446

2060

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

1447

2061

def ApprovalPending_dbus_property(self):

1448

2062

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

1449

2063

1450

2064

# ApprovedByDefault - property

1451

@dbus_service_property(_interface, signature="b",

2065

@dbus_service_property(_interface,

2066

signature="b",

1452

2067

access="readwrite")

1453

2068

def ApprovedByDefault_dbus_property(self, value=None):

1454

2069

if value is None: # get

1455

2070

return dbus.Boolean(self.approved_by_default)

1456

2071

self.approved_by_default = bool(value)

1457

2072

1458

2073

# ApprovalDelay - property

1459

@dbus_service_property(_interface, signature="t",

2074

@dbus_service_property(_interface,

2075

signature="t",

1460

2076

access="readwrite")

1461

2077

def ApprovalDelay_dbus_property(self, value=None):

1462

2078

if value is None: # get

1463

2079

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

1464

2080

* 1000)

1465

2081

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

1466

2082

1467

2083

# ApprovalDuration - property

1468

@dbus_service_property(_interface, signature="t",

2084

@dbus_service_property(_interface,

2085

signature="t",

1469

2086

access="readwrite")

1470

2087

def ApprovalDuration_dbus_property(self, value=None):

1471

2088

if value is None: # get

1472

2089

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

1473

2090

* 1000)

1474

2091

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

1475

2092

1476

2093

# Name - property

2094

@dbus_annotations(

2095

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

1477

2096

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

1478

2097

def Name_dbus_property(self):

1479

2098

return dbus.String(self.name)

1480

2099

2100

# KeyID - property

2101

@dbus_annotations(

2102

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

2103

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

2104

def KeyID_dbus_property(self):

2105

return dbus.String(self.key_id)

2106

1481

2107

# Fingerprint - property

2108

@dbus_annotations(

2109

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

1482

2110

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

1483

2111

def Fingerprint_dbus_property(self):

1484

2112

return dbus.String(self.fingerprint)

1485

2113

1486

2114

# Host - property

1487

@dbus_service_property(_interface, signature="s",

2115

@dbus_service_property(_interface,

2116

signature="s",

1488

2117

access="readwrite")

1489

2118

def Host_dbus_property(self, value=None):

1490

2119

if value is None: # get

1491

2120

return dbus.String(self.host)

1492

self.host = unicode(value)

1493

2121

self.host = str(value)

2122

1494

2123

# Created - property

2124

@dbus_annotations(

2125

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

1495

2126

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

1496

2127

def Created_dbus_property(self):

1497

2128

return datetime_to_dbus(self.created)

1498

2129

1499

2130

# LastEnabled - property

1500

2131

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

1501

2132

def LastEnabled_dbus_property(self):

1502

2133

return datetime_to_dbus(self.last_enabled)

1503

2134

1504

2135

# Enabled - property

1505

@dbus_service_property(_interface, signature="b",

2136

@dbus_service_property(_interface,

2137

signature="b",

1506

2138

access="readwrite")

1507

2139

def Enabled_dbus_property(self, value=None):

1508

2140

if value is None: # get

1511

2143

self.enable()

1512

2144

else:

1513

2145

self.disable()

1514

2146

1515

2147

# LastCheckedOK - property

1516

@dbus_service_property(_interface, signature="s",

2148

@dbus_service_property(_interface,

2149

signature="s",

1517

2150

access="readwrite")

1518

2151

def LastCheckedOK_dbus_property(self, value=None):

1519

2152

if value is not None:

1520

2153

self.checked_ok()

1521

2154

return

1522

2155

return datetime_to_dbus(self.last_checked_ok)

1523

2156

1524

2157

# LastCheckerStatus - property

1525

@dbus_service_property(_interface, signature="n",

1526

access="read")

2158

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

1527

2159

def LastCheckerStatus_dbus_property(self):

1528

2160

return dbus.Int16(self.last_checker_status)

1529

2161

1530

2162

# Expires - property

1531

2163

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

1532

2164

def Expires_dbus_property(self):

1533

2165

return datetime_to_dbus(self.expires)

1534

2166

1535

2167

# LastApprovalRequest - property

1536

2168

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

1537

2169

def LastApprovalRequest_dbus_property(self):

1538

2170

return datetime_to_dbus(self.last_approval_request)

1539

2171

1540

2172

# Timeout - property

1541

@dbus_service_property(_interface, signature="t",

2173

@dbus_service_property(_interface,

2174

signature="t",

1542

2175

access="readwrite")

1543

2176

def Timeout_dbus_property(self, value=None):

1544

2177

if value is None: # get

1556

2189

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

1557

2190

is None):

1558

2191

return

1559

gobject.source_remove(self.disable_initiator_tag)

1560

self.disable_initiator_tag = (

1561

gobject.timeout_add(

1562

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

1563

* 1000), self.disable))

1564

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

2194

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

2195

self.disable)

2196

1565

2197

# ExtendedTimeout - property

1566

@dbus_service_property(_interface, signature="t",

2198

@dbus_service_property(_interface,

2199

signature="t",

1567

2200

access="readwrite")

1568

2201

def ExtendedTimeout_dbus_property(self, value=None):

1569

2202

if value is None: # get

1570

2203

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

1571

2204

* 1000)

1572

2205

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

1573

2206

1574

2207

# Interval - property

1575

@dbus_service_property(_interface, signature="t",

2208

@dbus_service_property(_interface,

2209

signature="t",

1576

2210

access="readwrite")

1577

2211

def Interval_dbus_property(self, value=None):

1578

2212

if value is None: # get

1582

2216

return

1583

2217

if self.enabled:

1584

2218

# Reschedule checker run

1585

gobject.source_remove(self.checker_initiator_tag)

1586

self.checker_initiator_tag = (gobject.timeout_add

1587

(value, self.start_checker))

1588

self.start_checker() # Start one now, too

1589

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

2221

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

1590

2224

# Checker - property

1591

@dbus_service_property(_interface, signature="s",

2225

@dbus_service_property(_interface,

2226

signature="s",

1592

2227

access="readwrite")

1593

2228

def Checker_dbus_property(self, value=None):

1594

2229

if value is None: # get

1595

2230

return dbus.String(self.checker_command)

1596

self.checker_command = unicode(value)

1597

2231

self.checker_command = str(value)

2232

1598

2233

# CheckerRunning - property

1599

@dbus_service_property(_interface, signature="b",

2234

@dbus_service_property(_interface,

2235

signature="b",

1600

2236

access="readwrite")

1601

2237

def CheckerRunning_dbus_property(self, value=None):

1602

2238

if value is None: # get

1605

2241

self.start_checker()

1606

2242

else:

1607

2243

self.stop_checker()

1608

2244

1609

2245

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

1610

2249

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

1611

2250

def ObjectPath_dbus_property(self):

1612

return self.dbus_object_path # is already a dbus.ObjectPath

1613

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1614

2253

# Secret = property

1615

@dbus_service_property(_interface, signature="ay",

1616

access="write", byte_arrays=True)

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

2257

@dbus_service_property(_interface,

2258

signature="ay",

2259

access="write",

2260

byte_arrays=True)

1617

2261

def Secret_dbus_property(self, value):

1618

self.secret = str(value)

1619

2262

self.secret = bytes(value)

2263

1620

2264

del _interface

1621

2265

1622

2266

1623

class ProxyClient(object):

1624

def __init__(self, child_pipe, fpr, address):

2267

class ProxyClient:

2268

def __init__(self, child_pipe, key_id, fpr, address):

1625

2269

self._pipe = child_pipe

1626

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

2270

self._pipe.send(("init", key_id, fpr, address))

1627

2271

if not self._pipe.recv():

1628

raise KeyError()

1629

2272

raise KeyError(key_id or fpr)

2273

1630

2274

def __getattribute__(self, name):

1631

if name == '_pipe':

2275

if name == "_pipe":

1632

2276

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

1633

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

2277

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

1634

2278

data = self._pipe.recv()

1635

if data[0] == 'data':

2279

if data[0] == "data":

1636

2280

return data[1]

1637

if data[0] == 'function':

2281

if data[0] == "function":

2282

1638

2283

def func(*args, **kwargs):

1639

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

2284

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

1640

2285

return self._pipe.recv()[1]

2286

1641

2287

return func

1642

2288

1643

2289

def __setattr__(self, name, value):

1644

if name == '_pipe':

2290

if name == "_pipe":

1645

2291

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

1646

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

2292

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

1647

2293

1648

2294

1649

2295

class ClientHandler(socketserver.BaseRequestHandler, object):

1650

2296

"""A class to handle client connections.

1651

2297

1652

2298

Instantiated once for each connection to handle it.

1653

2299

Note: This will run in its own forked process."""

1654

2300

1655

2301

def handle(self):

1656

2302

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

1657

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

1658

unicode(self.client_address))

1659

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

1660

self.server.child_pipe.fileno())

1661

1662

session = (gnutls.connection

1663

.ClientSession(self.request,

1664

gnutls.connection

1665

.X509Credentials()))

1666

1667

# Note: gnutls.connection.X509Credentials is really a

1668

# generic GnuTLS certificate credentials object so long as

1669

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

1670

# here despite using OpenPGP certificates.

1671

1672

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

1673

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

1674

# "+COMP-NULL", "+CTYPE-OPENPGP",

1675

# "+DHE-DSS"))

2303

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

2304

str(self.client_address))

2305

log.debug("Pipe FD: %d", self.server.child_pipe.fileno())

2306

2307

session = gnutls.ClientSession(self.request)

2308

2309

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

2310

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

2311

# "+COMP-NULL", "+CTYPE-OPENPGP",

2312

# "+DHE-DSS"))

1676

2313

# Use a fallback default, since this MUST be set.

1677

2314

priority = self.server.gnutls_priority

1678

2315

if priority is None:

1679

2316

priority = "NORMAL"

1680

(gnutls.library.functions

1681

.gnutls_priority_set_direct(session._c_object,

1682

priority, None))

1683

2317

gnutls.priority_set_direct(session,

2318

priority.encode("utf-8"), None)

2319

1684

2320

# Start communication using the Mandos protocol

1685

2321

# Get protocol number

1686

2322

line = self.request.makefile().readline()

1687

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

2323

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

1688

2324

try:

1689

2325

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

1690

2326

raise RuntimeError(line)

1691

2327

except (ValueError, IndexError, RuntimeError) as error:

1692

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

2328

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

1693

2329

return

1694

2330

1695

2331

# Start GnuTLS connection

1696

2332

try:

1697

2333

session.handshake()

1698

except gnutls.errors.GNUTLSError as error:

1699

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

2334

except gnutls.Error as error:

2335

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

1700

2336

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

1701

2337

# established. Just abandon the request.

1702

2338

return

1703

logger.debug("Handshake succeeded")

1704

2339

log.debug("Handshake succeeded")

2340

1705

2341

approval_required = False

1706

2342

try:

1707

try:

1708

fpr = self.fingerprint(self.peer_certificate

1709

(session))

1710

except (TypeError,

1711

gnutls.errors.GNUTLSError) as error:

1712

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

1713

return

1714

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

1715

1716

try:

1717

client = ProxyClient(child_pipe, fpr,

2343

if gnutls.has_rawpk:

2344

fpr = b""

2345

try:

2346

key_id = self.key_id(

2347

self.peer_certificate(session))

2348

except (TypeError, gnutls.Error) as error:

2349

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

2350

return

2351

log.debug("Key ID: %s",

2352

key_id.decode("utf-8",

2353

errors="replace"))

2354

2355

else:

2356

key_id = b""

2357

try:

2358

fpr = self.fingerprint(

2359

self.peer_certificate(session))

2360

except (TypeError, gnutls.Error) as error:

2361

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

2362

return

2363

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

2364

2365

try:

2366

client = ProxyClient(child_pipe, key_id, fpr,

1718

2367

self.client_address)

1719

2368

except KeyError:

1720

2369

return

1721

2370

1722

2371

if client.approval_delay:

1723

2372

delay = client.approval_delay

1724

2373

client.approvals_pending += 1

1725

2374

approval_required = True

1726

2375

1727

2376

while True:

1728

2377

if not client.enabled:

1729

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

1730

client.name)

2378

log.info("Client %s is disabled", client.name)

1731

2379

if self.server.use_dbus:

1732

2380

# Emit D-Bus signal

1733

2381

client.Rejected("Disabled")

1734

2382

return

1735

2383

1736

2384

if client.approved or not client.approval_delay:

1737

#We are approved or approval is disabled

2385

# We are approved or approval is disabled

1738

2386

break

1739

2387

elif client.approved is None:

1740

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

1741

client.name)

2388

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

2389

client.name)

1742

2390

if self.server.use_dbus:

1743

2391

# Emit D-Bus signal

1744

2392

client.NeedApproval(

1745

2393

client.approval_delay.total_seconds()

1746

2394

* 1000, client.approved_by_default)

1747

2395

else:

1748

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

1749

client.name)

2396

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

2397

client.name)

1750

2398

if self.server.use_dbus:

1751

2399

# Emit D-Bus signal

1752

2400

client.Rejected("Denied")

1753

2401

return

1754

1755

#wait until timeout or approved

2402

2403

# wait until timeout or approved

1756

2404

time = datetime.datetime.now()

1757

2405

client.changedstate.acquire()

1758

2406

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

1760

2408

time2 = datetime.datetime.now()

1761

2409

if (time2 - time) >= delay:

1762

2410

if not client.approved_by_default:

1763

logger.warning("Client %s timed out while"

1764

" waiting for approval",

1765

client.name)

2411

log.warning("Client %s timed out while"

2412

" waiting for approval",

2413

client.name)

1766

2414

if self.server.use_dbus:

1767

2415

# Emit D-Bus signal

1768

2416

client.Rejected("Approval timed out")

1771

2419

break

1772

2420

else:

1773

2421

delay -= time2 - time

1774

1775

sent_size = 0

1776

while sent_size < len(client.secret):

1777

try:

1778

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

1779

except gnutls.errors.GNUTLSError as error:

1780

logger.warning("gnutls send failed",

1781

exc_info=error)

1782

return

1783

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

1784

sent, len(client.secret)

1785

- (sent_size + sent))

1786

sent_size += sent

1787

1788

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

2422

2423

try:

2424

session.send(client.secret)

2425

except gnutls.Error as error:

2426

log.warning("gnutls send failed", exc_info=error)

2427

return

2428

2429

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

1789

2430

# bump the timeout using extended_timeout

1790

2431

client.bump_timeout(client.extended_timeout)

1791

2432

if self.server.use_dbus:

1792

2433

# Emit D-Bus signal

1793

2434

client.GotSecret()

1794

2435

1795

2436

finally:

1796

2437

if approval_required:

1797

2438

client.approvals_pending -= 1

1798

2439

try:

1799

2440

session.bye()

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("GnuTLS bye failed",

1802

exc_info=error)

1803

2441

except gnutls.Error as error:

2442

log.warning("GnuTLS bye failed", exc_info=error)

2443

1804

2444

@staticmethod

1805

2445

def peer_certificate(session):

1806

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

1807

# If not an OpenPGP certificate...

1808

if (gnutls.library.functions

1809

.gnutls_certificate_type_get(session._c_object)

1810

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1811

# ...do the normal thing

1812

return session.peer_certificate

2446

"Return the peer's certificate as a bytestring"

2447

try:

2448

cert_type = gnutls.certificate_type_get2(

2449

session, gnutls.CTYPE_PEERS)

2450

except AttributeError:

2451

cert_type = gnutls.certificate_type_get(session)

2452

if gnutls.has_rawpk:

2453

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2454

else:

2455

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2456

# If not a valid certificate type...

2457

if cert_type not in valid_cert_types:

2458

log.info("Cert type %r not in %r", cert_type,

2459

valid_cert_types)

2460

# ...return invalid data

2461

return b""

1813

2462

list_size = ctypes.c_uint(1)

1814

cert_list = (gnutls.library.functions

1815

.gnutls_certificate_get_peers

1816

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

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1817

2465

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

1818

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

1819

" certificate")

2466

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

1820

2467

if list_size.value == 0:

1821

2468

return None

1822

2469

cert = cert_list[0]

1823

2470

return ctypes.string_at(cert.data, cert.size)

1824

2471

2472

@staticmethod

2473

def key_id(certificate):

2474

"Convert a certificate bytestring to a hexdigit key ID"

2475

# New GnuTLS "datum" with the public key

2476

datum = gnutls.datum_t(

2477

ctypes.cast(ctypes.c_char_p(certificate),

2478

ctypes.POINTER(ctypes.c_ubyte)),

2479

ctypes.c_uint(len(certificate)))

2480

# XXX all these need to be created in the gnutls "module"

2481

# New empty GnuTLS certificate

2482

pubkey = gnutls.pubkey_t()

2483

gnutls.pubkey_init(ctypes.byref(pubkey))

2484

# Import the raw public key into the certificate

2485

gnutls.pubkey_import(pubkey,

2486

ctypes.byref(datum),

2487

gnutls.X509_FMT_DER)

2488

# New buffer for the key ID

2489

buf = ctypes.create_string_buffer(32)

2490

buf_len = ctypes.c_size_t(len(buf))

2491

# Get the key ID from the raw public key into the buffer

2492

gnutls.pubkey_get_key_id(

2493

pubkey,

2494

gnutls.KEYID_USE_SHA256,

2495

ctypes.cast(ctypes.byref(buf),

2496

ctypes.POINTER(ctypes.c_ubyte)),

2497

ctypes.byref(buf_len))

2498

# Deinit the certificate

2499

gnutls.pubkey_deinit(pubkey)

2500

2501

# Convert the buffer to a Python bytestring

2502

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

2503

# Convert the bytestring to hexadecimal notation

2504

hex_key_id = binascii.hexlify(key_id).upper()

2505

return hex_key_id

2506

1825

2507

@staticmethod

1826

2508

def fingerprint(openpgp):

1827

2509

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1828

2510

# New GnuTLS "datum" with the OpenPGP public key

1829

datum = (gnutls.library.types

1830

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

1831

ctypes.POINTER

1832

(ctypes.c_ubyte)),

1833

ctypes.c_uint(len(openpgp))))

2511

datum = gnutls.datum_t(

2512

ctypes.cast(ctypes.c_char_p(openpgp),

2513

ctypes.POINTER(ctypes.c_ubyte)),

2514

ctypes.c_uint(len(openpgp)))

1834

2515

# New empty GnuTLS certificate

1835

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1836

(gnutls.library.functions

1837

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1838

2518

# Import the OpenPGP public key into the certificate

1839

(gnutls.library.functions

1840

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

1841

gnutls.library.constants

1842

.GNUTLS_OPENPGP_FMT_RAW))

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1843

2521

# Verify the self signature in the key

1844

2522

crtverify = ctypes.c_uint()

1845

(gnutls.library.functions

1846

.gnutls_openpgp_crt_verify_self(crt, 0,

1847

ctypes.byref(crtverify)))

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1848

2525

if crtverify.value != 0:

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1850

raise (gnutls.errors.CertificateSecurityError

1851

("Verify failed"))

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1852

2529

# New buffer for the fingerprint

1853

2530

buf = ctypes.create_string_buffer(20)

1854

2531

buf_len = ctypes.c_size_t()

1855

2532

# Get the fingerprint from the certificate into the buffer

1856

(gnutls.library.functions

1857

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

1858

ctypes.byref(buf_len)))

2533

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

2534

ctypes.byref(buf_len))

1859

2535

# Deinit the certificate

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2536

gnutls.openpgp_crt_deinit(crt)

1861

2537

# Convert the buffer to a Python bytestring

1862

2538

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

1863

2539

# Convert the bytestring to hexadecimal notation

1865

2541

return hex_fpr

1866

2542

1867

2543

1868

class MultiprocessingMixIn(object):

2544

class MultiprocessingMixIn:

1869

2545

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

2546

1870

2547

def sub_process_main(self, request, address):

1871

2548

try:

1872

2549

self.finish_request(request, address)

1873

2550

except Exception:

1874

2551

self.handle_error(request, address)

1875

2552

self.close_request(request)

1876

2553

1877

2554

def process_request(self, request, address):

1878

2555

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

1879

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

1880

args = (request, address))

2556

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

2557

args=(request, address))

1881

2558

proc.start()

1882

2559

return proc

1883

2560

1884

2561

1885

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1886

2563

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

2564

1887

2565

def process_request(self, request, client_address):

1888

2566

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

1889

2567

1890

2568

This function creates a new pipe in self.pipe

1891

2569

"""

1892

2570

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1893

2571

1894

2572

proc = MultiprocessingMixIn.process_request(self, request,

1895

2573

client_address)

1896

2574

self.child_pipe.close()

1897

2575

self.add_pipe(parent_pipe, proc)

1898

2576

1899

2577

def add_pipe(self, parent_pipe, proc):

1900

2578

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

1901

2579

raise NotImplementedError()

1902

2580

1903

2581

1904

2582

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1905

socketserver.TCPServer, object):

1906

"""IPv6-capable TCP server. Accepts 'None' as address and/or port

1907

2583

socketserver.TCPServer):

2584

"""IPv6-capable TCP server. Accepts None as address and/or port

2585

1908

2586

Attributes:

1909

2587

enabled: Boolean; whether this server is activated yet

1910

2588

interface: None or a network interface name (string)

1911

2589

use_ipv6: Boolean; to use IPv6 or not

1912

2590

"""

2591

1913

2592

def __init__(self, server_address, RequestHandlerClass,

1914

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

2593

interface=None,

2594

use_ipv6=True,

2595

socketfd=None):

1915

2596

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

1916

2597

creating a new one with socket.socket().

1917

2598

"""

1923

2604

self.socketfd = socketfd

1924

2605

# Save the original socket.socket() function

1925

2606

self.socket_socket = socket.socket

2607

1926

2608

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

1927

#

2609

#

1928

2610

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

1929

2611

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

1930

2612

# patching socket.socket.)

1931

#

2613

#

1932

2614

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

1933

2615

@functools.wraps(socket.socket)

1934

2616

def socket_wrapper(*args, **kwargs):

1946

2628

# socket_wrapper(), if socketfd was set.

1947

2629

socketserver.TCPServer.__init__(self, server_address,

1948

2630

RequestHandlerClass)

1949

2631

1950

2632

def server_bind(self):

1951

2633

"""This overrides the normal server_bind() function

1952

2634

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

1953

2635

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

2636

global SO_BINDTODEVICE

1954

2637

if self.interface is not None:

1955

2638

if SO_BINDTODEVICE is None:

1956

logger.error("SO_BINDTODEVICE does not exist;"

1957

" cannot bind to interface %s",

1958

self.interface)

1959

else:

1960

try:

1961

self.socket.setsockopt(socket.SOL_SOCKET,

1962

SO_BINDTODEVICE,

1963

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

1964

except socket.error as error:

1965

if error.errno == errno.EPERM:

1966

logger.error("No permission to bind to"

1967

" interface %s", self.interface)

1968

elif error.errno == errno.ENOPROTOOPT:

1969

logger.error("SO_BINDTODEVICE not available;"

1970

" cannot bind to interface %s",

1971

self.interface)

1972

elif error.errno == errno.ENODEV:

1973

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

1974

" cannot bind", self.interface)

1975

else:

1976

raise

2639

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

2640

# common enough.

2641

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

2642

SO_BINDTODEVICE = 25

2643

try:

2644

self.socket.setsockopt(

2645

socket.SOL_SOCKET, SO_BINDTODEVICE,

2646

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

2647

except socket.error as error:

2648

if error.errno == errno.EPERM:

2649

log.error("No permission to bind to interface %s",

2650

self.interface)

2651

elif error.errno == errno.ENOPROTOOPT:

2652

log.error("SO_BINDTODEVICE not available; cannot"

2653

" bind to interface %s", self.interface)

2654

elif error.errno == errno.ENODEV:

2655

log.error("Interface %s does not exist, cannot"

2656

" bind", self.interface)

2657

else:

2658

raise

1977

2659

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

1978

2660

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

1979

2663

if not self.server_address[0]:

1980

2664

if self.address_family == socket.AF_INET6:

1981

any_address = "::" # in6addr_any

2665

any_address = "::" # in6addr_any

1982

2666

else:

1983

any_address = "0.0.0.0" # INADDR_ANY

2667

any_address = "0.0.0.0" # INADDR_ANY

1984

2668

self.server_address = (any_address,

1985

2669

self.server_address[1])

1986

2670

elif not self.server_address[1]:

1987

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

1988

0)

2671

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

1989

2672

# if self.interface:

1990

2673

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

1991

2674

# 0, # port

1997

2680

1998

2681

class MandosServer(IPv6_TCPServer):

1999

2682

"""Mandos server.

2000

2683

2001

2684

Attributes:

2002

2685

clients: set of Client objects

2003

2686

gnutls_priority GnuTLS priority string

2004

2687

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

2005

2006

Assumes a gobject.MainLoop event loop.

2688

2689

Assumes a GLib.MainLoop event loop.

2007

2690

"""

2691

2008

2692

def __init__(self, server_address, RequestHandlerClass,

2009

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

2010

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

2693

interface=None,

2694

use_ipv6=True,

2695

clients=None,

2696

gnutls_priority=None,

2697

use_dbus=True,

2698

socketfd=None):

2011

2699

self.enabled = False

2012

2700

self.clients = clients

2013

2701

if self.clients is None:

2016

2704

self.gnutls_priority = gnutls_priority

2017

2705

IPv6_TCPServer.__init__(self, server_address,

2018

2706

RequestHandlerClass,

2019

interface = interface,

2020

use_ipv6 = use_ipv6,

2021

socketfd = socketfd)

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2022

2711

def server_activate(self):

2023

2712

if self.enabled:

2024

2713

return socketserver.TCPServer.server_activate(self)

2025

2714

2026

2715

def enable(self):

2027

2716

self.enabled = True

2028

2717

2029

2718

def add_pipe(self, parent_pipe, proc):

2030

2719

# Call "handle_ipc" for both data and EOF events

2031

gobject.io_add_watch(parent_pipe.fileno(),

2032

gobject.IO_IN | gobject.IO_HUP,

2033

functools.partial(self.handle_ipc,

2034

parent_pipe =

2035

parent_pipe,

2036

proc = proc))

2037

2038

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

2039

proc = None, client_object=None):

2720

GLib.io_add_watch(

2721

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2722

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2727

def handle_ipc(self, source, condition,

2728

parent_pipe=None,

2729

proc=None,

2730

client_object=None):

2040

2731

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

2041

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

2732

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

2042

2733

# Wait for other process to exit

2043

2734

proc.join()

2044

2735

return False

2045

2736

2046

2737

# Read a request from the child

2047

2738

request = parent_pipe.recv()

2048

2739

command = request[0]

2049

2050

if command == 'init':

2051

fpr = request[1]

2052

address = request[2]

2053

2054

for c in self.clients.itervalues():

2055

if c.fingerprint == fpr:

2740

2741

if command == "init":

2742

key_id = request[1].decode("ascii")

2743

fpr = request[2].decode("ascii")

2744

address = request[3]

2745

2746

for c in self.clients.values():

2747

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2748

"27AE41E4649B934CA495991B7852B855"):

2749

continue

2750

if key_id and c.key_id == key_id:

2751

client = c

2752

break

2753

if fpr and c.fingerprint == fpr:

2056

2754

client = c

2057

2755

break

2058

2756

else:

2059

logger.info("Client not found for fingerprint: %s, ad"

2060

"dress: %s", fpr, address)

2757

log.info("Client not found for key ID: %s, address:"

2758

" %s", key_id or fpr, address)

2061

2759

if self.use_dbus:

2062

2760

# Emit D-Bus signal

2063

mandos_dbus_service.ClientNotFound(fpr,

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2064

2762

address[0])

2065

2763

parent_pipe.send(False)

2066

2764

return False

2067

2068

gobject.io_add_watch(parent_pipe.fileno(),

2069

gobject.IO_IN | gobject.IO_HUP,

2070

functools.partial(self.handle_ipc,

2071

parent_pipe =

2072

parent_pipe,

2073

proc = proc,

2074

client_object =

2075

client))

2765

2766

GLib.io_add_watch(

2767

GLib.IOChannel.unix_new(parent_pipe.fileno()),

2768

GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,

2769

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2076

2773

parent_pipe.send(True)

2077

2774

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

2078

2775

# same fileno

2079

2776

return False

2080

if command == 'funcall':

2777

if command == "funcall":

2081

2778

funcname = request[1]

2082

2779

args = request[2]

2083

2780

kwargs = request[3]

2084

2085

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

2781

2782

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

2086

2783

funcname)(*args,

2087

**kwargs)))

2088

2089

if command == 'getattr':

2784

**kwargs)))

2785

2786

if command == "getattr":

2090

2787

attrname = request[1]

2091

if callable(client_object.__getattribute__(attrname)):

2092

parent_pipe.send(('function',))

2788

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2093

2791

else:

2094

parent_pipe.send(('data', client_object

2095

.__getattribute__(attrname)))

2096

2097

if command == 'setattr':

2792

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2098

2796

attrname = request[1]

2099

2797

value = request[2]

2100

2798

setattr(client_object, attrname, value)

2101

2799

2102

2800

return True

2103

2801

2104

2802

2105

2803

def rfc3339_duration_to_delta(duration):

2106

2804

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

2107

2108

>>> rfc3339_duration_to_delta("P7D")

2109

datetime.timedelta(7)

2110

>>> rfc3339_duration_to_delta("PT60S")

2111

datetime.timedelta(0, 60)

2112

>>> rfc3339_duration_to_delta("PT60M")

2113

datetime.timedelta(0, 3600)

2114

>>> rfc3339_duration_to_delta("PT24H")

2115

datetime.timedelta(1)

2116

>>> rfc3339_duration_to_delta("P1W")

2117

datetime.timedelta(7)

2118

>>> rfc3339_duration_to_delta("PT5M30S")

2119

datetime.timedelta(0, 330)

2120

>>> rfc3339_duration_to_delta("P1DT3M20S")

2121

datetime.timedelta(1, 200)

2805

2806

>>> timedelta = datetime.timedelta

2807

>>> rfc3339_duration_to_delta("P7D") == timedelta(7)

2808

True

2809

>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)

2810

True

2811

>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)

2812

True

2813

>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)

2814

True

2815

>>> rfc3339_duration_to_delta("P1W") == timedelta(7)

2816

True

2817

>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)

2818

True

2819

>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)

2820

True

2821

>>> del timedelta

2122

2822

"""

2123

2823

2124

2824

# Parsing an RFC 3339 duration with regular expressions is not

2125

2825

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

2126

2826

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

2127

2827

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

2128

2828

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

2129

2829

# avoid excessive use of external libraries.

2130

2830

2131

2831

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

2132

Token = collections.namedtuple("Token",

2133

("regexp", # To match token; if

2134

# "value" is not None,

2135

# must have a "group"

2136

# containing digits

2137

"value", # datetime.timedelta or

2138

# None

2139

"followers")) # Tokens valid after

2140

# this token

2832

Token = collections.namedtuple("Token", (

2833

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

2834

# a "group" containing digits

2835

"value", # datetime.timedelta or None

2836

"followers")) # Tokens valid after this token

2141

2837

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

2142

2838

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

2143

2839

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

2144

2840

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

2145

2841

datetime.timedelta(seconds=1),

2146

frozenset((token_end,)))

2842

frozenset((token_end, )))

2147

2843

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

2148

2844

datetime.timedelta(minutes=1),

2149

2845

frozenset((token_second, token_end)))

2165

2861

frozenset((token_month, token_end)))

2166

2862

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

2167

2863

datetime.timedelta(weeks=1),

2168

frozenset((token_end,)))

2864

frozenset((token_end, )))

2169

2865

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

2170

2866

frozenset((token_year, token_month,

2171

2867

token_day, token_time,

2172

2868

token_week)))

2173

# Define starting values

2174

value = datetime.timedelta() # Value so far

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2175

2872

found_token = None

2176

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

2177

s = duration # String left to parse

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2178

2877

# Loop until end token is found

2179

2878

while found_token is not token_end:

2180

2879

# Search for any currently valid tokens

2196

2895

break

2197

2896

else:

2198

2897

# No currently valid tokens were found

2199

raise ValueError("Invalid RFC 3339 duration")

2898

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

2899

.format(duration))

2200

2900

# End token found

2201

2901

return value

2202

2902

2203

2903

2204

2904

def string_to_delta(interval):

2205

2905

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

2206

2207

>>> string_to_delta('7d')

2208

datetime.timedelta(7)

2209

>>> string_to_delta('60s')

2210

datetime.timedelta(0, 60)

2211

>>> string_to_delta('60m')

2212

datetime.timedelta(0, 3600)

2213

>>> string_to_delta('24h')

2214

datetime.timedelta(1)

2215

>>> string_to_delta('1w')

2216

datetime.timedelta(7)

2217

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

2218

datetime.timedelta(0, 330)

2906

2907

>>> string_to_delta("7d") == datetime.timedelta(7)

2908

True

2909

>>> string_to_delta("60s") == datetime.timedelta(0, 60)

2910

True

2911

>>> string_to_delta("60m") == datetime.timedelta(0, 3600)

2912

True

2913

>>> string_to_delta("24h") == datetime.timedelta(1)

2914

True

2915

>>> string_to_delta("1w") == datetime.timedelta(7)

2916

True

2917

>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)

2918

True

2219

2919

"""

2220

2920

2221

2921

try:

2222

2922

return rfc3339_duration_to_delta(interval)

2223

2923

except ValueError:

2224

2924

pass

2225

2925

2226

2926

timevalue = datetime.timedelta(0)

2227

2927

for s in interval.split():

2228

2928

try:

2229

suffix = unicode(s[-1])

2929

suffix = s[-1]

2230

2930

value = int(s[:-1])

2231

2931

if suffix == "d":

2232

2932

delta = datetime.timedelta(value)

2239

2939

elif suffix == "w":

2240

2940

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

2241

2941

else:

2242

raise ValueError("Unknown suffix {!r}"

2243

.format(suffix))

2942

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

2244

2943

except IndexError as e:

2245

2944

raise ValueError(*(e.args))

2246

2945

timevalue += delta

2247

2946

return timevalue

2248

2947

2249

2948

2250

def daemon(nochdir = False, noclose = False):

2949

def daemon(nochdir=False, noclose=False):

2251

2950

"""See daemon(3). Standard BSD Unix function.

2252

2951

2253

2952

This should really exist as os.daemon, but it doesn't (yet)."""

2254

2953

if os.fork():

2255

2954

sys.exit()

2262

2961

# Close all standard open file descriptors

2263

2962

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

2264

2963

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

2265

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

2964

raise OSError(errno.ENODEV,

2965

"{} not a character device"

2266

2966

.format(os.devnull))

2267

2967

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

2268

2968

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

2272

2972

2273

2973

2274

2974

def main():

2275

2975

2276

2976

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

2277

2977

# Parsing of options, both command line and config file

2278

2978

2279

2979

parser = argparse.ArgumentParser()

2280

2980

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

2281

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

2981

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

2282

2982

help="show version number and exit")

2283

2983

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

2284

2984

help="Bind to interface IF")

2320

3020

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

2321

3021

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

2322

3022

default=None)

2323

3023

2324

3024

options = parser.parse_args()

2325

2326

if options.check:

2327

import doctest

2328

fail_count, test_count = doctest.testmod()

2329

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

2330

3025

2331

3026

# Default values for config file for server-global settings

2332

server_defaults = { "interface": "",

2333

"address": "",

2334

"port": "",

2335

"debug": "False",

2336

"priority":

2337

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

2338

"servicename": "Mandos",

2339

"use_dbus": "True",

2340

"use_ipv6": "True",

2341

"debuglevel": "",

2342

"restore": "True",

2343

"socket": "",

2344

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

2345

"foreground": "False",

2346

"zeroconf": "True",

2347

}

2348

3027

if gnutls.has_rawpk:

3028

priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"

3029

":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")

3030

else:

3031

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

3032

":+SIGN-DSA-SHA256")

3033

server_defaults = {"interface": "",

3034

"address": "",

3035

"port": "",

3036

"debug": "False",

3037

"priority": priority,

3038

"servicename": "Mandos",

3039

"use_dbus": "True",

3040

"use_ipv6": "True",

3041

"debuglevel": "",

3042

"restore": "True",

3043

"socket": "",

3044

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

3045

"foreground": "False",

3046

"zeroconf": "True",

3047

}

3048

del priority

3049

2349

3050

# Parse config file for server-global settings

2350

server_config = configparser.SafeConfigParser(server_defaults)

3051

server_config = configparser.ConfigParser(server_defaults)

2351

3052

del server_defaults

2352

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

2353

"mandos.conf"))

2354

# Convert the SafeConfigParser object to a dict

3053

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

3054

# Convert the ConfigParser object to a dict

2355

3055

server_settings = server_config.defaults()

2356

3056

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

2357

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

3057

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

3058

"foreground", "zeroconf"):

2358

3059

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

2359

3060

option)

2360

3061

if server_settings["port"]:

2370

3071

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

2371

3072

["socket"])

2372

3073

del server_config

2373

3074

2374

3075

# Override the settings from the config file with command line

2375

3076

# options, if set.

2376

3077

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

2377

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

2378

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

2379

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

3078

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

3079

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

3080

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

2380

3081

value = getattr(options, option)

2381

3082

if value is not None:

2382

3083

server_settings[option] = value

2383

3084

del options

2384

3085

# Force all strings to be unicode

2385

3086

for option in server_settings.keys():

2386

if type(server_settings[option]) is str:

2387

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

3087

if isinstance(server_settings[option], bytes):

3088

server_settings[option] = (server_settings[option]

3089

.decode("utf-8"))

2388

3090

# Force all boolean options to be boolean

2389

3091

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

2390

3092

"foreground", "zeroconf"):

2393

3095

if server_settings["debug"]:

2394

3096

server_settings["foreground"] = True

2395

3097

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

2396

3098

2397

3099

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

2398

2399

if (not server_settings["zeroconf"] and

2400

not (server_settings["port"]

2401

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

2402

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

2403

" Zeroconf")

2404

3100

3101

if (not server_settings["zeroconf"]

3102

and not (server_settings["port"]

3103

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

3104

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

3105

2405

3106

# For convenience

2406

3107

debug = server_settings["debug"]

2407

3108

debuglevel = server_settings["debuglevel"]

2411

3112

stored_state_file)

2412

3113

foreground = server_settings["foreground"]

2413

3114

zeroconf = server_settings["zeroconf"]

2414

3115

2415

3116

if debug:

2416

3117

initlogger(debug, logging.DEBUG)

2417

3118

else:

2420

3121

else:

2421

3122

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

2422

3123

initlogger(debug, level)

2423

3124

2424

3125

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

2425

syslogger.setFormatter(logging.Formatter

2426

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

2427

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

2428

.format(server_settings

2429

["servicename"])))

2430

3126

syslogger.setFormatter(

3127

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

3128

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

3129

server_settings["servicename"])))

3130

2431

3131

# Parse config file with clients

2432

client_config = configparser.SafeConfigParser(Client

2433

.client_defaults)

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2434

3133

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

2435

3134

"clients.conf"))

2436

3135

2437

3136

global mandos_dbus_service

2438

3137

mandos_dbus_service = None

2439

3138

2440

3139

socketfd = None

2441

3140

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

2442

3141

socketfd = server_settings["socket"]

2443

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

2444

server_settings["port"]),

2445

ClientHandler,

2446

interface=(server_settings["interface"]

2447

or None),

2448

use_ipv6=use_ipv6,

2449

gnutls_priority=

2450

server_settings["priority"],

2451

use_dbus=use_dbus,

2452

socketfd=socketfd)

3142

tcp_server = MandosServer(

3143

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

3144

ClientHandler,

3145

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

3146

use_ipv6=use_ipv6,

3147

gnutls_priority=server_settings["priority"],

3148

use_dbus=use_dbus,

3149

socketfd=socketfd)

2453

3150

if not foreground:

2454

3151

pidfilename = "/run/mandos.pid"

2455

3152

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

2456

3153

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

2457

3154

pidfile = None

2458

3155

try:

2459

pidfile = open(pidfilename, "w")

3156

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

2460

3157

except IOError as e:

2461

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

2462

exc_info=e)

2463

2464

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

3158

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

3159

exc_info=e)

3160

3161

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

3162

("mandos", "mandos"),

3163

("nobody", "nogroup")):

2465

3164

try:

2466

3165

uid = pwd.getpwnam(name).pw_uid

2467

gid = pwd.getpwnam(name).pw_gid

3166

gid = pwd.getpwnam(group).pw_gid

2468

3167

break

2469

3168

except KeyError:

2470

3169

continue

2474

3173

try:

2475

3174

os.setgid(gid)

2476

3175

os.setuid(uid)

3176

log.debug("Did setuid/setgid to %s:%s", uid, gid)

2477

3177

except OSError as error:

3178

log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,

3179

os.strerror(error.errno))

2478

3180

if error.errno != errno.EPERM:

2479

3181

raise

2480

3182

2481

3183

if debug:

2482

3184

# Enable all possible GnuTLS debugging

2483

3185

2484

3186

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

2485

3187

# - GnuTLS manual

2486

gnutls.library.functions.gnutls_global_set_log_level(11)

2487

2488

@gnutls.library.types.gnutls_log_func

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2489

3191

def debug_gnutls(level, string):

2490

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

2491

2492

(gnutls.library.functions

2493

.gnutls_global_set_log_function(debug_gnutls))

2494

3192

log.debug("GnuTLS: %s",

3193

string[:-1].decode("utf-8", errors="replace"))

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2495

3197

# Redirect stdin so all checkers get /dev/null

2496

3198

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

2497

3199

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

2498

3200

if null > 2:

2499

3201

os.close(null)

2500

3202

2501

3203

# Need to fork before connecting to D-Bus

2502

3204

if not foreground:

2503

3205

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

2504

3206

daemon()

2505

2506

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

2507

# need to inform gobject that threads will be used.

2508

gobject.threads_init()

2509

3207

3208

if gi.version_info < (3, 10, 2):

3209

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

3210

# need to inform GLib that threads will be used.

3211

GLib.threads_init()

3212

2510

3213

global main_loop

2511

3214

# From the Avahi example code

2512

3215

DBusGMainLoop(set_as_default=True)

2513

main_loop = gobject.MainLoop()

3216

main_loop = GLib.MainLoop()

2514

3217

bus = dbus.SystemBus()

2515

3218

# End of Avahi example code

2516

3219

if use_dbus:

2517

3220

try:

2518

3221

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

2519

bus, do_not_queue=True)

2520

old_bus_name = (dbus.service.BusName

2521

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

2522

do_not_queue=True))

2523

except dbus.exceptions.NameExistsException as e:

2524

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

3222

bus,

3223

do_not_queue=True)

3224

old_bus_name = dbus.service.BusName(

3225

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

3226

do_not_queue=True)

3227

except dbus.exceptions.DBusException as e:

3228

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

2525

3229

use_dbus = False

2526

3230

server_settings["use_dbus"] = False

2527

3231

tcp_server.use_dbus = False

2528

3232

if zeroconf:

2529

3233

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2530

service = AvahiServiceToSyslog(name =

2531

server_settings["servicename"],

2532

servicetype = "_mandos._tcp",

2533

protocol = protocol, bus = bus)

3234

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

2534

3239

if server_settings["interface"]:

2535

service.interface = (if_nametoindex

2536

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

2537

3240

service.interface = if_nametoindex(

3241

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

3242

2538

3243

global multiprocessing_manager

2539

3244

multiprocessing_manager = multiprocessing.Manager()

2540

3245

2541

3246

client_class = Client

2542

3247

if use_dbus:

2543

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

2544

3248

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

3249

2545

3250

client_settings = Client.config_parser(client_config)

2546

3251

old_client_settings = {}

2547

3252

clients_data = {}

2548

3253

2549

3254

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

2550

3255

global wnull

2551

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

3256

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

2552

3257

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

2553

3258

# mode

2554

3259

if debug or not foreground:

2555

3260

wnull.close()

2556

3261

2557

3262

# Get client data and settings from last running state.

2558

3263

if server_settings["restore"]:

2559

3264

try:

2560

3265

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

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3266

if sys.version_info.major == 2:

3267

clients_data, old_client_settings = pickle.load(

3268

stored_state)

3269

else:

3270

bytes_clients_data, bytes_old_client_settings = (

3271

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

3272

# Fix bytes to strings

3273

# clients_data

3274

# .keys()

3275

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

3276

if isinstance(key, bytes)

3277

else key): value

3278

for key, value in

3279

bytes_clients_data.items()}

3280

del bytes_clients_data

3281

for key in clients_data:

3282

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

3283

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

3284

for k, v in

3285

clients_data[key].items()}

3286

clients_data[key] = value

3287

# .client_structure

3288

value["client_structure"] = [

3289

(s.decode("utf-8")

3290

if isinstance(s, bytes)

3291

else s) for s in

3292

value["client_structure"]]

3293

# .name, .host, and .checker_command

3294

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

3295

if isinstance(value[k], bytes):

3296

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

3297

if "key_id" not in value:

3298

value["key_id"] = ""

3299

elif "fingerprint" not in value:

3300

value["fingerprint"] = ""

3301

# old_client_settings

3302

# .keys()

3303

old_client_settings = {

3304

(key.decode("utf-8")

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_old_client_settings.items()}

3309

del bytes_old_client_settings

3310

# .host and .checker_command

3311

for value in old_client_settings.values():

3312

for attribute in ("host", "checker_command"):

3313

if isinstance(value[attribute], bytes):

3314

value[attribute] = (value[attribute]

3315

.decode("utf-8"))

2563

3316

os.remove(stored_state_path)

2564

3317

except IOError as e:

2565

3318

if e.errno == errno.ENOENT:

2566

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

2567

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

3319

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

3320

" %s", os.strerror(e.errno))

2568

3321

else:

2569

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

2570

exc_info=e)

3322

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

3323

exc_info=e)

2571

3324

raise

2572

3325

except EOFError as e:

2573

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

2574

"EOFError:", exc_info=e)

2575

3326

log.warning("Could not load persistent state: EOFError:",

3327

exc_info=e)

3328

2576

3329

with PGPEngine() as pgp:

2577

3330

for client_name, client in clients_data.items():

2578

3331

# Skip removed clients

2579

3332

if client_name not in client_settings:

2580

3333

continue

2581

3334

2582

3335

# Decide which value to use after restoring saved state.

2583

3336

# We have three different values: Old config file,

2584

3337

# new config file, and saved state.

2589

3342

# For each value in new config, check if it

2590

3343

# differs from the old config value (Except for

2591

3344

# the "secret" attribute)

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3345

if (name != "secret"

3346

and (value !=

3347

old_client_settings[client_name][name])):

2595

3348

client[name] = value

2596

3349

except KeyError:

2597

3350

pass

2598

3351

2599

3352

# Clients who has passed its expire date can still be

2600

# enabled if its last checker was successful. Clients

3353

# enabled if its last checker was successful. A Client

2601

3354

# whose checker succeeded before we stored its state is

2602

3355

# assumed to have successfully run all checkers during

2603

3356

# downtime.

2604

3357

if client["enabled"]:

2605

3358

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

2606

3359

if not client["last_checked_ok"]:

2607

logger.warning(

2608

"disabling client {} - Client never "

2609

"performed a successful checker"

2610

.format(client_name))

3360

log.warning("disabling client %s - Client"

3361

" never performed a successful"

3362

" checker", client_name)

2611

3363

client["enabled"] = False

2612

3364

elif client["last_checker_status"] != 0:

2613

logger.warning(

2614

"disabling client {} - Client last"

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3365

log.warning("disabling client %s - Client"

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2618

3369

client["enabled"] = False

2619

3370

else:

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

2623

logger.debug("Last checker succeeded,"

2624

" keeping {} enabled"

2625

.format(client_name))

3371

client["expires"] = (

3372

datetime.datetime.utcnow()

3373

+ client["timeout"])

3374

log.debug("Last checker succeeded, keeping %s"

3375

" enabled", client_name)

2626

3376

try:

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3377

client["secret"] = pgp.decrypt(

3378

client["encrypted_secret"],

3379

client_settings[client_name]["secret"])

2631

3380

except PGPError:

2632

3381

# If decryption fails, we use secret from new settings

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3382

log.debug("Failed to decrypt %s old secret",

3383

client_name)

3384

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

3385

["secret"])

3386

2638

3387

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

2639

3388

for client_name in (set(old_client_settings)

2640

3389

- set(client_settings)):

2642

3391

for client_name in (set(client_settings)

2643

3392

- set(old_client_settings)):

2644

3393

clients_data[client_name] = client_settings[client_name]

2645

3394

2646

3395

# Create all client objects

2647

3396

for client_name, client in clients_data.items():

2648

3397

tcp_server.clients[client_name] = client_class(

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2652

3402

if not tcp_server.clients:

2653

logger.warning("No clients defined")

2654

3403

log.warning("No clients defined")

3404

2655

3405

if not foreground:

2656

3406

if pidfile is not None:

3407

pid = os.getpid()

2657

3408

try:

2658

3409

with pidfile:

2659

pid = os.getpid()

2660

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

3410

print(pid, file=pidfile)

2661

3411

except IOError:

2662

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

2663

pidfilename, pid)

3412

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

3413

pidfilename, pid)

2664

3414

del pidfile

2665

3415

del pidfilename

2666

2667

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

2668

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

2669

3416

3417

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

3418

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3419

lambda: main_loop.quit() and False)

3420

2670

3421

if use_dbus:

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3422

3423

@alternate_dbus_interfaces(

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2674

3426

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

3427

2675

3428

def __init__(self):

2676

3429

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

3430

2677

3431

_interface = "se.recompile.Mandos"

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3432

2685

3433

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

2686

3434

def ClientAdded(self, objpath):

2687

3435

"D-Bus signal"

2688

3436

pass

2689

3437

2690

3438

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

2691

def ClientNotFound(self, fingerprint, address):

3439

def ClientNotFound(self, key_id, address):

2692

3440

"D-Bus signal"

2693

3441

pass

2694

3442

3443

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

3444

"true"})

2695

3445

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

2696

3446

def ClientRemoved(self, objpath, name):

2697

3447

"D-Bus signal"

2698

3448

pass

2699

3449

3450

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

3451

"true"})

2700

3452

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

2701

3453

def GetAllClients(self):

2702

3454

"D-Bus method"

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3455

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2707

3460

@dbus.service.method(_interface,

2708

3461

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

2709

3462

def GetAllClientsWithProperties(self):

2710

3463

"D-Bus method"

2711

3464

return dbus.Dictionary(

2712

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

2713

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

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2714

3468

signature="oa{sv}")

2715

3469

2716

3470

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

2717

3471

def RemoveClient(self, object_path):

2718

3472

"D-Bus method"

2719

for c in tcp_server.clients.itervalues():

3473

for c in tcp_server.clients.values():

2720

3474

if c.dbus_object_path == object_path:

2721

3475

del tcp_server.clients[c.name]

2722

3476

c.remove_from_connection()

2723

# Don't signal anything except ClientRemoved

3477

# Don't signal the disabling

2724

3478

c.disable(quiet=True)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2727

3481

return

2728

3482

raise KeyError(object_path)

2729

3483

2730

3484

del _interface

2731

3485

3486

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3488

def GetManagedObjects(self):

3489

"""D-Bus method"""

3490

return dbus.Dictionary(

3491

{client.dbus_object_path:

3492

dbus.Dictionary(

3493

{interface: client.GetAll(interface)

3494

for interface in

3495

client._get_all_interface_names()})

3496

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

3497

3498

def client_added_signal(self, client):

3499

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

3500

if use_dbus:

3501

# New standard signal

3502

self.InterfacesAdded(

3503

client.dbus_object_path,

3504

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3508

# Old signal

3509

self.ClientAdded(client.dbus_object_path)

3510

3511

def client_removed_signal(self, client):

3512

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

3513

if use_dbus:

3514

# New standard signal

3515

self.InterfacesRemoved(

3516

client.dbus_object_path,

3517

client._get_all_interface_names())

3518

# Old signal

3519

self.ClientRemoved(client.dbus_object_path,

3520

client.name)

3521

2732

3522

mandos_dbus_service = MandosDBusService()

2733

3523

3524

# Save modules to variables to exempt the modules from being

3525

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

3526

mp = multiprocessing

3527

wn = wnull

3528

2734

3529

def cleanup():

2735

3530

"Cleanup function; run on exit"

2736

3531

if zeroconf:

2737

3532

service.cleanup()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3533

3534

mp.active_children()

3535

wn.close()

2741

3536

if not (tcp_server.clients or client_settings):

2742

3537

return

2743

3538

2744

3539

# Store client before exiting. Secrets are encrypted with key

2745

3540

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

2746

3541

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

2747

3542

clients = {}

2748

3543

with PGPEngine() as pgp:

2749

for client in tcp_server.clients.itervalues():

3544

for client in tcp_server.clients.values():

2750

3545

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

2751

3546

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

2752

3547

key)

2753

3548

client_dict = {}

2754

3549

2755

3550

# A list of attributes that can not be pickled

2756

3551

# + secret.

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3552

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

3553

"checker", "server_settings"}

3554

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

3555

.Object):

2761

3556

exclude.add(name)

2762

3557

2763

3558

client_dict["encrypted_secret"] = (client

2764

3559

.encrypted_secret)

2765

3560

for attr in client.client_structure:

2766

3561

if attr not in exclude:

2767

3562

client_dict[attr] = getattr(client, attr)

2768

3563

2769

3564

clients[client.name] = client_dict

2770

3565

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

2771

3566

2772

3567

try:

2773

with (tempfile.NamedTemporaryFile

2774

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

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3568

with tempfile.NamedTemporaryFile(

3569

mode="wb",

3570

suffix=".pickle",

3571

prefix="clients-",

3572

dir=os.path.dirname(stored_state_path),

3573

delete=False) as stored_state:

3574

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

3575

protocol=2)

3576

tempname = stored_state.name

2779

3577

os.rename(tempname, stored_state_path)

2780

3578

except (IOError, OSError) as e:

2781

3579

if not debug:

2784

3582

except NameError:

2785

3583

pass

2786

3584

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

2787

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

2788

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

3585

log.warning("Could not save persistent state: %s",

3586

os.strerror(e.errno))

2789

3587

else:

2790

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

2791

exc_info=e)

3588

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

3589

exc_info=e)

2792

3590

raise

2793

3591

2794

3592

# Delete all clients, and settings from config

2795

3593

while tcp_server.clients:

2796

3594

name, client = tcp_server.clients.popitem()

2797

3595

if use_dbus:

2798

3596

client.remove_from_connection()

2799

# Don't signal anything except ClientRemoved

3597

# Don't signal the disabling

2800

3598

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

2801

3600

if use_dbus:

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3601

mandos_dbus_service.client_removed_signal(client)

2806

3602

client_settings.clear()

2807

3603

2808

3604

atexit.register(cleanup)

2809

2810

for client in tcp_server.clients.itervalues():

3605

3606

for client in tcp_server.clients.values():

2811

3607

if use_dbus:

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2814

3610

# Need to initiate checking of clients

2815

3611

if client.enabled:

2816

3612

client.init_checker()

2817

3613

2818

3614

tcp_server.enable()

2819

3615

tcp_server.server_activate()

2820

3616

2821

3617

# Find out what port we got

2822

3618

if zeroconf:

2823

3619

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

2824

3620

if use_ipv6:

2825

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

2826

" flowinfo %d, scope_id %d",

2827

*tcp_server.socket.getsockname())

3621

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

3622

" scope_id %d", *tcp_server.socket.getsockname())

2828

3623

else: # IPv4

2829

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

2830

*tcp_server.socket.getsockname())

2831

2832

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

2833

3624

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

3625

*tcp_server.socket.getsockname())

3626

3627

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

3628

2834

3629

try:

2835

3630

if zeroconf:

2836

3631

# From the Avahi example code

2837

3632

try:

2838

3633

service.activate()

2839

3634

except dbus.exceptions.DBusException as error:

2840

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

3635

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

2841

3636

cleanup()

2842

3637

sys.exit(1)

2843

3638

# End of Avahi example code

2844

2845

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

2846

lambda *args, **kwargs:

2847

(tcp_server.handle_request

2848

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

2849

2850

logger.debug("Starting main loop")

3639

3640

GLib.io_add_watch(

3641

GLib.IOChannel.unix_new(tcp_server.fileno()),

3642

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3643

lambda *args, **kwargs: (tcp_server.handle_request

3644

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

3645

3646

log.debug("Starting main loop")

2851

3647

main_loop.run()

2852

3648

except AvahiError as error:

2853

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

3649

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

2854

3650

cleanup()

2855

3651

sys.exit(1)

2856

3652

except KeyboardInterrupt:

2857

3653

if debug:

2858

3654

print("", file=sys.stderr)

2859

logger.debug("Server received KeyboardInterrupt")

2860

logger.debug("Server exiting")

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2861

3657

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

2862

3658

cleanup()

2863

3659

2864

if __name__ == '__main__':

2865

main()

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

parser.add_argument("--check", action="store_true")

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

if not (unittest.main(argv=[""], exit=False)

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

# Call using ./scriptname --test [--verbose]

3690

unittest.main(argv=[""], testLoader=ExtraTestLoader())

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

# (if (not (funcall run-tests-in-test-buffer default-directory

3702

# extra))

3703

# (funcall show-test-buffer-in-test-window)

3704

# (funcall remove-test-window)

3705

# (if extra (message "Extra tests run successfully!"))))

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

# (with-current-buffer (get-buffer-create "*Test*")

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

# (let ((process-result

3714

# (let ((inhibit-read-only t))

3715

# (process-file-shell-command

3716

# (funcall get-command-line extra) nil "*Test*"))))

3717

# (and (numberp process-result)

3718

# (= process-result 0))))

3719

# get-command-line:

3720

# (lambda (&optional extra)

3721

# (let ((quoted-script

3722

# (shell-quote-argument (funcall get-script-name))))

3723

# (format

3724

# (concat "%s --check" (if extra " --prefix=atest" ""))

3725

# quoted-script)))

3726

# get-script-name:

3727

# (lambda ()

3728

# (if (fboundp 'file-local-name)

3729

# (file-local-name (buffer-file-name))

3730

# (or (file-remote-p (buffer-file-name) 'localname)

3731

# (buffer-file-name))))

3732

# remove-test-window:

3733

# (lambda ()

3734

# (let ((test-window (get-buffer-window "*Test*")))

3735

# (if test-window (delete-window test-window))))

3736

# show-test-buffer-in-test-window:

3737

# (lambda ()

3738

# (when (not (get-buffer-window-list "*Test*"))

3739

# (setq next-error-last-buffer (get-buffer "*Test*"))

3740

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3741

# (display-buffer-overriding-action

3742

# `((display-buffer-in-side-window) (side . ,side)

3743

# (window-height . fit-window-to-buffer)

3744

# (window-width . fit-window-to-buffer))))

3745

# (display-buffer "*Test*"))))

3746

# eval:

3747

# (progn

3748

# (let* ((run-extra-tests (lambda () (interactive)

3749

# (funcall run-tests t)))

3750

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3751

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3752

# (setq minor-mode-overriding-map-alist

3753

# (cons `(run-tests . ,outer-keymap)

3754

# minor-mode-overriding-map-alist)))

3755

# (add-hook 'after-save-hook run-tests 90 t))

3756

# End: