/mandos/release : revision 237.7.278

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

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:

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

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.16"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.8"

147

95

stored_state_file = "clients.pickle"

148

96

149

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

150

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

97

logger = logging.getLogger()

151

98

syslogger = None

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

165

112

return interface_index

166

113

167

114

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

184

115

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

185

116

"""init logger and add loglevel"""

186

117

187

118

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

191

123

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

124

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

125

' %(message)s'))

126

logger.addHandler(syslogger)

127

196

128

if debug:

197

129

console = logging.StreamHandler()

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)

130

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

131

' [%(process)d]:'

132

' %(levelname)s:'

133

' %(message)s'))

134

logger.addHandler(console)

135

logger.setLevel(level)

204

136

205

137

206

138

class PGPError(Exception):

208

140

pass

209

141

210

142

211

class PGPEngine:

143

class PGPEngine(object):

212

144

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

213

214

145

def __init__(self):

215

146

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

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

147

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

149

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

235

153

def __enter__(self):

236

154

return self

237

155

238

156

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

239

157

self._cleanup()

240

158

return False

241

159

242

160

def __del__(self):

243

161

self._cleanup()

244

162

245

163

def _cleanup(self):

246

164

if self.tempdir is not None:

247

165

# Delete contents of tempdir

248

166

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

249

topdown=False):

167

topdown = False):

250

168

for filename in files:

251

169

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

252

170

for dirname in dirs:

254

172

# Remove tempdir

255

173

os.rmdir(self.tempdir)

256

174

self.tempdir = None

257

175

258

176

def password_encode(self, password):

259

177

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

260

178

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

265

183

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

266

184

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

267

185

return encoded

268

186

269

187

def encrypt(self, data, password):

270

188

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

273

191

passfile.write(passphrase)

274

192

passfile.flush()

275

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

276

"--passphrase-file",

193

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

194

'--passphrase-file',

277

195

passfile.name]

278

196

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

283

201

if proc.returncode != 0:

284

202

raise PGPError(err)

285

203

return ciphertext

286

204

287

205

def decrypt(self, data, password):

288

206

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

291

209

passfile.write(passphrase)

292

210

passfile.flush()

293

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

294

"--passphrase-file",

211

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

212

'--passphrase-file',

295

213

passfile.name]

296

214

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

301

220

if proc.returncode != 0:

302

221

raise PGPError(err)

303

222

return decrypted_plaintext

304

223

305

224

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

332

225

class AvahiError(Exception):

333

226

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

334

227

self.value = value

335

228

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

336

229

**kwargs)

337

230

338

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

353

354

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

244

245

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

355

246

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

356

247

port: integer; what port to announce

357

248

TXT: list of strings; TXT record for the service

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

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

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

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

277

278

def rename(self):

395

279

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

396

280

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

281

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

282

" after %i retries, exiting.",

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

287

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

288

self.name)

289

self.remove()

290

try:

291

self.add()

292

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

403

296

self.rename_count += 1

404

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

405

self.name)

406

if remove:

407

self.remove()

408

try:

409

self.add()

410

except dbus.exceptions.DBusException as error:

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

297

420

298

def remove(self):

421

299

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

422

300

if self.entry_group_state_changed_match is not None:

424

302

self.entry_group_state_changed_match = None

425

303

if self.group is not None:

426

304

self.group.Reset()

427

305

428

306

def add(self):

429

307

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

430

308

self.remove()

435

313

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

314

self.entry_group_state_changed_match = (

437

315

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

316

'StateChanged', self.entry_group_state_changed))

317

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

318

self.name, self.type)

441

319

self.group.AddService(

442

320

self.interface,

443

321

self.protocol,

447

325

dbus.UInt16(self.port),

448

326

avahi.string_array_to_txt_array(self.TXT))

449

327

self.group.Commit()

450

328

451

329

def entry_group_state_changed(self, state, error):

452

330

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

453

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

454

331

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

332

455

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

334

logger.debug("Zeroconf service established.")

457

335

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

336

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

459

337

self.rename()

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

463

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

464

339

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

340

str(error))

341

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

342

.format(error))

343

465

344

def cleanup(self):

466

345

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

467

346

if self.group is not None:

472

351

pass

473

352

self.group = None

474

353

self.remove()

475

354

476

355

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

477

356

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

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

}

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

485

365

if state in bad_states:

486

366

if bad_states[state] is not None:

487

367

if error is None:

488

log.error(bad_states[state])

368

logger.error(bad_states[state])

489

369

else:

490

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

370

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

491

371

self.cleanup()

492

372

elif state == avahi.SERVER_RUNNING:

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)

373

self.add()

504

374

else:

505

375

if error is None:

506

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

376

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

507

377

else:

508

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

509

378

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

379

510

380

def activate(self):

511

381

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

512

382

if self.server is None:

516

386

follow_name_owner_changes=True),

517

387

avahi.DBUS_INTERFACE_SERVER)

518

388

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

389

self.server_state_changed)

520

390

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

521

391

522

392

523

393

class AvahiServiceToSyslog(AvahiService):

524

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

394

def rename(self):

525

395

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

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

531

401

return ret

532

402

533

403

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:

404

class Client(object):

875

405

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

876

406

877

407

Attributes:

878

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

408

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

879

409

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

880

410

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

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

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

885

415

checker_command: string; External command which is run to check

886

416

if client lives. %() expansions are done at

887

417

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

888

418

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

889

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

890

420

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

891

421

client_structure: Object describing what attributes a client has

892

422

and is used for storing the client at exit

893

423

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

895

425

enabled: bool()

896

426

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

427

uniquely identify the client

900

428

host: string; available for use by the checker command

901

429

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

902

430

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

904

432

last_checker_status: integer between 0 and 255 reflecting exit

905

433

status of last checker. -1 reflects crashed

906

434

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

909

435

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

910

436

911

437

D-Bus identifiers

918

444

disabled, or None

919

445

server_settings: The server_settings dict from main()

920

446

"""

921

447

922

448

runtime_expansions = ("approval_delay", "approval_duration",

923

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

449

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

924

450

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

925

451

"last_approval_request", "last_checked_ok",

926

452

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

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

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

939

464

@staticmethod

940

465

def config_parser(config):

941

466

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

948

473

for client_name in config.sections():

949

474

section = dict(config.items(client_name))

950

475

client = settings[client_name] = {}

951

476

952

477

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

953

478

# Reformat values from string types to Python types

954

479

client["approved_by_default"] = config.getboolean(

955

480

client_name, "approved_by_default")

956

481

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

957

482

"enabled")

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

964

client["fingerprint"] = (section.get("fingerprint",

965

"").upper()

483

484

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

966

485

.replace(" ", ""))

967

if not (client["key_id"] or client["fingerprint"]):

968

log.error("Skipping client %s without key_id or"

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

972

486

if "secret" in section:

973

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

974

.encode("utf-8"),

975

"base64")

487

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

976

488

elif "secfile" in section:

977

489

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

978

490

(section["secfile"])),

993

505

client["last_approval_request"] = None

994

506

client["last_checked_ok"] = None

995

507

client["last_checker_status"] = -2

996

508

997

509

return settings

998

999

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

510

511

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

1000

512

self.name = name

1001

513

if server_settings is None:

1002

514

server_settings = {}

1004

516

# adding all client settings

1005

517

for setting, value in settings.items():

1006

518

setattr(self, setting, value)

1007

519

1008

520

if self.enabled:

1009

521

if not hasattr(self, "last_enabled"):

1010

522

self.last_enabled = datetime.datetime.utcnow()

1014

526

else:

1015

527

self.last_enabled = None

1016

528

self.expires = None

1017

1018

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

1019

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

1020

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

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)

1021

535

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

1022

536

datetime.datetime.utcnow())

1023

537

1024

538

# attributes specific for this server instance

1025

539

self.checker = None

1026

540

self.checker_initiator_tag = None

1029

543

self.current_checker_command = None

1030

544

self.approved = None

1031

545

self.approvals_pending = 0

1032

self.changedstate = multiprocessing_manager.Condition(

1033

multiprocessing_manager.Lock())

1034

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

1036

551

if not attr.startswith("_")]

1037

552

self.client_structure.append("client_structure")

1038

1039

for name, t in inspect.getmembers(

1040

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

1041

558

if not name.startswith("_"):

1042

559

self.client_structure.append(name)

1043

560

1044

561

# Send notice to process children that client state has changed

1045

562

def send_changedstate(self):

1046

563

with self.changedstate:

1047

564

self.changedstate.notify_all()

1048

565

1049

566

def enable(self):

1050

567

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

1051

568

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

1052

569

# Already enabled

1053

570

return

571

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

1054

572

self.enabled = True

1055

573

self.last_enabled = datetime.datetime.utcnow()

1056

574

self.init_checker()

1057

575

self.send_changedstate()

1058

576

1059

577

def disable(self, quiet=True):

1060

578

"""Disable this client."""

1061

579

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

1062

580

return False

1063

581

if not quiet:

1064

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

582

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

1065

583

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

1066

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1067

585

self.disable_initiator_tag = None

1068

586

self.expires = None

1069

587

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

1070

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1071

589

self.checker_initiator_tag = None

1072

590

self.stop_checker()

1073

591

self.enabled = False

1074

592

if not quiet:

1075

593

self.send_changedstate()

1076

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

594

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

1077

595

return False

1078

596

1079

597

def __del__(self):

1080

598

self.disable()

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

# time (a fraction of 'interval') from now. This spreads out

1085

# the startup of checkers over time when the server is

1086

# started.

599

600

def init_checker(self):

601

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

602

# and every interval from then on.

1087

603

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

delay = datetime.timedelta(0, 0, 0, delay_milliseconds)

1099

# A checker might take up to an 'interval' of time, so we can

1100

# expire at the soonest one interval after a checker was

1101

# started. Since the initial checker is delayed, the expire

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

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

609

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

1106

610

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

1112

def checker_callback(self, source, condition, connection,

1113

command):

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

616

# Also start a new checker *right now*.

617

self.start_checker()

618

619

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

1114

620

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

1115

# Read return code from connection (see call_pipe)

1116

returncode = connection.recv()

1117

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

621

self.checker_callback_tag = None

1121

622

self.checker = None

1122

1123

if returncode >= 0:

1124

self.last_checker_status = returncode

1125

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1126

625

if self.last_checker_status == 0:

1127

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

626

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

627

vars(self))

1128

628

self.checked_ok()

1129

629

else:

1130

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

630

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

631

vars(self))

1131

632

else:

1132

633

self.last_checker_status = -1

1133

self.last_checker_signal = -returncode

1134

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

1135

return False

1136

634

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

635

vars(self))

636

1137

637

def checked_ok(self):

1138

638

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

1139

639

self.last_checked_ok = datetime.datetime.utcnow()

1140

640

self.last_checker_status = 0

1141

self.last_checker_signal = None

1142

641

self.bump_timeout()

1143

642

1144

643

def bump_timeout(self, timeout=None):

1145

644

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

1146

645

if timeout is None:

1147

646

timeout = self.timeout

1148

647

if self.disable_initiator_tag is not None:

1149

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1150

649

self.disable_initiator_tag = None

1151

650

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

1152

self.disable_initiator_tag = GLib.timeout_add(

1153

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1154

654

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

1155

655

1156

656

def need_approval(self):

1157

657

self.last_approval_request = datetime.datetime.utcnow()

1158

1159

def start_checker(self, start_was_randomized=False):

658

659

def start_checker(self):

1160

660

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

1161

661

1162

662

If a checker already exists, leave it running and do

1163

663

nothing."""

