/mandos/trunk : revision 723.1.4

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

89

SO_BINDTODEVICE = None

90

91

version = "1.6.7"

147

92

stored_state_file = "clients.pickle"

148

93

149

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

150

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

94

logger = logging.getLogger()

151

95

syslogger = None

152

96

153

97

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

156

101

except (OSError, AttributeError):

157

158

102

def if_nametoindex(interface):

159

103

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

160

104

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

161

105

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

162

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

165

111

return interface_index

166

112

167

113

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

114

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

185

115

"""init logger and add loglevel"""

186

116

187

117

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

191

122

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

123

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

124

' %(message)s'))

125

logger.addHandler(syslogger)

126

196

127

if debug:

197

128

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)

129

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

130

' [%(process)d]:'

131

' %(levelname)s:'

132

' %(message)s'))

133

logger.addHandler(console)

134

logger.setLevel(level)

204

135

205

136

206

137

class PGPError(Exception):

208

139

pass

209

140

210

141

211

class PGPEngine:

142

class PGPEngine(object):

212

143

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

213

214

144

def __init__(self):

215

145

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

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

265

182

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

266

183

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

267

184

return encoded

268

185

269

186

def encrypt(self, data, password):

270

187

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

273

190

passfile.write(passphrase)

274

191

passfile.flush()

275

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

276

"--passphrase-file",

192

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

193

'--passphrase-file',

277

194

passfile.name]

278

195

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

283

200

if proc.returncode != 0:

284

201

raise PGPError(err)

285

202

return ciphertext

286

203

287

204

def decrypt(self, data, password):

288

205

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

291

208

passfile.write(passphrase)

292

209

passfile.flush()

293

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

294

"--passphrase-file",

210

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

211

'--passphrase-file',

295

212

passfile.name]

296

213

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

301

219

if proc.returncode != 0:

302

220

raise PGPError(err)

303

221

return decrypted_plaintext

304

222

305

223

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

224

class AvahiError(Exception):

333

225

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

334

226

self.value = value

335

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

336

**kwargs)

337

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

338

230

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 = unicode(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

unicode(error))

341

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

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

class Client(object):

875

412

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

876

413

877

414

Attributes:

878

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

415

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

879

416

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

880

417

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

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

885

422

checker_command: string; External command which is run to check

886

423

if client lives. %() expansions are done at

887

424

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

888

425

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

889

checker_initiator_tag: a GLib event source tag, or None

426

checker_initiator_tag: a gobject event source tag, or None

890

427

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

891

428

client_structure: Object describing what attributes a client has

892

429

and is used for storing the client at exit

893

430

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

431

disable_initiator_tag: a gobject event source tag, or None

895

432

enabled: bool()

896

433

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

434

uniquely identify the client

900

435

host: string; available for use by the checker command

901

436

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

902

437

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

904

439

last_checker_status: integer between 0 and 255 reflecting exit

905

440

status of last checker. -1 reflects crashed

906

441

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

442

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

910

443

911

444

D-Bus identifiers

918

451

disabled, or None

919

452

server_settings: The server_settings dict from main()

920

453

"""

921

454

922

455

runtime_expansions = ("approval_delay", "approval_duration",

923

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

456

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

924

457

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

925

458

"last_approval_request", "last_checked_ok",

926

459

"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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

939

486

@staticmethod

940

487

def config_parser(config):

941

488

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

948

495

for client_name in config.sections():

949

496

section = dict(config.items(client_name))

950

497

client = settings[client_name] = {}

951

498

952

499

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

953

500

# Reformat values from string types to Python types

954

501

client["approved_by_default"] = config.getboolean(

955

502

client_name, "approved_by_default")

956

503

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

957

504

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

505

964

506

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

965

507

.replace(" ", ""))

966

508

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

509

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

970

510

elif "secfile" in section:

971

511

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

972

512

(section["secfile"])),

973

513

"rb") as secfile:

974

514

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

975

515

else:

976

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

516

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

977

517

.format(section))

978

518

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

979

519

client["extended_timeout"] = string_to_delta(

987

527

client["last_approval_request"] = None

988

528

client["last_checked_ok"] = None

989

529

client["last_checker_status"] = -2

990

530

991

531

return settings

992

993

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

532

533

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

994

534

self.name = name

995

535

if server_settings is None:

996

536

server_settings = {}

998

538

# adding all client settings

999

539

for setting, value in settings.items():

1000

540

setattr(self, setting, value)

1001

541

1002

542

if self.enabled:

1003

543

if not hasattr(self, "last_enabled"):

1004

544

self.last_enabled = datetime.datetime.utcnow()

1008

548

else:

1009

549

self.last_enabled = None

1010

550

self.expires = None

1011

1012

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

1013

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

1014

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

551

552

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

556

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

1015

557

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

1016

558

datetime.datetime.utcnow())

1017

559

1018

560

# attributes specific for this server instance

1019

561

self.checker = None

1020

562

self.checker_initiator_tag = None

1023

565

self.current_checker_command = None

1024

566

self.approved = None

1025

567

self.approvals_pending = 0

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

1030

573

if not attr.startswith("_")]

1031

574

self.client_structure.append("client_structure")

1032

1033

for name, t in inspect.getmembers(

1034

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

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

1035

580

if not name.startswith("_"):

1036

581

self.client_structure.append(name)

1037

582

1038

583

# Send notice to process children that client state has changed

1039

584

def send_changedstate(self):

1040

585

with self.changedstate:

1041

586

self.changedstate.notify_all()

1042

587

1043

588

def enable(self):

1044

589

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

1045

590

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

1050

595

self.last_enabled = datetime.datetime.utcnow()

1051

596

self.init_checker()

1052

597

self.send_changedstate()

1053

598

1054

599

def disable(self, quiet=True):

1055

600

"""Disable this client."""

1056

601

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

1057

602

return False

1058

603

if not quiet:

1059

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

604

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

1060

605

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

1061

GLib.source_remove(self.disable_initiator_tag)

606

gobject.source_remove(self.disable_initiator_tag)

1062

607

self.disable_initiator_tag = None

1063

608

self.expires = None

1064

609

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

1065

GLib.source_remove(self.checker_initiator_tag)

610

gobject.source_remove(self.checker_initiator_tag)

1066

611

self.checker_initiator_tag = None

1067

612

self.stop_checker()

1068

613

self.enabled = False

1069

614

if not quiet:

1070

615

self.send_changedstate()

1071

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

616

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

1072

617

return False

1073

618

1074

619

def __del__(self):

1075

620

self.disable()

1076

621

1077

622

def init_checker(self):

1078

623

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

1079

624

# and every interval from then on.

1080

625

if self.checker_initiator_tag is not None:

1081

GLib.source_remove(self.checker_initiator_tag)

1082

self.checker_initiator_tag = GLib.timeout_add(

1083

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

1084

+ 1)),

1085

self.start_checker)

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

1086

630

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

1087

631

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

1090

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

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

1091

636

# Also start a new checker *right now*.

1092

637

self.start_checker()

1093

1094

def checker_callback(self, source, condition, connection,

1095

command):

638

639

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

1096

640

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

1097

# Read return code from connection (see call_pipe)

1098

returncode = connection.recv()

1099

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

1102

641

self.checker_callback_tag = None

1103

642

self.checker = None

1104

1105

if returncode >= 0:

1106

self.last_checker_status = returncode

1107

self.last_checker_signal = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1108

645

if self.last_checker_status == 0:

1109

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

646

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

647

vars(self))

1110

648

self.checked_ok()

1111

649

else:

1112

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

650

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

651

vars(self))

1113

652

else:

1114

653

self.last_checker_status = -1

1115

self.last_checker_signal = -returncode

1116

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

1117

return False

1118

654

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

655

vars(self))

656

1119

657

def checked_ok(self):

1120

658

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

1121

659

self.last_checked_ok = datetime.datetime.utcnow()

1122

660

self.last_checker_status = 0

1123

self.last_checker_signal = None

1124

661

self.bump_timeout()

1125

662

1126

663

def bump_timeout(self, timeout=None):

1127

664

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

1128

665

if timeout is None:

1129

666

timeout = self.timeout

1130

667

if self.disable_initiator_tag is not None:

1131

GLib.source_remove(self.disable_initiator_tag)

668

gobject.source_remove(self.disable_initiator_tag)

1132

669

self.disable_initiator_tag = None

1133

670

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

1134

self.disable_initiator_tag = GLib.timeout_add(

1135

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1136

674

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

1137

675

1138

676

def need_approval(self):

1139

677

self.last_approval_request = datetime.datetime.utcnow()

1140

678

1141

679

def start_checker(self):

1142

680

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

1143

681

1144

682

If a checker already exists, leave it running and do

1145

683

nothing."""

1146

684

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

1151

689

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

1152

690

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

1153

691

# should be.

1154

1155

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

1156

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

1157

self.checker.join()

1158

self.checker = None

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1159

707

# Start a new checker if needed

1160

708

if self.checker is None:

1161

709

# Escape attributes for the shell

1162

escaped_attrs = {

1163

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

1164

for attr in self.runtime_expansions}

710

escaped_attrs = { attr:

711

re.escape(unicode(getattr(self,

712

attr)))

713

for attr in self.runtime_expansions }

1165

714

try:

1166

715

command = self.checker_command % escaped_attrs

1167

716

except TypeError as error:

1168

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

1169

self.checker_command, exc_info=error)

1170

return True # Try again later

717

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1171

720

self.current_checker_command = command

1172

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

1173

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

1174

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

1175

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

1176

# always replaced by /dev/null.)

1177

# The exception is when not debugging but nevertheless

1178

# running in the foreground; use the previously

1179

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

1183

if (not self.server_settings["debug"]

1184

and self.server_settings["foreground"]):

1185

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

1188

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

1192

self.checker.start()

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

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

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1196

self.checker_callback, pipe[0], command)

1197

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

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1198

763

return True

1199

764

1200

765

def stop_checker(self):

1201

766

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

1202

767

if self.checker_callback_tag:

1203

GLib.source_remove(self.checker_callback_tag)

768

gobject.source_remove(self.checker_callback_tag)

1204

769

self.checker_callback_tag = None

1205

770

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

1206

771

return

1207

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

1208

self.checker.terminate()

772

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1209

781

self.checker = None

1210

