/mandos/trunk : revision 819

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

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

44

import argparse

45

import logging

46

import os

47

39

try:

48

40

import SocketServer as socketserver

49

41

except ImportError:

50

42

import socketserver

51

43

import socket

44

import argparse

52

45

import datetime

53

46

import errno

54

47

try:

55

48

import ConfigParser as configparser

56

49

except ImportError:

57

50

import 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

77

73

import itertools

78

74

import collections

79

75

import codecs

80

import random

81

import shlex

82

76

83

77

import dbus

84

78

import dbus.service

85

import gi

86

from gi.repository import GLib

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

83

import avahi

87

84

from dbus.mainloop.glib import DBusGMainLoop

88

85

import ctypes

89

86

import ctypes.util

90

87

import xml.dom.minidom

91

88

import inspect

92

89

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:

90

try:

122

91

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

92

except AttributeError:

124

93

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

94

from IN import SO_BINDTODEVICE

128

95

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

96

SO_BINDTODEVICE = None

97

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.3"

147

102

stored_state_file = "clients.pickle"

148

103

149

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

150

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

104

logger = logging.getLogger()

151

105

syslogger = None

152

106

153

107

try:

154

108

if_nametoindex = ctypes.cdll.LoadLibrary(

155

109

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

156

110

except (OSError, AttributeError):

157

111

158

112

def if_nametoindex(interface):

159

113

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

160

114

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

165

119

return interface_index

166

120

167

121

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

122

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

185

123

"""init logger and add loglevel"""

186

124

187

125

global syslogger

188

126

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

191

129

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

196

134

if debug:

197

135

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)

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

204

142

205

143

206

144

class PGPError(Exception):

208

146

pass

209

147

210

148

211

class PGPEngine:

149

class PGPEngine(object):

212

150

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

213

151

214

152

def __init__(self):

215

153

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

216

154

self.gpg = "gpg"

217

155

try:

218

156

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

219

157

for line in output.splitlines():

220

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

221

if name == b"gpg":

158

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

159

if name == "gpg":

222

160

self.gpg = path

223

161

break

224

162

except OSError as e:

225

163

if e.errno != errno.ENOENT:

226

164

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

165

self.gnupgargs = ['--batch',

166

'--homedir', self.tempdir,

167

'--force-mdc',

168

'--quiet',

169

'--no-use-agent']

170

235

171

def __enter__(self):

236

172

return self

237

173

238

174

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

239

175

self._cleanup()

240

176

return False

241

177

242

178

def __del__(self):

243

179

self._cleanup()

244

180

245

181

def _cleanup(self):

246

182

if self.tempdir is not None:

247

183

# Delete contents of tempdir

248

184

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

249

topdown=False):

185

topdown = False):

250

186

for filename in files:

251

187

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

252

188

for dirname in dirs:

254

190

# Remove tempdir

255

191

os.rmdir(self.tempdir)

256

192

self.tempdir = None

257

193

258

194

def password_encode(self, password):

259

195

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

260

196

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

265

201

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

266

202

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

267

203

return encoded

268

204

269

205

def encrypt(self, data, password):

270

206

passphrase = self.password_encode(password)

271

207

with tempfile.NamedTemporaryFile(

272

208

dir=self.tempdir) as passfile:

273

209

passfile.write(passphrase)

274

210

passfile.flush()

275

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

276

"--passphrase-file",

211

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

212

'--passphrase-file',

277

213

passfile.name]

278

214

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

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

283

219

if proc.returncode != 0:

284

220

raise PGPError(err)

285

221

return ciphertext

286

222

287

223

def decrypt(self, data, password):

288

224

passphrase = self.password_encode(password)

289

225

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

226

dir = self.tempdir) as passfile:

291

227

passfile.write(passphrase)

292

228

passfile.flush()

293

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

294

"--passphrase-file",

229

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

230

'--passphrase-file',

295

231

passfile.name]

296

232

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

233

stdin = subprocess.PIPE,

234

stdout = subprocess.PIPE,

235

stderr = subprocess.PIPE)

236

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

301

237

if proc.returncode != 0:

302

238

raise PGPError(err)

303

239

return decrypted_plaintext

304

240

305

241

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

242

class AvahiError(Exception):

333

243

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

334

244

self.value = value

344

254

pass

345

255

346

256

347

class AvahiService:

257

class AvahiService(object):

348

258

"""An Avahi (Zeroconf) service.

349

259

350

260

Attributes:

351

261

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

352

262

Used to optionally bind to the specified interface.

353

name: string; Example: "Mandos"

354

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

263

name: string; Example: 'Mandos'

264

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

355

265

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

356

266

port: integer; what port to announce

357

267

TXT: list of strings; TXT record for the service

364

274

server: D-Bus Server

365

275

bus: dbus.SystemBus()

366

276

"""

367

277

368

278

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

279

interface = avahi.IF_UNSPEC,

280

name = None,

281

servicetype = None,

282

port = None,

283

TXT = None,

284

domain = "",

285

host = "",

286

max_renames = 32768,

287

protocol = avahi.PROTO_UNSPEC,

288

bus = None):

379

289

self.interface = interface

380

290

self.name = name

381

291

self.type = servicetype

390

300

self.server = None

391

301

self.bus = bus

392

302

self.entry_group_state_changed_match = None

393

303

394

304

def rename(self, remove=True):

395

305

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

396

306

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)

307

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

308

" after %i retries, exiting.",

309

self.rename_count)

400

310

raise AvahiServiceError("Too many renames")

401

311

self.name = str(

402

312

self.server.GetAlternativeServiceName(self.name))

403

313

self.rename_count += 1

404

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

405

self.name)

314

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

315

self.name)

406

316

if remove:

407

317

self.remove()

408

318

try:

410

320

except dbus.exceptions.DBusException as error:

411

321

if (error.get_dbus_name()

412

322

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

413

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

323

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

414

324

return self.rename(remove=False)

415

325

else:

416

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

326

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

417

327

self.cleanup()

418

328

os._exit(1)

419

329

420

330

def remove(self):

421

331

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

422

332

if self.entry_group_state_changed_match is not None:

424

334

self.entry_group_state_changed_match = None

425

335

if self.group is not None:

426

336

self.group.Reset()

427

337

428

338

def add(self):

429

339

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

430

340

self.remove()

435

345

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

346

self.entry_group_state_changed_match = (

437

347

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)

348

'StateChanged', self.entry_group_state_changed))

349

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

350

self.name, self.type)

441

351

self.group.AddService(

442

352

self.interface,

443

353

self.protocol,

447

357

dbus.UInt16(self.port),

448

358

avahi.string_array_to_txt_array(self.TXT))

449

359

self.group.Commit()

450

360

451

361

def entry_group_state_changed(self, state, error):

452

362

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

453

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

454

363

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

364

455

365

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

366

logger.debug("Zeroconf service established.")

457

367

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

368

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

459

369

self.rename()

460

370

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

371

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

372

str(error))

463

373

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

464

374

465

375

def cleanup(self):

466

376

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

467

377

if self.group is not None:

472

382

pass

473

383

self.group = None

474

384

self.remove()

475

385

476

386

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

477

387

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

478

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

388

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

479

389

bad_states = {

480

390

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

391

avahi.SERVER_REGISTERING: None,

485

395

if state in bad_states:

486

396

if bad_states[state] is not None:

487

397

if error is None:

488

log.error(bad_states[state])

398

logger.error(bad_states[state])

489

399

else:

490

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

400

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

491

401

self.cleanup()

492

402

elif state == avahi.SERVER_RUNNING:

493

403

try:

495

405

except dbus.exceptions.DBusException as error:

496

406

if (error.get_dbus_name()

497

407

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

498

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

408

logger.info("Local Zeroconf service name"

409

" collision.")

499

410

return self.rename(remove=False)

500

411

else:

501

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

412

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

502

413

self.cleanup()

503

414

os._exit(1)

504

415

else:

505

416

if error is None:

506

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

417

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

507

418

else:

508

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

509

419

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

420

510

421

def activate(self):

511

422

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

512

423

if self.server is None:

523

434

class AvahiServiceToSyslog(AvahiService):

524

435

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

525

436

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

526

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

527

**kwargs)

437

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

528

438

syslogger.setFormatter(logging.Formatter(

529

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

439

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

530

440

.format(self.name)))

531

441

return ret

532

442

533

534

443

# 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

444

class GnuTLS(object):

445

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

446

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

447

448

_library = ctypes.cdll.LoadLibrary(

449

ctypes.util.find_library("gnutls"))

450

_need_version = "3.3.0"

451

def __init__(self):

452

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

453

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

454

# happens.

455

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

456

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

457

.format(self._need_version))

458

544

459

# Unless otherwise indicated, the constants and types below are

545

460

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

546

461

547

462

# Constants

548

463

E_SUCCESS = 0

549

464

E_INTERRUPTED = -52

550

465

E_AGAIN = -28

551

466

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

467

CLIENT = 2

554

468

SHUT_RDWR = 0

555

469

CRD_CERTIFICATE = 1

556

470

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

471

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

472

564

473

# Types

565

class _session_int(ctypes.Structure):

474

class session_int(ctypes.Structure):

566

475

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

476

session_t = ctypes.POINTER(session_int)

569

477

class certificate_credentials_st(ctypes.Structure):

570

478

_fields_ = []

571

479

certificate_credentials_t = ctypes.POINTER(

572

480

certificate_credentials_st)

573

481

certificate_type_t = ctypes.c_int

574

575

482

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

483

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

484

('size', ctypes.c_uint)]

485

class openpgp_crt_int(ctypes.Structure):

580

486

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

487

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

488

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

489

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

584

credentials_type_t = ctypes.c_int

490

credentials_type_t = ctypes.c_int #

585

491

transport_ptr_t = ctypes.c_void_p

586

492

close_request_t = ctypes.c_int

587

493

588

494

# Exceptions

589

495

class Error(Exception):

590

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

496

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

497

# exception might be raised from within GnuTLS.__init__,

498

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

499

# global variable has happened.

500

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

591

501

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

592

502

# code is passed, convert it to a string with

593

503

# gnutls.strerror()

594

504

self.code = code

595

505

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

506

message = GnuTLS.strerror(code)

507

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

599

508

message, *args)

600

509

601

510

class CertificateSecurityError(Error):

602

511

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

512

629

513

# Classes

630

class Credentials(With_from_param):

514

class Credentials(object):

631

515

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

516

self._c_object = gnutls.certificate_credentials_t()

517

gnutls.certificate_allocate_credentials(

518

ctypes.byref(self._c_object))

634

519

self.type = gnutls.CRD_CERTIFICATE

635

520

636

521

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)

522

gnutls.certificate_free_credentials(self._c_object)

523

524

class ClientSession(object):

525

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

526

self._c_object = gnutls.session_t()

527

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

528

gnutls.set_default_priority(self._c_object)

529

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

530