1164

664

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

1169

669

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

1170

670

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

1171

671

# should be.

1172

1173

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

1174

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

1175

self.checker.join()

1176

self.checker = None

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)

1177

687

# Start a new checker if needed

1178

688

if self.checker is None:

1179

689

# Escape attributes for the shell

1180

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1183

693

try:

1184

694

command = self.checker_command % escaped_attrs

1185

695

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

1188

return True # Try again later

696

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

697

self.checker_command, exc_info=error)

698

return True # Try again later

1189

699

self.current_checker_command = command

1190

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

1191

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

1192

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

1193

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

1194

# always replaced by /dev/null.)

1195

# The exception is when not debugging but nevertheless

1196

# running in the foreground; use the previously

1197

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

1201

if (not self.server_settings["debug"]

1202

and self.server_settings["foreground"]):

1203

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

1206

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

1210

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1214

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

# We were started after a random delay; Schedule a new

1217

# checker to be started an 'interval' from now, and every

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

self.expires = max(self.expires, now + self.interval)

1224

# Don't start a new checker again after same random delay

1225

return False

1226

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

721

exc_info=error)

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1227

742

return True

1228

743

1229

744

def stop_checker(self):

1230

745

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

1231

746

if self.checker_callback_tag:

1232

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1233

748

self.checker_callback_tag = None

1234

749

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

1235

750

return

1236

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

1237

self.checker.terminate()

751

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

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1238

760

self.checker = None

1239

761

1240

762

1241

def dbus_service_property(dbus_interface,

1242

signature="v",

1243

access="readwrite",

1244

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1245

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1246

766

become properties on the D-Bus.

1247

767

1248

768

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

1249

769

and with one argument by "Set".

1250

770

1251

771

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

1252

772

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

1253

773

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

1257

777

if byte_arrays and signature != "ay":

1258

778

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

1259

779

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

1260

1261

780

def decorator(func):

1262

781

func._dbus_is_property = True

1263

782

func._dbus_interface = dbus_interface

1266

785

func._dbus_name = func.__name__

1267

786

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

1268

787

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

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1270

789

return func

1271

1272

790

return decorator

1273

791

1274

792

1275

793

def dbus_interface_annotations(dbus_interface):

1276

794

"""Decorator for marking functions returning interface annotations

1277

795

1278

796

Usage:

1279

797

1280

798

@dbus_interface_annotations("org.example.Interface")

1281

799

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

1282

800

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

1283

801

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

1284

802

"false"}

1285

803

"""

1286

1287

804

def decorator(func):

1288

805

func._dbus_is_interface = True

1289

806

func._dbus_interface = dbus_interface

1290

807

func._dbus_name = dbus_interface

1291

808

return func

1292

1293

809

return decorator

1294

810

1295

811

1296

812

def dbus_annotations(annotations):

1297

813

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

1298

814

Usage:

1299

1300

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

1301

"org.freedesktop.DBus.Property."

1302

"EmitsChangedSignal": "false"})

815

1303

816

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

1304

817

access="r")

818

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

819

"org.freedesktop.DBus.Property."

820

"EmitsChangedSignal": "false"})

1305

821

def Property_dbus_property(self):

1306

822

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

1309

823

"""

1310

1311

824

def decorator(func):

1312

825

func._dbus_annotations = annotations

1313

826

return func

1314

1315

827

return decorator

1316

828

1317

829

1320

832

"""

1321

833

pass

1322

834

1323

1324

835

class DBusPropertyAccessException(DBusPropertyException):

1325

836

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

1326

837

"""

1333

844

pass

1334

845

1335

846

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1337

"""A D-Bus object with annotations.

1338

1339

Classes inheriting from this can use the dbus_annotations

1340

decorator to add annotations to methods or signals.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1341

853

"""

1342

854

1343

855

@staticmethod

1344

856

def _is_dbus_thing(thing):

1345

857

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

1346

858

1347

859

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

1348

860

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

1349

861

"""

1350

862

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

1351

863

False)

1352

864

1353

865

def _get_all_dbus_things(self, thing):

1354

866

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

1355

867

"""

1356

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

868

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

869

name),

1357

870

athing.__get__(self))

1358

871

for cls in self.__class__.__mro__

1359

872

for name, athing in

1360

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

1361

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1366

def Introspect(self, object_path, connection):

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts annotation tags on methods and signals.

1370

"""

1371

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

1372

connection)

1373

try:

1374

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

1375

1376

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

1377

# Add annotation tags

1378

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

1379

for tag in if_tag.getElementsByTagName(typ):

1380

annots = dict()

1381

for name, prop in (self.

1382

_get_all_dbus_things(typ)):

1383

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

1384

and prop._dbus_interface

1385

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

1386

annots.update(getattr(

1387

prop, "_dbus_annotations", {}))

1388

for name, value in annots.items():

1389

ann_tag = document.createElement(

1390

"annotation")

1391

ann_tag.setAttribute("name", name)

1392

ann_tag.setAttribute("value", value)

1393

tag.appendChild(ann_tag)

1394

# Add interface annotation tags

1395

for annotation, value in dict(

1396

itertools.chain.from_iterable(

1397

annotations().items()

1398

for name, annotations

1399

in self._get_all_dbus_things("interface")

1400

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

1401

)).items():

1402

ann_tag = document.createElement("annotation")

1403

ann_tag.setAttribute("name", annotation)

1404

ann_tag.setAttribute("value", value)

1405

if_tag.appendChild(ann_tag)

1406

# Fix argument name for the Introspect method itself

1407

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1409

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

1410

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

1411

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

1412

if (arg.getAttribute("direction")

1413

== "out"):

1414

arg.setAttribute("name",

1415

"xml_data")

1416

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

1417

document.unlink()

1418

except (AttributeError, xml.dom.DOMException,

1419

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1422

return xmlstring

1423

1424

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

"""A D-Bus object with properties.

1427

1428

Classes inheriting from this can use the dbus_service_property

1429

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

1430

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

1431

"""

1432

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1433

876

def _get_dbus_property(self, interface_name, property_name):

1434

877

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

1435

878

property with the specified name and interface.

1436

879

"""

1437

for cls in self.__class__.__mro__:

1438

for name, value in inspect.getmembers(

1439

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1440

884

if (value._dbus_name == property_name

1441

885

and value._dbus_interface == interface_name):

1442

886

return value.__get__(self)

1443

887

1444

888

# No such property

1445

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

1446

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

1457

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

in_signature="ss",

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1459

894

out_signature="v")

1460

895

def Get(self, interface_name, property_name):

1461

896

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

1467

902

if not hasattr(value, "variant_level"):

1468

903

return value

1469

904

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

1470

905

1471

906

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

1472

907

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

1473

908

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

1482

917

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

1483

918

"'ay' signature {!r}"

1484

919

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

920

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

921

for byte in value))

1486

922

prop(value)

1487

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

in_signature="s",

923

924

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

1490

925

out_signature="a{sv}")

1491

926

def GetAll(self, interface_name):

1492

927

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

1493

928

standard.

1494

929

1495

930

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

1496

931

"""

1497

932

properties = {}

1507

942

if not hasattr(value, "variant_level"):

1508

943

properties[name] = value

1509

944

continue

1510

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1512

947

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

1513

1514

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

1515

def PropertiesChanged(self, interface_name, changed_properties,

1516

invalidated_properties):

1517

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

1518

standard.

1519

"""

1520

pass

1521

948

1522

949

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1523

950

out_signature="s",

1524

path_keyword="object_path",

1525

connection_keyword="connection")

951

path_keyword='object_path',

952

connection_keyword='connection')

1526

953

def Introspect(self, object_path, connection):

1527

954

"""Overloading of standard D-Bus method.

1528

955

1529

956

Inserts property tags and interface annotation tags.

1530

957

"""

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

958

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

959

connection)

1534

960

try:

1535

961

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

1536

1537

962

def make_tag(document, name, prop):

1538

963

e = document.createElement("property")

1539

964

e.setAttribute("name", name)

1540

965

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

1541

966

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

1542

967

return e

1543

1544

968

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

1545

969

# Add property tags

1546

970

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

1549

973

if prop._dbus_interface

1550

974

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

1551

975

if_tag.appendChild(tag)

1552

# Add annotation tags for properties

1553

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

1554

annots = dict()

1555

for name, prop in self._get_all_dbus_things(

1556

"property"):

1557

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

1558

and prop._dbus_interface

1559

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

1560

annots.update(getattr(

1561

prop, "_dbus_annotations", {}))

1562

for name, value in annots.items():

1563

ann_tag = document.createElement(

1564

"annotation")

1565

ann_tag.setAttribute("name", name)

1566

ann_tag.setAttribute("value", value)

1567

tag.appendChild(ann_tag)

976

# Add annotation tags

977

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

978

for tag in if_tag.getElementsByTagName(typ):

979

annots = dict()

980

for name, prop in (self.

981

_get_all_dbus_things(typ)):

982

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

983

and prop._dbus_interface

984

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

985

annots.update(getattr

986

(prop,

987

"_dbus_annotations",

988

{}))

989

for name, value in annots.items():

990

ann_tag = document.createElement(

991

"annotation")

992

ann_tag.setAttribute("name", name)

993

ann_tag.setAttribute("value", value)

994

tag.appendChild(ann_tag)

995

# Add interface annotation tags

996

for annotation, value in dict(

997

itertools.chain.from_iterable(

998

annotations().items()

999

for name, annotations in

1000

self._get_all_dbus_things("interface")

1001

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

1002

)).items():

1003

ann_tag = document.createElement("annotation")

1004

ann_tag.setAttribute("name", annotation)

1005

ann_tag.setAttribute("value", value)

1006

if_tag.appendChild(ann_tag)

1568

1007

# Add the names to the return values for the

1569

1008

# "org.freedesktop.DBus.Properties" methods

1570

1009

if (if_tag.getAttribute("name")

1584

1023

document.unlink()

1585

1024

except (AttributeError, xml.dom.DOMException,

1586

1025

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1026

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

1027

exc_info=error)

1660

1028

return xmlstring

1661

1029

1662

1030

1663

1031

def datetime_to_dbus(dt, variant_level=0):

1664

1032

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

1665

1033

if dt is None:

1666

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

1667

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

1034

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

1035

return dbus.String(dt.isoformat(),

1036

variant_level=variant_level)

1668

1037

1669

1038

1670

1039

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1672

1041

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

1673

1042

interface names according to the "alt_interface_names" mapping.

1674

1043

Usage:

1675

1044

1676

1045

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

1677

1046

"net.example.AlternateInterface"})

1678

1047

class SampleDBusObject(dbus.service.Object):

1679

1048

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

1680

1049

def SampleDBusMethod():

1681

1050

pass

1682

1051

1683

1052

The above "SampleDBusMethod" on "SampleDBusObject" will be

1684

1053

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

1685

1054

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

1686

1055

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

1687

1056

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

1688

1057

1689

1058

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

1690

1059

(from DBusObjectWithProperties) and interfaces (from the

1691

1060

dbus_interface_annotations decorator).

1692

1061

"""

1693

1694

1062

def wrapper(cls):

1695

1063

for orig_interface_name, alt_interface_name in (

1696

alt_interface_names.items()):

1064

alt_interface_names.items()):