782

1211

783

1212

def dbus_service_property(dbus_interface,

1213

signature="v",

1214

access="readwrite",

1215

byte_arrays=False):

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1216

786

"""Decorators for marking methods of a DBusObjectWithProperties to

1217

787

become properties on the D-Bus.

1218

788

1219

789

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

1220

790

and with one argument by "Set".

1221

791

1222

792

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

1223

793

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

1224

794

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

1227

797

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

1228

798

if byte_arrays and signature != "ay":

1229

799

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

1230

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

1231

800

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

1232

801

def decorator(func):

1233

802

func._dbus_is_property = True

1234

803

func._dbus_interface = dbus_interface

1237

806

func._dbus_name = func.__name__

1238

807

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

1239

808

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

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1241

810

return func

1242

1243

811

return decorator

1244

812

1245

813

1246

814

def dbus_interface_annotations(dbus_interface):

1247

815

"""Decorator for marking functions returning interface annotations

1248

816

1249

817

Usage:

1250

818

1251

819

@dbus_interface_annotations("org.example.Interface")

1252

820

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

1253

821

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

1254

822

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

1255

823

"false"}

1256

824

"""

1257

1258

825

def decorator(func):

1259

826

func._dbus_is_interface = True

1260

827

func._dbus_interface = dbus_interface

1261

828

func._dbus_name = dbus_interface

1262

829

return func

1263

1264

830

return decorator

1265

831

1266

832

1267

833

def dbus_annotations(annotations):

1268

834

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

1269

835

Usage:

1270

1271

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

1272

"org.freedesktop.DBus.Property."

1273

"EmitsChangedSignal": "false"})

836

1274

837

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

1275

838

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

1276

842

def Property_dbus_property(self):

1277

843

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

1280

844

"""

1281

1282

845

def decorator(func):

1283

846

func._dbus_annotations = annotations

1284

847

return func

1285

1286

848

return decorator

1287

849

1288

850

1289

851

class DBusPropertyException(dbus.exceptions.DBusException):

1290

852

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

1291

853

"""

1292

pass

854

def __unicode__(self):

855

return unicode(str(self))

1293

856

1294

857

1295

858

class DBusPropertyAccessException(DBusPropertyException):

1304

867

pass

1305

868

1306

869

1307

class DBusObjectWithAnnotations(dbus.service.Object):

1308

"""A D-Bus object with annotations.

1309

1310

Classes inheriting from this can use the dbus_annotations

1311

decorator to add annotations to methods or signals.

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1312

876

"""

1313

877

1314

878

@staticmethod

1315

879

def _is_dbus_thing(thing):

1316

880

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

1317

881

1318

882

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

1319

883

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

1320

884

"""

1321

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

885

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

1322

886

False)

1323

887

1324

888

def _get_all_dbus_things(self, thing):

1325

889

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

1326

890

"""

1327

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

891

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

892

name),

1328

893

athing.__get__(self))

1329

894

for cls in self.__class__.__mro__

1330

895

for name, athing in

1331

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

1332

1333

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1337

def Introspect(self, object_path, connection):

1338

"""Overloading of standard D-Bus method.

1339

1340

Inserts annotation tags on methods and signals.

1341

"""

1342

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

1343

connection)

1344

try:

1345

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

1346

1347

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

1348

# Add annotation tags

1349

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

1350

for tag in if_tag.getElementsByTagName(typ):

1351

annots = dict()

1352

for name, prop in (self.

1353

_get_all_dbus_things(typ)):

1354

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

1355

and prop._dbus_interface

1356

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

1357

annots.update(getattr(

1358

prop, "_dbus_annotations", {}))

1359

for name, value in annots.items():

1360

ann_tag = document.createElement(

1361

"annotation")

1362

ann_tag.setAttribute("name", name)

1363

ann_tag.setAttribute("value", value)

1364

tag.appendChild(ann_tag)

1365

# Add interface annotation tags

1366

for annotation, value in dict(

1367

itertools.chain.from_iterable(

1368

annotations().items()

1369

for name, annotations

1370

in self._get_all_dbus_things("interface")

1371

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

1372

)).items():

1373

ann_tag = document.createElement("annotation")

1374

ann_tag.setAttribute("name", annotation)

1375

ann_tag.setAttribute("value", value)

1376

if_tag.appendChild(ann_tag)

1377

# Fix argument name for the Introspect method itself

1378

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1380

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

1381

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

1382

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

1383

if (arg.getAttribute("direction")

1384

== "out"):

1385

arg.setAttribute("name",

1386

"xml_data")

1387

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

1388

document.unlink()

1389

except (AttributeError, xml.dom.DOMException,

1390

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1393

return xmlstring

1394

1395

1396

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

"""A D-Bus object with properties.

1398

1399

Classes inheriting from this can use the dbus_service_property

1400

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

1401

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

1402

"""

1403

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1404

899

def _get_dbus_property(self, interface_name, property_name):

1405

900

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

1406

901

property with the specified name and interface.

1407

902

"""

1408

for cls in self.__class__.__mro__:

1409

for name, value in inspect.getmembers(

1410

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

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1411

907

if (value._dbus_name == property_name

1412

908

and value._dbus_interface == interface_name):

1413

909

return value.__get__(self)

1414

910

1415

911

# No such property

1416

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

1417

self.dbus_object_path, interface_name, property_name))

1418

1419

@classmethod

1420

def _get_all_interface_names(cls):

1421

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

1422

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

1423

"_dbus_interface", None)

1424

for x in (inspect.getmro(cls))

1425

for attr in dir(x))

1426

if name is not None)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="ss",

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1430

917

out_signature="v")

1431

918

def Get(self, interface_name, property_name):

1432

919

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

1438

925

if not hasattr(value, "variant_level"):

1439

926

return value

1440

927

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

1441

928

1442

929

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

1443

930

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

1444

931

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

1451

938

# signatures other than "ay".

1452

939

if prop._dbus_signature != "ay":

1453

940

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

1454

"'ay' signature {!r}"

941

"'ay' signature {0!r}"

1455

942

.format(prop._dbus_signature))

1456

value = dbus.ByteArray(bytes(value))

943

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

944

for byte in value))

1457

945

prop(value)

1458

1459

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

in_signature="s",

946

947

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

1461

948

out_signature="a{sv}")

1462

949

def GetAll(self, interface_name):

1463

950

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

1464

951

standard.

1465

952

1466

953

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

1467

954

"""

1468

955

properties = {}

1478

965

if not hasattr(value, "variant_level"):

1479

966

properties[name] = value

1480

967

continue

1481

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

968

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

969

value.variant_level+1)

1483

970

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

1484

1485

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

1486

def PropertiesChanged(self, interface_name, changed_properties,

1487

invalidated_properties):

1488

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

1489

standard.

1490

"""

1491

pass

1492

971

1493

972

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1494

973

out_signature="s",

1495

path_keyword="object_path",

1496

connection_keyword="connection")

974

path_keyword='object_path',

975

connection_keyword='connection')

1497

976

def Introspect(self, object_path, connection):

1498

977

"""Overloading of standard D-Bus method.

1499

978

1500

979

Inserts property tags and interface annotation tags.

1501

980

"""

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

981

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

982

connection)

1505

983

try:

1506

984

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

1507

1508

985

def make_tag(document, name, prop):

1509

986

e = document.createElement("property")

1510

987

e.setAttribute("name", name)

1511

988

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

1512

989

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

1513

990

return e

1514

1515

991

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

1516

992

# Add property tags

1517

993

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

1520

996

if prop._dbus_interface

1521

997

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

1522

998

if_tag.appendChild(tag)

1523

# Add annotation tags for properties

1524

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

1525

annots = dict()

1526

for name, prop in self._get_all_dbus_things(

1527

"property"):

1528

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

1529

and prop._dbus_interface

1530

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

1531

annots.update(getattr(

1532

prop, "_dbus_annotations", {}))

1533

for name, value in annots.items():

1534

ann_tag = document.createElement(

1535

"annotation")

1536

ann_tag.setAttribute("name", name)

1537

ann_tag.setAttribute("value", value)

1538

tag.appendChild(ann_tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.items():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().items()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).items():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1539

1030

# Add the names to the return values for the

1540

1031

# "org.freedesktop.DBus.Properties" methods

1541

1032

if (if_tag.getAttribute("name")

1555

1046

document.unlink()

1556

1047

except (AttributeError, xml.dom.DOMException,

1557

1048

xml.parsers.expat.ExpatError) as error:

1558

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

1559

exc_info=error)

1560

return xmlstring

1561

1562

1563

try:

1564

dbus.OBJECT_MANAGER_IFACE

1565

except AttributeError:

1566

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

1567

1568

1569

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

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

1571

1572

Classes inheriting from this exposes the standard

1573

GetManagedObjects call and the InterfacesAdded and

1574

InterfacesRemoved signals on the standard

1575

"org.freedesktop.DBus.ObjectManager" interface.

1576

1577

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

1578

manually.

1579

"""

1580

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1582

def GetManagedObjects(self):

1583

"""This function must be overridden"""

1584

raise NotImplementedError()

1585

1586

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1588

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

pass

1590

1591

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

1592

def InterfacesRemoved(self, object_path, interfaces):

1593

pass

1594

1595

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1599

def Introspect(self, object_path, connection):

1600

"""Overloading of standard D-Bus method.

1601

1602

Override return argument name of GetManagedObjects to be

1603

"objpath_interfaces_and_properties"

1604

"""

1605

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1606

object_path,

1607

connection)

1608

try:

1609

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

1610

1611

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

1612

# Fix argument name for the GetManagedObjects method

1613

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1615

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

1616

if (cn.getAttribute("name")

1617

== "GetManagedObjects"):

1618

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

1619

if (arg.getAttribute("direction")

1620

== "out"):

1621

arg.setAttribute(

1622

"name",

1623

"objpath_interfaces"

1624

"_and_properties")

1625

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

1626

document.unlink()

1627

except (AttributeError, xml.dom.DOMException,

1628

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1049

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

1050

exc_info=error)

1631

1051

return xmlstring

1632

1052

1633

1053

1634

1054

def datetime_to_dbus(dt, variant_level=0):

1635

1055

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

1636

1056

if dt is None:

1637

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

1638

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

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1639

1060

1640

1061

1641

1062

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1643

1064

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

1644

1065

interface names according to the "alt_interface_names" mapping.

1645

1066

Usage:

1646

1067

1647

1068

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

1648

1069

"net.example.AlternateInterface"})

1649

1070

class SampleDBusObject(dbus.service.Object):

1650

1071

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

1651

1072

def SampleDBusMethod():

1652

1073

pass

1653

1074

1654

1075

The above "SampleDBusMethod" on "SampleDBusObject" will be

1655

1076

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

1656

1077

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

1657

1078

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

1658

1079

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

1659

1080

1660

1081

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

1661

1082

(from DBusObjectWithProperties) and interfaces (from the

1662

1083

dbus_interface_annotations decorator).

1663

1084

"""