gnutls.handshake_set_private_extensions(self._c_object,

531

True)

652

532

self.socket = socket

653

533

if credentials is None:

654

534

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

535

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

536

ctypes.cast(credentials._c_object,

537

ctypes.c_void_p))

657

538

self.credentials = credentials

658

539

659

540

def __del__(self):

660

gnutls.deinit(self)

661

541

gnutls.deinit(self._c_object)

542

662

543

def handshake(self):

663

return gnutls.handshake(self)

664

544

return gnutls.handshake(self._c_object)

545

665

546

def send(self, data):

666

547

data = bytes(data)

667

548

data_len = len(data)

668

549

while data_len > 0:

669

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

550

data_len -= gnutls.record_send(self._c_object,

551

data[-data_len:],

670

552

data_len)

671

553

672

554

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

555

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

556

675

557

# Error handling functions

676

558

def _error_code(result):

677

559

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

678

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

679

if result >= gnutls.E_SUCCESS:

560

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

561

if result >= 0:

680

562

return result

681

563

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

564

raise gnutls.CertificateSecurityError(code = result)

565

raise gnutls.Error(code = result)

566

567

def _retry_on_error(result, func, arguments):

687

568

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

688

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

689

while result < gnutls.E_SUCCESS:

569

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

570

while result < 0:

690

571

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

691

572

return _error_code(result)

692

573

result = func(*arguments)

693

574

return result

694

575

695

576

# Unless otherwise indicated, the function declarations below are

696

577

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

697

578

698

579

# Functions

699

580

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

581

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

701

582

ctypes.POINTER(ctypes.c_char_p)]

702

583

priority_set_direct.restype = _error_code

703

584

704

585

init = _library.gnutls_init

705

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

586

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

706

587

init.restype = _error_code

707

588

708

589

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

590

set_default_priority.argtypes = [session_t]

710

591

set_default_priority.restype = _error_code

711

592

712

593

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

594

record_send.argtypes = [session_t, ctypes.c_void_p,

714

595

ctypes.c_size_t]

715

596

record_send.restype = ctypes.c_ssize_t

716

597

record_send.errcheck = _retry_on_error

717

598

718

599

certificate_allocate_credentials = (

719

600

_library.gnutls_certificate_allocate_credentials)

720

601

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

602

ctypes.POINTER(certificate_credentials_t)]

722

603

certificate_allocate_credentials.restype = _error_code

723

604

724

605

certificate_free_credentials = (

725

606

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

607

certificate_free_credentials.argtypes = [certificate_credentials_t]

727

608

certificate_free_credentials.restype = None

728

609

729

610

handshake_set_private_extensions = (

730

611

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

612

handshake_set_private_extensions.argtypes = [session_t,

732

613

ctypes.c_int]

733

614

handshake_set_private_extensions.restype = None

734

615

735

616

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

617

credentials_set.argtypes = [session_t, credentials_type_t,

618

ctypes.c_void_p]

738

619

credentials_set.restype = _error_code

739

620

740

621

strerror = _library.gnutls_strerror

741

622

strerror.argtypes = [ctypes.c_int]

742

623

strerror.restype = ctypes.c_char_p

743

624

744

625

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

626

certificate_type_get.argtypes = [session_t]

746

627

certificate_type_get.restype = _error_code

747

628

748

629

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

630

certificate_get_peers.argtypes = [session_t,

750

631

ctypes.POINTER(ctypes.c_uint)]

751

632

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

633

753

634

global_set_log_level = _library.gnutls_global_set_log_level

754

635

global_set_log_level.argtypes = [ctypes.c_int]

755

636

global_set_log_level.restype = None

756

637

757

638

global_set_log_function = _library.gnutls_global_set_log_function

758

639

global_set_log_function.argtypes = [log_func]

759

640

global_set_log_function.restype = None

760

641

761

642

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

643

deinit.argtypes = [session_t]

763

644

deinit.restype = None

764

645

765

646

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

647

handshake.argtypes = [session_t]

648

handshake.restype = _error_code

768

649

handshake.errcheck = _retry_on_error

769

650

770

651

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

652

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

772

653

transport_set_ptr.restype = None

773

654

774

655

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

656

bye.argtypes = [session_t, close_request_t]

657

bye.restype = _error_code

777

658

bye.errcheck = _retry_on_error

778

659

779

660

check_version = _library.gnutls_check_version

780

661

check_version.argtypes = [ctypes.c_char_p]

781

662

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

663

664

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

665

666

openpgp_crt_init = _library.gnutls_openpgp_crt_init

667

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

668

openpgp_crt_init.restype = _error_code

669

670

openpgp_crt_import = _library.gnutls_openpgp_crt_import

671

openpgp_crt_import.argtypes = [openpgp_crt_t,

672

ctypes.POINTER(datum_t),

673

openpgp_crt_fmt_t]

674

openpgp_crt_import.restype = _error_code

675

676

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

677

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

678

ctypes.POINTER(ctypes.c_uint)]

679

openpgp_crt_verify_self.restype = _error_code

680

681

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

682

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

683

openpgp_crt_deinit.restype = None

684

685

openpgp_crt_get_fingerprint = (

686

_library.gnutls_openpgp_crt_get_fingerprint)

687

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

688

ctypes.c_void_p,

689

ctypes.POINTER(

690

ctypes.c_size_t)]

691

openpgp_crt_get_fingerprint.restype = _error_code

692

859

693

# Remove non-public functions

860

694

del _error_code, _retry_on_error

861

695

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

696

gnutls = GnuTLS()

862

697

863

698

def call_pipe(connection, # : multiprocessing.Connection

864

699

func, *args, **kwargs):

865

700

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

866

701

867

702

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

868

703

return value on the provided multiprocessing.Connection.

869

704

"""

870

705

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

871

706

connection.close()

872

707

873

874

class Client:

708

class Client(object):

875

709

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

876

710

877

711

Attributes:

878

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

712

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

879

713

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

880

714

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

715

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

716

to see if the client lives.

717

'None' if no process is running.

718

checker_callback_tag: a gobject event source tag, or None

885

719

checker_command: string; External command which is run to check

886

720

if client lives. %() expansions are done at

887

721

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

888

722

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

889

checker_initiator_tag: a GLib event source tag, or None

723

checker_initiator_tag: a gobject event source tag, or None

890

724

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

891

725

client_structure: Object describing what attributes a client has

892

726

and is used for storing the client at exit

893

727

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

728

disable_initiator_tag: a gobject event source tag, or None

895

729

enabled: bool()

896

730

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

731

uniquely identify the client

900

732

host: string; available for use by the checker command

901

733

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

902

734

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

918

750

disabled, or None

919

751

server_settings: The server_settings dict from main()

920

752

"""

921

753

922

754

runtime_expansions = ("approval_delay", "approval_duration",

923

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

755

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

924

756

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

925

757

"last_approval_request", "last_checked_ok",

926

758

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

935

767

"approved_by_default": "True",

936

768

"enabled": "True",

937

769

}

938

770

939

771

@staticmethod

940

772

def config_parser(config):

941

773

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

948

780

for client_name in config.sections():

949

781

section = dict(config.items(client_name))

950

782

client = settings[client_name] = {}

951

783

952

784

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

953

785

# Reformat values from string types to Python types

954

786

client["approved_by_default"] = config.getboolean(

955

787

client_name, "approved_by_default")

956

788

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

957

789

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

790

791

# Uppercase and remove spaces from fingerprint for later

792

# comparison purposes with return value from the

793

# fingerprint() function

964

794

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

965

795

.replace(" ", ""))

966

796

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

797

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

970

798

elif "secfile" in section:

971

799

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

972

800

(section["secfile"])),

987

815

client["last_approval_request"] = None

988

816

client["last_checked_ok"] = None

989

817

client["last_checker_status"] = -2

990

818

991

819

return settings

992

993

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

820

821

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

994

822

self.name = name

995

823

if server_settings is None:

996

824

server_settings = {}

998

826

# adding all client settings

999

827

for setting, value in settings.items():

1000

828

setattr(self, setting, value)

1001

829

1002

830

if self.enabled:

1003

831

if not hasattr(self, "last_enabled"):

1004

832

self.last_enabled = datetime.datetime.utcnow()

1008

836

else:

1009

837

self.last_enabled = None

1010

838

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)

839

840

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

841

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

1015

842

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

1016

843

datetime.datetime.utcnow())

1017

844

1018

845

# attributes specific for this server instance

1019

846

self.checker = None

1020

847

self.checker_initiator_tag = None

1026

853

self.changedstate = multiprocessing_manager.Condition(

1027

854

multiprocessing_manager.Lock())

1028

855

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

856

for attr in self.__dict__.iterkeys()

1030

857

if not attr.startswith("_")]

1031

858

self.client_structure.append("client_structure")

1032

859

1033

860

for name, t in inspect.getmembers(

1034

861

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

1035

862

if not name.startswith("_"):

1036

863

self.client_structure.append(name)

1037

864

1038

865

# Send notice to process children that client state has changed

1039

866

def send_changedstate(self):

1040

867

with self.changedstate:

1041

868

self.changedstate.notify_all()

1042

869

1043

870

def enable(self):

1044

871

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

1045

872

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

1050

877

self.last_enabled = datetime.datetime.utcnow()

1051

878

self.init_checker()

1052

879

self.send_changedstate()

1053

880

1054

881

def disable(self, quiet=True):

1055

882

"""Disable this client."""

1056

883

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

1057

884

return False

1058

885

if not quiet:

1059

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

886

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

1060

887

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

1061

GLib.source_remove(self.disable_initiator_tag)

888

gobject.source_remove(self.disable_initiator_tag)

1062

889

self.disable_initiator_tag = None

1063

890

self.expires = None

1064

891

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

1065

GLib.source_remove(self.checker_initiator_tag)

892

gobject.source_remove(self.checker_initiator_tag)

1066

893

self.checker_initiator_tag = None

1067

894

self.stop_checker()

1068

895

self.enabled = False

1069

896

if not quiet:

1070

897

self.send_changedstate()

1071

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

898

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

1072

899

return False

1073

900

1074

901

def __del__(self):

1075

902

self.disable()

1076

903

1077

904

def init_checker(self):

1078

905

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

1079

906

# and every interval from then on.

1080

907

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

908

gobject.source_remove(self.checker_initiator_tag)

909

self.checker_initiator_tag = gobject.timeout_add(

910

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

1085

911

self.start_checker)

1086

912

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

1087

913

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

914

gobject.source_remove(self.disable_initiator_tag)

915

self.disable_initiator_tag = gobject.timeout_add(

1090

916

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

1091

917

# Also start a new checker *right now*.

1092

918

self.start_checker()

1093

919

1094

920

def checker_callback(self, source, condition, connection,

1095

921

command):

1096

922

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

923

self.checker_callback_tag = None

924

self.checker = None

1097

925

# Read return code from connection (see call_pipe)

1098

926

returncode = connection.recv()

1099

927

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

1102

self.checker_callback_tag = None

1103

self.checker = None

1104

928

1105

929

if returncode >= 0:

1106

930

self.last_checker_status = returncode

1107

931

self.last_checker_signal = None

1108

932

if self.last_checker_status == 0:

1109

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

933

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

934

vars(self))

1110

935

self.checked_ok()

1111

936

else:

1112

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

937

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

1113

938

else:

1114

939

self.last_checker_status = -1

1115

940

self.last_checker_signal = -returncode

1116

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

941

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

942

vars(self))