1697

1065

attr = {}

1698

1066

interface_names = set()

1699

1067

# Go though all attributes of the class

1701

1069

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

1702

1070

# with the wrong interface name

1703

1071

if (not hasattr(attribute, "_dbus_interface")

1704

or not attribute._dbus_interface.startswith(

1705

orig_interface_name)):

1072

or not attribute._dbus_interface

1073

.startswith(orig_interface_name)):

1706

1074

continue

1707

1075

# Create an alternate D-Bus interface name based on

1708

1076

# the current name

1709

alt_interface = attribute._dbus_interface.replace(

1710

orig_interface_name, alt_interface_name)

1077

alt_interface = (attribute._dbus_interface

1078

.replace(orig_interface_name,

1079

alt_interface_name))

1711

1080

interface_names.add(alt_interface)

1712

1081

# Is this a D-Bus signal?

1713

1082

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

1714

1083

# Extract the original non-method undecorated

1715

1084

# function by black magic

1716

if sys.version_info.major == 2:

1717

nonmethod_func = (dict(

1085

nonmethod_func = (dict(

1718

1086

zip(attribute.func_code.co_freevars,

1719

attribute.__closure__))

1720

["func"].cell_contents)

1721

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1087

attribute.__closure__))["func"]

1088

.cell_contents)

1726

1089

# Create a new, but exactly alike, function

1727

1090

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

1728

1091

# with the alternate D-Bus interface name

1729

new_function = copy_function(nonmethod_func)

1730

new_function = (dbus.service.signal(

1731

alt_interface,

1732

attribute._dbus_signature)(new_function))

1092

new_function = (dbus.service.signal

1093

(alt_interface,

1094

attribute._dbus_signature)

1095

(types.FunctionType(

1096

nonmethod_func.func_code,

1097

nonmethod_func.func_globals,

1098

nonmethod_func.func_name,

1099

nonmethod_func.func_defaults,

1100

nonmethod_func.func_closure)))

1733

1101

# Copy annotations, if any

1734

1102

try:

1735

new_function._dbus_annotations = dict(

1736

attribute._dbus_annotations)

1103

new_function._dbus_annotations = (

1104

dict(attribute._dbus_annotations))

1737

1105

except AttributeError:

1738

1106

pass

1739

1740

1107

# Define a creator of a function to call both the

1741

1108

# original and alternate functions, so both the

1742

1109

# original and alternate signals gets sent when

1745

1112

"""This function is a scope container to pass

1746

1113

func1 and func2 to the "call_both" function

1747

1114

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1750

1115

def call_both(*args, **kwargs):

1751

1116

"""This function will emit two D-Bus

1752

1117

signals by calling func1 and func2"""

1753

1118

func1(*args, **kwargs)

1754

1119

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1761

1120

return call_both

1762

1121

# Create the "call_both" function and add it to

1763

1122

# the class

1768

1127

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

1769

1128

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

1770

1129

# to the class.

1771

attr[attrname] = (

1772

dbus.service.method(

1773

alt_interface,

1774

attribute._dbus_in_signature,

1775

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1130

attr[attrname] = (dbus.service.method

1131

(alt_interface,

1132

attribute._dbus_in_signature,

1133

attribute._dbus_out_signature)

1134

(types.FunctionType

1135

(attribute.func_code,

1136

attribute.func_globals,

1137

attribute.func_name,

1138

attribute.func_defaults,

1139

attribute.func_closure)))

1777

1140

# Copy annotations, if any

1778

1141

try:

1779

attr[attrname]._dbus_annotations = dict(

1780

attribute._dbus_annotations)

1142

attr[attrname]._dbus_annotations = (

1143

dict(attribute._dbus_annotations))

1781

1144

except AttributeError:

1782

1145

pass

1783

1146

# Is this a D-Bus property?

1786

1149

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

1787

1150

# property with the alternate D-Bus interface

1788

1151

# name. Add it to the class.

1789

attr[attrname] = (dbus_service_property(

1790

alt_interface, attribute._dbus_signature,

1791

attribute._dbus_access,

1792

attribute._dbus_get_args_options

1793

["byte_arrays"])

1794

(copy_function(attribute)))

1152

attr[attrname] = (dbus_service_property

1153

(alt_interface,

1154

attribute._dbus_signature,

1155

attribute._dbus_access,

1156

attribute

1157

._dbus_get_args_options

1158

["byte_arrays"])

1159

(types.FunctionType

1160

(attribute.func_code,

1161

attribute.func_globals,

1162

attribute.func_name,

1163

attribute.func_defaults,

1164

attribute.func_closure)))

1795

1165

# Copy annotations, if any

1796

1166

try:

1797

attr[attrname]._dbus_annotations = dict(

1798

attribute._dbus_annotations)

1167

attr[attrname]._dbus_annotations = (

1168

dict(attribute._dbus_annotations))

1799

1169

except AttributeError:

1800

1170

pass

1801

1171

# Is this a D-Bus interface?

1804

1174

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

1805

1175

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

1806

1176

# to the class.

1807

attr[attrname] = (

1808

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1177

attr[attrname] = (dbus_interface_annotations

1178

(alt_interface)

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1810

1185

if deprecate:

1811

1186

# Deprecate all alternate interfaces

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1187

iname="_AlternateDBusNames_interface_annotation{}"

1813

1188

for interface_name in interface_names:

1814

1815

1189

@dbus_interface_annotations(interface_name)

1816

1190

def func(self):

1817

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

1818

"true"}

1191

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

1192

"true" }

1819

1193

# Find an unused name

1820

1194

for aname in (iname.format(i)

1821

1195

for i in itertools.count()):

1825

1199

if interface_names:

1826

1200

# Replace the class with a new subclass of it with

1827

1201

# methods, signals, etc. as created above.

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1202

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

1203

(cls,), attr)

1834

1204

return cls

1835

1836

1205

return wrapper

1837

1206

1838

1207

1839

1208

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

1840

"se.bsnet.fukt.Mandos"})

1209

"se.bsnet.fukt.Mandos"})

1841

1210

class ClientDBus(Client, DBusObjectWithProperties):

1842

1211

"""A Client class using D-Bus

1843

1212

1844

1213

Attributes:

1845

1214

dbus_object_path: dbus.ObjectPath

1846

1215

bus: dbus.SystemBus()

1847

1216

"""

1848

1217

1849

1218

runtime_expansions = (Client.runtime_expansions

1850

+ ("dbus_object_path", ))

1851

1852

_interface = "se.recompile.Mandos.Client"

1853

1219

+ ("dbus_object_path",))

1220

1854

1221

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

1855

1856

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

1222

1223

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

1857

1224

self.bus = bus

1858

1225

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

1859

1226

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

1861

1228

client_object_name = str(self.name).translate(

1862

1229

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

1863

1230

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

1864

self.dbus_object_path = dbus.ObjectPath(

1865

"/clients/" + client_object_name)

1231

self.dbus_object_path = (dbus.ObjectPath

1232

("/clients/" + client_object_name))

1866

1233

DBusObjectWithProperties.__init__(self, self.bus,

1867

1234

self.dbus_object_path)

1868

1869

def notifychangeproperty(transform_func, dbus_name,

1870

type_func=lambda x: x,

1871

variant_level=1,

1872

invalidate_only=False,

1873

_interface=_interface):

1235

1236

def notifychangeproperty(transform_func,

1237

dbus_name, type_func=lambda x: x,

1238

variant_level=1):

1874

1239

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

1875

1240

its changes to DBus.

1876

1241

1877

1242

transform_fun: Function that takes a value and a variant_level

1878

1243

and transforms it to a D-Bus type.

1879

1244

dbus_name: D-Bus name of the variable

1882

1247

variant_level: D-Bus variant level. Default: 1

1883

1248

"""

1884

1249

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

1885

1886

1250

def setter(self, value):

1887

1251

if hasattr(self, "dbus_object_path"):

1888

1252

if (not hasattr(self, attrname) or

1889

1253

type_func(getattr(self, attrname, None))

1890

1254

!= type_func(value)):

1891

if invalidate_only:

1892

self.PropertiesChanged(

1893

_interface, dbus.Dictionary(),

1894

dbus.Array((dbus_name, )))

1895

else:

1896

dbus_value = transform_func(

1897

type_func(value),

1898

variant_level=variant_level)

1899

self.PropertyChanged(dbus.String(dbus_name),

1900

dbus_value)

1901

self.PropertiesChanged(

1902

_interface,

1903

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

1904

dbus_value}),

1905

dbus.Array())

1255

dbus_value = transform_func(type_func(value),

1256

variant_level

1257

=variant_level)

1258

self.PropertyChanged(dbus.String(dbus_name),

1259

dbus_value)

1906

1260