1664

1665

1085

def wrapper(cls):

1666

1086

for orig_interface_name, alt_interface_name in (

1667

alt_interface_names.items()):

1087

alt_interface_names.items()):

1668

1088

attr = {}

1669

1089

interface_names = set()

1670

1090

# Go though all attributes of the class

1672

1092

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

1673

1093

# with the wrong interface name

1674

1094

if (not hasattr(attribute, "_dbus_interface")

1675

or not attribute._dbus_interface.startswith(

1676

orig_interface_name)):

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1677

1097

continue

1678

1098

# Create an alternate D-Bus interface name based on

1679

1099

# the current name

1680

alt_interface = attribute._dbus_interface.replace(

1681

orig_interface_name, alt_interface_name)

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1682

1103

interface_names.add(alt_interface)

1683

1104

# Is this a D-Bus signal?

1684

1105

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

1685

1106

# Extract the original non-method undecorated

1686

1107

# function by black magic

1687

if sys.version_info.major == 2:

1688

nonmethod_func = (dict(

1108

nonmethod_func = (dict(

1689

1109

zip(attribute.func_code.co_freevars,

1690

attribute.__closure__))

1691

["func"].cell_contents)

1692

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1697

1112

# Create a new, but exactly alike, function

1698

1113

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

1699

1114

# with the alternate D-Bus interface name

1700

new_function = copy_function(nonmethod_func)

1701

new_function = (dbus.service.signal(

1702

alt_interface,

1703

attribute._dbus_signature)(new_function))

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1704

1124

# Copy annotations, if any

1705

1125

try:

1706

new_function._dbus_annotations = dict(

1707

attribute._dbus_annotations)

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1708

1128

except AttributeError:

1709

1129

pass

1710

1711

1130

# Define a creator of a function to call both the

1712

1131

# original and alternate functions, so both the

1713

1132

# original and alternate signals gets sent when

1716

1135

"""This function is a scope container to pass

1717

1136

func1 and func2 to the "call_both" function

1718

1137

outside of its arguments"""

1719

1720

@functools.wraps(func2)

1721

1138

def call_both(*args, **kwargs):

1722

1139

"""This function will emit two D-Bus

1723

1140

signals by calling func1 and func2"""

1724

1141

func1(*args, **kwargs)

1725

1142

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1728

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

1729

if name.startswith("_dbus_"):

1730

setattr(call_both, name, attr)

1731

1732

1143

return call_both

1733

1144

# Create the "call_both" function and add it to

1734

1145

# the class

1739

1150

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

1740

1151

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

1741

1152

# to the class.

1742

attr[attrname] = (

1743

dbus.service.method(

1744

alt_interface,

1745

attribute._dbus_in_signature,

1746

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1748

1163

# Copy annotations, if any

1749

1164

try:

1750

attr[attrname]._dbus_annotations = dict(

1751

attribute._dbus_annotations)

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1752

1167

except AttributeError:

1753

1168

pass

1754

1169

# Is this a D-Bus property?

1757

1172

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

1758

1173

# property with the alternate D-Bus interface

1759

1174

# name. Add it to the class.

1760

attr[attrname] = (dbus_service_property(

1761

alt_interface, attribute._dbus_signature,

1762

attribute._dbus_access,

1763

attribute._dbus_get_args_options

1764

["byte_arrays"])

1765

(copy_function(attribute)))

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1766

1188

# Copy annotations, if any

1767

1189

try:

1768

attr[attrname]._dbus_annotations = dict(

1769

attribute._dbus_annotations)

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1770

1192

except AttributeError:

1771

1193

pass

1772

1194

# Is this a D-Bus interface?

1775

1197

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

1776

1198

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

1777

1199

# to the class.

1778

attr[attrname] = (

1779

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1781

1208

if deprecate:

1782

1209

# Deprecate all alternate interfaces

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1784

1211

for interface_name in interface_names:

1785

1786

1212

@dbus_interface_annotations(interface_name)

1787

1213

def func(self):

1788

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

1789

"true"}

1214

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

1215

"true" }

1790

1216

# Find an unused name

1791

1217

for aname in (iname.format(i)

1792

1218

for i in itertools.count()):

1796

1222

if interface_names:

1797

1223

# Replace the class with a new subclass of it with

1798

1224

# methods, signals, etc. as created above.

1799

if sys.version_info.major == 2:

1800

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

1801

(cls, ), attr)

1802

else:

1803

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

1804

(cls, ), attr)

1225

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

1226

(cls,), attr)

1805

1227

return cls

1806

1807

1228

return wrapper

1808

1229

1809

1230

1810

1231

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

1811

"se.bsnet.fukt.Mandos"})

1232

"se.bsnet.fukt.Mandos"})

1812

1233

class ClientDBus(Client, DBusObjectWithProperties):

1813

1234

"""A Client class using D-Bus

1814

1235

1815

1236

Attributes:

1816

1237

dbus_object_path: dbus.ObjectPath

1817

1238

bus: dbus.SystemBus()

1818

1239

"""

1819

1240

1820

1241

runtime_expansions = (Client.runtime_expansions

1821

+ ("dbus_object_path", ))

1822

1823

_interface = "se.recompile.Mandos.Client"

1824

1242

+ ("dbus_object_path",))

1243

1825

1244

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

1826

1827

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

1245

1246

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

1828

1247

self.bus = bus

1829

1248

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

1830

1249

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

1831

1250

# the D-Bus

1832

client_object_name = str(self.name).translate(

1251

client_object_name = unicode(self.name).translate(

1833

1252

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

1834

1253

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

1835

self.dbus_object_path = dbus.ObjectPath(

1836

"/clients/" + client_object_name)

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1837

1256

DBusObjectWithProperties.__init__(self, self.bus,

1838

1257

self.dbus_object_path)

1839

1840

def notifychangeproperty(transform_func, dbus_name,

1841

type_func=lambda x: x,

1842

variant_level=1,

1843

invalidate_only=False,

1844

_interface=_interface):

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1845

1262

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

1846

1263

its changes to DBus.

1847

1264

1848

1265

transform_fun: Function that takes a value and a variant_level

1849

1266

and transforms it to a D-Bus type.

1850

1267

dbus_name: D-Bus name of the variable

1852

1269

to the D-Bus. Default: no transform

1853

1270

variant_level: D-Bus variant level. Default: 1

1854

1271

"""

1855

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

1856

1272

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

1857

1273

def setter(self, value):

1858

1274

if hasattr(self, "dbus_object_path"):

1859

1275

if (not hasattr(self, attrname) or

1860

1276

type_func(getattr(self, attrname, None))

1861

1277

!= type_func(value)):

1862

if invalidate_only:

1863

self.PropertiesChanged(

1864

_interface, dbus.Dictionary(),

1865

dbus.Array((dbus_name, )))

1866

else:

1867

dbus_value = transform_func(

1868

type_func(value),

1869

variant_level=variant_level)

1870

self.PropertyChanged(dbus.String(dbus_name),

1871

dbus_value)

1872

self.PropertiesChanged(

1873

_interface,

1874

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

1875

dbus_value}),

1876

dbus.Array())

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1877

1283

setattr(self, attrname, value)

1878

1284

1879

1285

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

1880

1286

1881

1287

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1882

1288

approvals_pending = notifychangeproperty(dbus.Boolean,

1883

1289

"ApprovalPending",

1884

type_func=bool)

1290

type_func = bool)

1885

1291

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

1886

1292

last_enabled = notifychangeproperty(datetime_to_dbus,

1887

1293

"LastEnabled")

1888

checker = notifychangeproperty(

1889

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1891

1297

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1892

1298

"LastCheckedOK")

1893

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1896

1302

datetime_to_dbus, "LastApprovalRequest")

1897

1303

approved_by_default = notifychangeproperty(dbus.Boolean,

1898

1304

"ApprovedByDefault")

1899

approval_delay = notifychangeproperty(

1900

dbus.UInt64, "ApprovalDelay",

1901

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

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1902

1309

approval_duration = notifychangeproperty(

1903

1310

dbus.UInt64, "ApprovalDuration",

1904

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

1311

type_func = timedelta_to_milliseconds)

1905

1312

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

1906

timeout = notifychangeproperty(

1907

dbus.UInt64, "Timeout",

1908

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1909

1316

extended_timeout = notifychangeproperty(

1910

1317

dbus.UInt64, "ExtendedTimeout",

1911

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

1912

interval = notifychangeproperty(

1913

dbus.UInt64, "Interval",

1914

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

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1915

1323

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

1916

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

1917

invalidate_only=True)

1918

1324

1919

1325

del notifychangeproperty

1920

1326

1921

1327

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

1922

1328

try:

1923

1329

self.remove_from_connection()

1926

1332

if hasattr(DBusObjectWithProperties, "__del__"):

1927

1333

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

1928

1334

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

1929

1930

def checker_callback(self, source, condition,

1931

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

1932

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

1933

connection, command, *args,

1934

**kwargs)

1935

exitstatus = self.last_checker_status

1936

if exitstatus >= 0:

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1937

1342

# Emit D-Bus signal

1938

1343

self.CheckerCompleted(dbus.Int16(exitstatus),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1344

dbus.Int64(condition),

1941

1345

dbus.String(command))

1942

1346

else:

1943

1347

# Emit D-Bus signal

1944

1348

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

1945

dbus.Int64(

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1349

dbus.Int64(condition),

1949

1350

dbus.String(command))

1950

return ret

1951

1351

1352

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

1353

*args, **kwargs)

1354

1952

1355

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

1953

1356

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

1954

1357

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

1958

1361

# Emit D-Bus signal

1959

1362

self.CheckerStarted(self.current_checker_command)

1960

1363

return r

1961

1364

1962

1365

def _reset_approved(self):

1963

1366

self.approved = None

1964

1367

return False

1965

1368

1966

1369

def approve(self, value=True):

1967

1370

self.approved = value

1968

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

1969

* 1000), self._reset_approved)

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1970

1374

self.send_changedstate()

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1978

1388

# CheckerCompleted - signal

1979

1389

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

1980

1390

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

1981

1391

"D-Bus signal"

1982

1392

pass

1983

1393

1984

1394

# CheckerStarted - signal

1985

1395

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

1986

1396

def CheckerStarted(self, command):

1987

1397

"D-Bus signal"

1988

1398

pass

1989

1399

1990

1400

# PropertyChanged - signal

1991

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

1992

1401

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

1993

1402

def PropertyChanged(self, property, value):

1994

1403

"D-Bus signal"

1995

1404

pass

1996

1405

1997

1406

# GotSecret - signal

1998

1407

@dbus.service.signal(_interface)

1999

1408

def GotSecret(self):

2002

1411

server to mandos-client

2003

1412

"""

2004

1413

pass

2005

1414

2006

1415

# Rejected - signal

2007

1416

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

2008

1417

def Rejected(self, reason):

2009

1418

"D-Bus signal"

2010

1419

pass

2011

1420

2012

1421

# NeedApproval - signal

2013

1422

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

2014

1423

def NeedApproval(self, timeout, default):

2015

1424

"D-Bus signal"

2016

1425

return self.need_approval()

2017

2018

# Methods

2019

1426

1427

## Methods

1428

2020

1429

# Approve - method

2021

1430

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

2022

1431

def Approve(self, value):

2023

1432

self.approve(value)

2024

1433

2025

1434

# CheckedOK - method

2026

1435

@dbus.service.method(_interface)

2027

1436

def CheckedOK(self):

2028

1437

self.checked_ok()

2029

1438

2030

1439

# Enable - method

2031

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

2032

1440

@dbus.service.method(_interface)

2033

1441

def Enable(self):

2034

1442

"D-Bus method"

2035

1443

self.enable()

2036

1444

2037

1445

# StartChecker - method

2038

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

2039

1446

@dbus.service.method(_interface)

2040

1447

def StartChecker(self):

2041

1448

"D-Bus method"

2042

1449

self.start_checker()

2043

1450

2044

1451

# Disable - method

2045

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

2046

1452

@dbus.service.method(_interface)

2047

1453

def Disable(self):

2048

1454

"D-Bus method"

2049

1455

self.disable()

2050

1456

2051

1457

# StopChecker - method

2052

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

2053

1458

@dbus.service.method(_interface)

2054

1459

def StopChecker(self):

2055

1460

self.stop_checker()

2056

2057

# Properties

2058

1461

1462

## Properties

1463

2059

1464

# ApprovalPending - property

2060

1465

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

2061

1466

def ApprovalPending_dbus_property(self):

2062

1467

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

2063

1468

2064

1469

# ApprovedByDefault - property

2065

@dbus_service_property(_interface,

2066

signature="b",

1470

@dbus_service_property(_interface, signature="b",

2067

1471

access="readwrite")

2068

1472

def ApprovedByDefault_dbus_property(self, value=None):

2069

1473

if value is None: # get

2070

1474

return dbus.Boolean(self.approved_by_default)

2071

1475

self.approved_by_default = bool(value)

2072

1476

2073

1477

# ApprovalDelay - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2076

1479

access="readwrite")

2077

1480

def ApprovalDelay_dbus_property(self, value=None):

2078

1481

if value is None: # get

2079

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

2080

* 1000)

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2081

1483

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

2082

1484

2083

1485

# ApprovalDuration - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1486

@dbus_service_property(_interface, signature="t",

2086

1487

access="readwrite")

2087

1488

def ApprovalDuration_dbus_property(self, value=None):

2088

1489

if value is None: # get

2089

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

2090

* 1000)

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2091