1117

943

return False

1118

944

1119

945

def checked_ok(self):

1120

946

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

1121

947

self.last_checked_ok = datetime.datetime.utcnow()

1122

948

self.last_checker_status = 0

1123

949

self.last_checker_signal = None

1124

950

self.bump_timeout()

1125

951

1126

952

def bump_timeout(self, timeout=None):

1127

953

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

1128

954

if timeout is None:

1129

955

timeout = self.timeout

1130

956

if self.disable_initiator_tag is not None:

1131

GLib.source_remove(self.disable_initiator_tag)

957

gobject.source_remove(self.disable_initiator_tag)

1132

958

self.disable_initiator_tag = None

1133

959

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

1134

self.disable_initiator_tag = GLib.timeout_add(

960

self.disable_initiator_tag = gobject.timeout_add(

1135

961

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

1136

962

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

1137

963

1138

964

def need_approval(self):

1139

965

self.last_approval_request = datetime.datetime.utcnow()

1140

966

1141

967

def start_checker(self):

1142

968

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

1143

969

1144

970

If a checker already exists, leave it running and do

1145

971

nothing."""

1146

972

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

1151

977

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

1152

978

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

1153

979

# should be.

1154

980

1155

981

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

1156

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

982

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

1157

983

self.checker.join()

1158

984

self.checker = None

1159

985

# Start a new checker if needed

1160

986

if self.checker is None:

1161

987

# Escape attributes for the shell

1162

988

escaped_attrs = {

1163

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

1164

for attr in self.runtime_expansions}

989

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

990

for attr in self.runtime_expansions }

1165

991

try:

1166

992

command = self.checker_command % escaped_attrs

1167

993

except TypeError as error:

1168

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

1169

self.checker_command, exc_info=error)

994

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

995

self.checker_command,

996

exc_info=error)

1170

997

return True # Try again later

1171

998

self.current_checker_command = command

1172

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

999

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

1000

self.name)

1173

1001

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

1174

1002

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

1175

1003

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

1177

1005

# The exception is when not debugging but nevertheless

1178

1006

# running in the foreground; use the previously

1179

1007

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

1008

popen_args = { "close_fds": True,

1009

"shell": True,

1010

"cwd": "/" }

1183

1011

if (not self.server_settings["debug"]

1184

1012

and self.server_settings["foreground"]):

1185

1013

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

1014

"stderr": wnull })

1015

pipe = multiprocessing.Pipe(duplex = False)

1188

1016

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

1017

target = call_pipe,

1018

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

1019

kwargs = popen_args)

1192

1020

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,

1021

self.checker_callback_tag = gobject.io_add_watch(

1022

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

1196

1023

self.checker_callback, pipe[0], command)

1197

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

1024

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

1198

1025

return True

1199

1026

1200

1027

def stop_checker(self):

1201

1028

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

1202

1029

if self.checker_callback_tag:

1203

GLib.source_remove(self.checker_callback_tag)

1030

gobject.source_remove(self.checker_callback_tag)

1204

1031

self.checker_callback_tag = None

1205

1032

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

1206

1033

return

1207

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

1034

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

1208

1035

self.checker.terminate()

1209

1036

self.checker = None

1210

1037

1215

1042

byte_arrays=False):

1216

1043

"""Decorators for marking methods of a DBusObjectWithProperties to

1217

1044

become properties on the D-Bus.

1218

1045

1219

1046

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

1220

1047

and with one argument by "Set".

1221

1048

1222

1049

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

1223

1050

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

1224

1051

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

1228

1055

if byte_arrays and signature != "ay":

1229

1056

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

1230

1057

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

1231

1058

1232

1059

def decorator(func):

1233

1060

func._dbus_is_property = True

1234

1061

func._dbus_interface = dbus_interface

1237

1064

func._dbus_name = func.__name__

1238

1065

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

1239

1066

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

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

1067

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1241

1068

return func

1242

1069

1243

1070

return decorator

1244

1071

1245

1072

1246

1073

def dbus_interface_annotations(dbus_interface):

1247

1074

"""Decorator for marking functions returning interface annotations

1248

1075

1249

1076

Usage:

1250

1077

1251

1078

@dbus_interface_annotations("org.example.Interface")

1252

1079

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

1253

1080

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

1254

1081

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

1255

1082

"false"}

1256

1083

"""

1257

1084

1258

1085

def decorator(func):

1259

1086

func._dbus_is_interface = True

1260

1087

func._dbus_interface = dbus_interface

1261

1088

func._dbus_name = dbus_interface

1262

1089

return func

1263

1090

1264

1091

return decorator

1265

1092

1266

1093

1267

1094

def dbus_annotations(annotations):

1268

1095

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

1269

1096

Usage:

1270

1097

1271

1098

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

1272

1099

"org.freedesktop.DBus.Property."

1273

1100

"EmitsChangedSignal": "false"})

1275

1102

access="r")

1276

1103

def Property_dbus_property(self):

1277

1104

return dbus.Boolean(False)

1278

1105

1279

1106

See also the DBusObjectWithAnnotations class.

1280

1107

"""

1281

1108

1282

1109

def decorator(func):

1283

1110

func._dbus_annotations = annotations

1284

1111

return func

1285

1112

1286

1113

return decorator

1287

1114

1288

1115

1306

1133

1307

1134

class DBusObjectWithAnnotations(dbus.service.Object):

1308

1135

"""A D-Bus object with annotations.

1309

1136

1310

1137

Classes inheriting from this can use the dbus_annotations

1311

1138

decorator to add annotations to methods or signals.

1312

1139

"""

1313

1140

1314

1141

@staticmethod

1315

1142

def _is_dbus_thing(thing):

1316

1143

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

1317

1144

1318

1145

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

1319

1146

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

1320

1147

"""

1321

1148

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

1322

1149

False)

1323

1150

1324

1151

def _get_all_dbus_things(self, thing):

1325

1152

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

1326

1153

"""

1329

1156

for cls in self.__class__.__mro__

1330

1157

for name, athing in

1331

1158

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

1332

1159

1333

1160

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1161

out_signature = "s",

1162

path_keyword = 'object_path',

1163

connection_keyword = 'connection')

1337

1164

def Introspect(self, object_path, connection):

1338

1165

"""Overloading of standard D-Bus method.

1339

1166

1340

1167

Inserts annotation tags on methods and signals.

1341

1168

"""

1342

1169

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

1343

1170

connection)

1344

1171

try:

1345

1172

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

1346

1173

1347

1174

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

1348

1175

# Add annotation tags

1349

1176

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

1376

1203

if_tag.appendChild(ann_tag)

1377

1204

# Fix argument name for the Introspect method itself

1378

1205

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1206

== dbus.INTROSPECTABLE_IFACE):

1380

1207

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

1381

1208

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

1382

1209

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

1388

1215

document.unlink()

1389

1216

except (AttributeError, xml.dom.DOMException,

1390

1217

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1218

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

1219

exc_info=error)

1393

1220

return xmlstring

1394

1221

1395

1222

1396

1223

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

1224

"""A D-Bus object with properties.

1398

1225

1399

1226

Classes inheriting from this can use the dbus_service_property

1400

1227

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

1401

1228

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

1402

1229

"""

1403

1230

1404

1231

def _get_dbus_property(self, interface_name, property_name):

1405

1232

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

1406

1233

property with the specified name and interface.

1411

1238

if (value._dbus_name == property_name

1412

1239

and value._dbus_interface == interface_name):

1413

1240

return value.__get__(self)

1414

1241

1415

1242

# No such property

1416

1243

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

1417

1244

self.dbus_object_path, interface_name, property_name))

1418

1245

1419

1246

@classmethod

1420

1247

def _get_all_interface_names(cls):

1421

1248

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

1424

1251

for x in (inspect.getmro(cls))

1425

1252

for attr in dir(x))

1426

1253

if name is not None)

1427

1254

1428

1255

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

1256

in_signature="ss",

1430

1257

out_signature="v")

1438

1265

if not hasattr(value, "variant_level"):

1439

1266

return value

1440

1267

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

1441

1268

1442

1269

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

1443

1270

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

1444

1271

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

1453

1280

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

1454

1281

"'ay' signature {!r}"

1455

1282

.format(prop._dbus_signature))

1456

value = dbus.ByteArray(bytes(value))

1283

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

1284

for byte in value))

1457

1285

prop(value)

1458

1286

1459

1287

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

1288

in_signature="s",

1461

1289

out_signature="a{sv}")

1462

1290

def GetAll(self, interface_name):

1463

1291

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

1464

1292

standard.

1465

1293

1466

1294

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

1467

1295

"""

1468

1296

properties = {}

1479

1307

properties[name] = value

1480

1308

continue

1481

1309

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

1310

value, variant_level = value.variant_level + 1)

1483

1311

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

1484

1312

1485

1313

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

1486

1314

def PropertiesChanged(self, interface_name, changed_properties,

1487

1315

invalidated_properties):

1489

1317

standard.

1490

1318

"""

1491

1319

pass

1492

1320

1493

1321

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1494

1322

out_signature="s",

1495

path_keyword="object_path",

1496

connection_keyword="connection")

1323

path_keyword='object_path',

1324

connection_keyword='connection')

1497

1325

def Introspect(self, object_path, connection):

1498

1326

"""Overloading of standard D-Bus method.

1499

1327

1500

1328

Inserts property tags and interface annotation tags.

1501

1329

"""

1502

1330

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1504

1332

connection)

1505

1333

try:

1506

1334

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

1507

1335

1508

1336

def make_tag(document, name, prop):

1509

1337

e = document.createElement("property")

1510

1338

e.setAttribute("name", name)

1511

1339

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

1512

1340

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

1513

1341

return e

1514

1342

1515

1343

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

1516

1344

# Add property tags

1517

1345

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

1555

1383

document.unlink()

1556

1384

except (AttributeError, xml.dom.DOMException,

1557

1385

xml.parsers.expat.ExpatError) as error:

1558

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

1559

exc_info=error)

1386

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

1387

exc_info=error)

1560

1388

return xmlstring

1561

1389

1562

1563

1390

try:

1564

1391

dbus.OBJECT_MANAGER_IFACE

1565

1392

except AttributeError:

1566

1393

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

1567

1394

1568

1569

1395

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

1396

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

1571

1397

1572

1398

Classes inheriting from this exposes the standard

1573

1399

GetManagedObjects call and the InterfacesAdded and

1574

1400

InterfacesRemoved signals on the standard

1575

1401

"org.freedesktop.DBus.ObjectManager" interface.

1576

1402

1577

1403

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

1578

1404

manually.

1579

1405

"""