setattr(self, attrname, value)

1907

1261

1908

1262

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

1909

1263

1910

1264

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1911

1265

approvals_pending = notifychangeproperty(dbus.Boolean,

1912

1266

"ApprovalPending",

1913

type_func=bool)

1267

type_func = bool)

1914

1268

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

1915

1269

last_enabled = notifychangeproperty(datetime_to_dbus,

1916

1270

"LastEnabled")

1917

checker = notifychangeproperty(

1918

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1271

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

1272

type_func = lambda checker:

1273

checker is not None)

1920

1274

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1921

1275

"LastCheckedOK")

1922

1276

last_checker_status = notifychangeproperty(dbus.Int16,

1925

1279

datetime_to_dbus, "LastApprovalRequest")

1926

1280

approved_by_default = notifychangeproperty(dbus.Boolean,

1927

1281

"ApprovedByDefault")

1928

approval_delay = notifychangeproperty(

1929

dbus.UInt64, "ApprovalDelay",

1930

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

1282

approval_delay = notifychangeproperty(dbus.UInt64,

1283

"ApprovalDelay",

1284

type_func =

1285

lambda td: td.total_seconds()

1286

* 1000)

1931

1287

approval_duration = notifychangeproperty(

1932

1288

dbus.UInt64, "ApprovalDuration",

1933

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

1289

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

1934

1290

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

1935

timeout = notifychangeproperty(

1936

dbus.UInt64, "Timeout",

1937

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

1291

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

1292

type_func = lambda td:

1293

td.total_seconds() * 1000)

1938

1294

extended_timeout = notifychangeproperty(

1939

1295

dbus.UInt64, "ExtendedTimeout",

1940

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

1941

interval = notifychangeproperty(

1942

dbus.UInt64, "Interval",

1943

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

1296

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

1297

interval = notifychangeproperty(dbus.UInt64,

1298

"Interval",

1299

type_func =

1300

lambda td: td.total_seconds()

1301

* 1000)

1944

1302

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

1945

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

1946

invalidate_only=True)

1947

1303

1948

1304

del notifychangeproperty

1949

1305

1950

1306

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

1951

1307

try:

1952

1308

self.remove_from_connection()

1955

1311

if hasattr(DBusObjectWithProperties, "__del__"):

1956

1312

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

1957

1313

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

1958

1959

def checker_callback(self, source, condition,

1960

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

1961

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

1962

connection, command, *args,

1963

**kwargs)

1964

exitstatus = self.last_checker_status

1965

if exitstatus >= 0:

1314

1315

def checker_callback(self, pid, condition, command,

1316

*args, **kwargs):

1317

self.checker_callback_tag = None

1318

self.checker = None

1319

if os.WIFEXITED(condition):

1320

exitstatus = os.WEXITSTATUS(condition)

1966

1321

# Emit D-Bus signal

1967

1322

self.CheckerCompleted(dbus.Int16(exitstatus),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1323

dbus.Int64(condition),

1970

1324

dbus.String(command))

1971

1325

else:

1972

1326

# Emit D-Bus signal

1973

1327

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

1974

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1328

dbus.Int64(condition),

1978

1329

dbus.String(command))

1979

return ret

1980

1330

1331

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

1332

*args, **kwargs)

1333

1981

1334

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

1982

1335

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

1983

1336

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

1987

1340

# Emit D-Bus signal

1988

1341

self.CheckerStarted(self.current_checker_command)

1989

1342

return r

1990

1343

1991

1344

def _reset_approved(self):

1992

1345

self.approved = None

1993

1346

return False

1994

1347

1995

1348

def approve(self, value=True):

1996

1349

self.approved = value

1997

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

1998

* 1000), self._reset_approved)

1350

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

1351

* 1000), self._reset_approved)

1999

1352

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1353

1354

## D-Bus methods, signals & properties

1355

_interface = "se.recompile.Mandos.Client"

1356

1357

## Interfaces

1358

1359

@dbus_interface_annotations(_interface)

1360

def _foo(self):

1361

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

1362

"false"}

1363

1364

## Signals

1365

2007

1366

# CheckerCompleted - signal

2008

1367

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

2009

1368

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

2010

1369

"D-Bus signal"

2011

1370

pass

2012

1371

2013

1372

# CheckerStarted - signal

2014

1373

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

2015

1374

def CheckerStarted(self, command):

2016

1375

"D-Bus signal"

2017

1376

pass

2018

1377

2019

1378

# PropertyChanged - signal

2020

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

2021

1379

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

2022

1380

def PropertyChanged(self, property, value):

2023

1381

"D-Bus signal"

2024

1382

pass

2025

1383

2026

1384

# GotSecret - signal

2027

1385

@dbus.service.signal(_interface)

2028

1386

def GotSecret(self):

2031

1389

server to mandos-client

2032

1390

"""

2033

1391

pass

2034

1392

2035

1393

# Rejected - signal

2036

1394

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

2037

1395

def Rejected(self, reason):

2038

1396

"D-Bus signal"

2039

1397

pass

2040

1398

2041

1399

# NeedApproval - signal

2042

1400

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

2043

1401

def NeedApproval(self, timeout, default):

2044

1402

"D-Bus signal"

2045

1403

return self.need_approval()

2046

2047

# Methods

2048

1404

1405

## Methods

1406

2049

1407

# Approve - method

2050

1408

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

2051

1409

def Approve(self, value):

2052

1410

self.approve(value)

2053

1411

2054

1412

# CheckedOK - method

2055

1413

@dbus.service.method(_interface)

2056

1414

def CheckedOK(self):

2057

1415

self.checked_ok()

2058

1416

2059

1417

# Enable - method

2060

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

2061

1418

@dbus.service.method(_interface)

2062

1419

def Enable(self):

2063

1420

"D-Bus method"

2064

1421

self.enable()

2065

1422

2066

1423

# StartChecker - method

2067

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

2068

1424

@dbus.service.method(_interface)

2069

1425

def StartChecker(self):

2070

1426

"D-Bus method"

2071

1427

self.start_checker()

2072

1428

2073

1429

# Disable - method

2074

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

2075

1430

@dbus.service.method(_interface)

2076

1431

def Disable(self):

2077

1432

"D-Bus method"

2078

1433

self.disable()

2079

1434

2080

1435

# StopChecker - method

2081

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

2082

1436

@dbus.service.method(_interface)

2083

1437

def StopChecker(self):

2084

1438

self.stop_checker()

2085

2086

# Properties

2087

1439

1440

## Properties

1441

2088

1442

# ApprovalPending - property

2089

1443

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

2090

1444

def ApprovalPending_dbus_property(self):

2091

1445

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

2092

1446

2093

1447

# ApprovedByDefault - property

2094

@dbus_service_property(_interface,

2095

signature="b",

1448

@dbus_service_property(_interface, signature="b",

2096

1449

access="readwrite")

2097

1450

def ApprovedByDefault_dbus_property(self, value=None):

2098

1451

if value is None: # get

2099

1452

return dbus.Boolean(self.approved_by_default)

2100

1453

self.approved_by_default = bool(value)

2101

1454

2102

1455

# ApprovalDelay - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1456

@dbus_service_property(_interface, signature="t",

2105

1457

access="readwrite")

2106

1458

def ApprovalDelay_dbus_property(self, value=None):

2107

1459

if value is None: # get

2108

1460

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

2109

1461

* 1000)

2110

1462

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

2111

1463

2112

1464

# ApprovalDuration - property

2113

@dbus_service_property(_interface,

2114

signature="t",

1465

@dbus_service_property(_interface, signature="t",

2115

1466

access="readwrite")

2116

1467

def ApprovalDuration_dbus_property(self, value=None):

2117

1468

if value is None: # get

2118

1469

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

2119

1470

* 1000)

2120

1471

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

2121

1472

2122

1473

# Name - property

2123

@dbus_annotations(

2124

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

2125

1474

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

2126

1475

def Name_dbus_property(self):

2127

1476

return dbus.String(self.name)

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1477

2136

1478

# Fingerprint - property

2137

@dbus_annotations(

2138

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

2139

1479

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

2140

1480

def Fingerprint_dbus_property(self):

2141

1481

return dbus.String(self.fingerprint)

2142

1482

2143

1483

# Host - property

2144

@dbus_service_property(_interface,

2145

signature="s",

1484

@dbus_service_property(_interface, signature="s",

2146

1485

access="readwrite")

2147

1486

def Host_dbus_property(self, value=None):

2148

1487

if value is None: # get

2149

1488

return dbus.String(self.host)

2150

1489

self.host = str(value)

2151

1490

2152

1491

# Created - property

2153

@dbus_annotations(

2154

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

2155

1492

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

2156

1493

def Created_dbus_property(self):

2157

1494

return datetime_to_dbus(self.created)

2158

1495

2159

1496

# LastEnabled - property

2160

1497

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

2161

1498

def LastEnabled_dbus_property(self):

2162

1499

return datetime_to_dbus(self.last_enabled)

2163

1500

2164

1501

# Enabled - property

2165

@dbus_service_property(_interface,

2166

signature="b",

1502

@dbus_service_property(_interface, signature="b",

2167

1503

access="readwrite")

2168

1504

def Enabled_dbus_property(self, value=None):

2169

1505

if value is None: # get

2172

1508

self.enable()

2173

1509

else:

2174

1510

self.disable()

2175

1511

2176

1512

# LastCheckedOK - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1513

@dbus_service_property(_interface, signature="s",

2179

1514

access="readwrite")

2180

1515

def LastCheckedOK_dbus_property(self, value=None):

2181

1516

if value is not None:

2182

1517

self.checked_ok()

2183

1518

return

2184

1519

return datetime_to_dbus(self.last_checked_ok)

2185

1520

2186

1521

# LastCheckerStatus - property

2187

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

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2188

1524

def LastCheckerStatus_dbus_property(self):

2189

1525

return dbus.Int16(self.last_checker_status)

2190

1526

2191

1527

# Expires - property

2192

1528

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

2193

1529

def Expires_dbus_property(self):

2194

1530

return datetime_to_dbus(self.expires)

2195

1531

2196

1532

# LastApprovalRequest - property

2197

1533

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

2198

1534

def LastApprovalRequest_dbus_property(self):

2199

1535

return datetime_to_dbus(self.last_approval_request)

2200

1536

2201

1537

# Timeout - property

2202

@dbus_service_property(_interface,

2203

signature="t",

1538

@dbus_service_property(_interface, signature="t",

2204

1539

access="readwrite")

2205

1540

def Timeout_dbus_property(self, value=None):

2206

1541

if value is None: # get

2218

1553

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

2219

1554

is None):

2220

1555

return

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2223

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

2224

self.disable)

2225

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

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

1560

* 1000), self.disable))

1561

2226

1562

# ExtendedTimeout - property

2227

@dbus_service_property(_interface,

2228

signature="t",

1563

@dbus_service_property(_interface, signature="t",

2229

1564

access="readwrite")

2230

1565

def ExtendedTimeout_dbus_property(self, value=None):

2231

1566

if value is None: # get

2232

1567

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

2233

1568

* 1000)

2234

1569

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

2235

1570

2236

1571

# Interval - property

2237

@dbus_service_property(_interface,

2238

signature="t",

1572

@dbus_service_property(_interface, signature="t",

2239

1573

access="readwrite")

2240

1574

def Interval_dbus_property(self, value=None):

2241

1575

if value is None: # get

2245

1579

return

2246

1580

if self.enabled:

2247

1581

# Reschedule checker run

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2250

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1582

gobject.source_remove(self.checker_initiator_tag)

1583

self.checker_initiator_tag = (gobject.timeout_add

1584

(value, self.start_checker))

1585

self.start_checker() # Start one now, too

1586

2253

1587

# Checker - property

2254

@dbus_service_property(_interface,

2255

signature="s",

1588

@dbus_service_property(_interface, signature="s",

2256

1589

access="readwrite")

2257

1590

def Checker_dbus_property(self, value=None):

2258

1591

if value is None: # get

2259

1592

return dbus.String(self.checker_command)

2260

1593

self.checker_command = str(value)

2261

1594

2262

1595

# CheckerRunning - property

2263

@dbus_service_property(_interface,

2264

signature="b",

1596

@dbus_service_property(_interface, signature="b",

2265

1597

access="readwrite")

2266

1598

def CheckerRunning_dbus_property(self, value=None):

2267

1599

if value is None: # get

2270

1602

self.start_checker()

2271

1603

else:

2272

1604

self.stop_checker()

2273

1605

2274

1606

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

2278

1607

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

2279

1608

def ObjectPath_dbus_property(self):

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1609

return self.dbus_object_path # is already a dbus.ObjectPath

1610

2282

1611

# Secret = property

2283

@dbus_annotations(

2284

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

2285

"invalidates"})

2286

@dbus_service_property(_interface,

2287

signature="ay",

2288

access="write",

2289

byte_arrays=True)

1612

@dbus_service_property(_interface, signature="ay",

1613

access="write", byte_arrays=True)

2290

1614

def Secret_dbus_property(self, value):

2291

1615

self.secret = bytes(value)

2292

1616

2293

1617

del _interface

2294

1618

2295

1619

2296

class ProxyClient:

2297

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

1620

class ProxyClient(object):

1621

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

2298

1622

self._pipe = child_pipe

2299

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

1623

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

2300

1624

if not self._pipe.recv():

2301

raise KeyError(key_id or fpr)

2302

1625

raise KeyError()

1626

2303

1627

def __getattribute__(self, name):

2304

if name == "_pipe":

1628

if name == '_pipe':

2305

1629

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

2306

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

1630

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

2307

1631

data = self._pipe.recv()

2308

if data[0] == "data":

1632

if data[0] == 'data':

2309

1633

return data[1]

2310

if data[0] == "function":

2311

1634

if data[0] == 'function':

2312

1635

def func(*args, **kwargs):

2313

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

1636

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

2314

1637

return self._pipe.recv()[1]

2315

2316

1638

return func

2317

1639

2318

1640

def __setattr__(self, name, value):

2319

if name == "_pipe":

1641

if name == '_pipe':

2320

1642

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

2321

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

1643

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

2322

1644

2323

1645

2324

1646

class ClientHandler(socketserver.BaseRequestHandler, object):

2325

1647

"""A class to handle client connections.