1492

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

2092

1493

2093

1494

# Name - property

2094

@dbus_annotations(

2095

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

2096

1495

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

2097

1496

def Name_dbus_property(self):

2098

1497

return dbus.String(self.name)

2099

2100

# KeyID - property

2101

@dbus_annotations(

2102

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

2103

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

2104

def KeyID_dbus_property(self):

2105

return dbus.String(self.key_id)

2106

1498

2107

1499

# Fingerprint - property

2108

@dbus_annotations(

2109

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

2110

1500

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

2111

1501

def Fingerprint_dbus_property(self):

2112

1502

return dbus.String(self.fingerprint)

2113

1503

2114

1504

# Host - property

2115

@dbus_service_property(_interface,

2116

signature="s",

1505

@dbus_service_property(_interface, signature="s",

2117

1506

access="readwrite")

2118

1507

def Host_dbus_property(self, value=None):

2119

1508

if value is None: # get

2120

1509

return dbus.String(self.host)

2121

self.host = str(value)

2122

1510

self.host = unicode(value)

1511

2123

1512

# Created - property

2124

@dbus_annotations(

2125

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

2126

1513

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

2127

1514

def Created_dbus_property(self):

2128

1515

return datetime_to_dbus(self.created)

2129

1516

2130

1517

# LastEnabled - property

2131

1518

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

2132

1519

def LastEnabled_dbus_property(self):

2133

1520

return datetime_to_dbus(self.last_enabled)

2134

1521

2135

1522

# Enabled - property

2136

@dbus_service_property(_interface,

2137

signature="b",

1523

@dbus_service_property(_interface, signature="b",

2138

1524

access="readwrite")

2139

1525

def Enabled_dbus_property(self, value=None):

2140

1526

if value is None: # get

2143

1529

self.enable()

2144

1530

else:

2145

1531

self.disable()

2146

1532

2147

1533

# LastCheckedOK - property

2148

@dbus_service_property(_interface,

2149

signature="s",

1534

@dbus_service_property(_interface, signature="s",

2150

1535

access="readwrite")

2151

1536

def LastCheckedOK_dbus_property(self, value=None):

2152

1537

if value is not None:

2153

1538

self.checked_ok()

2154

1539

return

2155

1540

return datetime_to_dbus(self.last_checked_ok)

2156

1541

2157

1542

# LastCheckerStatus - property

2158

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

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2159

1545

def LastCheckerStatus_dbus_property(self):

2160

1546

return dbus.Int16(self.last_checker_status)

2161

1547

2162

1548

# Expires - property

2163

1549

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

2164

1550

def Expires_dbus_property(self):

2165

1551

return datetime_to_dbus(self.expires)

2166

1552

2167

1553

# LastApprovalRequest - property

2168

1554

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

2169

1555

def LastApprovalRequest_dbus_property(self):

2170

1556

return datetime_to_dbus(self.last_approval_request)

2171

1557

2172

1558

# Timeout - property

2173

@dbus_service_property(_interface,

2174

signature="t",

1559

@dbus_service_property(_interface, signature="t",

2175

1560

access="readwrite")

2176

1561

def Timeout_dbus_property(self, value=None):

2177

1562

if value is None: # get

2178

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

1563

return dbus.UInt64(self.timeout_milliseconds())

2179

1564

old_timeout = self.timeout

2180

1565

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

2181

1566

# Reschedule disabling

2189

1574

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

2190

1575

is None):

2191

1576

return

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

2194

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

2195

self.disable)

2196

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2197

1583

# ExtendedTimeout - property

2198

@dbus_service_property(_interface,

2199

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2200

1585

access="readwrite")

2201

1586

def ExtendedTimeout_dbus_property(self, value=None):

2202

1587

if value is None: # get

2203

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

2204

* 1000)

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2205

1589

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

2206

1590

2207

1591

# Interval - property

2208

@dbus_service_property(_interface,

2209

signature="t",

1592

@dbus_service_property(_interface, signature="t",

2210

1593

access="readwrite")

2211

1594

def Interval_dbus_property(self, value=None):

2212

1595

if value is None: # get

2213

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

1596

return dbus.UInt64(self.interval_milliseconds())

2214

1597

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

2215

1598

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

2216

1599

return

2217

1600

if self.enabled:

2218

1601

# Reschedule checker run

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

2221

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2224

1607

# Checker - property

2225

@dbus_service_property(_interface,

2226

signature="s",

1608

@dbus_service_property(_interface, signature="s",

2227

1609

access="readwrite")

2228

1610

def Checker_dbus_property(self, value=None):

2229

1611

if value is None: # get

2230

1612

return dbus.String(self.checker_command)

2231

self.checker_command = str(value)

2232

1613

self.checker_command = unicode(value)

1614

2233

1615

# CheckerRunning - property

2234

@dbus_service_property(_interface,

2235

signature="b",

1616

@dbus_service_property(_interface, signature="b",

2236

1617

access="readwrite")

2237

1618

def CheckerRunning_dbus_property(self, value=None):

2238

1619

if value is None: # get

2241

1622

self.start_checker()

2242

1623

else:

2243

1624

self.stop_checker()

2244

1625

2245

1626

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

2249

1627

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

2250

1628

def ObjectPath_dbus_property(self):

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2253

1631

# Secret = property

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

2257

@dbus_service_property(_interface,

2258

signature="ay",

2259

access="write",

2260

byte_arrays=True)

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2261

1634

def Secret_dbus_property(self, value):

2262

self.secret = bytes(value)

2263

1635

self.secret = str(value)

1636

2264

1637

del _interface

2265

1638

2266

1639

2267

class ProxyClient:

2268

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

1640

class ProxyClient(object):

1641

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

2269

1642

self._pipe = child_pipe

2270

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

1643

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

2271

1644

if not self._pipe.recv():

2272

raise KeyError(key_id or fpr)

2273

1645

raise KeyError()

1646

2274

1647

def __getattribute__(self, name):

2275

if name == "_pipe":

1648

if name == '_pipe':

2276

1649

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

2277

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

1650

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

2278

1651

data = self._pipe.recv()

2279

if data[0] == "data":

1652

if data[0] == 'data':

2280

1653

return data[1]

2281

if data[0] == "function":

2282

1654

if data[0] == 'function':

2283

1655

def func(*args, **kwargs):

2284

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

1656

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

2285

1657

return self._pipe.recv()[1]

2286

2287

1658

return func

2288

1659

2289

1660

def __setattr__(self, name, value):

2290

if name == "_pipe":

1661

if name == '_pipe':

2291

1662

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

2292

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

1663

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

2293

1664

2294

1665

2295

1666

class ClientHandler(socketserver.BaseRequestHandler, object):

2296

1667

"""A class to handle client connections.

2297

1668

2298

1669

Instantiated once for each connection to handle it.

2299

1670

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

2300

1671

2301

1672

def handle(self):

2302

1673

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

2303

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

2304

str(self.client_address))

2305

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

2306

2307

session = gnutls.ClientSession(self.request)

2308

2309

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

2310

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

2311

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

2312

# "+DHE-DSS"))

1674

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

1675

unicode(self.client_address))

1676

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

1677

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2313

1693

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

2314

1694

priority = self.server.gnutls_priority

2315

1695

if priority is None:

2316

1696

priority = "NORMAL"

2317

gnutls.priority_set_direct(session,

2318

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

2319

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2320

1701

# Start communication using the Mandos protocol

2321

1702

# Get protocol number

2322

1703

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

2323

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

1704

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

2324

1705

try:

2325

1706

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

2326

1707

raise RuntimeError(line)

2327

1708

except (ValueError, IndexError, RuntimeError) as error:

2328

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

1709

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

2329

1710

return

2330

1711

2331

1712

# Start GnuTLS connection

2332

1713

try:

2333

1714

session.handshake()

2334

except gnutls.Error as error:

2335

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

1715

except gnutls.errors.GNUTLSError as error:

1716

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

2336

1717

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

2337

1718

# established. Just abandon the request.

2338

1719

return

2339

log.debug("Handshake succeeded")

2340

1720

logger.debug("Handshake succeeded")

1721

2341

1722

approval_required = False

2342

1723

try:

2343

if gnutls.has_rawpk:

2344

fpr = b""

2345

try:

2346

key_id = self.key_id(

2347

self.peer_certificate(session))

2348

except (TypeError, gnutls.Error) as error:

2349

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

2350

return

2351

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

2352

key_id.decode("utf-8",

2353

errors="replace"))

2354

2355

else:

2356

key_id = b""

2357

try:

2358

fpr = self.fingerprint(

2359

self.peer_certificate(session))

2360

except (TypeError, gnutls.Error) as error:

2361

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

2362

return

2363

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

2364

2365

try:

2366

client = ProxyClient(child_pipe, key_id, fpr,

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2367

1735

self.client_address)

2368

1736

except KeyError:

2369

1737

return

2370

1738

2371

1739

if client.approval_delay:

2372

1740

delay = client.approval_delay

2373

1741

client.approvals_pending += 1

2374

1742

approval_required = True

2375

1743

2376

1744

while True:

2377

1745

if not client.enabled:

2378

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

1746

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

1747

client.name)

2379

1748

if self.server.use_dbus:

2380

1749

# Emit D-Bus signal

2381

1750

client.Rejected("Disabled")

2382

1751

return

2383

1752

2384

1753

if client.approved or not client.approval_delay:

2385

# We are approved or approval is disabled

1754

#We are approved or approval is disabled

2386

1755

break

2387

1756

elif client.approved is None:

2388

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

2389

client.name)

1757

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

1758

client.name)

2390

1759

if self.server.use_dbus:

2391

1760

# Emit D-Bus signal

2392

1761

client.NeedApproval(

2393

client.approval_delay.total_seconds()

2394

* 1000, client.approved_by_default)

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2395

1764

else:

2396

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

2397

client.name)

1765

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

1766

client.name)

2398

1767

if self.server.use_dbus:

2399

1768

# Emit D-Bus signal

2400

1769

client.Rejected("Denied")

2401

1770

return

2402

2403

# wait until timeout or approved

1771

1772

#wait until timeout or approved

2404

1773

time = datetime.datetime.now()

2405

1774

client.changedstate.acquire()

2406

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

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2407

1778

client.changedstate.release()

2408

1779

time2 = datetime.datetime.now()

2409

1780

if (time2 - time) >= delay:

2410

1781

if not client.approved_by_default:

2411

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

2412

" waiting for approval",

2413

client.name)

1782

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

1783

" waiting for approval",

1784

client.name)

2414

1785

if self.server.use_dbus:

2415

1786

# Emit D-Bus signal

2416

1787

client.Rejected("Approval timed out")

2419

1790

break

2420

1791

else:

2421

1792

delay -= time2 - time

2422

2423

try:

2424

session.send(client.secret)

2425

except gnutls.Error as error:

2426

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

2427

return

2428

2429

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

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

1807

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

2430

1808

# bump the timeout using extended_timeout

2431

1809

client.bump_timeout(client.extended_timeout)

2432

1810

if self.server.use_dbus:

2433

1811

# Emit D-Bus signal

2434

1812

client.GotSecret()

2435

1813

2436

1814

finally:

2437

1815

if approval_required:

2438

1816

client.approvals_pending -= 1

2439

1817

try:

2440

1818

session.bye()

2441

except gnutls.Error as error:

2442

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

2443

1819

except gnutls.errors.GNUTLSError as error:

1820

logger.warning("GnuTLS bye failed",

1821

exc_info=error)

1822

2444

1823

@staticmethod

2445

1824

def peer_certificate(session):

2446

"Return the peer's certificate as a bytestring"

2447

try:

2448

cert_type = gnutls.certificate_type_get2(

2449

session, gnutls.CTYPE_PEERS)

2450

except AttributeError:

2451

cert_type = gnutls.certificate_type_get(session)

2452

if gnutls.has_rawpk:

2453

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2454

else:

2455

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2456

# If not a valid certificate type...

2457

if cert_type not in valid_cert_types:

2458

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

2459

valid_cert_types)

2460

# ...return invalid data

2461

return b""

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2462

1832

list_size = ctypes.c_uint(1)

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

1835

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

2465

1836

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

2466

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

1837

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

1838

" certificate")

2467

1839

if list_size.value == 0:

2468

1840

return None

2469

1841

cert = cert_list[0]

2470

1842

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

2471

2472

@staticmethod

2473

def key_id(certificate):

2474

"Convert a certificate bytestring to a hexdigit key ID"

2475

# New GnuTLS "datum" with the public key

2476

datum = gnutls.datum_t(

2477

ctypes.cast(ctypes.c_char_p(certificate),

2478

ctypes.POINTER(ctypes.c_ubyte)),

2479

ctypes.c_uint(len(certificate)))

2480

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

2481

# New empty GnuTLS certificate

2482

pubkey = gnutls.pubkey_t()

2483

gnutls.pubkey_init(ctypes.byref(pubkey))

2484

# Import the raw public key into the certificate

2485

gnutls.pubkey_import(pubkey,

2486

ctypes.byref(datum),

2487

gnutls.X509_FMT_DER)

2488

# New buffer for the key ID

2489

buf = ctypes.create_string_buffer(32)

2490

buf_len = ctypes.c_size_t(len(buf))

2491

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

2492

gnutls.pubkey_get_key_id(

2493

pubkey,

2494

gnutls.KEYID_USE_SHA256,

2495

ctypes.cast(ctypes.byref(buf),

2496

ctypes.POINTER(ctypes.c_ubyte)),

2497

ctypes.byref(buf_len))

2498

# Deinit the certificate

2499

gnutls.pubkey_deinit(pubkey)

2500

2501

# Convert the buffer to a Python bytestring

2502

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

2503

# Convert the bytestring to hexadecimal notation

2504

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

2505

return hex_key_id

2506

1843

2507

1844

@staticmethod

2508

1845

def fingerprint(openpgp):

2509

1846

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2510

1847

# New GnuTLS "datum" with the OpenPGP public key

2511

datum = gnutls.datum_t(

2512

ctypes.cast(ctypes.c_char_p(openpgp),

2513

ctypes.POINTER(ctypes.c_ubyte)),

2514

ctypes.c_uint(len(openpgp)))

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2515

1853

# New empty GnuTLS certificate

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2518

1857

# Import the OpenPGP public key into the certificate

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2521

1862

# Verify the self signature in the key

2522

1863

crtverify = ctypes.c_uint()

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2525

1867

if crtverify.value != 0:

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2529

1871

# New buffer for the fingerprint

2530

1872

buf = ctypes.create_string_buffer(20)

2531

1873

buf_len = ctypes.c_size_t()

2532

1874

# Get the fingerprint from the certificate into the buffer

2533

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

2534

ctypes.byref(buf_len))

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2535

1878

# Deinit the certificate

2536

gnutls.openpgp_crt_deinit(crt)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2537

1880

# Convert the buffer to a Python bytestring

2538

1881

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

2539

1882

# Convert the bytestring to hexadecimal notation

2541

1884

return hex_fpr

2542

1885

2543

1886

2544

class MultiprocessingMixIn:

1887

class MultiprocessingMixIn(object):

2545

1888

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

2546

2547

1889

def sub_process_main(self, request, address):

2548

1890

try:

2549

1891

self.finish_request(request, address)

2550

1892

except Exception:

2551

1893

self.handle_error(request, address)

2552

1894

self.close_request(request)

2553

1895

2554

1896

def process_request(self, request, address):

2555

1897

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

2556

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

2557

args=(request, address))

1898

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

1899

args = (request, address))

2558

1900

proc.start()

2559

1901

return proc

2560

1902

2561

1903

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2563

1905

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

2564

2565

1906

def process_request(self, request, client_address):

2566

1907

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

2567

1908

2568

1909

This function creates a new pipe in self.pipe

2569

1910

"""

2570

1911

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2571

1912

2572

1913

proc = MultiprocessingMixIn.process_request(self, request,

2573

1914

client_address)

2574

1915

self.child_pipe.close()

2575

1916

self.add_pipe(parent_pipe, proc)

2576

1917

2577

1918

def add_pipe(self, parent_pipe, proc):

2578

1919

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

2579

1920

raise NotImplementedError()

2580

1921

2581

1922

2582

1923

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2583

socketserver.TCPServer):

2584

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

2585

1924

socketserver.TCPServer, object):

1925

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

1926

2586

1927

Attributes:

2587

1928

enabled: Boolean; whether this server is activated yet

2588

1929

interface: None or a network interface name (string)

2589

1930

use_ipv6: Boolean; to use IPv6 or not

2590

1931

"""

2591

2592

1932

def __init__(self, server_address, RequestHandlerClass,

2593

interface=None,

2594

use_ipv6=True,

2595

socketfd=None):

1933

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

2596

1934

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

2597

1935

creating a new one with socket.socket().

2598

1936

"""

2604

1942

self.socketfd = socketfd

2605

1943

# Save the original socket.socket() function

2606

1944

self.socket_socket = socket.socket

2607

2608

1945

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

2609

#

1946

#

2610

1947

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

2611

1948

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

2612

1949

# patching socket.socket.)

2613

#

1950

#

2614

1951

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

2615

1952

@functools.wraps(socket.socket)

2616

1953

def socket_wrapper(*args, **kwargs):

2628

1965

# socket_wrapper(), if socketfd was set.

2629

1966

socketserver.TCPServer.__init__(self, server_address,

2630

1967

RequestHandlerClass)

2631

1968

2632

1969

def server_bind(self):

2633

1970

"""This overrides the normal server_bind() function

2634

1971

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

2635

1972

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

2636

global SO_BINDTODEVICE

2637

1973

if self.interface is not None:

2638

1974

if SO_BINDTODEVICE is None:

2639

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

2640

# common enough.

2641

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

2642

SO_BINDTODEVICE = 25

2643

try:

2644

self.socket.setsockopt(

2645

socket.SOL_SOCKET, SO_BINDTODEVICE,

2646

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

2647

except socket.error as error:

2648

if error.errno == errno.EPERM:

2649

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

2650

self.interface)

2651

elif error.errno == errno.ENOPROTOOPT:

2652

log.error("SO_BINDTODEVICE not available; cannot"

2653

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

2654

elif error.errno == errno.ENODEV:

2655

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

2656

" bind", self.interface)

2657

else:

2658

raise

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2659

1996

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

2660

1997

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2663

1998

if not self.server_address[0]:

2664

1999

if self.address_family == socket.AF_INET6:

2665

any_address = "::" # in6addr_any

2000

any_address = "::" # in6addr_any

2666

2001

else:

2667

any_address = "0.0.0.0" # INADDR_ANY

2002

any_address = "0.0.0.0" # INADDR_ANY

2668

2003

self.server_address = (any_address,

2669

2004

self.server_address[1])

2670

2005

elif not self.server_address[1]:

2671

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

2006

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

2007

0)

2672

2008

# if self.interface:

2673

2009

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

2674

2010

# 0, # port

2680

2016

2681

2017

class MandosServer(IPv6_TCPServer):

2682

2018

"""Mandos server.

2683

2019

2684

2020

Attributes:

2685

2021

clients: set of Client objects

2686

2022

gnutls_priority GnuTLS priority string

2687

2023

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

2688

2689

Assumes a GLib.MainLoop event loop.

2024

2025

Assumes a gobject.MainLoop event loop.

2690

2026

"""

2691

2692

2027

def __init__(self, server_address, RequestHandlerClass,

2693

interface=None,

2694

use_ipv6=True,

2695

clients=None,

2696

gnutls_priority=None,

2697

use_dbus=True,

2698

socketfd=None):

2028

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

2029

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

2699

2030

self.enabled = False

2700

2031

self.clients = clients

2701

2032

if self.clients is None:

2704

2035

self.gnutls_priority = gnutls_priority

2705

2036

IPv6_TCPServer.__init__(self, server_address,

2706

2037

RequestHandlerClass,

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2711

2041

def server_activate(self):

2712

2042

if self.enabled:

2713

2043

return socketserver.TCPServer.server_activate(self)

2714

2044

2715

2045

def enable(self):

2716

2046

self.enabled = True

2717

2047

2718

2048

def add_pipe(self, parent_pipe, proc):

2719

2049

# Call "handle_ipc" for both data and EOF events

2720

GLib.io_add_watch(

2721

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

2722

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

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2727

def handle_ipc(self, source, condition,

2728

parent_pipe=None,

2729

proc=None,

2730

client_object=None):

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2731

2059

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

2732

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

2060

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

2733

2061

# Wait for other process to exit

2734

2062

proc.join()

2735

2063

return False

2736

2064

2737

2065

# Read a request from the child

2738

2066

request = parent_pipe.recv()

2739

2067

command = request[0]

2740

2741

if command == "init":

2742

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

2743

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

2744

address = request[3]

2745

2746

for c in self.clients.values():

2747

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2748

"27AE41E4649B934CA495991B7852B855"):

2749

continue

2750

if key_id and c.key_id == key_id:

2751

client = c

2752

break

2753

if fpr and c.fingerprint == fpr:

2068

2069

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2754

2075

client = c

2755

2076

break

2756

2077

else:

2757

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

2758

" %s", key_id or fpr, address)

2078

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

2079

"dress: %s", fpr, address)

2759

2080

if self.use_dbus:

2760

2081

# Emit D-Bus signal

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2082

mandos_dbus_service.ClientNotFound(fpr,

2762

2083

address[0])

2763

2084

parent_pipe.send(False)

2764

2085

return False

2765

2766

GLib.io_add_watch(

2767

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

2768

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

2769

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2773

2095

parent_pipe.send(True)

2774

2096

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

2775

2097

# same fileno

2776

2098

return False

2777

if command == "funcall":

2099

if command == 'funcall':

2778

2100

funcname = request[1]

2779

2101

args = request[2]

2780

2102

kwargs = request[3]

2781

2782

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

2103

2104

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

2783

2105

funcname)(*args,

2784

**kwargs)))

2785

2786

if command == "getattr":

2106

**kwargs)))

2107

2108

if command == 'getattr':

2787

2109

attrname = request[1]

2788

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2791

2112

else:

2792

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2116

if command == 'setattr':

2796

2117

attrname = request[1]

2797

2118

value = request[2]

2798

2119

setattr(client_object, attrname, value)

2799

2120

2800

2121

return True

2801

2122

2802

2123

2803

2124

def rfc3339_duration_to_delta(duration):

2804

2125

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

2805

2806

>>> timedelta = datetime.timedelta

2807

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

2808

True

2809

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

2810

True

2811

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

2812

True

2813

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

2814

True

2815

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

2816

True

2817

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

2818

True

2819

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

2820

True

2821

>>> del timedelta

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2822

2141

"""

2823

2142

2824

2143

# Parsing an RFC 3339 duration with regular expressions is not

2825

2144

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

2826

2145

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

2827

2146

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

2828

2147

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

2829

2148

# avoid excessive use of external libraries.

2830

2149

2831

2150

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

2832

Token = collections.namedtuple("Token", (

2833

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

2834

# a "group" containing digits

2835

"value", # datetime.timedelta or None

2836

"followers")) # Tokens valid after this token

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2837

2160

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

2838

2161

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

2839

2162

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

2840

2163

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

2841

2164

datetime.timedelta(seconds=1),

2842

frozenset((token_end, )))

2165

frozenset((token_end,)))

2843

2166

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

2844

2167

datetime.timedelta(minutes=1),

2845

2168

frozenset((token_second, token_end)))

2861

2184

frozenset((token_month, token_end)))

2862

2185

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

2863

2186

datetime.timedelta(weeks=1),

2864

frozenset((token_end, )))

2187

frozenset((token_end,)))