1580

1406

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1407

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

1582

1408

def GetManagedObjects(self):

1583

1409

"""This function must be overridden"""

1584

1410

raise NotImplementedError()

1585

1411

1586

1412

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1413

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

1588

1414

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

1415

pass

1590

1591

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

1416

1417

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

1592

1418

def InterfacesRemoved(self, object_path, interfaces):

1593

1419

pass

1594

1420

1595

1421

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1422

out_signature = "s",

1423

path_keyword = 'object_path',

1424

connection_keyword = 'connection')

1599

1425

def Introspect(self, object_path, connection):

1600

1426

"""Overloading of standard D-Bus method.

1601

1427

1602

1428

Override return argument name of GetManagedObjects to be

1603

1429

"objpath_interfaces_and_properties"

1604

1430

"""

1607

1433

connection)

1608

1434

try:

1609

1435

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

1610

1436

1611

1437

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

1612

1438

# Fix argument name for the GetManagedObjects method

1613

1439

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1440

== dbus.OBJECT_MANAGER_IFACE):

1615

1441

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

1616

1442

if (cn.getAttribute("name")

1617

1443

== "GetManagedObjects"):

1626

1452

document.unlink()

1627

1453

except (AttributeError, xml.dom.DOMException,

1628

1454

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1455

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

1456

exc_info = error)

1631

1457

return xmlstring

1632

1458

1633

1634

1459

def datetime_to_dbus(dt, variant_level=0):

1635

1460

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

1636

1461

if dt is None:

1637

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

1462

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

1638

1463

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

1639

1464

1640

1465

1643

1468

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

1644

1469

interface names according to the "alt_interface_names" mapping.

1645

1470

Usage:

1646

1471

1647

1472

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

1648

1473

"net.example.AlternateInterface"})

1649

1474

class SampleDBusObject(dbus.service.Object):

1650

1475

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

1651

1476

def SampleDBusMethod():

1652

1477

pass

1653

1478

1654

1479

The above "SampleDBusMethod" on "SampleDBusObject" will be

1655

1480

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

1656

1481

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

1657

1482

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

1658

1483

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

1659

1484

1660

1485

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

1661

1486

(from DBusObjectWithProperties) and interfaces (from the

1662

1487

dbus_interface_annotations decorator).

1663

1488

"""

1664

1489

1665

1490

def wrapper(cls):

1666

1491

for orig_interface_name, alt_interface_name in (

1667

1492

alt_interface_names.items()):

1682

1507

interface_names.add(alt_interface)

1683

1508

# Is this a D-Bus signal?

1684

1509

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

1685

# Extract the original non-method undecorated

1686

# function by black magic

1687

1510

if sys.version_info.major == 2:

1511

# Extract the original non-method undecorated

1512

# function by black magic

1688

1513

nonmethod_func = (dict(

1689

1514

zip(attribute.func_code.co_freevars,

1690

1515

attribute.__closure__))

1691

1516

["func"].cell_contents)

1692

1517

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1518

nonmethod_func = attribute

1697

1519

# Create a new, but exactly alike, function

1698

1520

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

1699

1521

# with the alternate D-Bus interface name

1700

new_function = copy_function(nonmethod_func)

1522

if sys.version_info.major == 2:

1523

new_function = types.FunctionType(

1524

nonmethod_func.func_code,

1525

nonmethod_func.func_globals,

1526

nonmethod_func.func_name,

1527

nonmethod_func.func_defaults,

1528

nonmethod_func.func_closure)

1529

else:

1530

new_function = types.FunctionType(

1531

nonmethod_func.__code__,

1532

nonmethod_func.__globals__,

1533

nonmethod_func.__name__,

1534

nonmethod_func.__defaults__,

1535

nonmethod_func.__closure__)

1701

1536

new_function = (dbus.service.signal(

1702

1537

alt_interface,

1703

1538

attribute._dbus_signature)(new_function))

1707

1542

attribute._dbus_annotations)

1708

1543

except AttributeError:

1709

1544

pass

1710

1711

1545

# Define a creator of a function to call both the

1712

1546

# original and alternate functions, so both the

1713

1547

# original and alternate signals gets sent when

1716

1550

"""This function is a scope container to pass

1717

1551

func1 and func2 to the "call_both" function

1718

1552

outside of its arguments"""

1719

1553

1720

1554

@functools.wraps(func2)

1721

1555

def call_both(*args, **kwargs):

1722

1556

"""This function will emit two D-Bus

1723

1557

signals by calling func1 and func2"""

1724

1558

func1(*args, **kwargs)

1725

1559

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1560

# Make wrapper function look like a D-Bus signal

1728

1561

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

1729

1562

if name.startswith("_dbus_"):

1730

1563

setattr(call_both, name, attr)

1731

1564

1732

1565

return call_both

1733

1566

# Create the "call_both" function and add it to

1734

1567

# the class

1744

1577

alt_interface,

1745

1578

attribute._dbus_in_signature,

1746

1579

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1580

(types.FunctionType(attribute.func_code,

1581

attribute.func_globals,

1582

attribute.func_name,

1583

attribute.func_defaults,

1584

attribute.func_closure)))

1748

1585

# Copy annotations, if any

1749

1586

try:

1750

1587

attr[attrname]._dbus_annotations = dict(

1762

1599

attribute._dbus_access,

1763

1600

attribute._dbus_get_args_options

1764

1601

["byte_arrays"])

1765

(copy_function(attribute)))

1602

(types.FunctionType(

1603

attribute.func_code,

1604

attribute.func_globals,

1605

attribute.func_name,

1606

attribute.func_defaults,

1607

attribute.func_closure)))

1766

1608

# Copy annotations, if any

1767

1609

try:

1768

1610

attr[attrname]._dbus_annotations = dict(

1777

1619

# to the class.

1778

1620

attr[attrname] = (

1779

1621

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1622

(types.FunctionType(attribute.func_code,

1623

attribute.func_globals,

1624

attribute.func_name,

1625

attribute.func_defaults,

1626

attribute.func_closure)))

1781

1627

if deprecate:

1782

1628

# Deprecate all alternate interfaces

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1629

iname="_AlternateDBusNames_interface_annotation{}"

1784

1630

for interface_name in interface_names:

1785

1631

1786

1632

@dbus_interface_annotations(interface_name)

1787

1633

def func(self):

1788

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

1789

"true"}

1634

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

1635

"true" }

1790

1636

# Find an unused name

1791

1637

for aname in (iname.format(i)

1792

1638

for i in itertools.count()):

1796

1642

if interface_names:

1797

1643

# Replace the class with a new subclass of it with

1798

1644

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

1645

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

1646

(cls, ), attr)

1805

1647

return cls

1806

1648

1807

1649

return wrapper

1808

1650

1809

1651

1811

1653

"se.bsnet.fukt.Mandos"})

1812

1654

class ClientDBus(Client, DBusObjectWithProperties):

1813

1655

"""A Client class using D-Bus

1814

1656

1815

1657

Attributes:

1816

1658

dbus_object_path: dbus.ObjectPath

1817

1659

bus: dbus.SystemBus()

1818

1660

"""

1819

1661

1820

1662

runtime_expansions = (Client.runtime_expansions

1821

1663

+ ("dbus_object_path", ))

1822

1664

1823

1665

_interface = "se.recompile.Mandos.Client"

1824

1666

1825

1667

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

1826

1827

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

1668

1669

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

1828

1670

self.bus = bus

1829

1671

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

1830

1672

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

1836

1678

"/clients/" + client_object_name)

1837

1679

DBusObjectWithProperties.__init__(self, self.bus,

1838

1680

self.dbus_object_path)

1839

1681

1840

1682

def notifychangeproperty(transform_func, dbus_name,

1841

1683

type_func=lambda x: x,

1842

1684

variant_level=1,

1844

1686

_interface=_interface):

1845

1687

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

1846

1688

its changes to DBus.

1847

1689

1848

1690

transform_fun: Function that takes a value and a variant_level

1849

1691

and transforms it to a D-Bus type.

1850

1692

dbus_name: D-Bus name of the variable

1853

1695

variant_level: D-Bus variant level. Default: 1

1854

1696

"""

1855

1697

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

1856

1698

1857

1699

def setter(self, value):

1858

1700

if hasattr(self, "dbus_object_path"):

1859

1701

if (not hasattr(self, attrname) or

1866

1708

else:

1867

1709

dbus_value = transform_func(

1868

1710

type_func(value),

1869

variant_level=variant_level)

1711

variant_level = variant_level)

1870

1712

self.PropertyChanged(dbus.String(dbus_name),

1871

1713

dbus_value)

1872

1714

self.PropertiesChanged(

1873

1715

_interface,

1874

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

1875

dbus_value}),

1716

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

1717

dbus_value }),

1876

1718

dbus.Array())

1877

1719

setattr(self, attrname, value)

1878

1720

1879

1721

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

1880

1722

1881

1723

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1882

1724

approvals_pending = notifychangeproperty(dbus.Boolean,

1883

1725

"ApprovalPending",

1884

type_func=bool)

1726

type_func = bool)

1885

1727

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

1886

1728

last_enabled = notifychangeproperty(datetime_to_dbus,

1887

1729

"LastEnabled")

1888

1730

checker = notifychangeproperty(

1889

1731

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1732

type_func = lambda checker: checker is not None)

1891

1733

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1892

1734

"LastCheckedOK")

1893

1735

last_checker_status = notifychangeproperty(dbus.Int16,

1898

1740

"ApprovedByDefault")

1899

1741

approval_delay = notifychangeproperty(

1900

1742

dbus.UInt64, "ApprovalDelay",

1901

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

1743

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

1902

1744

approval_duration = notifychangeproperty(

1903

1745

dbus.UInt64, "ApprovalDuration",

1904

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

1746

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

1905

1747

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

1906

1748

timeout = notifychangeproperty(

1907

1749

dbus.UInt64, "Timeout",

1908

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

1750

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

1909

1751

extended_timeout = notifychangeproperty(

1910

1752

dbus.UInt64, "ExtendedTimeout",

1911

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

1753

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

1912

1754

interval = notifychangeproperty(

1913

1755

dbus.UInt64, "Interval",

1914

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

1756

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

1915

1757

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

1916

1758

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

1917

1759

invalidate_only=True)

1918

1760

1919

1761

del notifychangeproperty

1920

1762

1921

1763

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

1922

1764

try:

1923

1765

self.remove_from_connection()

1926

1768

if hasattr(DBusObjectWithProperties, "__del__"):

1927

1769

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

1928

1770

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

1929

1771

1930

1772

def checker_callback(self, source, condition,

1931

1773

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

1932

1774

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

1948

1790

| self.last_checker_signal),

1949

1791

dbus.String(command))

1950

1792

return ret

1951

1793

1952

1794

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

1953

1795

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

1954

1796

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

1958

1800

# Emit D-Bus signal

1959

1801

self.CheckerStarted(self.current_checker_command)

1960

1802

return r

1961

1803

1962

1804

def _reset_approved(self):

1963

1805

self.approved = None

1964

1806

return False

1965

1807

1966

1808

def approve(self, value=True):

1967

1809

self.approved = value

1968

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

1969

* 1000), self._reset_approved)

1810

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

1811

* 1000), self._reset_approved)