2326

1648

2327

1649

Instantiated once for each connection to handle it.

2328

1650

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

2329

1651

2330

1652

def handle(self):

2331

1653

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

2332

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

2333

str(self.client_address))

2334

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

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1654

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

1655

str(self.client_address))

1656

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

1657

self.server.child_pipe.fileno())

1658

1659

session = (gnutls.connection

1660

.ClientSession(self.request,

1661

gnutls.connection

1662

.X509Credentials()))

1663

1664

# Note: gnutls.connection.X509Credentials is really a

1665

# generic GnuTLS certificate credentials object so long as

1666

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

1667

# here despite using OpenPGP certificates.

1668

1669

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

1670

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

1671

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

1672

# "+DHE-DSS"))

2342

1673

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

2343

1674

priority = self.server.gnutls_priority

2344

1675

if priority is None:

2345

1676

priority = "NORMAL"

2346

gnutls.priority_set_direct(session,

2347

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

2348

1677

(gnutls.library.functions

1678

.gnutls_priority_set_direct(session._c_object,

1679

priority, None))

1680

2349

1681

# Start communication using the Mandos protocol

2350

1682

# Get protocol number

2351

1683

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

2352

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

1684

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

2353

1685

try:

2354

1686

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

2355

1687

raise RuntimeError(line)

2356

1688

except (ValueError, IndexError, RuntimeError) as error:

2357

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

1689

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

2358

1690

return

2359

1691

2360

1692

# Start GnuTLS connection

2361

1693

try:

2362

1694

session.handshake()

2363

except gnutls.Error as error:

2364

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

1695

except gnutls.errors.GNUTLSError as error:

1696

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

2365

1697

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

2366

1698

# established. Just abandon the request.

2367

1699

return

2368

log.debug("Handshake succeeded")

2369

1700

logger.debug("Handshake succeeded")

1701

2370

1702

approval_required = False

2371

1703

try:

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1704

try:

1705

fpr = self.fingerprint(self.peer_certificate

1706

(session))

1707

except (TypeError,

1708

gnutls.errors.GNUTLSError) as error:

1709

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

1710

return

1711

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

1712

1713

try:

1714

client = ProxyClient(child_pipe, fpr,

2396

1715

self.client_address)

2397

1716

except KeyError:

2398

1717

return

2399

1718

2400

1719

if client.approval_delay:

2401

1720

delay = client.approval_delay

2402

1721

client.approvals_pending += 1

2403

1722

approval_required = True

2404

1723

2405

1724

while True:

2406

1725

if not client.enabled:

2407

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

1726

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

1727

client.name)

2408

1728

if self.server.use_dbus:

2409

1729

# Emit D-Bus signal

2410

1730

client.Rejected("Disabled")

2411

1731

return

2412

1732

2413

1733

if client.approved or not client.approval_delay:

2414

# We are approved or approval is disabled

1734

#We are approved or approval is disabled

2415

1735

break

2416

1736

elif client.approved is None:

2417

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

2418

client.name)

1737

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

1738

client.name)

2419

1739

if self.server.use_dbus:

2420

1740

# Emit D-Bus signal

2421

1741

client.NeedApproval(

2422

1742

client.approval_delay.total_seconds()

2423

1743

* 1000, client.approved_by_default)

2424

1744

else:

2425

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

2426

client.name)

1745

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

1746

client.name)

2427

1747

if self.server.use_dbus:

2428

1748

# Emit D-Bus signal

2429

1749

client.Rejected("Denied")

2430

1750

return

2431

2432

# wait until timeout or approved

1751

1752

#wait until timeout or approved

2433

1753

time = datetime.datetime.now()

2434

1754

client.changedstate.acquire()

2435

1755

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

2437

1757

time2 = datetime.datetime.now()

2438

1758

if (time2 - time) >= delay:

2439

1759

if not client.approved_by_default:

2440

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

2441

" waiting for approval",

2442

client.name)

1760

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

1761

" waiting for approval",

1762

client.name)

2443

1763

if self.server.use_dbus:

2444

1764

# Emit D-Bus signal

2445

1765

client.Rejected("Approval timed out")

2448

1768

break

2449

1769

else:

2450

1770

delay -= time2 - time

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

1771

1772

sent_size = 0

1773

while sent_size < len(client.secret):

1774

try:

1775

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

1776

except gnutls.errors.GNUTLSError as error:

1777

logger.warning("gnutls send failed",

1778

exc_info=error)

1779

return

1780

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

1781

sent, len(client.secret)

1782

- (sent_size + sent))

1783

sent_size += sent

1784

1785

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

2459

1786

# bump the timeout using extended_timeout

2460

1787

client.bump_timeout(client.extended_timeout)

2461

1788

if self.server.use_dbus:

2462

1789

# Emit D-Bus signal

2463

1790

client.GotSecret()

2464

1791

2465

1792

finally:

2466

1793

if approval_required:

2467

1794

client.approvals_pending -= 1

2468

1795

try:

2469

1796

session.bye()

2470

except gnutls.Error as error:

2471

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

2472

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("GnuTLS bye failed",

1799

exc_info=error)

1800

2473

1801

@staticmethod

2474

1802

def peer_certificate(session):

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1803

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

1804

# If not an OpenPGP certificate...

1805

if (gnutls.library.functions

1806

.gnutls_certificate_type_get(session._c_object)

1807

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1808

# ...do the normal thing

1809

return session.peer_certificate

2491

1810

list_size = ctypes.c_uint(1)

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1811

cert_list = (gnutls.library.functions

1812

.gnutls_certificate_get_peers

1813

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

2494

1814

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

2495

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

1815

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

1816

" certificate")

2496

1817

if list_size.value == 0:

2497

1818

return None

2498

1819

cert = cert_list[0]

2499

1820

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

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

1821

2536

1822

@staticmethod

2537

1823

def fingerprint(openpgp):

2538

1824

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2539

1825

# New GnuTLS "datum" with the OpenPGP public key

2540

datum = gnutls.datum_t(

2541

ctypes.cast(ctypes.c_char_p(openpgp),

2542

ctypes.POINTER(ctypes.c_ubyte)),

2543

ctypes.c_uint(len(openpgp)))

1826

datum = (gnutls.library.types

1827

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

1828

ctypes.POINTER

1829

(ctypes.c_ubyte)),

1830

ctypes.c_uint(len(openpgp))))

2544

1831

# New empty GnuTLS certificate

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1832

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2547

1835

# Import the OpenPGP public key into the certificate

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1836

(gnutls.library.functions

1837

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

1838

gnutls.library.constants

1839

.GNUTLS_OPENPGP_FMT_RAW))

2550

1840

# Verify the self signature in the key

2551

1841

crtverify = ctypes.c_uint()

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1842