2865

2188

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

2866

2189

frozenset((token_year, token_month,

2867

2190

token_day, token_time,

2868

2191

token_week)))

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2872

2194

found_token = None

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2195

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

2196

s = duration # String left to parse

2877

2197

# Loop until end token is found

2878

2198

while found_token is not token_end:

2879

2199

# Search for any currently valid tokens

2895

2215

break

2896

2216

else:

2897

2217

# No currently valid tokens were found

2898

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

2899

.format(duration))

2218

raise ValueError("Invalid RFC 3339 duration")

2900

2219

# End token found

2901

2220

return value

2902

2221

2903

2222

2904

2223

def string_to_delta(interval):

2905

2224

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

2906

2907

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

2908

True

2909

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

2910

True

2911

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

2912

True

2913

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

2914

True

2915

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

2916

True

2917

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

2918

True

2225

2226

>>> string_to_delta('7d')

2227

datetime.timedelta(7)

2228

>>> string_to_delta('60s')

2229

datetime.timedelta(0, 60)

2230

>>> string_to_delta('60m')

2231

datetime.timedelta(0, 3600)

2232

>>> string_to_delta('24h')

2233

datetime.timedelta(1)

2234

>>> string_to_delta('1w')

2235

datetime.timedelta(7)

2236

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

2237