1970

1812

self.send_changedstate()

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1813

1814

## D-Bus methods, signals & properties

1815

1816

## Interfaces

1817

1818

## Signals

1819

1978

1820

# CheckerCompleted - signal

1979

1821

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

1980

1822

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

1981

1823

"D-Bus signal"

1982

1824

pass

1983

1825

1984

1826

# CheckerStarted - signal

1985

1827

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

1986

1828

def CheckerStarted(self, command):

1987

1829

"D-Bus signal"

1988

1830

pass

1989

1831

1990

1832

# PropertyChanged - signal

1991

1833

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

1992

1834

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

1993

1835

def PropertyChanged(self, property, value):

1994

1836

"D-Bus signal"

1995

1837

pass

1996

1838

1997

1839

# GotSecret - signal

1998

1840

@dbus.service.signal(_interface)

1999

1841

def GotSecret(self):

2002

1844

server to mandos-client

2003

1845

"""

2004

1846

pass

2005

1847

2006

1848

# Rejected - signal

2007

1849

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

2008

1850

def Rejected(self, reason):

2009

1851

"D-Bus signal"

2010

1852

pass

2011

1853

2012

1854

# NeedApproval - signal

2013

1855

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

2014

1856

def NeedApproval(self, timeout, default):

2015

1857

"D-Bus signal"

2016

1858

return self.need_approval()

2017

2018

# Methods

2019

1859

1860

## Methods

1861

2020

1862

# Approve - method

2021

1863

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

2022

1864

def Approve(self, value):

2023

1865

self.approve(value)

2024

1866

2025

1867

# CheckedOK - method

2026

1868

@dbus.service.method(_interface)

2027

1869

def CheckedOK(self):

2028

1870

self.checked_ok()

2029

1871

2030

1872

# Enable - method

2031

1873

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

2032

1874

@dbus.service.method(_interface)

2033

1875

def Enable(self):

2034

1876

"D-Bus method"

2035

1877

self.enable()

2036

1878

2037

1879

# StartChecker - method

2038

1880

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

2039

1881

@dbus.service.method(_interface)

2040

1882

def StartChecker(self):

2041

1883

"D-Bus method"

2042

1884

self.start_checker()

2043

1885

2044

1886

# Disable - method

2045

1887

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

2046

1888

@dbus.service.method(_interface)

2047

1889

def Disable(self):

2048

1890

"D-Bus method"

2049

1891

self.disable()

2050

1892

2051

1893

# StopChecker - method

2052

1894

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

2053

1895

@dbus.service.method(_interface)

2054

1896

def StopChecker(self):

2055

1897

self.stop_checker()

2056

2057

# Properties

2058

1898

1899

## Properties

1900

2059

1901

# ApprovalPending - property

2060

1902

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

2061

1903

def ApprovalPending_dbus_property(self):

2062

1904

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

2063

1905

2064

1906

# ApprovedByDefault - property

2065

1907

@dbus_service_property(_interface,

2066

1908

signature="b",

2069

1911

if value is None: # get

2070

1912

return dbus.Boolean(self.approved_by_default)

2071

1913

self.approved_by_default = bool(value)

2072

1914

2073

1915

# ApprovalDelay - property

2074

1916

@dbus_service_property(_interface,

2075

1917

signature="t",

2079

1921

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

2080

1922

* 1000)

2081

1923

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

2082

1924

2083

1925

# ApprovalDuration - property

2084

1926

@dbus_service_property(_interface,

2085

1927

signature="t",

2089

1931

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

2090

1932

* 1000)

2091

1933

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

2092

1934

2093

1935

# Name - property

2094

1936

@dbus_annotations(

2095

1937

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

2096

1938

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

2097

1939

def Name_dbus_property(self):

2098

1940

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

1941

2107

1942

# Fingerprint - property

2108

1943

@dbus_annotations(

2109

1944

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

2110

1945

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

2111

1946

def Fingerprint_dbus_property(self):

2112

1947

return dbus.String(self.fingerprint)

2113

1948

2114

1949

# Host - property

2115

1950

@dbus_service_property(_interface,

2116

1951

signature="s",

2119

1954

if value is None: # get

2120

1955

return dbus.String(self.host)

2121

1956

self.host = str(value)

2122

1957

2123

1958

# Created - property

2124

1959

@dbus_annotations(

2125

1960

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

2126

1961

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

2127

1962

def Created_dbus_property(self):

2128

1963

return datetime_to_dbus(self.created)

2129

1964

2130

1965

# LastEnabled - property

2131

1966

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

2132

1967

def LastEnabled_dbus_property(self):

2133

1968

return datetime_to_dbus(self.last_enabled)

2134

1969

2135

1970

# Enabled - property

2136

1971

@dbus_service_property(_interface,

2137

1972

signature="b",

2143

1978

self.enable()

2144

1979

else:

2145

1980

self.disable()

2146

1981

2147

1982

# LastCheckedOK - property

2148

1983

@dbus_service_property(_interface,

2149

1984

signature="s",

2153

1988

self.checked_ok()

2154

1989

return

2155

1990

return datetime_to_dbus(self.last_checked_ok)

2156

1991

2157

1992

# LastCheckerStatus - property

2158

1993

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

2159

1994

def LastCheckerStatus_dbus_property(self):

2160

1995

return dbus.Int16(self.last_checker_status)

2161

1996

2162

1997

# Expires - property

2163

1998

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

2164

1999

def Expires_dbus_property(self):

2165

2000

return datetime_to_dbus(self.expires)

2166

2001

2167

2002

# LastApprovalRequest - property

2168

2003

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

2169

2004

def LastApprovalRequest_dbus_property(self):

2170

2005

return datetime_to_dbus(self.last_approval_request)

2171

2006

2172

2007

# Timeout - property

2173

2008

@dbus_service_property(_interface,

2174

2009

signature="t",

2189

2024

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

2190

2025

is None):

2191

2026

return

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

2027

gobject.source_remove(self.disable_initiator_tag)

2028

self.disable_initiator_tag = gobject.timeout_add(

2194

2029

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

2195

2030

self.disable)

2196

2031

2197

2032

# ExtendedTimeout - property

2198

2033

@dbus_service_property(_interface,

2199

2034

signature="t",

2203

2038

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

2204

2039

* 1000)

2205

2040

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

2206

2041

2207

2042

# Interval - property

2208

2043

@dbus_service_property(_interface,

2209

2044

signature="t",

2216

2051

return

2217

2052

if self.enabled:

2218

2053

# Reschedule checker run

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

2054

gobject.source_remove(self.checker_initiator_tag)

2055

self.checker_initiator_tag = gobject.timeout_add(

2221

2056

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

2057

self.start_checker() # Start one now, too

2058

2224

2059

# Checker - property

2225

2060

@dbus_service_property(_interface,

2226

2061

signature="s",

2229

2064

if value is None: # get

2230

2065

return dbus.String(self.checker_command)

2231

2066

self.checker_command = str(value)

2232

2067

2233

2068

# CheckerRunning - property

2234

2069

@dbus_service_property(_interface,

2235

2070

signature="b",

2241

2076

self.start_checker()

2242

2077

else:

2243

2078

self.stop_checker()

2244

2079

2245

2080

# ObjectPath - property

2246

2081

@dbus_annotations(

2247

2082

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

2248

2083

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

2249

2084

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

2250

2085

def ObjectPath_dbus_property(self):

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

2086

return self.dbus_object_path # is already a dbus.ObjectPath

2087

2253

2088

# Secret = property

2254

2089

@dbus_annotations(

2255

2090

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

2260

2095

byte_arrays=True)

2261

2096

def Secret_dbus_property(self, value):

2262

2097

self.secret = bytes(value)

2263

2098

2264

2099

del _interface

2265

2100

2266

2101

2267

class ProxyClient:

2268

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

2102

class ProxyClient(object):

2103

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

2269

2104

self._pipe = child_pipe

2270

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

2105

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

2271

2106

if not self._pipe.recv():

2272

raise KeyError(key_id or fpr)

2273

2107

raise KeyError(fpr)

2108

2274

2109

def __getattribute__(self, name):

2275

if name == "_pipe":

2110

if name == '_pipe':

2276

2111

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

2277

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

2112

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

2278

2113

data = self._pipe.recv()

2279

if data[0] == "data":

2114

if data[0] == 'data':

2280

2115

return data[1]

2281

if data[0] == "function":

2282

2116

if data[0] == 'function':

2117

2283

2118

def func(*args, **kwargs):

2284

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

2119

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

2285

2120

return self._pipe.recv()[1]

2286

2121

2287

2122

return func

2288

2123

2289

2124

def __setattr__(self, name, value):

2290

if name == "_pipe":

2125

if name == '_pipe':

2291

2126

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

2292

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

2127

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

2293

2128

2294

2129

2295

2130

class ClientHandler(socketserver.BaseRequestHandler, object):

2296

2131

"""A class to handle client connections.

2297

2132

2298

2133

Instantiated once for each connection to handle it.

2299

2134

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

2300

2135

2301

2136

def handle(self):

2302

2137

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

2138

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

2139

str(self.client_address))

2140

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

2141

self.server.child_pipe.fileno())

2142

2307

2143

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

2144

2145

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

2146

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

2147

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

2148

# "+DHE-DSS"))

2313

2149

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

2314

2150

priority = self.server.gnutls_priority

2315

2151

if priority is None:

2316

2152

priority = "NORMAL"

2317

gnutls.priority_set_direct(session,

2318

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

2319

2153

gnutls.priority_set_direct(session._c_object, priority,

2154

None)

2155

2320

2156

# Start communication using the Mandos protocol

2321

2157

# Get protocol number

2322

2158

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

2323

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

2159

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

2324

2160

try:

2325

2161

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

2326

2162

raise RuntimeError(line)

2327

2163

except (ValueError, IndexError, RuntimeError) as error:

2328

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

2164

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

2329

2165

return

2330

2166

2331

2167

# Start GnuTLS connection

2332

2168

try:

2333

2169

session.handshake()

2334

2170

except gnutls.Error as error:

2335

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

2171

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

2336

2172

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

2337

2173

# established. Just abandon the request.

2338

2174

return

2339

log.debug("Handshake succeeded")

2340

2175

logger.debug("Handshake succeeded")

2176

2341

2177

approval_required = False

2342

2178

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,

2179

try:

2180

fpr = self.fingerprint(

2181

self.peer_certificate(session))

2182

except (TypeError, gnutls.Error) as error:

2183

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

2184

return

2185

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

2186

2187

try:

2188

client = ProxyClient(child_pipe, fpr,

2367

2189

self.client_address)

2368

2190

except KeyError:

2369

2191

return

2370

2192

2371

2193

if client.approval_delay:

2372

2194

delay = client.approval_delay

2373

2195

client.approvals_pending += 1

2374

2196

approval_required = True

2375

2197

2376

2198

while True:

2377

2199

if not client.enabled:

2378

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

2200

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

2201

client.name)