(gnutls.library.functions

1843

.gnutls_openpgp_crt_verify_self(crt, 0,

1844

ctypes.byref(crtverify)))

2554

1845

if crtverify.value != 0:

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1846

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1847

raise (gnutls.errors.CertificateSecurityError

1848

("Verify failed"))

2558

1849

# New buffer for the fingerprint

2559

1850

buf = ctypes.create_string_buffer(20)

2560

1851

buf_len = ctypes.c_size_t()

2561

1852

# Get the fingerprint from the certificate into the buffer

2562

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

2563

ctypes.byref(buf_len))

1853

(gnutls.library.functions

1854

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

1855

ctypes.byref(buf_len)))

2564

1856

# Deinit the certificate

2565

gnutls.openpgp_crt_deinit(crt)

1857

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2566

1858

# Convert the buffer to a Python bytestring

2567

1859

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

2568

1860

# Convert the bytestring to hexadecimal notation

2570

1862

return hex_fpr

2571

1863

2572

1864

2573

class MultiprocessingMixIn:

1865

class MultiprocessingMixIn(object):

2574

1866

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

2575

2576

1867

def sub_process_main(self, request, address):

2577

1868

try:

2578

1869

self.finish_request(request, address)

2579

1870

except Exception:

2580

1871

self.handle_error(request, address)

2581

1872

self.close_request(request)

2582

1873

2583

1874

def process_request(self, request, address):

2584

1875

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

2585

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

2586

args=(request, address))

1876

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

1877

args = (request, address))

2587

1878

proc.start()

2588

1879

return proc

2589

1880

2590

1881

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1882

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2592

1883

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

2593

2594

1884

def process_request(self, request, client_address):

2595

1885

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

2596

1886

2597

1887

This function creates a new pipe in self.pipe

2598

1888

"""

2599

1889

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2600

1890

2601

1891

proc = MultiprocessingMixIn.process_request(self, request,

2602

1892

client_address)

2603

1893

self.child_pipe.close()

2604

1894

self.add_pipe(parent_pipe, proc)

2605

1895

2606

1896

def add_pipe(self, parent_pipe, proc):

2607

1897

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

2608

1898

raise NotImplementedError()

2609

1899

2610

1900

2611

1901

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2612

socketserver.TCPServer):

2613

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

2614

1902

socketserver.TCPServer, object):

1903

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

1904

2615

1905

Attributes:

2616

1906

enabled: Boolean; whether this server is activated yet

2617

1907

interface: None or a network interface name (string)

2618

1908

use_ipv6: Boolean; to use IPv6 or not

2619

1909

"""

2620

2621

1910

def __init__(self, server_address, RequestHandlerClass,

2622

interface=None,

2623

use_ipv6=True,

2624

socketfd=None):

1911

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

2625

1912

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

2626

1913

creating a new one with socket.socket().

2627

1914

"""

2633

1920

self.socketfd = socketfd

2634

1921

# Save the original socket.socket() function

2635

1922

self.socket_socket = socket.socket

2636

2637

1923

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

2638

#

1924

#

2639

1925

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

2640

1926

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

2641

1927

# patching socket.socket.)

2642

#

1928

#

2643

1929

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

2644

1930

@functools.wraps(socket.socket)

2645

1931

def socket_wrapper(*args, **kwargs):

2657

1943

# socket_wrapper(), if socketfd was set.

2658

1944

socketserver.TCPServer.__init__(self, server_address,

2659

1945

RequestHandlerClass)

2660

1946

2661

1947

def server_bind(self):

2662

1948

"""This overrides the normal server_bind() function

2663

1949

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

2664

1950

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

2665

global SO_BINDTODEVICE

2666

1951

if self.interface is not None:

2667

1952

if SO_BINDTODEVICE is None:

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

1953

logger.error("SO_BINDTODEVICE does not exist;"

1954

" cannot bind to interface %s",

1955

self.interface)

1956

else:

1957

try:

1958

self.socket.setsockopt(socket.SOL_SOCKET,

1959

SO_BINDTODEVICE,

1960

(self.interface + "\0")

1961

.encode("utf-8"))

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2688

1975

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

2689

1976

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2692

1977

if not self.server_address[0]:

2693

1978

if self.address_family == socket.AF_INET6:

2694

any_address = "::" # in6addr_any

1979

any_address = "::" # in6addr_any

2695

1980

else:

2696

any_address = "0.0.0.0" # INADDR_ANY

1981

any_address = "0.0.0.0" # INADDR_ANY

2697

1982

self.server_address = (any_address,

2698

1983

self.server_address[1])

2699

1984

elif not self.server_address[1]:

2700

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

1985

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

1986

0)

2701

1987

# if self.interface:

2702

1988

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

2703

1989

# 0, # port

2709

1995

2710

1996

class MandosServer(IPv6_TCPServer):

2711

1997

"""Mandos server.

2712

1998

2713

1999

Attributes:

2714

2000

clients: set of Client objects

2715

2001

gnutls_priority GnuTLS priority string

2716

2002

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

2717

2718

Assumes a GLib.MainLoop event loop.

2003

2004

Assumes a gobject.MainLoop event loop.

2719

2005

"""

2720

2721

2006

def __init__(self, server_address, RequestHandlerClass,

2722

interface=None,

2723

use_ipv6=True,

2724

clients=None,

2725

gnutls_priority=None,

2726

use_dbus=True,

2727

socketfd=None):

2007

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

2008

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

2728

2009

self.enabled = False

2729

2010

self.clients = clients

2730

2011

if self.clients is None:

2733

2014

self.gnutls_priority = gnutls_priority

2734

2015

IPv6_TCPServer.__init__(self, server_address,

2735

2016

RequestHandlerClass,

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2740

2020

def server_activate(self):

2741

2021

if self.enabled:

2742

2022

return socketserver.TCPServer.server_activate(self)

2743

2023

2744

2024

def enable(self):

2745

2025

self.enabled = True

2746

2026

2747

2027

def add_pipe(self, parent_pipe, proc):

2748

2028

# Call "handle_ipc" for both data and EOF events

2749

GLib.io_add_watch(

2750

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

2751

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

2752

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2756

def handle_ipc(self, source, condition,

2757

parent_pipe=None,

2758

proc=None,

2759

client_object=None):

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2760

2038

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

2761

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

2039

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

2762

2040

# Wait for other process to exit

2763

2041

proc.join()

2764

2042

return False

2765

2043

2766

2044

# Read a request from the child

2767

2045

request = parent_pipe.recv()

2768

2046

command = request[0]

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2047

2048

if command == 'init':

2049

fpr = request[1]

2050

address = request[2]

2051

2052

for c in self.clients.itervalues():

2053

if c.fingerprint == fpr:

2783

2054

client = c

2784

2055

break

2785

2056

else:

2786

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

2787

" %s", key_id or fpr, address)

2057

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

2058

"dress: %s", fpr, address)

2788

2059

if self.use_dbus:

2789

2060

# Emit D-Bus signal

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2061

mandos_dbus_service.ClientNotFound(fpr,

2791

2062

address[0])

2792

2063

parent_pipe.send(False)

2793

2064

return False

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2798

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2802

2074

parent_pipe.send(True)

2803

2075

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

2804

2076

# same fileno

2805

2077

return False

2806

if command == "funcall":

2078

if command == 'funcall':

2807

2079

funcname = request[1]

2808

2080

args = request[2]

2809

2081

kwargs = request[3]

2810

2811

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

2082

2083

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

2812

2084

funcname)(*args,

2813

**kwargs)))

2814

2815

if command == "getattr":

2085

**kwargs)))

2086

2087

if command == 'getattr':

2816

2088

attrname = request[1]

2817

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2820

2091

else:

2821

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2095

if command == 'setattr':

2825

2096

attrname = request[1]

2826

2097

value = request[2]

2827

2098

setattr(client_object, attrname, value)

2828

2099

2829

2100

return True

2830

2101

2831

2102

2832

2103

def rfc3339_duration_to_delta(duration):

2833

2104

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

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2105

2106

>>> rfc3339_duration_to_delta("P7D")

2107

datetime.timedelta(7)

2108

>>> rfc3339_duration_to_delta("PT60S")

2109

datetime.timedelta(0, 60)

2110

>>> rfc3339_duration_to_delta("PT60M")

2111

datetime.timedelta(0, 3600)

2112

>>> rfc3339_duration_to_delta("PT24H")

2113

datetime.timedelta(1)

2114

>>> rfc3339_duration_to_delta("P1W")

2115

datetime.timedelta(7)

2116

>>> rfc3339_duration_to_delta("PT5M30S")

2117

datetime.timedelta(0, 330)

2118

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

datetime.timedelta(1, 200)

2851

2120

"""

2852

2121

2853

2122

# Parsing an RFC 3339 duration with regular expressions is not

2854

2123

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

2855

2124

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

2856

2125

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

2857

2126

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

2858

2127

# avoid excessive use of external libraries.

2859

2128

2860

2129

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

2861

Token = collections.namedtuple("Token", (

2862

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

2863

# a "group" containing digits

2864

"value", # datetime.timedelta or None

2865

"followers")) # Tokens valid after this token

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2866

2139

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

2867

2140

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

2868

2141

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

2869

2142

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

2870

2143

datetime.timedelta(seconds=1),

2871

frozenset((token_end, )))

2144

frozenset((token_end,)))

2872

2145

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

2873

2146

datetime.timedelta(minutes=1),

2874

2147

frozenset((token_second, token_end)))

2890

2163

frozenset((token_month, token_end)))

2891

2164

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

2892

2165

datetime.timedelta(weeks=1),

2893

frozenset((token_end, )))

2166

frozenset((token_end,)))

2894

2167

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

2895

2168

frozenset((token_year, token_month,

2896

2169

token_day, token_time,

2897

2170

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2901

2173

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2174

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

2175

s = duration # String left to parse

2906

2176

# Loop until end token is found

2907

2177

while found_token is not token_end:

2908

2178

# Search for any currently valid tokens

2924

2194

break

2925

2195

else:

2926

2196

# No currently valid tokens were found

2927

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

2928

.format(duration))

2197

raise ValueError("Invalid RFC 3339 duration")

2929

2198

# End token found

2930

2199

return value

2931

2200

2932

2201

2933

2202

def string_to_delta(interval):

2934

2203

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

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2204

2205

>>> string_to_delta('7d')

2206

datetime.timedelta(7)

2207

>>> string_to_delta('60s')

2208

datetime.timedelta(0, 60)

2209

>>> string_to_delta('60m')

2210

datetime.timedelta(0, 3600)

2211

>>> string_to_delta('24h')

2212

datetime.timedelta(1)

2213

>>> string_to_delta('1w')

2214

datetime.timedelta(7)

2215

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

2216

datetime.timedelta(0, 330)

2948

2217

"""