datetime.timedelta(0, 330)

2919

2238

"""

2920

2239

2921

2240

try:

2922

2241

return rfc3339_duration_to_delta(interval)

2923

2242

except ValueError:

2924

2243

pass

2925

2244

2926

2245

timevalue = datetime.timedelta(0)

2927

2246

for s in interval.split():

2928

2247

try:

2929

suffix = s[-1]

2248

suffix = unicode(s[-1])

2930

2249

value = int(s[:-1])

2931

2250

if suffix == "d":

2932

2251

delta = datetime.timedelta(value)

2939

2258

elif suffix == "w":

2940

2259

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

2941

2260

else:

2942

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

2261

raise ValueError("Unknown suffix {0!r}"

2262

.format(suffix))

2943

2263

except IndexError as e:

2944

2264

raise ValueError(*(e.args))

2945

2265

timevalue += delta

2946

2266

return timevalue

2947

2267

2948

2268

2949

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

2269

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

2950

2270

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

2951

2271

2952

2272

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

2953

2273

if os.fork():

2954

2274

sys.exit()

2962

2282

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

2963

2283

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

2964

2284

raise OSError(errno.ENODEV,

2965

"{} not a character device"

2285

"{0} not a character device"

2966

2286

.format(os.devnull))

2967

2287

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

2968

2288

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

2972

2292

2973

2293

2974

2294

def main():

2975

2295

2976

2296

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

2977

2297

# Parsing of options, both command line and config file

2978

2298

2979

2299

parser = argparse.ArgumentParser()

2980

2300

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

2981

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

2301

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

2982

2302

help="show version number and exit")

2983

2303

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

2984

2304

help="Bind to interface IF")

3020

2340

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

3021

2341

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

3022

2342

default=None)

3023

2343

3024

2344

options = parser.parse_args()

3025

2345

2346

if options.check:

2347

import doctest

2348

fail_count, test_count = doctest.testmod()

2349

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

2350

3026

2351

# Default values for config file for server-global settings

3027

if gnutls.has_rawpk:

3028

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

3029

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

3030

else:

3031

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

3032

":+SIGN-DSA-SHA256")

3033

server_defaults = {"interface": "",

3034

"address": "",

3035

"port": "",

3036

"debug": "False",

3037

"priority": priority,

3038

"servicename": "Mandos",

3039

"use_dbus": "True",

3040

"use_ipv6": "True",

3041

"debuglevel": "",

3042

"restore": "True",

3043

"socket": "",

3044

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

3045

"foreground": "False",

3046

"zeroconf": "True",

3047

}

3048

del priority

3049

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

3050

2369

# Parse config file for server-global settings

3051

server_config = configparser.ConfigParser(server_defaults)

2370

server_config = configparser.SafeConfigParser(server_defaults)

3052

2371

del server_defaults

3053

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

3054

# Convert the ConfigParser object to a dict

2372

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

2373

"mandos.conf"))

2374

# Convert the SafeConfigParser object to a dict

3055

2375

server_settings = server_config.defaults()

3056

2376

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

3057

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

3058

"foreground", "zeroconf"):

2377

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

3059

2378

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

3060

2379

option)

3061

2380

if server_settings["port"]:

3071

2390

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

3072

2391

["socket"])

3073

2392

del server_config

3074

2393

3075

2394

# Override the settings from the config file with command line

3076

2395

# options, if set.

3077

2396

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

3078

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

3079

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

3080

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

2397

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

2398

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

2399

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

3081

2400

value = getattr(options, option)

3082

2401

if value is not None:

3083

2402

server_settings[option] = value

3084

2403

del options

3085

2404

# Force all strings to be unicode

3086

2405

for option in server_settings.keys():

3087

if isinstance(server_settings[option], bytes):

3088

server_settings[option] = (server_settings[option]

3089

.decode("utf-8"))

2406

if type(server_settings[option]) is str:

2407

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

3090

2408

# Force all boolean options to be boolean

3091

2409

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

3092

2410

"foreground", "zeroconf"):

3095

2413

if server_settings["debug"]:

3096

2414

server_settings["foreground"] = True

3097

2415

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

3098

2416

3099

2417

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

3100

3101

if (not server_settings["zeroconf"]

3102

and not (server_settings["port"]

3103

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

3104

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

3105

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

3106

2425

# For convenience

3107

2426

debug = server_settings["debug"]

3108

2427

debuglevel = server_settings["debuglevel"]

3112

2431

stored_state_file)

3113

2432

foreground = server_settings["foreground"]

3114

2433

zeroconf = server_settings["zeroconf"]

3115

2434

3116

2435

if debug:

3117

2436

initlogger(debug, logging.DEBUG)

3118

2437

else:

3121

2440

else:

3122

2441

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

3123

2442

initlogger(debug, level)

3124

2443

3125

2444

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

3126

syslogger.setFormatter(

3127

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

3128

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

3129

server_settings["servicename"])))

3130

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

3131

2451

# Parse config file with clients

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2452

client_config = configparser.SafeConfigParser(Client

2453

.client_defaults)

3133

2454

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

3134

2455

"clients.conf"))

3135

2456

3136

2457

global mandos_dbus_service

3137

2458

mandos_dbus_service = None

3138

2459

3139

2460

socketfd = None

3140

2461

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

3141

2462

socketfd = server_settings["socket"]

3142

tcp_server = MandosServer(

3143

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

3144

ClientHandler,

3145

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

3146

use_ipv6=use_ipv6,

3147

gnutls_priority=server_settings["priority"],

3148

use_dbus=use_dbus,

3149

socketfd=socketfd)

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

3150

2473

if not foreground:

3151

2474

pidfilename = "/run/mandos.pid"

3152

2475

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

3153

2476

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

3154

2477

pidfile = None

3155

2478

try:

3156

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

2479

pidfile = open(pidfilename, "w")

3157

2480

except IOError as e:

3158

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

3159

exc_info=e)

3160

3161

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

3162

("mandos", "mandos"),

3163

("nobody", "nogroup")):

2481

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

2482

exc_info=e)

2483

2484

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

3164

2485

try:

3165

2486

uid = pwd.getpwnam(name).pw_uid

3166

gid = pwd.getpwnam(group).pw_gid

2487

gid = pwd.getpwnam(name).pw_gid

3167

2488

break

3168

2489

except KeyError:

3169

2490

continue

3173

2494

try:

3174

2495

os.setgid(gid)

3175

2496

os.setuid(uid)

3176

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

3177

2497

except OSError as error:

3178

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

3179

os.strerror(error.errno))

3180

2498

if error.errno != errno.EPERM:

3181

2499

raise

3182

2500

3183

2501

if debug:

3184

2502

# Enable all possible GnuTLS debugging

3185

2503

3186

2504

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

3187

2505

# - GnuTLS manual

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3191

2509

def debug_gnutls(level, string):

3192

log.debug("GnuTLS: %s",

3193

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

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2510

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3197

2515

# Redirect stdin so all checkers get /dev/null

3198

2516

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

3199

2517

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

3200

2518

if null > 2:

3201

2519

os.close(null)

3202

2520

3203

2521

# Need to fork before connecting to D-Bus

3204

2522

if not foreground:

3205

2523

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

3206

2524

daemon()

3207

3208

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

3209

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

3210

# need to inform GLib that threads will be used.

3211

GLib.threads_init()

3212

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3213

2530

global main_loop

3214

2531

# From the Avahi example code

3215

2532

DBusGMainLoop(set_as_default=True)

3216

main_loop = GLib.MainLoop()

2533

main_loop = gobject.MainLoop()

3217

2534

bus = dbus.SystemBus()

3218

2535

# End of Avahi example code

3219

2536

if use_dbus:

3220

2537

try:

3221

2538

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

3222

bus,

3223

do_not_queue=True)

3224

old_bus_name = dbus.service.BusName(

3225

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

3226

do_not_queue=True)

3227

except dbus.exceptions.DBusException as e:

3228

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

2544

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

3229

2545

use_dbus = False

3230

2546

server_settings["use_dbus"] = False

3231

2547

tcp_server.use_dbus = False

3232

2548

if zeroconf:

3233

2549

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3234

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3239

2554

if server_settings["interface"]:

3240

service.interface = if_nametoindex(

3241

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

3242

2555

service.interface = (if_nametoindex

2556

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

2557

3243

2558

global multiprocessing_manager

3244

2559

multiprocessing_manager = multiprocessing.Manager()

3245

2560

3246

2561

client_class = Client

3247

2562

if use_dbus:

3248

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

3249

2563

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

2564

3250

2565

client_settings = Client.config_parser(client_config)

3251

2566

old_client_settings = {}

3252

2567

clients_data = {}

3253

2568

3254

2569

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

3255

2570

global wnull

3256

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

2571

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

3257

2572

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

3258

2573

# mode

3259

2574

if debug or not foreground:

3260

2575

wnull.close()

3261

2576

3262

2577

# Get client data and settings from last running state.

3263

2578

if server_settings["restore"]:

3264

2579

try:

3265

2580

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

3266

if sys.version_info.major == 2:

3267

clients_data, old_client_settings = pickle.load(

3268

stored_state)

3269

else:

3270

bytes_clients_data, bytes_old_client_settings = (

3271

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

3272

# Fix bytes to strings

3273

# clients_data

3274

# .keys()

3275

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

3276

if isinstance(key, bytes)

3277

else key): value

3278

for key, value in

3279

bytes_clients_data.items()}

3280

del bytes_clients_data

3281

for key in clients_data:

3282

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

3283

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

3284

for k, v in

3285

clients_data[key].items()}

3286

clients_data[key] = value

3287

# .client_structure

3288

value["client_structure"] = [

3289

(s.decode("utf-8")

3290

if isinstance(s, bytes)

3291

else s) for s in

3292

value["client_structure"]]

3293

# .name, .host, and .checker_command

3294

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

3295

if isinstance(value[k], bytes):

3296

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

3297

if "key_id" not in value:

3298

value["key_id"] = ""

3299

elif "fingerprint" not in value:

3300

value["fingerprint"] = ""

3301

# old_client_settings

3302

# .keys()

3303

old_client_settings = {

3304

(key.decode("utf-8")

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_old_client_settings.items()}

3309

del bytes_old_client_settings

3310

# .host and .checker_command

3311

for value in old_client_settings.values():

3312

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

3313

if isinstance(value[attribute], bytes):

3314

value[attribute] = (value[attribute]

3315

.decode("utf-8"))

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3316

2583

os.remove(stored_state_path)

3317

2584

except IOError as e:

3318

2585

if e.errno == errno.ENOENT:

3319

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

3320

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

2586

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

2587

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

3321

2588

else:

3322

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

3323

exc_info=e)

2589

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

2590

exc_info=e)

3324

2591

raise

3325

2592

except EOFError as e:

3326

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

3327

exc_info=e)

3328

2593

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

2594

"EOFError:", exc_info=e)

2595

3329

2596

with PGPEngine() as pgp:

3330

2597

for client_name, client in clients_data.items():

3331

2598

# Skip removed clients

3332

2599

if client_name not in client_settings:

3333

2600

continue

3334

2601

3335

2602

# Decide which value to use after restoring saved state.

3336

2603

# We have three different values: Old config file,

3337

2604

# new config file, and saved state.

3342

2609

# For each value in new config, check if it

3343

2610

# differs from the old config value (Except for

3344

2611

# the "secret" attribute)

3345

if (name != "secret"

3346

and (value !=

3347

old_client_settings[client_name][name])):

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3348

2615

client[name] = value

3349

2616

except KeyError:

3350

2617

pass

3351

2618

3352

2619

# Clients who has passed its expire date can still be

3353

# enabled if its last checker was successful. A Client

2620

# enabled if its last checker was successful. Clients

3354

2621

# whose checker succeeded before we stored its state is

3355

2622

# assumed to have successfully run all checkers during

3356

2623

# downtime.

3357

2624

if client["enabled"]:

3358

2625

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

3359

2626

if not client["last_checked_ok"]:

3360

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

3361

" never performed a successful"

3362

" checker", client_name)

2627

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3363

2631

client["enabled"] = False

3364

2632

elif client["last_checker_status"] != 0:

3365

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

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2633

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3369

2638

client["enabled"] = False

3370

2639

else:

3371

client["expires"] = (

3372

datetime.datetime.utcnow()

3373

+ client["timeout"])

3374

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

3375

" enabled", client_name)

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

2643

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3376

2646

try:

3377

client["secret"] = pgp.decrypt(

3378

client["encrypted_secret"],

3379

client_settings[client_name]["secret"])

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3380

2651

except PGPError:

3381

2652

# If decryption fails, we use secret from new settings

3382

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

3383

client_name)

3384

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

3385

["secret"])

3386

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3387

2658

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

3388

2659

for client_name in (set(old_client_settings)

3389

2660

- set(client_settings)):

3391

2662

for client_name in (set(client_settings)

3392

2663

- set(old_client_settings)):

3393

2664

clients_data[client_name] = client_settings[client_name]

3394

2665

3395

2666

# Create all client objects

3396

2667

for client_name, client in clients_data.items():

3397

2668

tcp_server.clients[client_name] = client_class(

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3402

2672

if not tcp_server.clients:

3403

log.warning("No clients defined")

3404

2673

logger.warning("No clients defined")

2674

3405

2675

if not foreground:

3406

2676

if pidfile is not None:

3407

pid = os.getpid()

3408

2677

try:

3409

2678

with pidfile:

3410

print(pid, file=pidfile)

2679

pid = os.getpid()

2680

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

3411

2681

except IOError:

3412

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

3413

pidfilename, pid)

2682

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

2683

pidfilename, pid)

3414

2684

del pidfile

3415

2685

del pidfilename

3416

3417

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

3418

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3419

lambda: main_loop.quit() and False)

3420

2686

2687

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

2688

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

2689

3421

2690

if use_dbus:

3422

3423

@alternate_dbus_interfaces(

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3426

2694

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

3427

3428

2695

def __init__(self):

3429

2696

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

3430

3431

2697

_interface = "se.recompile.Mandos"

3432

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3433

2705

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

3434

2706

def ClientAdded(self, objpath):

3435

2707

"D-Bus signal"

3436

2708

pass

3437

2709

3438

2710

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

3439

def ClientNotFound(self, key_id, address):

2711

def ClientNotFound(self, fingerprint, address):

3440

2712

"D-Bus signal"

3441

2713

pass

3442

3443

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

3444

"true"})

2714

3445

2715

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

3446

2716

def ClientRemoved(self, objpath, name):

3447

2717

"D-Bus signal"

3448

2718

pass

3449

3450

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

3451

"true"})

2719

3452

2720

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

3453

2721

def GetAllClients(self):

3454

2722

"D-Bus method"

3455

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3460

2727

@dbus.service.method(_interface,

3461

2728

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

3462

2729

def GetAllClientsWithProperties(self):

3463

2730

"D-Bus method"

3464

2731

return dbus.Dictionary(

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2732

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

2733

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

3468

2734

signature="oa{sv}")

3469

2735

3470

2736

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

3471

2737

def RemoveClient(self, object_path):

3472

2738

"D-Bus method"

3473

for c in tcp_server.clients.values():

2739

for c in tcp_server.clients.itervalues():

3474

2740

if c.dbus_object_path == object_path:

3475

2741

del tcp_server.clients[c.name]

3476

2742

c.remove_from_connection()

3477

# Don't signal the disabling

2743

# Don't signal anything except ClientRemoved

3478

2744

c.disable(quiet=True)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3481

2747

return

3482

2748

raise KeyError(object_path)

3483

2749

3484

2750

del _interface

3485

3486

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3488

def GetManagedObjects(self):

3489

"""D-Bus method"""

3490

return dbus.Dictionary(

3491

{client.dbus_object_path:

3492

dbus.Dictionary(

3493

{interface: client.GetAll(interface)

3494

for interface in

3495

client._get_all_interface_names()})

3496

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

3497

3498

def client_added_signal(self, client):

3499

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

3500

if use_dbus:

3501

# New standard signal

3502

self.InterfacesAdded(

3503

client.dbus_object_path,

3504

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3508

# Old signal

3509

self.ClientAdded(client.dbus_object_path)

3510

3511

def client_removed_signal(self, client):

3512

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

3513

if use_dbus:

3514

# New standard signal

3515

self.InterfacesRemoved(

3516

client.dbus_object_path,

3517

client._get_all_interface_names())

3518

# Old signal

3519

self.ClientRemoved(client.dbus_object_path,

3520

client.name)

3521

2751

3522

2752

mandos_dbus_service = MandosDBusService()

3523

3524

# Save modules to variables to exempt the modules from being

3525

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

3526

mp = multiprocessing

3527

wn = wnull

3528

2753

3529

2754

def cleanup():

3530

2755

"Cleanup function; run on exit"

3531

2756

if zeroconf:

3532

2757

service.cleanup()

3533

3534

mp.active_children()

3535

wn.close()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3536

2761

if not (tcp_server.clients or client_settings):

3537

2762

return

3538

2763

3539

2764

# Store client before exiting. Secrets are encrypted with key

3540

2765

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

3541

2766

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

3542

2767

clients = {}

3543

2768

with PGPEngine() as pgp:

3544

for client in tcp_server.clients.values():

2769

for client in tcp_server.clients.itervalues():

3545

2770

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

3546

2771

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

3547

2772

key)

3548

2773

client_dict = {}

3549

2774

3550

2775

# A list of attributes that can not be pickled

3551

2776

# + secret.

3552

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

3553

"checker", "server_settings"}

3554

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

3555

.Object):

2777

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

2778

"checker", "server_settings" }

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3556

2781

exclude.add(name)

3557

2782

3558

2783

client_dict["encrypted_secret"] = (client

3559

2784

.encrypted_secret)

3560

2785

for attr in client.client_structure:

3561

2786

if attr not in exclude:

3562

2787

client_dict[attr] = getattr(client, attr)

3563

2788

3564

2789

clients[client.name] = client_dict

3565

2790

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

3566

2791

3567

2792

try:

3568

with tempfile.NamedTemporaryFile(

3569

mode="wb",

3570

suffix=".pickle",

3571

prefix="clients-",

3572

dir=os.path.dirname(stored_state_path),

3573

delete=False) as stored_state:

3574

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

3575

protocol=2)

3576

tempname = stored_state.name

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3577

2799

os.rename(tempname, stored_state_path)

3578

2800

except (IOError, OSError) as e:

3579

2801

if not debug:

3582

2804

except NameError:

3583

2805

pass

3584

2806

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

3585

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

3586

os.strerror(e.errno))

2807

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

2808

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

3587

2809

else:

3588

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

3589

exc_info=e)

2810

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

2811

exc_info=e)

3590

2812

raise

3591

2813

3592

2814

# Delete all clients, and settings from config

3593

2815

while tcp_server.clients:

3594

2816

name, client = tcp_server.clients.popitem()

3595

2817

if use_dbus:

3596

2818

client.remove_from_connection()

3597

# Don't signal the disabling

2819

# Don't signal anything except ClientRemoved

3598

2820

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

3600

2821

if use_dbus:

3601

mandos_dbus_service.client_removed_signal(client)

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3602

2826

client_settings.clear()

3603

2827

3604

2828

atexit.register(cleanup)

3605

3606

for client in tcp_server.clients.values():

2829

2830

for client in tcp_server.clients.itervalues():

3607

2831

if use_dbus:

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3610

2834

# Need to initiate checking of clients

3611

2835

if client.enabled:

3612

2836

client.init_checker()

3613

2837

3614

2838

tcp_server.enable()

3615

2839

tcp_server.server_activate()

3616

2840

3617

2841

# Find out what port we got

3618

2842

if zeroconf:

3619

2843

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

3620

2844

if use_ipv6:

3621

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

3622

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

2845

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

2846

" flowinfo %d, scope_id %d",

2847

*tcp_server.socket.getsockname())

3623

2848

else: # IPv4

3624

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

3625

*tcp_server.socket.getsockname())

3626

3627

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

3628

2849

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

2850

*tcp_server.socket.getsockname())

2851

2852

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

2853

3629

2854

try:

3630

2855

if zeroconf:

3631

2856

# From the Avahi example code

3632

2857

try:

3633

2858

service.activate()

3634

2859

except dbus.exceptions.DBusException as error:

3635

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

2860

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

3636

2861

cleanup()

3637

2862

sys.exit(1)

3638

2863

# End of Avahi example code

3639

3640

GLib.io_add_watch(

3641

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

3642

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3643

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

3644

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

3645

3646

log.debug("Starting main loop")

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

2870

logger.debug("Starting main loop")

3647

2871

main_loop.run()

3648

2872

except AvahiError as error:

3649

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

2873

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

3650

2874

cleanup()

3651

2875

sys.exit(1)

3652

2876

except KeyboardInterrupt:

3653

2877

if debug:

3654

2878

print("", file=sys.stderr)

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2879

logger.debug("Server received KeyboardInterrupt")

2880

logger.debug("Server exiting")

3657

2881

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

3658

2882

cleanup()

3659

2883

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

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

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

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

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

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

3690

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

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

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

3702

# extra))

3703

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

3704

# (funcall remove-test-window)

3705

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

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

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

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

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

3714

# (= (process-file-shell-command

3715

# (funcall get-command-line extra)

3716

# nil "*Test*") 0)))

3717

# get-command-line:

3718

# (lambda (&optional extra)

3719

# (let ((quoted-script

3720

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

3721

# (format

3722

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

3723

# quoted-script)))

3724

# get-script-name:

3725

# (lambda ()

3726

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

3727

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

3728

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

3729

# (buffer-file-name))))

3730

# remove-test-window:

3731

# (lambda ()

3732

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

3733

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

3734

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

3735

# (lambda ()

3736

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

3737

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

3738

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

3739

# (display-buffer-overriding-action

3740

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

3741

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

3742

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

3743

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

3744

# eval:

3745

# (progn

3746

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

3747

# (funcall run-tests t)))

3748

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

3749

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

3750

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

3751

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

3752

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

3753

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

3754

# End:

2884

if __name__ == '__main__':

2885

main()