2379

2202

if self.server.use_dbus:

2380

2203

# Emit D-Bus signal

2381

2204

client.Rejected("Disabled")

2382

2205

return

2383

2206

2384

2207

if client.approved or not client.approval_delay:

2385

# We are approved or approval is disabled

2208

#We are approved or approval is disabled

2386

2209

break

2387

2210

elif client.approved is None:

2388

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

2389

client.name)

2211

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

2212

client.name)

2390

2213

if self.server.use_dbus:

2391

2214

# Emit D-Bus signal

2392

2215

client.NeedApproval(

2393

2216

client.approval_delay.total_seconds()

2394

2217

* 1000, client.approved_by_default)

2395

2218

else:

2396

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

2397

client.name)

2219

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

2220

client.name)

2398

2221

if self.server.use_dbus:

2399

2222

# Emit D-Bus signal

2400

2223

client.Rejected("Denied")

2401

2224

return

2402

2403

# wait until timeout or approved

2225

2226

#wait until timeout or approved

2404

2227

time = datetime.datetime.now()

2405

2228

client.changedstate.acquire()

2406

2229

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

2408

2231

time2 = datetime.datetime.now()

2409

2232

if (time2 - time) >= delay:

2410

2233

if not client.approved_by_default:

2411

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

2412

" waiting for approval",

2413

client.name)

2234

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

2235

" waiting for approval",

2236

client.name)

2414

2237

if self.server.use_dbus:

2415

2238

# Emit D-Bus signal

2416

2239

client.Rejected("Approval timed out")

2419

2242

break

2420

2243

else:

2421

2244

delay -= time2 - time

2422

2245

2423

2246

try:

2424

2247

session.send(client.secret)

2425

2248

except gnutls.Error as error:

2426

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

2249

logger.warning("gnutls send failed",

2250

exc_info = error)

2427

2251

return

2428

2429

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

2252

2253

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

2430

2254

# bump the timeout using extended_timeout

2431

2255

client.bump_timeout(client.extended_timeout)

2432

2256

if self.server.use_dbus:

2433

2257

# Emit D-Bus signal

2434

2258

client.GotSecret()

2435

2259

2436

2260

finally:

2437

2261

if approval_required:

2438

2262

client.approvals_pending -= 1

2439

2263

try:

2440

2264

session.bye()

2441

2265

except gnutls.Error as error:

2442

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

2443

2266

logger.warning("GnuTLS bye failed",

2267

exc_info=error)

2268

2444

2269

@staticmethod

2445

2270

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)

2271

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

2272

# If not an OpenPGP certificate...

2273

if (gnutls.certificate_type_get(session._c_object)

2274

!= gnutls.CRT_OPENPGP):

2460

2275

# ...return invalid data

2461

2276

return b""

2462

2277

list_size = ctypes.c_uint(1)

2463

2278

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

2279

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

2465

2280

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

2466

2281

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

2467

2282

if list_size.value == 0:

2468

2283

return None

2469

2284

cert = cert_list[0]

2470

2285

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

2286

2507

2287

@staticmethod

2508

2288

def fingerprint(openpgp):

2509

2289

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2524

2304

ctypes.byref(crtverify))

2525

2305

if crtverify.value != 0:

2526

2306

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

2307

raise gnutls.CertificateSecurityError("Verify failed")

2529

2308

# New buffer for the fingerprint

2530

2309

buf = ctypes.create_string_buffer(20)

2531

2310

buf_len = ctypes.c_size_t()

2541

2320

return hex_fpr

2542

2321

2543

2322

2544

class MultiprocessingMixIn:

2323

class MultiprocessingMixIn(object):

2545

2324

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

2546

2325

2547

2326

def sub_process_main(self, request, address):

2548

2327

try:

2549

2328

self.finish_request(request, address)

2550

2329

except Exception:

2551

2330

self.handle_error(request, address)

2552

2331

self.close_request(request)

2553

2332

2554

2333

def process_request(self, request, address):

2555

2334

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

2556

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

2557

args=(request, address))

2335

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

2336

args = (request, address))

2558

2337

proc.start()

2559

2338

return proc

2560

2339

2561

2340

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

2341

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2563

2342

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

2564

2343

2565

2344

def process_request(self, request, client_address):

2566

2345

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

2567

2346

2568

2347

This function creates a new pipe in self.pipe

2569

2348

"""

2570

2349

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2571

2350

2572

2351

proc = MultiprocessingMixIn.process_request(self, request,

2573

2352

client_address)

2574

2353

self.child_pipe.close()

2575

2354

self.add_pipe(parent_pipe, proc)

2576

2355

2577

2356

def add_pipe(self, parent_pipe, proc):

2578

2357

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

2579

2358

raise NotImplementedError()

2580

2359

2581

2360

2582

2361

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2583

socketserver.TCPServer):

2584

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

2585

2362

socketserver.TCPServer, object):

2363

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

2364

2586

2365

Attributes:

2587

2366

enabled: Boolean; whether this server is activated yet

2588

2367

interface: None or a network interface name (string)

2589

2368

use_ipv6: Boolean; to use IPv6 or not

2590

2369

"""

2591

2370

2592

2371