2949

2218

2950

2219

try:

2951

2220

return rfc3339_duration_to_delta(interval)

2952

2221

except ValueError:

2953

2222

pass

2954

2223

2955

2224

timevalue = datetime.timedelta(0)

2956

2225

for s in interval.split():

2957

2226

try:

2968

2237

elif suffix == "w":

2969

2238

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

2970

2239

else:

2971

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

2240

raise ValueError("Unknown suffix {!r}"

2241

.format(suffix))

2972

2242

except IndexError as e:

2973

2243

raise ValueError(*(e.args))

2974

2244

timevalue += delta

2975

2245

return timevalue

2976

2246

2977

2247

2978

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

2248

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

2979

2249

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

2980

2250

2981

2251

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

2982

2252

if os.fork():

2983

2253

sys.exit()

2990

2260

# Close all standard open file descriptors

2991

2261

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

2992

2262

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

2993

raise OSError(errno.ENODEV,

2994

"{} not a character device"

2263

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

2995

2264

.format(os.devnull))

2996

2265

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

2997

2266

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

3001

2270

3002

2271

3003

2272

def main():

3004

2273

3005

2274

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

3006

2275

# Parsing of options, both command line and config file

3007

2276

3008

2277

parser = argparse.ArgumentParser()

3009

2278

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

3010

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

2279

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

3011

2280

help="show version number and exit")

3012

2281

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

3013

2282

help="Bind to interface IF")

3049

2318

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

3050

2319

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

3051

2320

default=None)

3052

2321

3053

2322

options = parser.parse_args()

3054

2323

2324

if options.check:

2325

import doctest

2326

fail_count, test_count = doctest.testmod()

2327

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

2328

3055

2329

# Default values for config file for server-global settings

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2330

server_defaults = { "interface": "",

2331

"address": "",

2332

"port": "",

2333

"debug": "False",

2334

"priority":

2335

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

2336

"servicename": "Mandos",

2337

"use_dbus": "True",

2338

"use_ipv6": "True",

2339

"debuglevel": "",

2340

"restore": "True",

2341

"socket": "",

2342

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

2343

"foreground": "False",

2344

"zeroconf": "True",

2345

}

2346

3079

2347

# Parse config file for server-global settings

3080

server_config = configparser.ConfigParser(server_defaults)

2348

server_config = configparser.SafeConfigParser(server_defaults)

3081

2349

del server_defaults

3082

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

3083

# Convert the ConfigParser object to a dict

2350

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

2351

"mandos.conf"))

2352

# Convert the SafeConfigParser object to a dict

3084

2353

server_settings = server_config.defaults()

3085

2354

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

3086

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

3087

"foreground", "zeroconf"):

2355

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

3088

2356

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

3089

2357

option)

3090

2358

if server_settings["port"]:

3100

2368

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

3101

2369

["socket"])

3102

2370

del server_config

3103

2371

3104

2372

# Override the settings from the config file with command line

3105

2373

# options, if set.

3106

2374

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

3107

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

3108

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

3109

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

2375

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

2376

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

2377

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

3110

2378

value = getattr(options, option)

3111

2379

if value is not None:

3112

2380

server_settings[option] = value

3124

2392

if server_settings["debug"]:

3125

2393

server_settings["foreground"] = True

3126

2394

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

3127

2395

3128

2396

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

3129

3130

if (not server_settings["zeroconf"]

3131

and not (server_settings["port"]

3132

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

3133

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

3134

2397

2398

if (not server_settings["zeroconf"] and

2399

not (server_settings["port"]

2400

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

2401

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

2402

" Zeroconf")

2403

3135

2404

# For convenience

3136

2405

debug = server_settings["debug"]

3137

2406

debuglevel = server_settings["debuglevel"]

3141

2410

stored_state_file)

3142

2411

foreground = server_settings["foreground"]

3143

2412

zeroconf = server_settings["zeroconf"]

3144

2413

3145

2414

if debug:

3146

2415

initlogger(debug, logging.DEBUG)

3147

2416

else:

3150

2419

else:

3151

2420

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

3152

2421

initlogger(debug, level)

3153

2422

3154

2423

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

3155

syslogger.setFormatter(

3156

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

3157

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

3158

server_settings["servicename"])))

3159

2424

syslogger.setFormatter(logging.Formatter

2425

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

2426

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

2427

.format(server_settings

2428

["servicename"])))

2429

3160

2430

# Parse config file with clients

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2431

client_config = configparser.SafeConfigParser(Client

2432

.client_defaults)

3162

2433

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

3163

2434

"clients.conf"))

3164

2435

3165

2436

global mandos_dbus_service

3166

2437

mandos_dbus_service = None

3167

2438

3168

2439

socketfd = None

3169

2440

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

3170

2441

socketfd = server_settings["socket"]

3171

tcp_server = MandosServer(

3172

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

3173

ClientHandler,

3174

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

3175

use_ipv6=use_ipv6,

3176

gnutls_priority=server_settings["priority"],

3177

use_dbus=use_dbus,

3178

socketfd=socketfd)

2442

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

2443

server_settings["port"]),

2444

ClientHandler,

2445

interface=(server_settings["interface"]

2446

or None),

2447

use_ipv6=use_ipv6,

2448

gnutls_priority=

2449

server_settings["priority"],

2450

use_dbus=use_dbus,

2451

socketfd=socketfd)

3179

2452

if not foreground:

3180

2453

pidfilename = "/run/mandos.pid"

3181

2454

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

3182

2455

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

3183

2456

pidfile = None

3184

2457

try:

3185

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

2458

pidfile = open(pidfilename, "w")

3186

2459

except IOError as e:

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2460

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

2461

exc_info=e)

2462

2463

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

3193

2464

try:

3194

2465

uid = pwd.getpwnam(name).pw_uid

3195

gid = pwd.getpwnam(group).pw_gid

2466

gid = pwd.getpwnam(name).pw_gid

3196

2467

break

3197

2468

except KeyError:

3198

2469

continue

3202

2473

try:

3203

2474

os.setgid(gid)

3204

2475

os.setuid(uid)

3205

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

3206

2476

except OSError as error:

3207

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

3208

os.strerror(error.errno))

3209

2477

if error.errno != errno.EPERM:

3210

2478

raise

3211

2479

3212

2480

if debug:

3213

2481

# Enable all possible GnuTLS debugging

3214

2482

3215

2483

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

3216

2484

# - GnuTLS manual

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2485

gnutls.library.functions.gnutls_global_set_log_level(11)

2486

2487

@gnutls.library.types.gnutls_log_func

3220

2488

def debug_gnutls(level, string):

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2489

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

2490

2491

(gnutls.library.functions

2492

.gnutls_global_set_log_function(debug_gnutls))

2493

3226

2494

# Redirect stdin so all checkers get /dev/null

3227

2495

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

3228

2496

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

3229

2497

if null > 2:

3230

2498

os.close(null)

3231

2499

3232

2500

# Need to fork before connecting to D-Bus

3233

2501

if not foreground:

3234

2502

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

3235

2503

daemon()

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2504

2505

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

2506

# need to inform gobject that threads will be used.

2507

gobject.threads_init()

2508

3242

2509

global main_loop

3243

2510

# From the Avahi example code

3244

2511

DBusGMainLoop(set_as_default=True)

3245

main_loop = GLib.MainLoop()

2512

main_loop = gobject.MainLoop()

3246

2513

bus = dbus.SystemBus()

3247

2514

# End of Avahi example code

3248

2515

if use_dbus:

3249

2516

try:

3250

2517

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

3251

bus,

3252

do_not_queue=True)

3253

old_bus_name = dbus.service.BusName(

3254

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

3255

do_not_queue=True)

3256

except dbus.exceptions.DBusException as e:

3257

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

2518

bus, do_not_queue=True)

2519

old_bus_name = (dbus.service.BusName

2520

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

2521

do_not_queue=True))

2522

except dbus.exceptions.NameExistsException as e:

2523

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

3258

2524

use_dbus = False

3259

2525

server_settings["use_dbus"] = False

3260

2526

tcp_server.use_dbus = False

3261

2527

if zeroconf:

3262

2528

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

2529

service = AvahiServiceToSyslog(name =

2530

server_settings["servicename"],

2531

servicetype = "_mandos._tcp",

2532

protocol = protocol, bus = bus)

3268

2533

if server_settings["interface"]:

3269

service.interface = if_nametoindex(

3270

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

3271

2534

service.interface = (if_nametoindex

2535

(server_settings["interface"]

2536

.encode("utf-8")))

2537

3272

2538

global multiprocessing_manager

3273

2539

multiprocessing_manager = multiprocessing.Manager()

3274

2540

3275

2541

client_class = Client

3276

2542

if use_dbus:

3277

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

3278

2543

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

2544

3279

2545

client_settings = Client.config_parser(client_config)

3280

2546

old_client_settings = {}

3281

2547

clients_data = {}

3282

2548

3283

2549

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

3284

2550

global wnull

3285

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

2551

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

3286

2552

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

3287

2553

# mode

3288

2554

if debug or not foreground:

3289

2555

wnull.close()

3290

2556

3291

2557

# Get client data and settings from last running state.

3292

2558

if server_settings["restore"]:

3293

2559

try:

3294

2560

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

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2561

clients_data, old_client_settings = (pickle.load

2562

(stored_state))

3345

2563

os.remove(stored_state_path)

3346

2564

except IOError as e:

3347

2565

if e.errno == errno.ENOENT:

3348

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

3349

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

2566

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

2567

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

3350

2568

else:

3351

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

3352

exc_info=e)

2569

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

2570

exc_info=e)

3353

2571

raise

3354

2572

except EOFError as e:

3355

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

3356

exc_info=e)

3357

2573

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

2574

"EOFError:", exc_info=e)

2575

3358

2576

with PGPEngine() as pgp:

3359

2577

for client_name, client in clients_data.items():

3360

2578

# Skip removed clients

3361

2579

if client_name not in client_settings:

3362

2580

continue

3363

2581

3364

2582

# Decide which value to use after restoring saved state.

3365

2583

# We have three different values: Old config file,

3366

2584

# new config file, and saved state.

3371

2589

# For each value in new config, check if it

3372

2590

# differs from the old config value (Except for

3373

2591

# the "secret" attribute)