def __init__(self, server_address, RequestHandlerClass,

2593

2372

interface=None,

2594

2373

use_ipv6=True,

2604

2383

self.socketfd = socketfd

2605

2384

# Save the original socket.socket() function

2606

2385

self.socket_socket = socket.socket

2607

2608

2386

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

2609

#

2387

#

2610

2388

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

2611

2389

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

2612

2390

# patching socket.socket.)

2613

#

2391

#

2614

2392

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

2615

2393

@functools.wraps(socket.socket)

2616

2394

def socket_wrapper(*args, **kwargs):

2628

2406

# socket_wrapper(), if socketfd was set.

2629

2407

socketserver.TCPServer.__init__(self, server_address,

2630

2408

RequestHandlerClass)

2631

2409

2632

2410

def server_bind(self):

2633

2411

"""This overrides the normal server_bind() function

2634

2412

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

2635

2413

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

2636

global SO_BINDTODEVICE

2637

2414

if self.interface is not None:

2638

2415

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

2416

logger.error("SO_BINDTODEVICE does not exist;"

2417

" cannot bind to interface %s",

2418

self.interface)

2419

else:

2420

try:

2421

self.socket.setsockopt(

2422

socket.SOL_SOCKET, SO_BINDTODEVICE,

2423

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

2424

except socket.error as error:

2425

if error.errno == errno.EPERM:

2426

logger.error("No permission to bind to"

2427

" interface %s", self.interface)

2428

elif error.errno == errno.ENOPROTOOPT:

2429

logger.error("SO_BINDTODEVICE not available;"

2430

" cannot bind to interface %s",

2431

self.interface)

2432

elif error.errno == errno.ENODEV:

2433

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

2434

" cannot bind", self.interface)

2435

else:

2436

raise

2659

2437

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

2660

2438

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2663

2439

if not self.server_address[0]:

2664

2440

if self.address_family == socket.AF_INET6:

2665

any_address = "::" # in6addr_any

2441

any_address = "::" # in6addr_any

2666

2442

else:

2667

any_address = "0.0.0.0" # INADDR_ANY

2443

any_address = "0.0.0.0" # INADDR_ANY

2668

2444

self.server_address = (any_address,

2669

2445

self.server_address[1])

2670

2446

elif not self.server_address[1]:

2680

2456

2681

2457

class MandosServer(IPv6_TCPServer):

2682

2458

"""Mandos server.

2683

2459

2684

2460

Attributes:

2685

2461

clients: set of Client objects

2686

2462

gnutls_priority GnuTLS priority string

2687

2463

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

2688

2689

Assumes a GLib.MainLoop event loop.

2464

2465

Assumes a gobject.MainLoop event loop.

2690

2466

"""

2691

2467

2692

2468

def __init__(self, server_address, RequestHandlerClass,

2693

2469

interface=None,

2694

2470

use_ipv6=True,

2704

2480

self.gnutls_priority = gnutls_priority

2705

2481

IPv6_TCPServer.__init__(self, server_address,

2706

2482

RequestHandlerClass,

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2483

interface = interface,

2484

use_ipv6 = use_ipv6,

2485

socketfd = socketfd)

2486

2711

2487

def server_activate(self):

2712

2488

if self.enabled:

2713

2489

return socketserver.TCPServer.server_activate(self)

2714

2490

2715

2491

def enable(self):

2716

2492

self.enabled = True

2717

2493

2718

2494

def add_pipe(self, parent_pipe, proc):

2719

2495

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

2496

gobject.io_add_watch(

2497

parent_pipe.fileno(),

2498

gobject.IO_IN | gobject.IO_HUP,

2723

2499

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2500

parent_pipe = parent_pipe,

2501

proc = proc))

2502

2727

2503

def handle_ipc(self, source, condition,

2728

2504

parent_pipe=None,

2729

proc=None,

2505

proc = None,

2730

2506

client_object=None):

2731

2507

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

2732

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

2508

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

2733

2509

# Wait for other process to exit

2734

2510

proc.join()

2735

2511

return False

2736

2512

2737

2513

# Read a request from the child

2738

2514

request = parent_pipe.recv()

2739

2515

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:

2516

2517

if command == 'init':

2518

fpr = request[1]

2519

address = request[2]

2520

2521

for c in self.clients.itervalues():

2522

if c.fingerprint == fpr:

2754

2523

client = c

2755

2524

break

2756

2525

else:

2757

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

2758

" %s", key_id or fpr, address)

2526

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

2527

"dress: %s", fpr, address)

2759

2528

if self.use_dbus:

2760

2529

# Emit D-Bus signal

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2530

mandos_dbus_service.ClientNotFound(fpr,

2762

2531

address[0])

2763

2532

parent_pipe.send(False)

2764

2533

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,

2534

2535

gobject.io_add_watch(

2536

parent_pipe.fileno(),

2537

gobject.IO_IN | gobject.IO_HUP,

2769

2538

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2539

parent_pipe = parent_pipe,

2540

proc = proc,

2541

client_object = client))

2773

2542

parent_pipe.send(True)

2774

2543

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

2775

2544

# same fileno

2776

2545

return False

2777

if command == "funcall":

2546

if command == 'funcall':

2778

2547

funcname = request[1]

2779

2548

args = request[2]

2780

2549

kwargs = request[3]

2781

2782

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

2550

2551

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

2783

2552

funcname)(*args,

2784

2553

**kwargs)))

2785

2786

if command == "getattr":

2554

2555

if command == 'getattr':

2787

2556

attrname = request[1]

2788

2557

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2558

collections.Callable):

2559

parent_pipe.send(('function', ))

2791

2560

else:

2792

2561

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2562

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

2563

2564

if command == 'setattr':

2796

2565

attrname = request[1]

2797

2566

value = request[2]

2798

2567

setattr(client_object, attrname, value)

2799

2568

2800

2569

return True

2801

2570

2802

2571

2803

2572

def rfc3339_duration_to_delta(duration):

2804

2573

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

2574

2575

>>> rfc3339_duration_to_delta("P7D")

2576

datetime.timedelta(7)

2577

>>> rfc3339_duration_to_delta("PT60S")

2578

datetime.timedelta(0, 60)

2579

>>> rfc3339_duration_to_delta("PT60M")

2580

datetime.timedelta(0, 3600)

2581

>>> rfc3339_duration_to_delta("PT24H")

2582

datetime.timedelta(1)

2583

>>> rfc3339_duration_to_delta("P1W")

2584

datetime.timedelta(7)

2585

>>> rfc3339_duration_to_delta("PT5M30S")

2586

datetime.timedelta(0, 330)

2587

>>> rfc3339_duration_to_delta("P1DT3M20S")

2588

datetime.timedelta(1, 200)

2822

2589

"""

2823

2590

2824

2591

# Parsing an RFC 3339 duration with regular expressions is not

2825

2592

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

2826

2593

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

2827

2594

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

2828

2595

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

2829

2596

# avoid excessive use of external libraries.

2830

2597

2831

2598

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

2832

2599

Token = collections.namedtuple("Token", (

2833

2600

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

2866

2633

frozenset((token_year, token_month,

2867

2634

token_day, token_time,

2868

2635

token_week)))

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2636

# Define starting values

2637

value = datetime.timedelta() # Value so far

2872

2638

found_token = None

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2639

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

2640

s = duration # String left to parse

2877

2641

# Loop until end token is found

2878

2642

while found_token is not token_end:

2879

2643

# Search for any currently valid tokens

2903

2667

2904

2668

def string_to_delta(interval):

2905

2669

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

2670

2671

>>> string_to_delta('7d')

2672

datetime.timedelta(7)

2673

>>> string_to_delta('60s')

2674

datetime.timedelta(0, 60)

2675

>>> string_to_delta('60m')

2676

datetime.timedelta(0, 3600)

2677

>>> string_to_delta('24h')

2678

datetime.timedelta(1)

2679

>>> string_to_delta('1w')

2680

datetime.timedelta(7)

2681

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

2682

datetime.timedelta(0, 330)

2919

2683

"""

2920

2684

2921

2685

try:

2922

2686

return rfc3339_duration_to_delta(interval)

2923

2687

except ValueError:

2924

2688

pass

2925

2689

2926

2690

timevalue = datetime.timedelta(0)

2927

2691

for s in interval.split():

2928

2692

try:

2946

2710

return timevalue

2947

2711

2948

2712

2949

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

2713

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

2950

2714

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

2951

2715

2952

2716

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

2953

2717

if os.fork():

2954

2718

sys.exit()

2972

2736

2973

2737

2974

2738

def main():

2975

2739

2976

2740

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

2977

2741

# Parsing of options, both command line and config file

2978

2742

2979

2743

parser = argparse.ArgumentParser()

2980

2744

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

2981

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

2745

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

2982

2746

help="show version number and exit")

2983

2747

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

2984

2748

help="Bind to interface IF")

3020

2784

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

3021

2785

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

3022

2786

default=None)

3023

2787

3024

2788

options = parser.parse_args()

3025

2789

2790

if options.check:

2791

import doctest

2792

fail_count, test_count = doctest.testmod()

2793

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

2794

3026

2795

# 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

2796

server_defaults = { "interface": "",

2797

"address": "",

2798

"port": "",

2799

"debug": "False",

2800

"priority":

2801

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

2802

":+SIGN-DSA-SHA256",

2803

"servicename": "Mandos",

2804

"use_dbus": "True",

2805

"use_ipv6": "True",

2806

"debuglevel": "",

2807

"restore": "True",

2808

"socket": "",

2809

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

2810

"foreground": "False",

2811

"zeroconf": "True",

2812

}

2813

3050

2814

# Parse config file for server-global settings

3051

server_config = configparser.ConfigParser(server_defaults)

2815

server_config = configparser.SafeConfigParser(server_defaults)

3052

2816

del server_defaults

3053

2817

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

3054

# Convert the ConfigParser object to a dict

2818

# Convert the SafeConfigParser object to a dict

3055

2819

server_settings = server_config.defaults()

3056

2820

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

3057

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

3058

"foreground", "zeroconf"):

2821

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

3059

2822

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

3060

2823

option)

3061

2824

if server_settings["port"]:

3071

2834

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

3072

2835

["socket"])

3073

2836

del server_config

3074

2837

3075

2838

# Override the settings from the config file with command line

3076

2839

# options, if set.

3077

2840

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

3095

2858

if server_settings["debug"]:

3096

2859

server_settings["foreground"] = True

3097

2860

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

3098

2861

3099

2862

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

3100

2863

3101

2864

if (not server_settings["zeroconf"]

3102

2865

and not (server_settings["port"]

3103

2866

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

3104

2867

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

3105

2868

3106

2869

# For convenience

3107

2870

debug = server_settings["debug"]

3108

2871

debuglevel = server_settings["debuglevel"]

3112

2875

stored_state_file)

3113

2876

foreground = server_settings["foreground"]

3114

2877

zeroconf = server_settings["zeroconf"]

3115

2878

3116

2879

if debug:

3117

2880

initlogger(debug, logging.DEBUG)

3118

2881

else:

3121

2884

else:

3122

2885

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

3123

2886

initlogger(debug, level)

3124

2887

3125

2888

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

3126

2889

syslogger.setFormatter(

3127

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

3128

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

2890

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

2891

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

3129

2892

server_settings["servicename"])))

3130

2893

3131

2894

# Parse config file with clients

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2895

client_config = configparser.SafeConfigParser(Client

2896

.client_defaults)

3133

2897

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

3134

2898

"clients.conf"))

3135

2899

3136

2900

global mandos_dbus_service

3137

2901

mandos_dbus_service = None

3138

2902

3139

2903

socketfd = None

3140

2904

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

3141

2905

socketfd = server_settings["socket"]

3155

2919

try:

3156

2920

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

3157

2921

except IOError as e:

3158

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

3159

exc_info=e)

3160

2922

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

2923

exc_info=e)

2924

3161

2925

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

3162

2926

("mandos", "mandos"),

3163

2927

("nobody", "nogroup")):

3173

2937

try:

3174

2938

os.setgid(gid)

3175

2939

os.setuid(uid)

3176

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

3177

2940

except OSError as error:

3178

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

3179

os.strerror(error.errno))

3180

2941

if error.errno != errno.EPERM:

3181

2942

raise

3182

2943

3183

2944

if debug:

3184

2945

# Enable all possible GnuTLS debugging

3185

2946

3186

2947

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

3187

2948

# - GnuTLS manual

3188

2949

gnutls.global_set_log_level(11)

3189

2950

3190

2951

@gnutls.log_func

3191

2952

def debug_gnutls(level, string):

3192

log.debug("GnuTLS: %s",

3193

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

3194

2953

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

2954

3195

2955

gnutls.global_set_log_function(debug_gnutls)

3196

2956

3197

2957

# Redirect stdin so all checkers get /dev/null

3198

2958

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

3199

2959

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

3200

2960

if null > 2:

3201

2961

os.close(null)

3202

2962

3203

2963

# Need to fork before connecting to D-Bus

3204

2964

if not foreground:

3205

2965

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

3206

2966

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

2967

2968

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

2969

# need to inform gobject that threads will be used.

2970

gobject.threads_init()

2971

3213

2972

global main_loop

3214

2973

# From the Avahi example code

3215

2974

DBusGMainLoop(set_as_default=True)

3216

main_loop = GLib.MainLoop()

2975

main_loop = gobject.MainLoop()

3217

2976

bus = dbus.SystemBus()

3218

2977

# End of Avahi example code

3219

2978

if use_dbus:

3225

2984

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

3226

2985

do_not_queue=True)

3227

2986

except dbus.exceptions.DBusException as e:

3228

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

2987

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

3229

2988

use_dbus = False

3230

2989

server_settings["use_dbus"] = False

3231

2990

tcp_server.use_dbus = False

3232

2991

if zeroconf:

3233

2992

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3234

2993

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

2994

name = server_settings["servicename"],

2995

servicetype = "_mandos._tcp",

2996

protocol = protocol,

2997

bus = bus)

3239

2998

if server_settings["interface"]:

3240

2999

service.interface = if_nametoindex(

3241

3000

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

3242

3001

3243

3002

global multiprocessing_manager

3244

3003

multiprocessing_manager = multiprocessing.Manager()

3245

3004

3246

3005

client_class = Client

3247

3006

if use_dbus:

3248

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

3249

3007

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

3008

3250

3009

client_settings = Client.config_parser(client_config)

3251

3010

old_client_settings = {}

3252

3011

clients_data = {}

3253

3012

3254

3013

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

3255

3014

global wnull

3256

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

3015

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

3257

3016

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

3258

3017

# mode

3259

3018

if debug or not foreground:

3260

3019

wnull.close()

3261

3020

3262

3021

# Get client data and settings from last running state.

3263

3022

if server_settings["restore"]:

3264

3023

try:

3265

3024

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

3025

clients_data, old_client_settings = pickle.load(

3026

stored_state)

3316

3027

os.remove(stored_state_path)

3317

3028

except IOError as e:

3318

3029

if e.errno == errno.ENOENT:

3319

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

3320

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

3030

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

3031

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

3321

3032

else:

3322

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

3323

exc_info=e)

3033

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

3034

exc_info=e)

3324

3035

raise

3325

3036

except EOFError as e:

3326

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

3327

exc_info=e)

3328

3037

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

3038

"EOFError:",

3039

exc_info=e)

3040

3329

3041

with PGPEngine() as pgp:

3330

3042

for client_name, client in clients_data.items():

3331

3043

# Skip removed clients

3332

3044

if client_name not in client_settings:

3333

3045

continue

3334

3046

3335

3047

# Decide which value to use after restoring saved state.

3336

3048

# We have three different values: Old config file,

3337

3049

# new config file, and saved state.

3348

3060

client[name] = value

3349

3061

except KeyError:

3350

3062

pass

3351

3063

3352

3064

# Clients who has passed its expire date can still be

3353

3065

# enabled if its last checker was successful. A Client

3354

3066

# whose checker succeeded before we stored its state is

3357

3069

if client["enabled"]:

3358

3070

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

3359

3071

if not client["last_checked_ok"]:

3360

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

3361

" never performed a successful"

3362

" checker", client_name)

3072

logger.warning(

3073

"disabling client {} - Client never "

3074

"performed a successful checker".format(

3075

client_name))

3363

3076

client["enabled"] = False

3364

3077

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

3078

logger.warning(

3079

"disabling client {} - Client last"

3080

" checker failed with error code"

3081

" {}".format(

3082

client_name,

3083

client["last_checker_status"]))

3369

3084

client["enabled"] = False

3370

3085

else:

3371

3086

client["expires"] = (

3372

3087

datetime.datetime.utcnow()

3373

3088

+ client["timeout"])

3374

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

3375

" enabled", client_name)

3089

logger.debug("Last checker succeeded,"

3090

" keeping {} enabled".format(

3091

client_name))

3376

3092

try:

3377

3093

client["secret"] = pgp.decrypt(

3378

3094

client["encrypted_secret"],

3379

3095

client_settings[client_name]["secret"])

3380

3096

except PGPError:

3381

3097

# If decryption fails, we use secret from new settings

3382

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

3383

client_name)

3098

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

3099

client_name))

3384

3100

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

3385

3101

["secret"])

3386

3102

3387

3103

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

3388

3104

for client_name in (set(old_client_settings)

3389

3105

- set(client_settings)):

3391

3107

for client_name in (set(client_settings)

3392

3108

- set(old_client_settings)):

3393

3109

clients_data[client_name] = client_settings[client_name]

3394

3110

3395

3111

# Create all client objects

3396

3112

for client_name, client in clients_data.items():

3397

3113

tcp_server.clients[client_name] = client_class(

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

3114

name = client_name,

3115

settings = client,

3116

server_settings = server_settings)

3117

3402

3118

if not tcp_server.clients:

3403

log.warning("No clients defined")

3404

3119

logger.warning("No clients defined")

3120

3405

3121

if not foreground:

3406

3122

if pidfile is not None:

3407

3123

pid = os.getpid()

3409

3125

with pidfile:

3410

3126

print(pid, file=pidfile)

3411

3127

except IOError:

3412

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

3413

pidfilename, pid)

3128

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

3129

pidfilename, pid)

3414

3130

del pidfile

3415

3131

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

3132

3133

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

3134

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

3135

3421

3136

if use_dbus:

3422

3137

3423

3138

@alternate_dbus_interfaces(

3424

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

3139

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

3425

3140

class MandosDBusService(DBusObjectWithObjectManager):

3426

3141

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

3427

3142

3428

3143

def __init__(self):

3429

3144

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

3430

3145

3431

3146

_interface = "se.recompile.Mandos"

3432

3147

3433

3148

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

3434

3149

def ClientAdded(self, objpath):

3435

3150

"D-Bus signal"

3436

3151

pass

3437

3152

3438

3153

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

3439

def ClientNotFound(self, key_id, address):

3154

def ClientNotFound(self, fingerprint, address):

3440

3155

"D-Bus signal"

3441

3156

pass

3442

3157

3443

3158

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

3444

3159

"true"})

3445

3160

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

3446

3161

def ClientRemoved(self, objpath, name):

3447

3162

"D-Bus signal"

3448

3163

pass

3449

3164

3450

3165

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

3451

3166

"true"})

3452

3167

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

3453

3168

def GetAllClients(self):

3454

3169

"D-Bus method"

3455

3170

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3171

tcp_server.clients.itervalues())

3172

3458

3173

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

3459

3174

"true"})

3460

3175

@dbus.service.method(_interface,

3462

3177

def GetAllClientsWithProperties(self):

3463

3178

"D-Bus method"

3464

3179

return dbus.Dictionary(

3465

{c.dbus_object_path: c.GetAll(

3180

{ c.dbus_object_path: c.GetAll(

3466

3181

"se.recompile.Mandos.Client")

3467

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

3182

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

3468

3183

signature="oa{sv}")

3469

3184

3470

3185

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

3471

3186

def RemoveClient(self, object_path):

3472

3187

"D-Bus method"

3473

for c in tcp_server.clients.values():

3188

for c in tcp_server.clients.itervalues():

3474

3189

if c.dbus_object_path == object_path:

3475

3190

del tcp_server.clients[c.name]

3476

3191

c.remove_from_connection()

3480

3195

self.client_removed_signal(c)

3481

3196

return

3482

3197

raise KeyError(object_path)

3483

3198

3484

3199

del _interface

3485

3200

3486

3201

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3202

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

3488

3203

def GetManagedObjects(self):

3489

3204

"""D-Bus method"""

3490

3205

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

3206

{ client.dbus_object_path:

3207

dbus.Dictionary(

3208

{ interface: client.GetAll(interface)

3209

for interface in

3210

client._get_all_interface_names()})

3211

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

3212

3498

3213

def client_added_signal(self, client):

3499

3214

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

3500

3215

if use_dbus:

3502

3217

self.InterfacesAdded(

3503

3218

client.dbus_object_path,

3504

3219

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3220

{ interface: client.GetAll(interface)

3221

for interface in

3222

client._get_all_interface_names()}))

3508

3223

# Old signal

3509

3224

self.ClientAdded(client.dbus_object_path)

3510

3225

3511

3226

def client_removed_signal(self, client):

3512

3227

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

3513

3228

if use_dbus:

3518

3233

# Old signal

3519

3234

self.ClientRemoved(client.dbus_object_path,

3520

3235

client.name)

3521

3236

3522

3237

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

3238

3529

3239

def cleanup():

3530

3240

"Cleanup function; run on exit"

3531

3241

if zeroconf:

3532

3242

service.cleanup()

3533

3534

mp.active_children()

3535

wn.close()

3243

3244

multiprocessing.active_children()

3245

wnull.close()

3536

3246

if not (tcp_server.clients or client_settings):

3537

3247

return

3538

3248

3539

3249

# Store client before exiting. Secrets are encrypted with key

3540

3250

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

3541

3251

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

3542

3252

clients = {}

3543

3253

with PGPEngine() as pgp:

3544

for client in tcp_server.clients.values():

3254

for client in tcp_server.clients.itervalues():

3545

3255

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

3546

3256

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

3547

3257

key)

3548

3258

client_dict = {}

3549

3259

3550

3260

# A list of attributes that can not be pickled

3551

3261

# + secret.

3552

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

3553

"checker", "server_settings"}

3262

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

3263

"checker", "server_settings" }

3554

3264

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

3555

3265

.Object):

3556

3266

exclude.add(name)

3557

3267

3558

3268

client_dict["encrypted_secret"] = (client

3559

3269

.encrypted_secret)

3560

3270

for attr in client.client_structure:

3561

3271

if attr not in exclude:

3562

3272

client_dict[attr] = getattr(client, attr)

3563

3273

3564

3274

clients[client.name] = client_dict

3565

3275

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

3566

3276

3567

3277

try:

3568

3278

with tempfile.NamedTemporaryFile(

3569

mode="wb",

3279

mode='wb',

3570

3280

suffix=".pickle",

3571

prefix="clients-",

3281

prefix='clients-',

3572

3282

dir=os.path.dirname(stored_state_path),

3573

3283

delete=False) as stored_state:

3574

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

3575

protocol=2)

3284

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

3576

3285

tempname = stored_state.name

3577

3286

os.rename(tempname, stored_state_path)

3578

3287

except (IOError, OSError) as e:

3582

3291

except NameError:

3583

3292

pass

3584

3293

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

3585

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

3586

os.strerror(e.errno))

3294

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

3295

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

3587

3296

else:

3588

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

3589

exc_info=e)

3297

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

3298

exc_info=e)

3590

3299

raise

3591

3300

3592

3301

# Delete all clients, and settings from config

3593

3302

while tcp_server.clients:

3594

3303

name, client = tcp_server.clients.popitem()

3600

3309

if use_dbus:

3601

3310

mandos_dbus_service.client_removed_signal(client)

3602

3311

client_settings.clear()

3603

3312

3604

3313

atexit.register(cleanup)

3605

3606

for client in tcp_server.clients.values():

3314

3315

for client in tcp_server.clients.itervalues():

3607

3316

if use_dbus:

3608

3317

# Emit D-Bus signal for adding

3609

3318

mandos_dbus_service.client_added_signal(client)

3610

3319

# Need to initiate checking of clients

3611

3320

if client.enabled:

3612

3321

client.init_checker()

3613

3322

3614

3323

tcp_server.enable()

3615

3324

tcp_server.server_activate()

3616

3325

3617

3326

# Find out what port we got

3618

3327

if zeroconf:

3619

3328

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

3620

3329

if use_ipv6:

3621

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

3622

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

3330

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

3331

" flowinfo %d, scope_id %d",

3332

*tcp_server.socket.getsockname())

3623

3333

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

3334

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

3335

*tcp_server.socket.getsockname())

3336

3337

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

3338

3629

3339

try:

3630

3340

if zeroconf:

3631

3341

# From the Avahi example code

3632

3342

try:

3633

3343

service.activate()

3634

3344

except dbus.exceptions.DBusException as error:

3635

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

3345

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

3636

3346

cleanup()

3637

3347

sys.exit(1)

3638

3348

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

3349

3350

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

3351

lambda *args, **kwargs:

3352

(tcp_server.handle_request

3353

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

3354

3355

logger.debug("Starting main loop")

3647

3356

main_loop.run()

3648

3357

except AvahiError as error:

3649

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

3358

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

3650

3359

cleanup()

3651

3360

sys.exit(1)

3652

3361

except KeyboardInterrupt:

3653

3362

if debug:

3654

3363

print("", file=sys.stderr)

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

3364

logger.debug("Server received KeyboardInterrupt")

3365

logger.debug("Server exiting")

3657

3366

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

3658

3367

cleanup()

3659

3368

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

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

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

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

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

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

3690

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

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

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

3702

# extra))

3703

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

3704

# (funcall remove-test-window)

3705

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

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

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

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

# (let ((process-result

3714

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

3715

# (process-file-shell-command

3716

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

3717

# (and (numberp process-result)

3718

# (= process-result 0))))

3719

# get-command-line:

3720

# (lambda (&optional extra)

3721

# (let ((quoted-script

3722

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

3723

# (format

3724

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

3725

# quoted-script)))

3726

# get-script-name:

3727

# (lambda ()

3728

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

3729

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

3730

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

3731

# (buffer-file-name))))

3732

# remove-test-window:

3733

# (lambda ()

3734

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

3735

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

3736

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

3737

# (lambda ()

3738

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

3739

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

3740

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

3741

# (display-buffer-overriding-action

3742

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

3743

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

3744

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

3745

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

3746

# eval:

3747

# (progn

3748

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

3749

# (funcall run-tests t)))

3750

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

3751

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

3752

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

3753

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

3754

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

3755

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

3756

# End:

3369

3370

if __name__ == '__main__':

3371

main()