3374

if (name != "secret"

3375

and (value !=

3376

old_client_settings[client_name][name])):

2592

if (name != "secret" and

2593

value != old_client_settings[client_name]

2594

[name]):

3377

2595

client[name] = value

3378

2596

except KeyError:

3379

2597

pass

3380

2598

3381

2599

# Clients who has passed its expire date can still be

3382

# enabled if its last checker was successful. A Client

2600

# enabled if its last checker was successful. Clients

3383

2601

# whose checker succeeded before we stored its state is

3384

2602

# assumed to have successfully run all checkers during

3385

2603

# downtime.

3386

2604

if client["enabled"]:

3387

2605

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

3388

2606

if not client["last_checked_ok"]:

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

2607

logger.warning(

2608

"disabling client {} - Client never "

2609

"performed a successful checker"

2610

.format(client_name))

3392

2611

client["enabled"] = False

3393

2612

elif client["last_checker_status"] != 0:

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2613

logger.warning(

2614

"disabling client {} - Client last"

2615

" checker failed with error code {}"

2616

.format(client_name,

2617

client["last_checker_status"]))

3398

2618

client["enabled"] = False

3399

2619

else:

3400

client["expires"] = (

3401

datetime.datetime.utcnow()

3402

+ client["timeout"])

3403

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

3404

" enabled", client_name)

2620

client["expires"] = (datetime.datetime

2621

.utcnow()

2622

+ client["timeout"])

2623

logger.debug("Last checker succeeded,"

2624

" keeping {} enabled"

2625

.format(client_name))

3405

2626

try:

3406

client["secret"] = pgp.decrypt(

3407

client["encrypted_secret"],

3408

client_settings[client_name]["secret"])

2627

client["secret"] = (

2628

pgp.decrypt(client["encrypted_secret"],

2629

client_settings[client_name]

2630

["secret"]))

3409

2631

except PGPError:

3410

2632

# If decryption fails, we use secret from new settings

3411

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

3412

client_name)

3413

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

3414

["secret"])

3415

2633

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

2634

.format(client_name))

2635

client["secret"] = (

2636

client_settings[client_name]["secret"])

2637

3416

2638

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

3417

2639

for client_name in (set(old_client_settings)

3418

2640

- set(client_settings)):

3420

2642

for client_name in (set(client_settings)

3421

2643

- set(old_client_settings)):

3422

2644

clients_data[client_name] = client_settings[client_name]

3423

2645

3424

2646

# Create all client objects

3425

2647

for client_name, client in clients_data.items():

3426

2648

tcp_server.clients[client_name] = client_class(

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2649

name = client_name, settings = client,

2650

server_settings = server_settings)

2651

3431

2652

if not tcp_server.clients:

3432

log.warning("No clients defined")

3433

2653

logger.warning("No clients defined")

2654

3434

2655

if not foreground:

3435

2656

if pidfile is not None:

3436

pid = os.getpid()

3437

2657

try:

3438

2658

with pidfile:

3439

print(pid, file=pidfile)

2659

pid = os.getpid()

2660

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

3440

2661

except IOError:

3441

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

3442

pidfilename, pid)

2662

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

2663

pidfilename, pid)

3443

2664

del pidfile

3444

2665

del pidfilename

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2666

2667

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

2668

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

2669

3450

2670

if use_dbus:

3451

3452

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2671

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

2672

"se.bsnet.fukt.Mandos"})

2673

class MandosDBusService(DBusObjectWithProperties):

3455

2674

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

3456

3457

2675

def __init__(self):

3458

2676

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

3459

3460

2677

_interface = "se.recompile.Mandos"

3461

2678

2679

@dbus_interface_annotations(_interface)

2680

def _foo(self):

2681

return { "org.freedesktop.DBus.Property"

2682

".EmitsChangedSignal":

2683

"false"}

2684

3462

2685

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

3463

2686

def ClientAdded(self, objpath):

3464

2687

"D-Bus signal"

3465

2688

pass

3466

2689

3467

2690

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

3468

def ClientNotFound(self, key_id, address):

2691

def ClientNotFound(self, fingerprint, address):

3469

2692

"D-Bus signal"

3470

2693

pass

3471

3472

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

3473

"true"})

2694

3474

2695

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

3475

2696

def ClientRemoved(self, objpath, name):

3476

2697

"D-Bus signal"

3477

2698

pass

3478

3479

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

3480

"true"})

2699

3481

2700

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

3482

2701

def GetAllClients(self):

3483

2702

"D-Bus method"

3484

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2703

return dbus.Array(c.dbus_object_path

2704

for c in

2705

tcp_server.clients.itervalues())

2706

3489

2707

@dbus.service.method(_interface,

3490

2708

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

3491

2709

def GetAllClientsWithProperties(self):

3492

2710

"D-Bus method"

3493

2711

return dbus.Dictionary(

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2712

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

2713

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

3497

2714

signature="oa{sv}")

3498

2715

3499

2716

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

3500

2717

def RemoveClient(self, object_path):

3501

2718

"D-Bus method"

3502

for c in tcp_server.clients.values():

2719

for c in tcp_server.clients.itervalues():

3503

2720

if c.dbus_object_path == object_path:

3504

2721

del tcp_server.clients[c.name]

3505

2722

c.remove_from_connection()

3506

# Don't signal the disabling

2723

# Don't signal anything except ClientRemoved

3507

2724

c.disable(quiet=True)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2725

# Emit D-Bus signal

2726

self.ClientRemoved(object_path, c.name)

3510

2727

return

3511

2728

raise KeyError(object_path)

3512

2729

3513

2730

del _interface

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2731

3551

2732

mandos_dbus_service = MandosDBusService()

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2733

3558

2734

def cleanup():

3559

2735

"Cleanup function; run on exit"

3560

2736

if zeroconf:

3561

2737

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

2738

2739

multiprocessing.active_children()

2740

wnull.close()

3565

2741

if not (tcp_server.clients or client_settings):

3566

2742

return

3567

2743

3568

2744

# Store client before exiting. Secrets are encrypted with key

3569

2745

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

3570

2746

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

3571

2747

clients = {}

3572

2748

with PGPEngine() as pgp:

3573

for client in tcp_server.clients.values():

2749

for client in tcp_server.clients.itervalues():

3574

2750

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

3575

2751

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

3576

2752

key)

3577

2753

client_dict = {}

3578

2754

3579

2755

# A list of attributes that can not be pickled

3580

2756

# + secret.

3581

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

3582

"checker", "server_settings"}

3583

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

3584

.Object):

2757

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

2758

"checker", "server_settings" }

2759

for name, typ in (inspect.getmembers

2760

(dbus.service.Object)):

3585

2761

exclude.add(name)

3586

2762

3587

2763

client_dict["encrypted_secret"] = (client

3588

2764

.encrypted_secret)

3589

2765

for attr in client.client_structure:

3590

2766

if attr not in exclude:

3591

2767

client_dict[attr] = getattr(client, attr)

3592

2768

3593

2769

clients[client.name] = client_dict

3594

2770

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

3595

2771

3596

2772

try:

3597

with tempfile.NamedTemporaryFile(

3598

mode="wb",

3599

suffix=".pickle",

3600

prefix="clients-",

3601

dir=os.path.dirname(stored_state_path),

3602

delete=False) as stored_state:

3603

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

3604

protocol=2)

3605

tempname = stored_state.name

2773

with (tempfile.NamedTemporaryFile

2774

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

2775

dir=os.path.dirname(stored_state_path),

2776

delete=False)) as stored_state:

2777

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

2778

tempname=stored_state.name

3606

2779

os.rename(tempname, stored_state_path)

3607

2780

except (IOError, OSError) as e:

3608

2781

if not debug:

3611

2784

except NameError:

3612

2785

pass

3613

2786

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

3614

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

3615

os.strerror(e.errno))

2787

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

2788

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

3616

2789

else:

3617

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

3618

exc_info=e)

2790

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

2791

exc_info=e)

3619

2792

raise

3620

2793

3621

2794

# Delete all clients, and settings from config

3622

2795

while tcp_server.clients:

3623

2796

name, client = tcp_server.clients.popitem()

3624

2797

if use_dbus:

3625

2798

client.remove_from_connection()

3626

# Don't signal the disabling

2799

# Don't signal anything except ClientRemoved

3627

2800

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

3629

2801

if use_dbus:

3630

mandos_dbus_service.client_removed_signal(client)

2802

# Emit D-Bus signal

2803

mandos_dbus_service.ClientRemoved(client

2804

.dbus_object_path,

2805

client.name)

3631

2806

client_settings.clear()

3632

2807

3633

2808

atexit.register(cleanup)

3634

3635

for client in tcp_server.clients.values():

2809

2810

for client in tcp_server.clients.itervalues():

3636

2811

if use_dbus:

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2812

# Emit D-Bus signal

2813

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3639

2814

# Need to initiate checking of clients

3640

2815

if client.enabled:

3641

client.init_checker(randomize_start=True)

3642

2816

client.init_checker()

2817

3643

2818

tcp_server.enable()

3644

2819

tcp_server.server_activate()

3645

2820

3646

2821

# Find out what port we got

3647

2822

if zeroconf:

3648

2823

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

3649

2824

if use_ipv6:

3650

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

3651

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

2825

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

2826

" flowinfo %d, scope_id %d",

2827

*tcp_server.socket.getsockname())

3652

2828

else: # IPv4

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

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

3658

2834

try:

3659

2835

if zeroconf:

3660

2836

# From the Avahi example code

3661

2837

try:

3662

2838

service.activate()

3663

2839

except dbus.exceptions.DBusException as error:

3664

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

2840

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

3665

2841

cleanup()

3666

2842

sys.exit(1)

3667

2843

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3674

3675

log.debug("Starting main loop")

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

3676

2851

main_loop.run()

3677

2852

except AvahiError as error:

3678

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

2853

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

3679

2854

cleanup()

3680

2855

sys.exit(1)

3681

2856

except KeyboardInterrupt:

3682

2857

if debug:

3683

2858

print("", file=sys.stderr)

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2859

logger.debug("Server received KeyboardInterrupt")

2860

logger.debug("Server exiting")

3686

2861

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

3687

2862

cleanup()

3688

2863

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

# (setq minor-mode-overriding-map-alist

3782

# (cons `(run-tests . ,outer-keymap)

3783

# minor-mode-overriding-map-alist)))

3784

# (add-hook 'after-save-hook run-tests 90 t))

3785

# End:

2864

if __name__ == '__main__':

2865

main()