/mandos/release : revision 237.7.281

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python2.7

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Add os.set_inheritable if it does not exist

114

try:

115

os.set_inheritable

116

except AttributeError:

117

def set_inheritable(fd, inheritable):

118

flags = fcntl.fcntl(fd, fcntl.F_GETFD)

119

if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):

120

fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)

121

elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):

122

fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)

123

os.set_inheritable = set_inheritable

124

del set_inheritable

125

126

# Show warnings by default

127

if not sys.warnoptions:

128

import warnings

129

warnings.simplefilter("default")

130

131

# Try to find the value of SO_BINDTODEVICE:

132

try:

133

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

134

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

83

try:

135

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

136

85

except AttributeError:

137

86

try:

138

# This is where SO_BINDTODEVICE was up to and including Python

139

# 2.6, and also 3.2:

140

87

from IN import SO_BINDTODEVICE

141

88

except ImportError:

142

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

143

# Try running the C preprocessor:

144

try:

145

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

146

"/dev/stdin"],

147

stdin=subprocess.PIPE,

148

stdout=subprocess.PIPE)

149

stdout = cc.communicate(

150

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

151

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

152

except (OSError, ValueError, IndexError):

153

# No value found

154

SO_BINDTODEVICE = None

155

156

if sys.version_info < (3, 2):

157

configparser.Configparser = configparser.SafeConfigParser

158

159

version = "1.8.17"

89

SO_BINDTODEVICE = None

90

91

if sys.version_info.major == 2:

92

str = unicode

93

94

version = "1.6.8"

160

95

stored_state_file = "clients.pickle"

161

96

162

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

163

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

97

logger = logging.getLogger()

164

98

syslogger = None

165

99

166

100

try:

167

if_nametoindex = ctypes.cdll.LoadLibrary(

168

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

169

104

except (OSError, AttributeError):

170

171

105

def if_nametoindex(interface):

172

106

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

173

107

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

178

112

return interface_index

179

113

180

114

181

def copy_function(func):

182

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

183

if sys.version_info.major == 2:

184

return types.FunctionType(func.func_code,

185

func.func_globals,

186

func.func_name,

187

func.func_defaults,

188

func.func_closure)

189

else:

190

return types.FunctionType(func.__code__,

191

func.__globals__,

192

func.__name__,

193

func.__defaults__,

194

func.__closure__)

195

196

197

115

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

198

116

"""init logger and add loglevel"""

199

117

200

118

global syslogger

201

syslogger = (logging.handlers.SysLogHandler(

202

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

203

address="/dev/log"))

119

syslogger = (logging.handlers.SysLogHandler

120

(facility =

121

logging.handlers.SysLogHandler.LOG_DAEMON,

122

address = "/dev/log"))

204

123

syslogger.setFormatter(logging.Formatter

205

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

206

" %(message)s"))

207

log.addHandler(syslogger)

208

124

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

125

' %(message)s'))

126

logger.addHandler(syslogger)

127

209

128

if debug:

210

129

console = logging.StreamHandler()

211

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

212

" [%(process)d]:"

213

" %(levelname)s:"

214

" %(message)s"))

215

log.addHandler(console)

216

log.setLevel(level)

130

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

131

' [%(process)d]:'

132

' %(levelname)s:'

133

' %(message)s'))

134

logger.addHandler(console)

135

logger.setLevel(level)

217

136

218

137

219

138

class PGPError(Exception):

221

140

pass

222

141

223

142

224

class PGPEngine:

143

class PGPEngine(object):

225

144

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

226

227

145

def __init__(self):

228

146

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

229

self.gpg = "gpg"

230

try:

231

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

232

for line in output.splitlines():

233

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

234

if name == b"gpg":

235

self.gpg = path

236

break

237

except OSError as e:

238

if e.errno != errno.ENOENT:

239

raise

240

self.gnupgargs = ["--batch",

241

"--homedir", self.tempdir,

242

"--force-mdc",

243

"--quiet"]

244

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

245

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

246

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

247

147

self.gnupgargs = ['--batch',

148

'--home', self.tempdir,

149

'--force-mdc',

150

'--quiet',

151

'--no-use-agent']

152

248

153

def __enter__(self):

249

154

return self

250

155

251

156

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

252

157

self._cleanup()

253

158

return False

254

159

255

160

def __del__(self):

256

161

self._cleanup()

257

162

258

163

def _cleanup(self):

259

164

if self.tempdir is not None:

260

165

# Delete contents of tempdir

261

166

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

262

topdown=False):

167

topdown = False):

263

168

for filename in files:

264

169

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

265

170

for dirname in dirs:

267

172

# Remove tempdir

268

173

os.rmdir(self.tempdir)

269

174

self.tempdir = None

270

175

271

176

def password_encode(self, password):

272

177

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

273

178

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

278

183

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

279

184

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

280

185

return encoded

281

186

282

187

def encrypt(self, data, password):

283

188

passphrase = self.password_encode(password)

284

with tempfile.NamedTemporaryFile(

285

dir=self.tempdir) as passfile:

189

with tempfile.NamedTemporaryFile(dir=self.tempdir

190

) as passfile:

286

191

passfile.write(passphrase)

287

192

passfile.flush()

288

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

289

"--passphrase-file",

193

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

194

'--passphrase-file',

290

195

passfile.name]

291

196

+ self.gnupgargs,

292

stdin=subprocess.PIPE,

293

stdout=subprocess.PIPE,

294

stderr=subprocess.PIPE)

295

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

197

stdin = subprocess.PIPE,

198

stdout = subprocess.PIPE,

199

stderr = subprocess.PIPE)

200

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

296

201

if proc.returncode != 0:

297

202

raise PGPError(err)

298

203

return ciphertext

299

204

300

205

def decrypt(self, data, password):

301

206

passphrase = self.password_encode(password)

302

with tempfile.NamedTemporaryFile(

303

dir=self.tempdir) as passfile:

207

with tempfile.NamedTemporaryFile(dir = self.tempdir

208

) as passfile:

304

209

passfile.write(passphrase)

305

210

passfile.flush()

306

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

307

"--passphrase-file",

211

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

212

'--passphrase-file',

308

213

passfile.name]

309

214

+ self.gnupgargs,

310

stdin=subprocess.PIPE,

311

stdout=subprocess.PIPE,

312

stderr=subprocess.PIPE)

313

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

215

stdin = subprocess.PIPE,

216

stdout = subprocess.PIPE,

217

stderr = subprocess.PIPE)

218

decrypted_plaintext, err = proc.communicate(input

219

= data)

314

220

if proc.returncode != 0:

315

221

raise PGPError(err)

316

222

return decrypted_plaintext

317

223

318

224

319

# Pretend that we have an Avahi module

320

class avahi:

321

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

322

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

323

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

324

PROTO_INET = 0 # avahi-common/address.h

325

PROTO_INET6 = 1 # avahi-common/address.h

326

DBUS_NAME = "org.freedesktop.Avahi"

327

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

328

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

329

DBUS_PATH_SERVER = "/"

330

331

@staticmethod

332

def string_array_to_txt_array(t):

333

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

334

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

335

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

336

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

337

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

338

SERVER_INVALID = 0 # avahi-common/defs.h

339

SERVER_REGISTERING = 1 # avahi-common/defs.h

340

SERVER_RUNNING = 2 # avahi-common/defs.h

341

SERVER_COLLISION = 3 # avahi-common/defs.h

342

SERVER_FAILURE = 4 # avahi-common/defs.h

343

344

345

225

class AvahiError(Exception):

346

226

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

347

227

self.value = value

348

228

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

349

229

**kwargs)

350

230

351

352

231

class AvahiServiceError(AvahiError):

353

232

pass

354

233

355

356

234

class AvahiGroupError(AvahiError):

357

235

pass

358

236

359

237

360

class AvahiService:

238

class AvahiService(object):

361

239

"""An Avahi (Zeroconf) service.

362

240

363

241

Attributes:

364

242

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

365

243

Used to optionally bind to the specified interface.

366

367

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

244

245

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

368

246

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

369

247

port: integer; what port to announce

370

248

TXT: list of strings; TXT record for the service

377

255

server: D-Bus Server

378

256

bus: dbus.SystemBus()

379

257

"""

380

381

def __init__(self,

382

interface=avahi.IF_UNSPEC,

383

name=None,

384

servicetype=None,

385

port=None,

386

TXT=None,

387

domain="",

388

host="",

389

max_renames=32768,

390

protocol=avahi.PROTO_UNSPEC,

391

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

392

263

self.interface = interface

393

264

self.name = name

394

265

self.type = servicetype

403

274

self.server = None

404

275

self.bus = bus

405

276

self.entry_group_state_changed_match = None

406

407

def rename(self, remove=True):

277

278

def rename(self):

408

279

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

409

280

if self.rename_count >= self.max_renames:

410

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

411

" after %i retries, exiting.",

412

self.rename_count)

281

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

282

" after %i retries, exiting.",

283

self.rename_count)

413

284

raise AvahiServiceError("Too many renames")

414

self.name = str(

415

self.server.GetAlternativeServiceName(self.name))

285

self.name = str(self.server

286

.GetAlternativeServiceName(self.name))

287

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

288

self.name)

289

self.remove()

290

try:

291

self.add()

292

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

416

296

self.rename_count += 1

417

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

418

self.name)

419

if remove:

420

self.remove()

421

try:

422

self.add()

423

except dbus.exceptions.DBusException as error:

424

if (error.get_dbus_name()

425

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

426

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

427

return self.rename(remove=False)

428

else:

429

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

430

self.cleanup()

431

os._exit(1)

432

297

433

298

def remove(self):

434

299

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

435

300

if self.entry_group_state_changed_match is not None:

437

302

self.entry_group_state_changed_match = None

438

303

if self.group is not None:

439

304

self.group.Reset()

440

305

441

306

def add(self):

442

307

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

443

308

self.remove()

448

313

avahi.DBUS_INTERFACE_ENTRY_GROUP)

449

314

self.entry_group_state_changed_match = (

450

315

self.group.connect_to_signal(

451

"StateChanged", self.entry_group_state_changed))

452

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

453

self.name, self.type)

316

'StateChanged', self.entry_group_state_changed))

317

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

318

self.name, self.type)

454

319

self.group.AddService(

455

320

self.interface,

456

321

self.protocol,

460

325

dbus.UInt16(self.port),

461

326

avahi.string_array_to_txt_array(self.TXT))

462

327

self.group.Commit()

463

328

464

329

def entry_group_state_changed(self, state, error):

465

330

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

466

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

467

331

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

332

468

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

469

log.debug("Zeroconf service established.")

334

logger.debug("Zeroconf service established.")

470

335

elif state == avahi.ENTRY_GROUP_COLLISION:

471

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

336

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

472

337

self.rename()

473

338

elif state == avahi.ENTRY_GROUP_FAILURE:

474

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

475

str(error))

476

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

477

339

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

340

str(error))

341

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

342

.format(error))

343

478

344

def cleanup(self):

479

345

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

480

346

if self.group is not None:

485

351

pass

486

352

self.group = None

487

353

self.remove()

488

354

489

355

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

490

356

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

491

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

492

bad_states = {

493

avahi.SERVER_INVALID: "Zeroconf server invalid",

494

avahi.SERVER_REGISTERING: None,

495

avahi.SERVER_COLLISION: "Zeroconf server name collision",

496

avahi.SERVER_FAILURE: "Zeroconf server failure",

497

}

357

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

498

365

if state in bad_states:

499

366

if bad_states[state] is not None:

500

367

if error is None:

501

log.error(bad_states[state])

368

logger.error(bad_states[state])

502

369

else:

503

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

370

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

504

371

self.cleanup()

505

372

elif state == avahi.SERVER_RUNNING:

506

try:

507

self.add()

508

except dbus.exceptions.DBusException as error:

509

if (error.get_dbus_name()

510

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

511

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

512

return self.rename(remove=False)

513

else:

514

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

515

self.cleanup()

516

os._exit(1)

373

self.add()

517

374

else:

518

375

if error is None:

519

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

376

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

520

377

else:

521

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

522

378

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

379

523

380

def activate(self):

524

381

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

525

382

if self.server is None:

529

386

follow_name_owner_changes=True),

530

387

avahi.DBUS_INTERFACE_SERVER)

531

388

self.server.connect_to_signal("StateChanged",

532

self.server_state_changed)

389

self.server_state_changed)

533

390

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

534

391

535

392

536

393

class AvahiServiceToSyslog(AvahiService):

537

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

394

def rename(self):

538

395

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

539

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

540

**kwargs)

541

syslogger.setFormatter(logging.Formatter(

542

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

543

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

544

401

return ret

545

402

546

403

547

# Pretend that we have a GnuTLS module

548

class gnutls:

549

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

550

551

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

552

if library is None:

553

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

554

_library = ctypes.cdll.LoadLibrary(library)

555

del library

556

557

# Unless otherwise indicated, the constants and types below are

558

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

559

560

# Constants

561

E_SUCCESS = 0

562

E_INTERRUPTED = -52

563

E_AGAIN = -28

564

CRT_OPENPGP = 2

565

CRT_RAWPK = 3

566

CLIENT = 2

567

SHUT_RDWR = 0

568

CRD_CERTIFICATE = 1

569

E_NO_CERTIFICATE_FOUND = -49

570

X509_FMT_DER = 0

571

NO_TICKETS = 1<<10

572

ENABLE_RAWPK = 1<<18

573

CTYPE_PEERS = 3

574

KEYID_USE_SHA256 = 1 # gnutls/x509.h

575

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

576

577

# Types

578

class _session_int(ctypes.Structure):

579

_fields_ = []

580

session_t = ctypes.POINTER(_session_int)

581

582

class certificate_credentials_st(ctypes.Structure):

583

_fields_ = []

584

certificate_credentials_t = ctypes.POINTER(

585

certificate_credentials_st)

586

certificate_type_t = ctypes.c_int

587

588

class datum_t(ctypes.Structure):

589

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

590

("size", ctypes.c_uint)]

591

592

class _openpgp_crt_int(ctypes.Structure):

593

_fields_ = []

594

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

595

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

596

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

597

credentials_type_t = ctypes.c_int

598

transport_ptr_t = ctypes.c_void_p

599

close_request_t = ctypes.c_int

600

601

# Exceptions

602

class Error(Exception):

603

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

604

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

605

# code is passed, convert it to a string with

606

# gnutls.strerror()

607

self.code = code

608

if message is None and code is not None:

609

message = gnutls.strerror(code).decode(

610

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

611

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

612

message, *args)

613

614

class CertificateSecurityError(Error):

615

pass

616

617

class PointerTo:

618

def __init__(self, cls):

619

self.cls = cls

620

621

def from_param(self, obj):

622

if not isinstance(obj, self.cls):

623

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

624

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

625

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

626

627

class CastToVoidPointer:

628

def __init__(self, cls):

629

self.cls = cls

630

631

def from_param(self, obj):

632

if not isinstance(obj, self.cls):

633

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

634

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

635

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

636

637

class With_from_param:

638

@classmethod

639

def from_param(cls, obj):

640

return obj._as_parameter_

641

642

# Classes

643

class Credentials(With_from_param):

644

def __init__(self):

645

self._as_parameter_ = gnutls.certificate_credentials_t()

646

gnutls.certificate_allocate_credentials(self)

647

self.type = gnutls.CRD_CERTIFICATE

648

649

def __del__(self):

650

gnutls.certificate_free_credentials(self)

651

652

class ClientSession(With_from_param):

653

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

654

self._as_parameter_ = gnutls.session_t()

655

gnutls_flags = gnutls.CLIENT

656

if gnutls.check_version(b"3.5.6"):

657

gnutls_flags |= gnutls.NO_TICKETS

658

if gnutls.has_rawpk:

659

gnutls_flags |= gnutls.ENABLE_RAWPK

660

gnutls.init(self, gnutls_flags)

661

del gnutls_flags

662

gnutls.set_default_priority(self)

663

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

664

gnutls.handshake_set_private_extensions(self, True)

665

self.socket = socket

666

if credentials is None:

667

credentials = gnutls.Credentials()

668

gnutls.credentials_set(self, credentials.type,

669

credentials)

670

self.credentials = credentials

671

672

def __del__(self):

673

gnutls.deinit(self)

674

675

def handshake(self):

676

return gnutls.handshake(self)

677

678

def send(self, data):

679

data = bytes(data)

680

data_len = len(data)

681

while data_len > 0:

682

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

683

data_len)

684

685

def bye(self):

686

return gnutls.bye(self, gnutls.SHUT_RDWR)

687

688

# Error handling functions

689

def _error_code(result):

690

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

691

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

692

if result >= gnutls.E_SUCCESS:

693

return result

694

if result == gnutls.E_NO_CERTIFICATE_FOUND:

695

raise gnutls.CertificateSecurityError(code=result)

696

raise gnutls.Error(code=result)

697

698

def _retry_on_error(result, func, arguments,

699

_error_code=_error_code):

700

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

701

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

702

while result < gnutls.E_SUCCESS:

703

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

704

return _error_code(result)

705

result = func(*arguments)

706

return result

707

708

# Unless otherwise indicated, the function declarations below are

709

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

710

711

# Functions

712

priority_set_direct = _library.gnutls_priority_set_direct

713

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

714

ctypes.POINTER(ctypes.c_char_p)]

715

priority_set_direct.restype = _error_code

716

717

init = _library.gnutls_init

718

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

719

init.restype = _error_code

720

721

set_default_priority = _library.gnutls_set_default_priority

722

set_default_priority.argtypes = [ClientSession]

723

set_default_priority.restype = _error_code

724

725

record_send = _library.gnutls_record_send

726

record_send.argtypes = [ClientSession, ctypes.c_void_p,

727

ctypes.c_size_t]

728

record_send.restype = ctypes.c_ssize_t

729

record_send.errcheck = _retry_on_error

730

731

certificate_allocate_credentials = (

732

_library.gnutls_certificate_allocate_credentials)

733

certificate_allocate_credentials.argtypes = [

734

PointerTo(Credentials)]

735

certificate_allocate_credentials.restype = _error_code

736

737

certificate_free_credentials = (

738

_library.gnutls_certificate_free_credentials)

739

certificate_free_credentials.argtypes = [Credentials]

740

certificate_free_credentials.restype = None

741

742

handshake_set_private_extensions = (

743

_library.gnutls_handshake_set_private_extensions)

744

handshake_set_private_extensions.argtypes = [ClientSession,

745

ctypes.c_int]

746

handshake_set_private_extensions.restype = None

747

748

credentials_set = _library.gnutls_credentials_set

749

credentials_set.argtypes = [ClientSession, credentials_type_t,

750

CastToVoidPointer(Credentials)]

751

credentials_set.restype = _error_code

752

753

strerror = _library.gnutls_strerror

754

strerror.argtypes = [ctypes.c_int]

755

strerror.restype = ctypes.c_char_p

756

757

certificate_type_get = _library.gnutls_certificate_type_get

758

certificate_type_get.argtypes = [ClientSession]

759

certificate_type_get.restype = _error_code

760

761

certificate_get_peers = _library.gnutls_certificate_get_peers

762

certificate_get_peers.argtypes = [ClientSession,

763

ctypes.POINTER(ctypes.c_uint)]

764

certificate_get_peers.restype = ctypes.POINTER(datum_t)

765

766

global_set_log_level = _library.gnutls_global_set_log_level

767

global_set_log_level.argtypes = [ctypes.c_int]

768

global_set_log_level.restype = None

769

770

global_set_log_function = _library.gnutls_global_set_log_function

771

global_set_log_function.argtypes = [log_func]

772

global_set_log_function.restype = None

773

774

deinit = _library.gnutls_deinit

775

deinit.argtypes = [ClientSession]

776

deinit.restype = None

777

778

handshake = _library.gnutls_handshake

779

handshake.argtypes = [ClientSession]

780

handshake.restype = ctypes.c_int

781

handshake.errcheck = _retry_on_error

782

783

transport_set_ptr = _library.gnutls_transport_set_ptr

784

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

785

transport_set_ptr.restype = None

786

787

bye = _library.gnutls_bye

788

bye.argtypes = [ClientSession, close_request_t]

789

bye.restype = ctypes.c_int

790

bye.errcheck = _retry_on_error

791

792

check_version = _library.gnutls_check_version

793

check_version.argtypes = [ctypes.c_char_p]

794

check_version.restype = ctypes.c_char_p

795

796

_need_version = b"3.3.0"

797

if check_version(_need_version) is None:

798

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

799

.format(_need_version))

800

801

_tls_rawpk_version = b"3.6.6"

802

has_rawpk = bool(check_version(_tls_rawpk_version))

803

804

if has_rawpk:

805

# Types

806

class pubkey_st(ctypes.Structure):

807

_fields = []

808

pubkey_t = ctypes.POINTER(pubkey_st)

809

810

x509_crt_fmt_t = ctypes.c_int

811

812

# All the function declarations below are from

813

# gnutls/abstract.h

814

pubkey_init = _library.gnutls_pubkey_init

815

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

816

pubkey_init.restype = _error_code

817

818

pubkey_import = _library.gnutls_pubkey_import

819

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

820

x509_crt_fmt_t]

821

pubkey_import.restype = _error_code

822

823

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

824

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

825

ctypes.POINTER(ctypes.c_ubyte),

826

ctypes.POINTER(ctypes.c_size_t)]

827

pubkey_get_key_id.restype = _error_code

828

829

pubkey_deinit = _library.gnutls_pubkey_deinit

830

pubkey_deinit.argtypes = [pubkey_t]

831

pubkey_deinit.restype = None

832

else:

833

# All the function declarations below are from

834

# gnutls/openpgp.h

835

836

openpgp_crt_init = _library.gnutls_openpgp_crt_init

837

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

838

openpgp_crt_init.restype = _error_code

839

840

openpgp_crt_import = _library.gnutls_openpgp_crt_import

841

openpgp_crt_import.argtypes = [openpgp_crt_t,

842

ctypes.POINTER(datum_t),

843

openpgp_crt_fmt_t]

844

openpgp_crt_import.restype = _error_code

845

846

openpgp_crt_verify_self = \

847

_library.gnutls_openpgp_crt_verify_self

848

openpgp_crt_verify_self.argtypes = [

849

openpgp_crt_t,

850

ctypes.c_uint,

851

ctypes.POINTER(ctypes.c_uint),

852

]

853

openpgp_crt_verify_self.restype = _error_code

854

855

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

856

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

857

openpgp_crt_deinit.restype = None

858

859

openpgp_crt_get_fingerprint = (

860

_library.gnutls_openpgp_crt_get_fingerprint)

861

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

862

ctypes.c_void_p,

863

ctypes.POINTER(

864

ctypes.c_size_t)]

865

openpgp_crt_get_fingerprint.restype = _error_code

866

867

if check_version(b"3.6.4"):

868

certificate_type_get2 = _library.gnutls_certificate_type_get2

869

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

870

certificate_type_get2.restype = _error_code

871

872

# Remove non-public functions

873

del _error_code, _retry_on_error

874

875

876

def call_pipe(connection, # : multiprocessing.Connection

877

func, *args, **kwargs):

878

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

879

880

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

881

return value on the provided multiprocessing.Connection.

882

"""

883

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

884

connection.close()

885

886

887

class Client:

404

class Client(object):

888

405

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

889

406

890

407

Attributes:

891

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

408

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

892

409

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

893

410

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

894

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

895

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

896

running.

897

checker_callback_tag: a GLib event source tag, or None

411

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

412

to see if the client lives.

413

'None' if no process is running.

414

checker_callback_tag: a gobject event source tag, or None

898

415

checker_command: string; External command which is run to check

899

416

if client lives. %() expansions are done at

900

417

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

901

418

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

902

checker_initiator_tag: a GLib event source tag, or None

419

checker_initiator_tag: a gobject event source tag, or None

903

420

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

904

421

client_structure: Object describing what attributes a client has

905

422

and is used for storing the client at exit

906

423

current_checker_command: string; current running checker_command

907

disable_initiator_tag: a GLib event source tag, or None

424

disable_initiator_tag: a gobject event source tag, or None

908

425

enabled: bool()

909

426

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

910

uniquely identify an OpenPGP client

911

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

912

a client using raw public keys

427

uniquely identify the client

913

428

host: string; available for use by the checker command

914

429

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

915

430

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

917

432

last_checker_status: integer between 0 and 255 reflecting exit

918

433

status of last checker. -1 reflects crashed

919

434

checker, -2 means no checker completed yet.

920

last_checker_signal: The signal which killed the last checker, if

921

last_checker_status is -1

922

435

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

923

436

924

437

D-Bus identifiers

931

444

disabled, or None

932

445

server_settings: The server_settings dict from main()

933

446

"""

934

447

935

448

runtime_expansions = ("approval_delay", "approval_duration",

936

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

449

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

937

450

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

938

451

"last_approval_request", "last_checked_ok",

939

452

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

940

client_defaults = {

941

"timeout": "PT5M",

942

"extended_timeout": "PT15M",

943

"interval": "PT2M",

944

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

945

"host": "",

946

"approval_delay": "PT0S",

947

"approval_duration": "PT1S",

948

"approved_by_default": "True",

949

"enabled": "True",

950

}

951

453

client_defaults = { "timeout": "PT5M",

454

"extended_timeout": "PT15M",

455

"interval": "PT2M",

456

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

457

"host": "",

458

"approval_delay": "PT0S",

459

"approval_duration": "PT1S",

460

"approved_by_default": "True",

461

"enabled": "True",

462

}

463

952

464

@staticmethod

953

465

def config_parser(config):

954

466

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

961

473

for client_name in config.sections():

962

474

section = dict(config.items(client_name))

963

475

client = settings[client_name] = {}

964

476

965

477

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

966

478

# Reformat values from string types to Python types

967

479

client["approved_by_default"] = config.getboolean(

968

480

client_name, "approved_by_default")

969

481

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

970

482

"enabled")

971

972

# Uppercase and remove spaces from key_id and fingerprint

973

# for later comparison purposes with return value from the

974

# key_id() and fingerprint() functions

975

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

976

.replace(" ", ""))

977

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

978

"").upper()

483

484

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

979

485

.replace(" ", ""))

980

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

981

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

982

" fingerprint", client_name)

983

del settings[client_name]

984

continue

985

486

if "secret" in section:

986

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

987

.encode("utf-8"),

988

"base64")

487

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

989

488

elif "secfile" in section:

990

489

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

991

490

(section["secfile"])),

1006

505

client["last_approval_request"] = None

1007

506

client["last_checked_ok"] = None

1008

507

client["last_checker_status"] = -2

1009

508

1010

509

return settings

1011

1012

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

510

511

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

1013

512

self.name = name

1014

513

if server_settings is None:

1015

514

server_settings = {}

1017

516

# adding all client settings

1018

517

for setting, value in settings.items():

1019

518

setattr(self, setting, value)

1020

519

1021

520

if self.enabled:

1022

521

if not hasattr(self, "last_enabled"):

1023

522

self.last_enabled = datetime.datetime.utcnow()

1027

526

else:

1028

527

self.last_enabled = None

1029

528

self.expires = None

1030

1031

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

1032

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

1033

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

529

530

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

531

# Uppercase and remove spaces from fingerprint for later

532

# comparison purposes with return value from the fingerprint()

533

# function

534

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

1034

535

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

1035

536

datetime.datetime.utcnow())

1036

537

1037

538

# attributes specific for this server instance

1038

539

self.checker = None

1039

540

self.checker_initiator_tag = None

1042

543

self.current_checker_command = None

1043

544

self.approved = None

1044

545

self.approvals_pending = 0

1045

self.changedstate = multiprocessing_manager.Condition(

1046

multiprocessing_manager.Lock())

1047

self.client_structure = [attr

1048

for attr in self.__dict__.keys()

546

self.changedstate = (multiprocessing_manager

547

.Condition(multiprocessing_manager

548

.Lock()))

549

self.client_structure = [attr for attr in

550

self.__dict__.iterkeys()

1049

551

if not attr.startswith("_")]

1050

552

self.client_structure.append("client_structure")

1051

1052

for name, t in inspect.getmembers(

1053

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

553

554

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

555

lambda obj:

556

isinstance(obj,

557

property)):

1054

558

if not name.startswith("_"):

1055

559

self.client_structure.append(name)

1056

560

1057

561

# Send notice to process children that client state has changed

1058

562

def send_changedstate(self):

1059

563

with self.changedstate:

1060

564

self.changedstate.notify_all()

1061

565

1062

566

def enable(self):

1063

567

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

1064

568

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

1065

569

# Already enabled

1066

570

return

571

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

1067

572

self.enabled = True

1068

573

self.last_enabled = datetime.datetime.utcnow()

1069

574

self.init_checker()

1070

575

self.send_changedstate()

1071

576

1072

577

def disable(self, quiet=True):

1073

578

"""Disable this client."""

1074

579

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

1075

580

return False

1076

581

if not quiet:

1077

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

582

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

1078

583

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

1079

GLib.source_remove(self.disable_initiator_tag)

584

gobject.source_remove(self.disable_initiator_tag)

1080

585

self.disable_initiator_tag = None

1081

586

self.expires = None

1082

587

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

1083

GLib.source_remove(self.checker_initiator_tag)

588

gobject.source_remove(self.checker_initiator_tag)

1084

589

self.checker_initiator_tag = None

1085

590

self.stop_checker()

1086

591

self.enabled = False

1087

592

if not quiet:

1088

593

self.send_changedstate()

1089

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

594

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

1090

595

return False

1091

596

1092

597

def __del__(self):

1093

598

self.disable()

1094

1095

def init_checker(self, randomize_start=False):

1096

# Schedule a new checker to be started a randomly selected

1097

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

1098

# the startup of checkers over time when the server is

1099

# started.

599

600

def init_checker(self):

601

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

602

# and every interval from then on.

1100

603

if self.checker_initiator_tag is not None:

1101

GLib.source_remove(self.checker_initiator_tag)

1102

interval_milliseconds = int(self.interval.total_seconds()

1103

* 1000)

1104

if randomize_start:

1105

delay_milliseconds = random.randrange(

1106

interval_milliseconds + 1)

1107

else:

1108

delay_milliseconds = interval_milliseconds

1109

self.checker_initiator_tag = GLib.timeout_add(

1110

delay_milliseconds, self.start_checker, randomize_start)

1111

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

1112

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

1113

# expire at the soonest one interval after a checker was

1114

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

1115

# time might have to be extended.

1116

now = datetime.datetime.utcnow()

1117

self.expires = now + delay + self.interval

1118

# Schedule a disable() at expire time

604

gobject.source_remove(self.checker_initiator_tag)

605

self.checker_initiator_tag = (gobject.timeout_add

606

(int(self.interval

607

.total_seconds() * 1000),

608

self.start_checker))

609

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

1119

610

if self.disable_initiator_tag is not None:

1120

GLib.source_remove(self.disable_initiator_tag)

1121

self.disable_initiator_tag = GLib.timeout_add(

1122

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

1123

self.disable)

1124

1125

def checker_callback(self, source, condition, connection,

1126

command):

611

gobject.source_remove(self.disable_initiator_tag)

612

self.disable_initiator_tag = (gobject.timeout_add

613

(int(self.timeout

614

.total_seconds() * 1000),

615

self.disable))

616

# Also start a new checker *right now*.

617

self.start_checker()

618

619

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

1127

620

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

1128

# Read return code from connection (see call_pipe)

1129

returncode = connection.recv()

1130

connection.close()

1131

if self.checker is not None:

1132

self.checker.join()

1133

621

self.checker_callback_tag = None

1134

622

self.checker = None

1135

1136

if returncode >= 0:

1137

self.last_checker_status = returncode

1138

self.last_checker_signal = None

623

if os.WIFEXITED(condition):

624

self.last_checker_status = os.WEXITSTATUS(condition)

1139

625

if self.last_checker_status == 0:

1140

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

626

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

627

vars(self))

1141

628

self.checked_ok()

1142

629

else:

1143

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

630

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

631

vars(self))

1144

632

else:

1145

633

self.last_checker_status = -1

1146

self.last_checker_signal = -returncode

1147

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

1148

return False

1149

634

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

635

vars(self))

636

1150

637

def checked_ok(self):

1151

638

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

1152

639

self.last_checked_ok = datetime.datetime.utcnow()

1153

640

self.last_checker_status = 0

1154

self.last_checker_signal = None

1155

641

self.bump_timeout()

1156

642

1157

643

def bump_timeout(self, timeout=None):

1158

644

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

1159

645

if timeout is None:

1160

646

timeout = self.timeout

1161

647

if self.disable_initiator_tag is not None:

1162

GLib.source_remove(self.disable_initiator_tag)

648

gobject.source_remove(self.disable_initiator_tag)

1163

649

self.disable_initiator_tag = None

1164

650

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

1165

self.disable_initiator_tag = GLib.timeout_add(

1166

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

651

self.disable_initiator_tag = (gobject.timeout_add

652

(int(timeout.total_seconds()

653

* 1000), self.disable))

1167

654

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

1168

655

1169

656

def need_approval(self):

1170

657

self.last_approval_request = datetime.datetime.utcnow()

1171

1172

def start_checker(self, start_was_randomized=False):

658

659

def start_checker(self):

1173

660

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

1174

661

1175

662

If a checker already exists, leave it running and do

1176

663

nothing."""

1177

664

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

1182

669

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

1183

670

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

1184

671

# should be.

1185

1186

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

1187

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

1188

self.checker.join()

1189

self.checker = None

672

673

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

674

try:

675

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

676

except AttributeError:

677

pass

678

except OSError as error:

679

if error.errno != errno.ECHILD:

680

raise

681

else:

682

if pid:

683

logger.warning("Checker was a zombie")

684

gobject.source_remove(self.checker_callback_tag)

685

self.checker_callback(pid, status,

686

self.current_checker_command)

1190

687

# Start a new checker if needed

1191

688

if self.checker is None:

1192

689

# Escape attributes for the shell

1193

escaped_attrs = {

1194

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

1195

for attr in self.runtime_expansions}

690

escaped_attrs = { attr:

691

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

692

for attr in self.runtime_expansions }

1196

693

try:

1197

694

command = self.checker_command % escaped_attrs

1198

695

except TypeError as error:

1199

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

1200

self.checker_command, exc_info=error)

1201

return True # Try again later

696

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

697

self.checker_command, exc_info=error)

698

return True # Try again later

1202

699

self.current_checker_command = command

1203

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

1204

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

1205

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

1206

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

1207

# always replaced by /dev/null.)

1208

# The exception is when not debugging but nevertheless

1209

# running in the foreground; use the previously

1210

# created wnull.

1211

popen_args = {"close_fds": True,

1212

"shell": True,

1213

"cwd": "/"}

1214

if (not self.server_settings["debug"]

1215

and self.server_settings["foreground"]):

1216

popen_args.update({"stdout": wnull,

1217

"stderr": wnull})

1218

pipe = multiprocessing.Pipe(duplex=False)

1219

self.checker = multiprocessing.Process(

1220

target=call_pipe,

1221

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

1222

kwargs=popen_args)

1223

self.checker.start()

1224

self.checker_callback_tag = GLib.io_add_watch(

1225

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

1226

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1227

self.checker_callback, pipe[0], command)

1228

if start_was_randomized:

1229

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

1230

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

1231

# interval from then on.

1232

now = datetime.datetime.utcnow()

1233

self.checker_initiator_tag = GLib.timeout_add(

1234

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

1235

self.start_checker)

1236

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

1237

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

1238

return False

1239

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

700

try:

701

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

702

command, self.name)

703

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

704

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

705

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

706

# always replaced by /dev/null.)

707

# The exception is when not debugging but nevertheless

708

# running in the foreground; use the previously

709

# created wnull.

710

popen_args = {}

711

if (not self.server_settings["debug"]

712

and self.server_settings["foreground"]):

713

popen_args.update({"stdout": wnull,

714

"stderr": wnull })

715

self.checker = subprocess.Popen(command,

716

close_fds=True,

717

shell=True, cwd="/",

718

**popen_args)

719

except OSError as error:

720

logger.error("Failed to start subprocess",

721

exc_info=error)

722

return True

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

try:

730

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

731

except OSError as error:

732

if error.errno == errno.ECHILD:

733

# This should never happen

734

logger.error("Child process vanished",

735

exc_info=error)

736

return True

737

raise

738

if pid:

739

gobject.source_remove(self.checker_callback_tag)

740

self.checker_callback(pid, status, command)

741

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

1240

742

return True

1241

743

1242

744

def stop_checker(self):

1243

745

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

1244

746

if self.checker_callback_tag:

1245

GLib.source_remove(self.checker_callback_tag)

747

gobject.source_remove(self.checker_callback_tag)

1246

748

self.checker_callback_tag = None

1247

749

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

1248

750

return

1249

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

1250

self.checker.terminate()

751

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

752

try:

753

self.checker.terminate()

754

#time.sleep(0.5)

755

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

756

# self.checker.kill()

757

except OSError as error:

758

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

759

raise

1251

760

self.checker = None

1252

761

1253

762

1254

def dbus_service_property(dbus_interface,

1255

signature="v",

1256

access="readwrite",

1257

byte_arrays=False):

763

def dbus_service_property(dbus_interface, signature="v",

764

access="readwrite", byte_arrays=False):

1258

765

"""Decorators for marking methods of a DBusObjectWithProperties to

1259

766

become properties on the D-Bus.

1260

767

1261

768

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

1262

769

and with one argument by "Set".

1263

770

1264

771

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

1265

772

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

1266

773

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

1270

777

if byte_arrays and signature != "ay":

1271

778

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

1272

779

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

1273

1274

780

def decorator(func):

1275

781

func._dbus_is_property = True

1276

782

func._dbus_interface = dbus_interface

1279

785

func._dbus_name = func.__name__

1280

786

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

1281

787

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

1282

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

788

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1283

789

return func

1284

1285

790

return decorator

1286

791

1287

792

1288

793

def dbus_interface_annotations(dbus_interface):

1289

794

"""Decorator for marking functions returning interface annotations

1290

795

1291

796

Usage:

1292

797

1293

798

@dbus_interface_annotations("org.example.Interface")

1294

799

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

1295

800

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

1296

801

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

1297

802

"false"}

1298

803

"""

1299

1300

804

def decorator(func):

1301

805

func._dbus_is_interface = True

1302

806

func._dbus_interface = dbus_interface

1303

807

func._dbus_name = dbus_interface

1304

808

return func

1305

1306

809

return decorator

1307

810

1308

811

1309

812

def dbus_annotations(annotations):

1310

813

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

1311

814

Usage:

1312

815

1313

816

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

1314

817

"org.freedesktop.DBus.Property."

1315

818

"EmitsChangedSignal": "false"})

1317

820

access="r")

1318

821

def Property_dbus_property(self):

1319

822

return dbus.Boolean(False)

1320

1321

See also the DBusObjectWithAnnotations class.

1322

823

"""

1323

1324

824

def decorator(func):

1325

825

func._dbus_annotations = annotations

1326

826

return func

1327

1328

827

return decorator

1329

828

1330

829

1333

832

"""

1334

833

pass

1335

834

1336

1337

835

class DBusPropertyAccessException(DBusPropertyException):

1338

836

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

1339

837

"""

1346

844

pass

1347

845

1348

846

1349

class DBusObjectWithAnnotations(dbus.service.Object):

1350

"""A D-Bus object with annotations.

1351

1352

Classes inheriting from this can use the dbus_annotations

1353

decorator to add annotations to methods or signals.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1354

853

"""

1355

854

1356

855

@staticmethod

1357

856

def _is_dbus_thing(thing):

1358

857

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

1359

858

1360

859

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

1361

860

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

1362

861

"""

1363

862

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

1364

863

False)

1365

864

1366

865

def _get_all_dbus_things(self, thing):

1367

866

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

1368

867

"""

1369

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

868

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

869

name),

1370

870

athing.__get__(self))

1371

871

for cls in self.__class__.__mro__

1372

872

for name, athing in

1373

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

1374

1375

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1376

out_signature="s",

1377

path_keyword="object_path",

1378

connection_keyword="connection")

1379

def Introspect(self, object_path, connection):

1380

"""Overloading of standard D-Bus method.

1381

1382

Inserts annotation tags on methods and signals.

1383

"""

1384

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

1385

connection)

1386

try:

1387

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

1388

1389

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

1390

# Add annotation tags

1391

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

1392

for tag in if_tag.getElementsByTagName(typ):

1393

annots = dict()

1394

for name, prop in (self.

1395

_get_all_dbus_things(typ)):

1396

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

1397

and prop._dbus_interface

1398

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

1399

annots.update(getattr(

1400

prop, "_dbus_annotations", {}))

1401

for name, value in annots.items():

1402

ann_tag = document.createElement(

1403

"annotation")

1404

ann_tag.setAttribute("name", name)

1405

ann_tag.setAttribute("value", value)

1406

tag.appendChild(ann_tag)

1407

# Add interface annotation tags

1408

for annotation, value in dict(

1409

itertools.chain.from_iterable(

1410

annotations().items()

1411

for name, annotations

1412

in self._get_all_dbus_things("interface")

1413

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

1414

)).items():

1415

ann_tag = document.createElement("annotation")

1416

ann_tag.setAttribute("name", annotation)

1417

ann_tag.setAttribute("value", value)

1418

if_tag.appendChild(ann_tag)

1419

# Fix argument name for the Introspect method itself

1420

if (if_tag.getAttribute("name")

1421

== dbus.INTROSPECTABLE_IFACE):

1422

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

1423

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

1424

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

1425

if (arg.getAttribute("direction")

1426

== "out"):

1427

arg.setAttribute("name",

1428

"xml_data")

1429

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

1430

document.unlink()

1431

except (AttributeError, xml.dom.DOMException,

1432

xml.parsers.expat.ExpatError) as error:

1433

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

1434

exc_info=error)

1435

return xmlstring

1436

1437

1438

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1439

"""A D-Bus object with properties.

1440

1441

Classes inheriting from this can use the dbus_service_property

1442

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

1443

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

1444

"""

1445

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1446

876

def _get_dbus_property(self, interface_name, property_name):

1447

877

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

1448

878

property with the specified name and interface.

1449

879

"""

1450

for cls in self.__class__.__mro__:

1451

for name, value in inspect.getmembers(

1452

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1453

884

if (value._dbus_name == property_name

1454

885

and value._dbus_interface == interface_name):

1455

886

return value.__get__(self)

1456

887

1457

888

# No such property

1458

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

1459

self.dbus_object_path, interface_name, property_name))

1460

1461

@classmethod

1462

def _get_all_interface_names(cls):

1463

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

1464

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

1465

"_dbus_interface", None)

1466

for x in (inspect.getmro(cls))

1467

for attr in dir(x))

1468

if name is not None)

1469

1470

@dbus.service.method(dbus.PROPERTIES_IFACE,

1471

in_signature="ss",

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1472

894

out_signature="v")

1473

895

def Get(self, interface_name, property_name):

1474

896

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

1480

902

if not hasattr(value, "variant_level"):

1481

903

return value

1482

904

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

1483

905

1484

906

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

1485

907

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

1486

908

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

1495

917

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

1496

918

"'ay' signature {!r}"

1497

919

.format(prop._dbus_signature))

1498

value = dbus.ByteArray(bytes(value))

920

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

921

for byte in value))

1499

922

prop(value)

1500

1501

@dbus.service.method(dbus.PROPERTIES_IFACE,

1502

in_signature="s",

923

924

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

1503

925

out_signature="a{sv}")

1504

926

def GetAll(self, interface_name):

1505

927

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

1506

928

standard.

1507

929

1508

930

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

1509

931

"""

1510

932

properties = {}

1520

942

if not hasattr(value, "variant_level"):

1521

943

properties[name] = value

1522

944

continue

1523

properties[name] = type(value)(

1524

value, variant_level=value.variant_level + 1)

945

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

946

value.variant_level+1)

1525

947

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

1526

948

1527

949

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

1528

950

def PropertiesChanged(self, interface_name, changed_properties,

1529

951

invalidated_properties):

1531

953

standard.

1532

954

"""

1533

955

pass

1534

956

1535

957

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1536

958

out_signature="s",

1537

path_keyword="object_path",

1538

connection_keyword="connection")

959

path_keyword='object_path',

960

connection_keyword='connection')

1539

961

def Introspect(self, object_path, connection):

1540

962

"""Overloading of standard D-Bus method.

1541

963

1542

964

Inserts property tags and interface annotation tags.

1543

965

"""

1544

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1545

object_path,

1546

connection)

966

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

967

connection)

1547

968

try:

1548

969

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

1549

1550

970

def make_tag(document, name, prop):

1551

971

e = document.createElement("property")

1552

972

e.setAttribute("name", name)

1553

973

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

1554

974

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

1555

975

return e

1556

1557

976

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

1558

977

# Add property tags

1559

978

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

1562

981

if prop._dbus_interface

1563

982

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

1564

983

if_tag.appendChild(tag)

1565

# Add annotation tags for properties

1566

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

1567

annots = dict()

1568

for name, prop in self._get_all_dbus_things(

1569

"property"):

1570

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

1571

and prop._dbus_interface

1572

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

1573

annots.update(getattr(

1574

prop, "_dbus_annotations", {}))

1575

for name, value in annots.items():

1576

ann_tag = document.createElement(

1577

"annotation")

1578

ann_tag.setAttribute("name", name)

1579

ann_tag.setAttribute("value", value)

1580

tag.appendChild(ann_tag)

984

# Add annotation tags

985

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

986

for tag in if_tag.getElementsByTagName(typ):

987

annots = dict()

988

for name, prop in (self.

989

_get_all_dbus_things(typ)):

990

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

991

and prop._dbus_interface

992

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

993

annots.update(getattr

994

(prop,

995

"_dbus_annotations",

996

{}))

997

for name, value in annots.items():

998

ann_tag = document.createElement(

999

"annotation")

1000

ann_tag.setAttribute("name", name)

1001

ann_tag.setAttribute("value", value)

1002

tag.appendChild(ann_tag)

1003

# Add interface annotation tags

1004

for annotation, value in dict(

1005

itertools.chain.from_iterable(

1006

annotations().items()

1007

for name, annotations in

1008

self._get_all_dbus_things("interface")

1009

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

1010

)).items():

1011

ann_tag = document.createElement("annotation")

1012

ann_tag.setAttribute("name", annotation)

1013

ann_tag.setAttribute("value", value)

1014

if_tag.appendChild(ann_tag)

1581

1015

# Add the names to the return values for the

1582

1016

# "org.freedesktop.DBus.Properties" methods

1583

1017

if (if_tag.getAttribute("name")

1597

1031

document.unlink()

1598

1032

except (AttributeError, xml.dom.DOMException,

1599

1033

xml.parsers.expat.ExpatError) as error:

1600

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

1601

exc_info=error)

1602

return xmlstring

1603

1604

1605

try:

1606

dbus.OBJECT_MANAGER_IFACE

1607

except AttributeError:

1608

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

1609

1610

1611

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1612

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

1613

1614

Classes inheriting from this exposes the standard

1615

GetManagedObjects call and the InterfacesAdded and

1616

InterfacesRemoved signals on the standard

1617

"org.freedesktop.DBus.ObjectManager" interface.

1618

1619

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

1620

manually.

1621

"""

1622

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1623

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

1624

def GetManagedObjects(self):

1625

"""This function must be overridden"""

1626

raise NotImplementedError()

1627

1628

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1629

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

1630

def InterfacesAdded(self, object_path, interfaces_and_properties):

1631

pass

1632

1633

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

1634

def InterfacesRemoved(self, object_path, interfaces):

1635

pass

1636

1637

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1638

out_signature="s",

1639

path_keyword="object_path",

1640

connection_keyword="connection")

1641

def Introspect(self, object_path, connection):

1642

"""Overloading of standard D-Bus method.

1643

1644

Override return argument name of GetManagedObjects to be

1645

"objpath_interfaces_and_properties"

1646

"""

1647

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1648

object_path,

1649

connection)

1650

try:

1651

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

1652

1653

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

1654

# Fix argument name for the GetManagedObjects method

1655

if (if_tag.getAttribute("name")

1656

== dbus.OBJECT_MANAGER_IFACE):

1657

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

1658

if (cn.getAttribute("name")

1659

== "GetManagedObjects"):

1660

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

1661

if (arg.getAttribute("direction")

1662

== "out"):

1663

arg.setAttribute(

1664

"name",

1665

"objpath_interfaces"

1666

"_and_properties")

1667

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

1668

document.unlink()

1669

except (AttributeError, xml.dom.DOMException,

1670

xml.parsers.expat.ExpatError) as error:

1671

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

1672

exc_info=error)

1034

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

1035

exc_info=error)

1673

1036

return xmlstring

1674

1037

1675

1038

1676

1039

def datetime_to_dbus(dt, variant_level=0):

1677

1040

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

1678

1041

if dt is None:

1679

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

1680

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

1042

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

1043

return dbus.String(dt.isoformat(),

1044

variant_level=variant_level)

1681

1045

1682

1046

1683

1047

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1685

1049

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

1686

1050

interface names according to the "alt_interface_names" mapping.

1687

1051

Usage:

1688

1052

1689

1053

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

1690

1054

"net.example.AlternateInterface"})

1691

1055

class SampleDBusObject(dbus.service.Object):

1692

1056

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

1693

1057

def SampleDBusMethod():

1694

1058

pass

1695

1059

1696

1060

The above "SampleDBusMethod" on "SampleDBusObject" will be

1697

1061

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

1698

1062

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

1699

1063

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

1700

1064

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

1701

1065

1702

1066

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

1703

1067

(from DBusObjectWithProperties) and interfaces (from the

1704

1068

dbus_interface_annotations decorator).

1705

1069

"""

1706

1707

1070

def wrapper(cls):

1708

1071

for orig_interface_name, alt_interface_name in (

1709

alt_interface_names.items()):

1072

alt_interface_names.items()):

1710

1073

attr = {}

1711

1074

interface_names = set()

1712

1075

# Go though all attributes of the class

1714

1077

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

1715

1078

# with the wrong interface name

1716

1079

if (not hasattr(attribute, "_dbus_interface")

1717

or not attribute._dbus_interface.startswith(

1718

orig_interface_name)):

1080

or not attribute._dbus_interface

1081

.startswith(orig_interface_name)):

1719

1082

continue

1720

1083

# Create an alternate D-Bus interface name based on

1721

1084

# the current name

1722

alt_interface = attribute._dbus_interface.replace(

1723

orig_interface_name, alt_interface_name)

1085

alt_interface = (attribute._dbus_interface

1086

.replace(orig_interface_name,

1087

alt_interface_name))

1724

1088

interface_names.add(alt_interface)

1725

1089

# Is this a D-Bus signal?

1726

1090

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

1727

1091

# Extract the original non-method undecorated

1728

1092

# function by black magic

1729

if sys.version_info.major == 2:

1730

nonmethod_func = (dict(

1093

nonmethod_func = (dict(

1731

1094

zip(attribute.func_code.co_freevars,

1732

attribute.__closure__))

1733

["func"].cell_contents)

1734

else:

1735

nonmethod_func = (dict(

1736

zip(attribute.__code__.co_freevars,

1737

attribute.__closure__))

1738

["func"].cell_contents)

1095

attribute.__closure__))["func"]

1096

.cell_contents)

1739

1097

# Create a new, but exactly alike, function

1740

1098

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

1741

1099

# with the alternate D-Bus interface name

1742

new_function = copy_function(nonmethod_func)

1743

new_function = (dbus.service.signal(

1744

alt_interface,

1745

attribute._dbus_signature)(new_function))

1100

new_function = (dbus.service.signal

1101

(alt_interface,

1102

attribute._dbus_signature)

1103

(types.FunctionType(

1104

nonmethod_func.func_code,

1105

nonmethod_func.func_globals,

1106

nonmethod_func.func_name,

1107

nonmethod_func.func_defaults,

1108

nonmethod_func.func_closure)))

1746

1109

# Copy annotations, if any

1747

1110

try:

1748

new_function._dbus_annotations = dict(

1749

attribute._dbus_annotations)

1111

new_function._dbus_annotations = (

1112

dict(attribute._dbus_annotations))

1750

1113

except AttributeError:

1751

1114

pass

1752

1753

1115

# Define a creator of a function to call both the

1754

1116

# original and alternate functions, so both the

1755

1117

# original and alternate signals gets sent when

1758

1120

"""This function is a scope container to pass

1759

1121

func1 and func2 to the "call_both" function

1760

1122

outside of its arguments"""

1761

1762

@functools.wraps(func2)

1763

1123

def call_both(*args, **kwargs):

1764

1124

"""This function will emit two D-Bus

1765

1125

signals by calling func1 and func2"""

1766

1126

func1(*args, **kwargs)

1767

1127

func2(*args, **kwargs)

1768

# Make wrapper function look like a D-Bus

1769

# signal

1770

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

1771

if name.startswith("_dbus_"):

1772

setattr(call_both, name, attr)

1773

1774

1128

return call_both

1775

1129

# Create the "call_both" function and add it to

1776

1130

# the class

1781

1135

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

1782

1136

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

1783

1137

# to the class.

1784

attr[attrname] = (

1785

dbus.service.method(

1786

alt_interface,

1787

attribute._dbus_in_signature,

1788

attribute._dbus_out_signature)

1789

(copy_function(attribute)))

1138

attr[attrname] = (dbus.service.method

1139

(alt_interface,

1140

attribute._dbus_in_signature,

1141

attribute._dbus_out_signature)

1142

(types.FunctionType

1143

(attribute.func_code,

1144

attribute.func_globals,

1145

attribute.func_name,

1146

attribute.func_defaults,

1147

attribute.func_closure)))

1790

1148

# Copy annotations, if any

1791

1149

try:

1792

attr[attrname]._dbus_annotations = dict(

1793

attribute._dbus_annotations)

1150

attr[attrname]._dbus_annotations = (

1151

dict(attribute._dbus_annotations))

1794

1152

except AttributeError:

1795

1153

pass

1796

1154

# Is this a D-Bus property?

1799

1157

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

1800

1158

# property with the alternate D-Bus interface

1801

1159

# name. Add it to the class.

1802

attr[attrname] = (dbus_service_property(

1803

alt_interface, attribute._dbus_signature,

1804

attribute._dbus_access,

1805

attribute._dbus_get_args_options

1806

["byte_arrays"])

1807

(copy_function(attribute)))

1160

attr[attrname] = (dbus_service_property

1161

(alt_interface,

1162

attribute._dbus_signature,

1163

attribute._dbus_access,

1164

attribute

1165

._dbus_get_args_options

1166

["byte_arrays"])

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1808

1173

# Copy annotations, if any

1809

1174

try:

1810

attr[attrname]._dbus_annotations = dict(

1811

attribute._dbus_annotations)

1175

attr[attrname]._dbus_annotations = (

1176

dict(attribute._dbus_annotations))

1812

1177

except AttributeError:

1813

1178

pass

1814

1179

# Is this a D-Bus interface?

1817

1182

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

1818

1183

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

1819

1184

# to the class.

1820

attr[attrname] = (

1821

dbus_interface_annotations(alt_interface)

1822

(copy_function(attribute)))

1185

attr[attrname] = (dbus_interface_annotations

1186

(alt_interface)

1187

(types.FunctionType

1188

(attribute.func_code,

1189

attribute.func_globals,

1190

attribute.func_name,

1191

attribute.func_defaults,

1192

attribute.func_closure)))

1823

1193

if deprecate:

1824

1194

# Deprecate all alternate interfaces

1825

iname = "_AlternateDBusNames_interface_annotation{}"

1195

iname="_AlternateDBusNames_interface_annotation{}"

1826

1196

for interface_name in interface_names:

1827

1828

1197

@dbus_interface_annotations(interface_name)

1829

1198

def func(self):

1830

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

1831

"true"}

1199

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

1200

"true" }

1832

1201

# Find an unused name

1833

1202

for aname in (iname.format(i)

1834

1203

for i in itertools.count()):

1838

1207

if interface_names:

1839

1208

# Replace the class with a new subclass of it with

1840

1209

# methods, signals, etc. as created above.

1841

if sys.version_info.major == 2:

1842

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

1843

(cls, ), attr)

1844

else:

1845

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

1846

(cls, ), attr)

1210

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

1211

(cls,), attr)

1847

1212

return cls

1848

1849

1213

return wrapper

1850

1214

1851

1215

1852

1216

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

1853

"se.bsnet.fukt.Mandos"})

1217

"se.bsnet.fukt.Mandos"})

1854

1218

class ClientDBus(Client, DBusObjectWithProperties):

1855

1219

"""A Client class using D-Bus

1856

1220

1857

1221

Attributes:

1858

1222

dbus_object_path: dbus.ObjectPath

1859

1223

bus: dbus.SystemBus()

1860

1224

"""

1861

1225

1862

1226

runtime_expansions = (Client.runtime_expansions

1863

+ ("dbus_object_path", ))

1864

1227

+ ("dbus_object_path",))

1228

1865

1229

_interface = "se.recompile.Mandos.Client"

1866

1230

1867

1231

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

1868

1869

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

1232

1233

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

1870

1234

self.bus = bus

1871

1235

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

1872

1236

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

1874

1238

client_object_name = str(self.name).translate(

1875

1239

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

1876

1240

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

1877

self.dbus_object_path = dbus.ObjectPath(

1878

"/clients/" + client_object_name)

1241

self.dbus_object_path = (dbus.ObjectPath

1242

("/clients/" + client_object_name))

1879

1243

DBusObjectWithProperties.__init__(self, self.bus,

1880

1244

self.dbus_object_path)

1881

1882

def notifychangeproperty(transform_func, dbus_name,

1883

type_func=lambda x: x,

1884

variant_level=1,

1885

invalidate_only=False,

1245

1246

def notifychangeproperty(transform_func,

1247

dbus_name, type_func=lambda x: x,

1248

variant_level=1, invalidate_only=False,

1886

1249

_interface=_interface):

1887

1250

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

1888

1251

its changes to DBus.

1889

1252

1890

1253

transform_fun: Function that takes a value and a variant_level

1891

1254

and transforms it to a D-Bus type.

1892

1255

dbus_name: D-Bus name of the variable

1895

1258

variant_level: D-Bus variant level. Default: 1

1896

1259

"""

1897

1260

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

1898

1899

1261

def setter(self, value):

1900

1262

if hasattr(self, "dbus_object_path"):

1901

1263

if (not hasattr(self, attrname) or

1902

1264

type_func(getattr(self, attrname, None))

1903

1265

!= type_func(value)):

1904

1266

if invalidate_only:

1905

self.PropertiesChanged(

1906

_interface, dbus.Dictionary(),

1907

dbus.Array((dbus_name, )))

1267

self.PropertiesChanged(_interface,

1268

dbus.Dictionary(),

1269

dbus.Array

1270

((dbus_name,)))

1908

1271

else:

1909

dbus_value = transform_func(

1910

type_func(value),

1911

variant_level=variant_level)

1272

dbus_value = transform_func(type_func(value),

1273

variant_level

1274

=variant_level)

1912

1275

self.PropertyChanged(dbus.String(dbus_name),

1913

1276

dbus_value)

1914

self.PropertiesChanged(

1915

_interface,

1916

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

1917

dbus_value}),

1918

dbus.Array())

1277

self.PropertiesChanged(_interface,

1278

dbus.Dictionary({

1279

dbus.String(dbus_name):

1280

dbus_value }), dbus.Array())

1919

1281

setattr(self, attrname, value)

1920

1282

1921

1283

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

1922

1284

1923

1285

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1924

1286

approvals_pending = notifychangeproperty(dbus.Boolean,

1925

1287

"ApprovalPending",

1926

type_func=bool)

1288

type_func = bool)

1927

1289

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

1928

1290

last_enabled = notifychangeproperty(datetime_to_dbus,

1929

1291

"LastEnabled")

1930

checker = notifychangeproperty(

1931

dbus.Boolean, "CheckerRunning",

1932

type_func=lambda checker: checker is not None)

1292

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

1293

type_func = lambda checker:

1294

checker is not None)

1933

1295

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1934

1296

"LastCheckedOK")

1935

1297

last_checker_status = notifychangeproperty(dbus.Int16,

1938

1300

datetime_to_dbus, "LastApprovalRequest")

1939

1301

approved_by_default = notifychangeproperty(dbus.Boolean,

1940

1302

"ApprovedByDefault")

1941

approval_delay = notifychangeproperty(

1942

dbus.UInt64, "ApprovalDelay",

1943

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

1303

approval_delay = notifychangeproperty(dbus.UInt64,

1304

"ApprovalDelay",

1305

type_func =

1306

lambda td: td.total_seconds()

1307

* 1000)

1944

1308

approval_duration = notifychangeproperty(

1945

1309

dbus.UInt64, "ApprovalDuration",

1946

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

1310

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

1947

1311

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

1948

timeout = notifychangeproperty(

1949

dbus.UInt64, "Timeout",

1950

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

1312

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

1313

type_func = lambda td:

1314

td.total_seconds() * 1000)

1951

1315

extended_timeout = notifychangeproperty(

1952

1316

dbus.UInt64, "ExtendedTimeout",

1953

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

1954

interval = notifychangeproperty(

1955

dbus.UInt64, "Interval",

1956

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

1317

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

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

lambda td: td.total_seconds()

1322

* 1000)

1957

1323

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

1958

1324

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

1959

1325

invalidate_only=True)

1960

1326

1961

1327

del notifychangeproperty

1962

1328

1963

1329

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

1964

1330

try:

1965

1331

self.remove_from_connection()

1968

1334

if hasattr(DBusObjectWithProperties, "__del__"):

1969

1335

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

1970

1336

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

1971

1972

def checker_callback(self, source, condition,

1973

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

1974

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

1975

connection, command, *args,

1976

**kwargs)

1977

exitstatus = self.last_checker_status

1978

if exitstatus >= 0:

1337

1338

def checker_callback(self, pid, condition, command,

1339

*args, **kwargs):

1340

self.checker_callback_tag = None

1341

self.checker = None

1342

if os.WIFEXITED(condition):

1343

exitstatus = os.WEXITSTATUS(condition)

1979

1344

# Emit D-Bus signal

1980

1345

self.CheckerCompleted(dbus.Int16(exitstatus),

1981

# This is specific to GNU libC

1982

dbus.Int64(exitstatus << 8),

1346

dbus.Int64(condition),

1983

1347

dbus.String(command))

1984

1348

else:

1985

1349

# Emit D-Bus signal

1986

1350

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

1987

dbus.Int64(

1988

# This is specific to GNU libC

1989

(exitstatus << 8)

1990

| self.last_checker_signal),

1351

dbus.Int64(condition),

1991

1352

dbus.String(command))

1992

return ret

1993

1353

1354

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

1355

*args, **kwargs)

1356

1994

1357

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

1995

1358

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

1996

1359

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

2000

1363

# Emit D-Bus signal

2001

1364

self.CheckerStarted(self.current_checker_command)

2002

1365

return r

2003

1366

2004

1367

def _reset_approved(self):

2005

1368

self.approved = None

2006

1369

return False

2007

1370

2008

1371

def approve(self, value=True):

2009

1372

self.approved = value

2010

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

2011

* 1000), self._reset_approved)

1373

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

1374

* 1000), self._reset_approved)

2012

1375

self.send_changedstate()

2013

2014

# D-Bus methods, signals & properties

2015

2016

# Interfaces

2017

2018

# Signals

2019

1376

1377

## D-Bus methods, signals & properties

1378

1379

## Interfaces

1380

1381

## Signals

1382

2020

1383

# CheckerCompleted - signal

2021

1384

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

2022

1385

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

2023

1386

"D-Bus signal"

2024

1387

pass

2025

1388

2026

1389

# CheckerStarted - signal

2027

1390

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

2028

1391

def CheckerStarted(self, command):

2029

1392

"D-Bus signal"

2030

1393

pass

2031

1394

2032

1395

# PropertyChanged - signal

2033

1396

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

2034

1397

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

2035

1398

def PropertyChanged(self, property, value):

2036

1399

"D-Bus signal"

2037

1400

pass

2038

1401

2039

1402

# GotSecret - signal

2040

1403

@dbus.service.signal(_interface)

2041

1404

def GotSecret(self):

2044

1407

server to mandos-client

2045

1408

"""

2046

1409

pass

2047

1410

2048

1411

# Rejected - signal

2049

1412

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

2050

1413

def Rejected(self, reason):

2051

1414

"D-Bus signal"

2052

1415

pass

2053

1416

2054

1417

# NeedApproval - signal

2055

1418

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

2056

1419

def NeedApproval(self, timeout, default):

2057

1420

"D-Bus signal"

2058

1421

return self.need_approval()

2059

2060

# Methods

2061

1422

1423

## Methods

1424

2062

1425

# Approve - method

2063

1426

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

2064

1427

def Approve(self, value):

2065

1428

self.approve(value)

2066

1429

2067

1430

# CheckedOK - method

2068

1431

@dbus.service.method(_interface)

2069

1432

def CheckedOK(self):

2070

1433

self.checked_ok()

2071

1434

2072

1435

# Enable - method

2073

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

2074

1436

@dbus.service.method(_interface)

2075

1437

def Enable(self):

2076

1438

"D-Bus method"

2077

1439

self.enable()

2078

1440

2079

1441

# StartChecker - method

2080

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

2081

1442

@dbus.service.method(_interface)

2082

1443

def StartChecker(self):

2083

1444

"D-Bus method"

2084

1445

self.start_checker()

2085

1446

2086

1447

# Disable - method

2087

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

2088

1448

@dbus.service.method(_interface)

2089

1449

def Disable(self):

2090

1450

"D-Bus method"

2091

1451

self.disable()

2092

1452

2093

1453

# StopChecker - method

2094

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

2095

1454

@dbus.service.method(_interface)

2096

1455

def StopChecker(self):

2097

1456

self.stop_checker()

2098

2099

# Properties

2100

1457

1458

## Properties

1459

2101

1460

# ApprovalPending - property

2102

1461

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

2103

1462

def ApprovalPending_dbus_property(self):

2104

1463

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

2105

1464

2106

1465

# ApprovedByDefault - property

2107

@dbus_service_property(_interface,

2108

signature="b",

1466

@dbus_service_property(_interface, signature="b",

2109

1467

access="readwrite")

2110

1468

def ApprovedByDefault_dbus_property(self, value=None):

2111

1469

if value is None: # get

2112

1470

return dbus.Boolean(self.approved_by_default)

2113

1471

self.approved_by_default = bool(value)

2114

1472

2115

1473

# ApprovalDelay - property

2116

@dbus_service_property(_interface,

2117

signature="t",

1474

@dbus_service_property(_interface, signature="t",

2118

1475

access="readwrite")

2119

1476

def ApprovalDelay_dbus_property(self, value=None):

2120

1477

if value is None: # get

2121

1478

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

2122

1479

* 1000)

2123

1480

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

2124

1481

2125

1482

# ApprovalDuration - property

2126

@dbus_service_property(_interface,

2127

signature="t",

1483

@dbus_service_property(_interface, signature="t",

2128

1484

access="readwrite")

2129

1485

def ApprovalDuration_dbus_property(self, value=None):

2130

1486

if value is None: # get

2131

1487

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

2132

1488

* 1000)

2133

1489

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

2134

1490

2135

1491

# Name - property

2136

@dbus_annotations(

2137

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

2138

1492

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

2139

1493

def Name_dbus_property(self):

2140

1494

return dbus.String(self.name)

2141

2142

# KeyID - property

2143

@dbus_annotations(

2144

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

2145

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

2146

def KeyID_dbus_property(self):

2147

return dbus.String(self.key_id)

2148

1495

2149

1496

# Fingerprint - property

2150

@dbus_annotations(

2151

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

2152

1497

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

2153

1498

def Fingerprint_dbus_property(self):

2154

1499

return dbus.String(self.fingerprint)

2155

1500

2156

1501

# Host - property

2157

@dbus_service_property(_interface,

2158

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2159

1503

access="readwrite")

2160

1504

def Host_dbus_property(self, value=None):

2161

1505

if value is None: # get

2162

1506

return dbus.String(self.host)

2163

1507

self.host = str(value)

2164

1508

2165

1509

# Created - property

2166

@dbus_annotations(

2167

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

2168

1510

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

2169

1511

def Created_dbus_property(self):

2170

1512

return datetime_to_dbus(self.created)

2171

1513

2172

1514

# LastEnabled - property

2173

1515

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

2174

1516

def LastEnabled_dbus_property(self):

2175

1517

return datetime_to_dbus(self.last_enabled)

2176

1518

2177

1519

# Enabled - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1520

@dbus_service_property(_interface, signature="b",

2180

1521

access="readwrite")

2181

1522

def Enabled_dbus_property(self, value=None):

2182

1523

if value is None: # get

2185

1526

self.enable()

2186

1527

else:

2187

1528

self.disable()

2188

1529

2189

1530

# LastCheckedOK - property

2190

@dbus_service_property(_interface,

2191

signature="s",

1531

@dbus_service_property(_interface, signature="s",

2192

1532

access="readwrite")

2193

1533

def LastCheckedOK_dbus_property(self, value=None):

2194

1534

if value is not None:

2195

1535

self.checked_ok()

2196

1536

return

2197

1537

return datetime_to_dbus(self.last_checked_ok)

2198

1538

2199

1539

# LastCheckerStatus - property

2200

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

1540

@dbus_service_property(_interface, signature="n",

1541

access="read")

2201

1542

def LastCheckerStatus_dbus_property(self):

2202

1543

return dbus.Int16(self.last_checker_status)

2203

1544

2204

1545

# Expires - property

2205

1546

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

2206

1547

def Expires_dbus_property(self):

2207

1548

return datetime_to_dbus(self.expires)

2208

1549

2209

1550

# LastApprovalRequest - property

2210

1551

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

2211

1552

def LastApprovalRequest_dbus_property(self):

2212

1553

return datetime_to_dbus(self.last_approval_request)

2213

1554

2214

1555

# Timeout - property

2215

@dbus_service_property(_interface,

2216

signature="t",

1556

@dbus_service_property(_interface, signature="t",

2217

1557

access="readwrite")

2218

1558

def Timeout_dbus_property(self, value=None):

2219

1559

if value is None: # get

2231

1571

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

2232

1572

is None):

2233

1573

return

2234

GLib.source_remove(self.disable_initiator_tag)

2235

self.disable_initiator_tag = GLib.timeout_add(

2236

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

2237

self.disable)

2238

1574

gobject.source_remove(self.disable_initiator_tag)

1575

self.disable_initiator_tag = (

1576

gobject.timeout_add(

1577

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

1578

* 1000), self.disable))

1579

2239

1580

# ExtendedTimeout - property

2240

@dbus_service_property(_interface,

2241

signature="t",

1581

@dbus_service_property(_interface, signature="t",

2242

1582

access="readwrite")

2243

1583

def ExtendedTimeout_dbus_property(self, value=None):

2244

1584

if value is None: # get

2245

1585

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

2246

1586

* 1000)

2247

1587

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

2248

1588

2249

1589

# Interval - property

2250

@dbus_service_property(_interface,

2251

signature="t",

1590

@dbus_service_property(_interface, signature="t",

2252

1591

access="readwrite")

2253

1592

def Interval_dbus_property(self, value=None):

2254

1593

if value is None: # get

2258

1597

return

2259

1598

if self.enabled:

2260

1599

# Reschedule checker run

2261

GLib.source_remove(self.checker_initiator_tag)

2262

self.checker_initiator_tag = GLib.timeout_add(

2263

value, self.start_checker)

2264

self.start_checker() # Start one now, too

2265

1600

gobject.source_remove(self.checker_initiator_tag)

1601

self.checker_initiator_tag = (gobject.timeout_add

1602

(value, self.start_checker))

1603

self.start_checker() # Start one now, too

1604

2266

1605

# Checker - property

2267

@dbus_service_property(_interface,

2268

signature="s",

1606

@dbus_service_property(_interface, signature="s",

2269

1607

access="readwrite")

2270

1608

def Checker_dbus_property(self, value=None):

2271

1609

if value is None: # get

2272

1610

return dbus.String(self.checker_command)

2273

1611

self.checker_command = str(value)

2274

1612

2275

1613

# CheckerRunning - property

2276

@dbus_service_property(_interface,

2277

signature="b",

1614

@dbus_service_property(_interface, signature="b",

2278

1615

access="readwrite")

2279

1616

def CheckerRunning_dbus_property(self, value=None):

2280

1617

if value is None: # get

2283

1620

self.start_checker()

2284

1621

else:

2285

1622

self.stop_checker()

2286

1623

2287

1624

# ObjectPath - property

2288

@dbus_annotations(

2289

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

2290

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

2291

1625

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

2292

1626

def ObjectPath_dbus_property(self):

2293

return self.dbus_object_path # is already a dbus.ObjectPath

2294

1627

return self.dbus_object_path # is already a dbus.ObjectPath

1628

2295

1629

# Secret = property

2296

@dbus_annotations(

2297

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

2298

"invalidates"})

2299

@dbus_service_property(_interface,

2300

signature="ay",

2301

access="write",

2302

byte_arrays=True)

1630

@dbus_service_property(_interface, signature="ay",

1631

access="write", byte_arrays=True)

2303

1632

def Secret_dbus_property(self, value):

2304

1633

self.secret = bytes(value)

2305

1634

2306

1635

del _interface

2307

1636

2308

1637

2309

class ProxyClient:

2310

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

1638

class ProxyClient(object):

1639

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

2311

1640

self._pipe = child_pipe

2312

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

1641

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

2313

1642

if not self._pipe.recv():

2314

raise KeyError(key_id or fpr)

2315

1643

raise KeyError()

1644

2316

1645

def __getattribute__(self, name):

2317

if name == "_pipe":

1646

if name == '_pipe':

2318

1647

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

2319

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

1648

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

2320

1649

data = self._pipe.recv()

2321

if data[0] == "data":

1650

if data[0] == 'data':

2322

1651

return data[1]

2323

if data[0] == "function":

2324

1652

if data[0] == 'function':

2325

1653

def func(*args, **kwargs):

2326

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

1654

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

2327

1655

return self._pipe.recv()[1]

2328

2329

1656

return func

2330

1657

2331

1658

def __setattr__(self, name, value):

2332

if name == "_pipe":

1659

if name == '_pipe':

2333

1660

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

2334

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

1661

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

2335

1662

2336

1663

2337

1664

class ClientHandler(socketserver.BaseRequestHandler, object):

2338

1665

"""A class to handle client connections.

2339

1666

2340

1667

Instantiated once for each connection to handle it.

2341

1668

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

2342

1669

2343

1670

def handle(self):

2344

1671

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

2345

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

2346

str(self.client_address))

2347

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

2348

2349

session = gnutls.ClientSession(self.request)

2350

2351

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

2352

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

2353

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

2354

# "+DHE-DSS"))

1672

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

1673

str(self.client_address))

1674

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

1675

self.server.child_pipe.fileno())

1676

1677

session = (gnutls.connection

1678

.ClientSession(self.request,

1679

gnutls.connection

1680

.X509Credentials()))

1681

1682

# Note: gnutls.connection.X509Credentials is really a

1683

# generic GnuTLS certificate credentials object so long as

1684

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

1685

# here despite using OpenPGP certificates.

1686

1687

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

1688

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

1689

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

1690

# "+DHE-DSS"))

2355

1691

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

2356

1692

priority = self.server.gnutls_priority

2357

1693

if priority is None:

2358

1694

priority = "NORMAL"

2359

gnutls.priority_set_direct(session,

2360

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

2361

1695

(gnutls.library.functions

1696

.gnutls_priority_set_direct(session._c_object,

1697

priority, None))

1698

2362

1699

# Start communication using the Mandos protocol

2363

1700

# Get protocol number

2364

1701

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

2365

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

1702

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

2366

1703

try:

2367

1704

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

2368

1705

raise RuntimeError(line)

2369

1706

except (ValueError, IndexError, RuntimeError) as error:

2370

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

1707

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

2371

1708

return

2372

1709

2373

1710

# Start GnuTLS connection

2374

1711

try:

2375

1712

session.handshake()

2376

except gnutls.Error as error:

2377

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

1713

except gnutls.errors.GNUTLSError as error:

1714

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

2378

1715

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

2379

1716

# established. Just abandon the request.

2380

1717

return

2381

log.debug("Handshake succeeded")

2382

1718

logger.debug("Handshake succeeded")

1719

2383

1720

approval_required = False

2384

1721

try:

2385

if gnutls.has_rawpk:

2386

fpr = b""

2387

try:

2388

key_id = self.key_id(

2389

self.peer_certificate(session))

2390

except (TypeError, gnutls.Error) as error:

2391

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

2392

return

2393

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

2394

key_id.decode("utf-8",

2395

errors="replace"))

2396

2397

else:

2398

key_id = b""

2399

try:

2400

fpr = self.fingerprint(

2401

self.peer_certificate(session))

2402

except (TypeError, gnutls.Error) as error:

2403

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

2404

return

2405

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

2406

2407

try:

2408

client = ProxyClient(child_pipe, key_id, fpr,

1722

try:

1723

fpr = self.fingerprint(self.peer_certificate

1724

(session))

1725

except (TypeError,

1726

gnutls.errors.GNUTLSError) as error:

1727

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

1728

return

1729

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

1730

1731

try:

1732

client = ProxyClient(child_pipe, fpr,

2409

1733

self.client_address)

2410

1734

except KeyError:

2411

1735

return

2412

1736

2413

1737

if client.approval_delay:

2414

1738

delay = client.approval_delay

2415

1739

client.approvals_pending += 1

2416

1740

approval_required = True

2417

1741

2418

1742

while True:

2419

1743

if not client.enabled:

2420

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

1744

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

1745

client.name)

2421

1746

if self.server.use_dbus:

2422

1747

# Emit D-Bus signal

2423

1748

client.Rejected("Disabled")

2424

1749

return

2425

1750

2426

1751

if client.approved or not client.approval_delay:

2427

# We are approved or approval is disabled

1752

#We are approved or approval is disabled

2428

1753

break

2429

1754

elif client.approved is None:

2430

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

2431

client.name)

1755

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

1756

client.name)

2432

1757

if self.server.use_dbus:

2433

1758

# Emit D-Bus signal

2434

1759

client.NeedApproval(

2435

1760

client.approval_delay.total_seconds()

2436

1761

* 1000, client.approved_by_default)

2437

1762

else:

2438

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

2439

client.name)

1763

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

1764

client.name)

2440

1765

if self.server.use_dbus:

2441

1766

# Emit D-Bus signal

2442

1767

client.Rejected("Denied")

2443

1768

return

2444

2445

# wait until timeout or approved

1769

1770

#wait until timeout or approved

2446

1771

time = datetime.datetime.now()

2447

1772

client.changedstate.acquire()

2448

1773

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

2450

1775

time2 = datetime.datetime.now()

2451

1776

if (time2 - time) >= delay:

2452

1777

if not client.approved_by_default:

2453

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

2454

" waiting for approval",

2455

client.name)

1778

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

1779

" waiting for approval",

1780

client.name)

2456

1781

if self.server.use_dbus:

2457

1782

# Emit D-Bus signal

2458

1783

client.Rejected("Approval timed out")

2461

1786

break

2462

1787

else:

2463

1788

delay -= time2 - time

2464

2465

try:

2466

session.send(client.secret)

2467

except gnutls.Error as error:

2468

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

2469

return

2470

2471

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

1789

1790

sent_size = 0

1791

while sent_size < len(client.secret):

1792

try:

1793

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

1794

except gnutls.errors.GNUTLSError as error:

1795

logger.warning("gnutls send failed",

1796

exc_info=error)

1797

return

1798

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

1799

sent, len(client.secret)

1800

- (sent_size + sent))

1801

sent_size += sent

1802

1803

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

2472

1804

# bump the timeout using extended_timeout

2473

1805

client.bump_timeout(client.extended_timeout)

2474

1806

if self.server.use_dbus:

2475

1807

# Emit D-Bus signal

2476

1808

client.GotSecret()

2477

1809

2478

1810

finally:

2479

1811

if approval_required:

2480

1812

client.approvals_pending -= 1

2481

1813

try:

2482

1814

session.bye()

2483

except gnutls.Error as error:

2484

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

2485

1815

except gnutls.errors.GNUTLSError as error:

1816

logger.warning("GnuTLS bye failed",

1817

exc_info=error)

1818

2486

1819

@staticmethod

2487

1820

def peer_certificate(session):

2488

"Return the peer's certificate as a bytestring"

2489

try:

2490

cert_type = gnutls.certificate_type_get2(

2491

session, gnutls.CTYPE_PEERS)

2492

except AttributeError:

2493

cert_type = gnutls.certificate_type_get(session)

2494

if gnutls.has_rawpk:

2495

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2496

else:

2497

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2498

# If not a valid certificate type...

2499

if cert_type not in valid_cert_types:

2500

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

2501

valid_cert_types)

2502

# ...return invalid data

2503

return b""

1821

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

1822

# If not an OpenPGP certificate...

1823

if (gnutls.library.functions

1824

.gnutls_certificate_type_get(session._c_object)

1825

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1826

# ...do the normal thing

1827

return session.peer_certificate

2504

1828

list_size = ctypes.c_uint(1)

2505

cert_list = (gnutls.certificate_get_peers

2506

(session, ctypes.byref(list_size)))

1829

cert_list = (gnutls.library.functions

1830

.gnutls_certificate_get_peers

1831

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

2507

1832

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

2508

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

1833

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

1834

" certificate")

2509

1835

if list_size.value == 0:

2510

1836

return None

2511

1837

cert = cert_list[0]

2512

1838

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

2513

2514

@staticmethod

2515

def key_id(certificate):

2516

"Convert a certificate bytestring to a hexdigit key ID"

2517

# New GnuTLS "datum" with the public key

2518

datum = gnutls.datum_t(

2519

ctypes.cast(ctypes.c_char_p(certificate),

2520

ctypes.POINTER(ctypes.c_ubyte)),

2521

ctypes.c_uint(len(certificate)))

2522

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

2523

# New empty GnuTLS certificate

2524

pubkey = gnutls.pubkey_t()

2525

gnutls.pubkey_init(ctypes.byref(pubkey))

2526

# Import the raw public key into the certificate

2527

gnutls.pubkey_import(pubkey,

2528

ctypes.byref(datum),

2529

gnutls.X509_FMT_DER)

2530

# New buffer for the key ID

2531

buf = ctypes.create_string_buffer(32)

2532

buf_len = ctypes.c_size_t(len(buf))

2533

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

2534

gnutls.pubkey_get_key_id(

2535

pubkey,

2536

gnutls.KEYID_USE_SHA256,

2537

ctypes.cast(ctypes.byref(buf),

2538

ctypes.POINTER(ctypes.c_ubyte)),

2539

ctypes.byref(buf_len))

2540

# Deinit the certificate

2541

gnutls.pubkey_deinit(pubkey)

2542

2543

# Convert the buffer to a Python bytestring

2544

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

2545

# Convert the bytestring to hexadecimal notation

2546

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

2547

return hex_key_id

2548

1839

2549

1840

@staticmethod

2550

1841

def fingerprint(openpgp):

2551

1842

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2552

1843

# New GnuTLS "datum" with the OpenPGP public key

2553

datum = gnutls.datum_t(

2554

ctypes.cast(ctypes.c_char_p(openpgp),

2555

ctypes.POINTER(ctypes.c_ubyte)),

2556

ctypes.c_uint(len(openpgp)))

1844

datum = (gnutls.library.types

1845

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

1846

ctypes.POINTER

1847

(ctypes.c_ubyte)),

1848

ctypes.c_uint(len(openpgp))))

2557

1849

# New empty GnuTLS certificate

2558

crt = gnutls.openpgp_crt_t()

2559

gnutls.openpgp_crt_init(ctypes.byref(crt))

1850

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1851

(gnutls.library.functions

1852

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2560

1853

# Import the OpenPGP public key into the certificate

2561

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

2562

gnutls.OPENPGP_FMT_RAW)

1854

(gnutls.library.functions

1855

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

1856

gnutls.library.constants

1857

.GNUTLS_OPENPGP_FMT_RAW))

2563

1858

# Verify the self signature in the key

2564

1859

crtverify = ctypes.c_uint()

2565

gnutls.openpgp_crt_verify_self(crt, 0,

2566

ctypes.byref(crtverify))

1860

(gnutls.library.functions

1861

.gnutls_openpgp_crt_verify_self(crt, 0,

1862

ctypes.byref(crtverify)))

2567

1863

if crtverify.value != 0:

2568

gnutls.openpgp_crt_deinit(crt)

2569

raise gnutls.CertificateSecurityError(code

2570

=crtverify.value)

1864

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1865

raise (gnutls.errors.CertificateSecurityError

1866

("Verify failed"))

2571

1867

# New buffer for the fingerprint

2572

1868

buf = ctypes.create_string_buffer(20)

2573

1869

buf_len = ctypes.c_size_t()

2574

1870

# Get the fingerprint from the certificate into the buffer

2575

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

2576

ctypes.byref(buf_len))

1871

(gnutls.library.functions

1872

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

1873

ctypes.byref(buf_len)))

2577

1874

# Deinit the certificate

2578

gnutls.openpgp_crt_deinit(crt)

1875

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2579

1876

# Convert the buffer to a Python bytestring

2580

1877

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

2581

1878

# Convert the bytestring to hexadecimal notation

2583

1880

return hex_fpr

2584

1881

2585

1882

2586

class MultiprocessingMixIn:

1883

class MultiprocessingMixIn(object):

2587

1884

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

2588

2589

1885

def sub_process_main(self, request, address):

2590

1886

try:

2591

1887

self.finish_request(request, address)

2592

1888

except Exception:

2593

1889

self.handle_error(request, address)

2594

1890

self.close_request(request)

2595

1891

2596

1892

def process_request(self, request, address):

2597

1893

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

2598

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

2599

args=(request, address))

1894

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

1895

args = (request, address))

2600

1896

proc.start()

2601

1897

return proc

2602

1898

2603

1899

2604

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1900

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2605

1901

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

2606

2607

1902

def process_request(self, request, client_address):

2608

1903

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

2609

1904

2610

1905

This function creates a new pipe in self.pipe

2611

1906

"""

2612

1907

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2613

1908

2614

1909

proc = MultiprocessingMixIn.process_request(self, request,

2615

1910

client_address)

2616

1911

self.child_pipe.close()

2617

1912

self.add_pipe(parent_pipe, proc)

2618

1913

2619

1914

def add_pipe(self, parent_pipe, proc):

2620

1915

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

2621

1916

raise NotImplementedError()

2622

1917

2623

1918

2624

1919

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2625

socketserver.TCPServer):

2626

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

2627

1920

socketserver.TCPServer, object):

1921

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

1922

2628

1923

Attributes:

2629

1924

enabled: Boolean; whether this server is activated yet

2630

1925

interface: None or a network interface name (string)

2631

1926

use_ipv6: Boolean; to use IPv6 or not

2632

1927

"""

2633

2634

1928

def __init__(self, server_address, RequestHandlerClass,

2635

interface=None,

2636

use_ipv6=True,

2637

socketfd=None):

1929

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

2638

1930

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

2639

1931

creating a new one with socket.socket().

2640

1932

"""

2646

1938

self.socketfd = socketfd

2647

1939

# Save the original socket.socket() function

2648

1940

self.socket_socket = socket.socket

2649

2650

1941

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

2651

#

1942

#

2652

1943

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

2653

1944

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

2654

1945

# patching socket.socket.)

2655

#

1946

#

2656

1947

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

2657

1948

@functools.wraps(socket.socket)

2658

1949

def socket_wrapper(*args, **kwargs):

2670

1961

# socket_wrapper(), if socketfd was set.

2671

1962

socketserver.TCPServer.__init__(self, server_address,

2672

1963

RequestHandlerClass)

2673

1964

2674

1965

def server_bind(self):

2675

1966

"""This overrides the normal server_bind() function

2676

1967

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

2677

1968

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

2678

global SO_BINDTODEVICE

2679

1969

if self.interface is not None:

2680

1970

if SO_BINDTODEVICE is None:

2681

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

2682

# common enough.

2683

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

2684

SO_BINDTODEVICE = 25

2685

try:

2686

self.socket.setsockopt(

2687

socket.SOL_SOCKET, SO_BINDTODEVICE,

2688

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

2689

except socket.error as error:

2690

if error.errno == errno.EPERM:

2691

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

2692

self.interface)

2693

elif error.errno == errno.ENOPROTOOPT:

2694

log.error("SO_BINDTODEVICE not available; cannot"

2695

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

2696

elif error.errno == errno.ENODEV:

2697

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

2698

" bind", self.interface)

2699

else:

2700

raise

1971

logger.error("SO_BINDTODEVICE does not exist;"

1972

" cannot bind to interface %s",

1973

self.interface)

1974

else:

1975

try:

1976

self.socket.setsockopt(socket.SOL_SOCKET,

1977

SO_BINDTODEVICE,

1978

(self.interface + "\0")

1979

.encode("utf-8"))

1980

except socket.error as error:

1981

if error.errno == errno.EPERM:

1982

logger.error("No permission to bind to"

1983

" interface %s", self.interface)

1984

elif error.errno == errno.ENOPROTOOPT:

1985

logger.error("SO_BINDTODEVICE not available;"

1986

" cannot bind to interface %s",

1987

self.interface)

1988

elif error.errno == errno.ENODEV:

1989

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

1990

" cannot bind", self.interface)

1991

else:

1992

raise

2701

1993

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

2702

1994

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

2703

if self.server_address[1]:

2704

self.allow_reuse_address = True

2705

1995

if not self.server_address[0]:

2706

1996

if self.address_family == socket.AF_INET6:

2707

any_address = "::" # in6addr_any

1997

any_address = "::" # in6addr_any

2708

1998

else:

2709

any_address = "0.0.0.0" # INADDR_ANY

1999

any_address = "0.0.0.0" # INADDR_ANY

2710

2000

self.server_address = (any_address,

2711

2001

self.server_address[1])

2712

2002

elif not self.server_address[1]:

2713

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

2003

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

2004

0)

2714

2005

# if self.interface:

2715

2006

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

2716

2007

# 0, # port

2722

2013

2723

2014

class MandosServer(IPv6_TCPServer):

2724

2015

"""Mandos server.

2725

2016

2726

2017

Attributes:

2727

2018

clients: set of Client objects

2728

2019

gnutls_priority GnuTLS priority string

2729

2020

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

2730

2731

Assumes a GLib.MainLoop event loop.

2021

2022

Assumes a gobject.MainLoop event loop.

2732

2023

"""

2733

2734

2024

def __init__(self, server_address, RequestHandlerClass,

2735

interface=None,

2736

use_ipv6=True,

2737

clients=None,

2738

gnutls_priority=None,

2739

use_dbus=True,

2740

socketfd=None):

2025

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

2026

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

2741

2027

self.enabled = False

2742

2028

self.clients = clients

2743

2029

if self.clients is None:

2746

2032

self.gnutls_priority = gnutls_priority

2747

2033

IPv6_TCPServer.__init__(self, server_address,

2748

2034

RequestHandlerClass,

2749

interface=interface,

2750

use_ipv6=use_ipv6,

2751

socketfd=socketfd)

2752

2035

interface = interface,

2036

use_ipv6 = use_ipv6,

2037

socketfd = socketfd)

2753

2038

def server_activate(self):

2754

2039

if self.enabled:

2755

2040

return socketserver.TCPServer.server_activate(self)

2756

2041

2757

2042

def enable(self):

2758

2043

self.enabled = True

2759

2044

2760

2045

def add_pipe(self, parent_pipe, proc):

2761

2046

# Call "handle_ipc" for both data and EOF events

2762

GLib.io_add_watch(

2763

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

2764

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

2765

functools.partial(self.handle_ipc,

2766

parent_pipe=parent_pipe,

2767

proc=proc))

2768

2769

def handle_ipc(self, source, condition,

2770

parent_pipe=None,

2771

proc=None,

2772

client_object=None):

2047

gobject.io_add_watch(parent_pipe.fileno(),

2048

gobject.IO_IN | gobject.IO_HUP,

2049

functools.partial(self.handle_ipc,

2050

parent_pipe =

2051

parent_pipe,

2052

proc = proc))

2053

2054

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

2055

proc = None, client_object=None):

2773

2056

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

2774

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

2057

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

2775

2058

# Wait for other process to exit

2776

2059

proc.join()

2777

2060

return False

2778

2061

2779

2062

# Read a request from the child

2780

2063

request = parent_pipe.recv()

2781

2064

command = request[0]

2782

2783

if command == "init":

2784

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

2785

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

2786

address = request[3]

2787

2788

for c in self.clients.values():

2789

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2790

"27AE41E4649B934CA495991B7852B855"):

2791

continue

2792

if key_id and c.key_id == key_id:

2793

client = c

2794

break

2795

if fpr and c.fingerprint == fpr:

2065

2066

if command == 'init':

2067

fpr = request[1]

2068

address = request[2]

2069

2070

for c in self.clients.itervalues():

2071

if c.fingerprint == fpr:

2796

2072

client = c

2797

2073

break

2798

2074

else:

2799

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

2800

" %s", key_id or fpr, address)

2075

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

2076

"dress: %s", fpr, address)

2801

2077

if self.use_dbus:

2802

2078

# Emit D-Bus signal

2803

mandos_dbus_service.ClientNotFound(key_id or fpr,

2079

mandos_dbus_service.ClientNotFound(fpr,

2804

2080

address[0])

2805

2081

parent_pipe.send(False)

2806

2082

return False

2807

2808

GLib.io_add_watch(

2809

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

2810

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

2811

functools.partial(self.handle_ipc,

2812

parent_pipe=parent_pipe,

2813

proc=proc,

2814

client_object=client))

2083

2084

gobject.io_add_watch(parent_pipe.fileno(),

2085

gobject.IO_IN | gobject.IO_HUP,

2086

functools.partial(self.handle_ipc,

2087

parent_pipe =

2088

parent_pipe,

2089

proc = proc,

2090

client_object =

2091

client))

2815

2092

parent_pipe.send(True)

2816

2093

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

2817

2094

# same fileno

2818

2095

return False

2819

if command == "funcall":

2096

if command == 'funcall':

2820

2097

funcname = request[1]

2821

2098

args = request[2]

2822

2099

kwargs = request[3]

2823

2824

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

2100

2101

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

2825

2102

funcname)(*args,

2826

**kwargs)))

2827

2828

if command == "getattr":

2103

**kwargs)))

2104

2105

if command == 'getattr':

2829

2106

attrname = request[1]

2830

if isinstance(client_object.__getattribute__(attrname),

2831

collections.abc.Callable):

2832

parent_pipe.send(("function", ))

2107

if callable(client_object.__getattribute__(attrname)):

2108

parent_pipe.send(('function',))

2833

2109

else:

2834

parent_pipe.send((

2835

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

2836

2837

if command == "setattr":

2110

parent_pipe.send(('data', client_object

2111

.__getattribute__(attrname)))

2112

2113

if command == 'setattr':

2838

2114

attrname = request[1]

2839

2115

value = request[2]

2840

2116

setattr(client_object, attrname, value)

2841

2117

2842

2118

return True

2843

2119

2844

2120

2845

2121

def rfc3339_duration_to_delta(duration):

2846

2122

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

2847

2848

>>> timedelta = datetime.timedelta

2849

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

2850

True

2851

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

2852

True

2853

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

2854

True

2855

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

2856

True

2857

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

2858

True

2859

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

2860

True

2861

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

2862

True

2863

>>> del timedelta

2123

2124

>>> rfc3339_duration_to_delta("P7D")

2125

datetime.timedelta(7)

2126

>>> rfc3339_duration_to_delta("PT60S")

2127

datetime.timedelta(0, 60)

2128

>>> rfc3339_duration_to_delta("PT60M")

2129

datetime.timedelta(0, 3600)

2130

>>> rfc3339_duration_to_delta("PT24H")

2131

datetime.timedelta(1)

2132

>>> rfc3339_duration_to_delta("P1W")

2133

datetime.timedelta(7)

2134

>>> rfc3339_duration_to_delta("PT5M30S")

2135

datetime.timedelta(0, 330)

2136

>>> rfc3339_duration_to_delta("P1DT3M20S")

2137

datetime.timedelta(1, 200)

2864

2138

"""

2865

2139

2866

2140

# Parsing an RFC 3339 duration with regular expressions is not

2867

2141

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

2868

2142

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

2869

2143

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

2870

2144

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

2871

2145

# avoid excessive use of external libraries.

2872

2146

2873

2147

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

2874

Token = collections.namedtuple("Token", (

2875

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

2876

# a "group" containing digits

2877

"value", # datetime.timedelta or None

2878

"followers")) # Tokens valid after this token

2148

Token = collections.namedtuple("Token",

2149

("regexp", # To match token; if

2150

# "value" is not None,

2151

# must have a "group"

2152

# containing digits

2153

"value", # datetime.timedelta or

2154

# None

2155

"followers")) # Tokens valid after

2156

# this token

2879

2157

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

2880

2158

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

2881

2159

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

2882

2160

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

2883

2161

datetime.timedelta(seconds=1),

2884

frozenset((token_end, )))

2162

frozenset((token_end,)))

2885

2163

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

2886

2164

datetime.timedelta(minutes=1),

2887

2165

frozenset((token_second, token_end)))

2903

2181

frozenset((token_month, token_end)))

2904

2182

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

2905

2183

datetime.timedelta(weeks=1),

2906

frozenset((token_end, )))

2184

frozenset((token_end,)))

2907

2185

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

2908

2186

frozenset((token_year, token_month,

2909

2187

token_day, token_time,

2910

2188

token_week)))

2911

# Define starting values:

2912

# Value so far

2913

value = datetime.timedelta()

2189

# Define starting values

2190

value = datetime.timedelta() # Value so far

2914

2191

found_token = None

2915

# Following valid tokens

2916

followers = frozenset((token_duration, ))

2917

# String left to parse

2918

s = duration

2192

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

2193

s = duration # String left to parse

2919

2194

# Loop until end token is found

2920

2195

while found_token is not token_end:

2921

2196

# Search for any currently valid tokens

2937

2212

break

2938

2213

else:

2939

2214

# No currently valid tokens were found

2940

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

2941

.format(duration))

2215

raise ValueError("Invalid RFC 3339 duration")

2942

2216

# End token found

2943

2217

return value

2944

2218

2945

2219

2946

2220

def string_to_delta(interval):

2947

2221

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

2948

2949

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

2950

True

2951

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

2952

True

2953

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

2954

True

2955

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

2956

True

2957

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

2958

True

2959

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

2960

True

2222

2223

>>> string_to_delta('7d')

2224

datetime.timedelta(7)

2225

>>> string_to_delta('60s')

2226

datetime.timedelta(0, 60)

2227

>>> string_to_delta('60m')

2228

datetime.timedelta(0, 3600)

2229

>>> string_to_delta('24h')

2230

datetime.timedelta(1)

2231

>>> string_to_delta('1w')

2232

datetime.timedelta(7)

2233

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

2234

datetime.timedelta(0, 330)

2961

2235

"""

2962

2236

2963

2237

try:

2964

2238

return rfc3339_duration_to_delta(interval)

2965

2239

except ValueError:

2966

2240

pass

2967

2241

2968

2242

timevalue = datetime.timedelta(0)

2969

2243

for s in interval.split():

2970

2244

try:

2981

2255

elif suffix == "w":

2982

2256

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

2983

2257

else:

2984

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

2258

raise ValueError("Unknown suffix {!r}"

2259

.format(suffix))

2985

2260

except IndexError as e:

2986

2261

raise ValueError(*(e.args))

2987

2262

timevalue += delta

2988

2263

return timevalue

2989

2264

2990

2265

2991

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

2266

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

2992

2267

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

2993

2268

2994

2269

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

2995

2270

if os.fork():

2996

2271

sys.exit()

3003

2278

# Close all standard open file descriptors

3004

2279

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

3005

2280

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

3006

raise OSError(errno.ENODEV,

3007

"{} not a character device"

2281

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

3008

2282

.format(os.devnull))

3009

2283

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

3010

2284

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

3014

2288

3015

2289

3016

2290

def main():

3017

2291

3018

2292

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

3019

2293

# Parsing of options, both command line and config file

3020

2294

3021

2295

parser = argparse.ArgumentParser()

3022

2296

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

3023

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

2297

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

3024

2298

help="show version number and exit")

3025

2299

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

3026

2300

help="Bind to interface IF")

3062

2336

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

3063

2337

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

3064

2338

default=None)

3065

2339

3066

2340

options = parser.parse_args()

3067

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

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

2346

3068

2347

# Default values for config file for server-global settings

3069

if gnutls.has_rawpk:

3070

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

3071

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

3072

else:

3073

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

3074

":+SIGN-DSA-SHA256")

3075

server_defaults = {"interface": "",

3076

"address": "",

3077

"port": "",

3078

"debug": "False",

3079

"priority": priority,

3080

"servicename": "Mandos",

3081

"use_dbus": "True",

3082

"use_ipv6": "True",

3083

"debuglevel": "",

3084

"restore": "True",

3085

"socket": "",

3086

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

3087

"foreground": "False",

3088

"zeroconf": "True",

3089

}

3090

del priority

3091

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

"zeroconf": "True",

2363

}

2364

3092

2365

# Parse config file for server-global settings

3093

server_config = configparser.ConfigParser(server_defaults)

2366

server_config = configparser.SafeConfigParser(server_defaults)

3094

2367

del server_defaults

3095

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

3096

# Convert the ConfigParser object to a dict

2368

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

2369

"mandos.conf"))

2370

# Convert the SafeConfigParser object to a dict

3097

2371

server_settings = server_config.defaults()

3098

2372

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

3099

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

3100

"foreground", "zeroconf"):

2373

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

3101

2374

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

3102

2375

option)

3103

2376

if server_settings["port"]:

3109

2382

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

3110

2383

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

3111

2384

# happen with a supplied network socket.

3112

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

2385

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

3113

2386

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

3114

2387

["socket"])

3115

os.set_inheritable(server_settings["socket"], False)

3116

2388

del server_config

3117

2389

3118

2390

# Override the settings from the config file with command line

3119

2391

# options, if set.

3120

2392

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

3121

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

3122

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

3123

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

2393

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

2394

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

2395

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

3124

2396

value = getattr(options, option)

3125

2397

if value is not None:

3126

2398

server_settings[option] = value

3138

2410

if server_settings["debug"]:

3139

2411

server_settings["foreground"] = True

3140

2412

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

3141

2413

3142

2414

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

3143

3144

if (not server_settings["zeroconf"]

3145

and not (server_settings["port"]

3146

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

3147

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

3148

2415

2416

if (not server_settings["zeroconf"] and

2417

not (server_settings["port"]

2418

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

2419

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

2420

" Zeroconf")

2421

3149

2422

# For convenience

3150

2423

debug = server_settings["debug"]

3151

2424

debuglevel = server_settings["debuglevel"]

3155

2428

stored_state_file)

3156

2429

foreground = server_settings["foreground"]

3157

2430

zeroconf = server_settings["zeroconf"]

3158

2431

3159

2432

if debug:

3160

2433

initlogger(debug, logging.DEBUG)

3161

2434

else:

3164

2437

else:

3165

2438

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

3166

2439

initlogger(debug, level)

3167

2440

3168

2441

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

3169

syslogger.setFormatter(

3170

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

3171

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

3172

server_settings["servicename"])))

3173

2442

syslogger.setFormatter(logging.Formatter

2443

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

2444

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

2445

.format(server_settings

2446

["servicename"])))

2447

3174

2448

# Parse config file with clients

3175

client_config = configparser.ConfigParser(Client.client_defaults)

2449

client_config = configparser.SafeConfigParser(Client

2450

.client_defaults)

3176

2451

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

3177

2452

"clients.conf"))

3178

2453

3179

2454

global mandos_dbus_service

3180

2455

mandos_dbus_service = None

3181

2456

3182

2457

socketfd = None

3183

2458

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

3184

2459

socketfd = server_settings["socket"]

3185

tcp_server = MandosServer(

3186

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

3187

ClientHandler,

3188

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

3189

use_ipv6=use_ipv6,

3190

gnutls_priority=server_settings["priority"],

3191

use_dbus=use_dbus,

3192

socketfd=socketfd)

2460

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

2461

server_settings["port"]),

2462

ClientHandler,

2463

interface=(server_settings["interface"]

2464

or None),

2465

use_ipv6=use_ipv6,

2466

gnutls_priority=

2467

server_settings["priority"],

2468

use_dbus=use_dbus,

2469

socketfd=socketfd)

3193

2470

if not foreground:

3194

2471

pidfilename = "/run/mandos.pid"

3195

2472

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

3196

2473

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

3197

2474

pidfile = None

3198

2475

try:

3199

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

2476

pidfile = open(pidfilename, "w")

3200

2477

except IOError as e:

3201

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

3202

exc_info=e)

3203

3204

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

3205

("mandos", "mandos"),

3206

("nobody", "nogroup")):

2478

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

2479

exc_info=e)

2480

2481

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

3207

2482

try:

3208

2483

uid = pwd.getpwnam(name).pw_uid

3209

gid = pwd.getpwnam(group).pw_gid

2484

gid = pwd.getpwnam(name).pw_gid

3210

2485

break

3211

2486

except KeyError:

3212

2487

continue

3216

2491

try:

3217

2492

os.setgid(gid)

3218

2493

os.setuid(uid)

3219

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

3220

2494

except OSError as error:

3221

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

3222

os.strerror(error.errno))

3223

2495

if error.errno != errno.EPERM:

3224

2496

raise

3225

2497

3226

2498

if debug:

3227

2499

# Enable all possible GnuTLS debugging

3228

2500

3229

2501

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

3230

2502

# - GnuTLS manual

3231

gnutls.global_set_log_level(11)

3232

3233

@gnutls.log_func

2503

gnutls.library.functions.gnutls_global_set_log_level(11)

2504

2505

@gnutls.library.types.gnutls_log_func

3234

2506

def debug_gnutls(level, string):

3235

log.debug("GnuTLS: %s",

3236

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

3237

3238

gnutls.global_set_log_function(debug_gnutls)

3239

2507

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

2508

2509

(gnutls.library.functions

2510

.gnutls_global_set_log_function(debug_gnutls))

2511

3240

2512

# Redirect stdin so all checkers get /dev/null

3241

2513

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

3242

2514

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

3243

2515

if null > 2:

3244

2516

os.close(null)

3245

2517

3246

2518

# Need to fork before connecting to D-Bus

3247

2519

if not foreground:

3248

2520

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

3249

2521

daemon()

3250

3251

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

3252

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

3253

# need to inform GLib that threads will be used.

3254

GLib.threads_init()

3255

2522

2523

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

2524

# need to inform gobject that threads will be used.

2525

gobject.threads_init()

2526

3256

2527

global main_loop

3257

2528

# From the Avahi example code

3258

2529

DBusGMainLoop(set_as_default=True)

3259

main_loop = GLib.MainLoop()

3260

if use_dbus or zeroconf:

3261

bus = dbus.SystemBus()

2530

main_loop = gobject.MainLoop()

2531

bus = dbus.SystemBus()

3262

2532

# End of Avahi example code

3263

2533

if use_dbus:

3264

2534

try:

3265

2535

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

3266

bus,

3267

do_not_queue=True)

3268

old_bus_name = dbus.service.BusName(

3269

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

3270

do_not_queue=True)

3271

except dbus.exceptions.DBusException as e:

3272

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

2536

bus, do_not_queue=True)

2537

old_bus_name = (dbus.service.BusName

2538

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

2539

do_not_queue=True))

2540

except dbus.exceptions.NameExistsException as e:

2541

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

3273

2542

use_dbus = False

3274

2543

server_settings["use_dbus"] = False

3275

2544

tcp_server.use_dbus = False

3276

2545

if zeroconf:

3277

2546

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3278

service = AvahiServiceToSyslog(

3279

name=server_settings["servicename"],

3280

servicetype="_mandos._tcp",

3281

protocol=protocol,

3282

bus=bus)

2547

service = AvahiServiceToSyslog(name =

2548

server_settings["servicename"],

2549

servicetype = "_mandos._tcp",

2550

protocol = protocol, bus = bus)

3283

2551

if server_settings["interface"]:

3284

service.interface = if_nametoindex(

3285

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

3286

2552

service.interface = (if_nametoindex

2553

(server_settings["interface"]

2554

.encode("utf-8")))

2555

3287

2556

global multiprocessing_manager

3288

2557

multiprocessing_manager = multiprocessing.Manager()

3289

2558

3290

2559

client_class = Client

3291

2560

if use_dbus:

3292

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

3293

2561

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

2562

3294

2563

client_settings = Client.config_parser(client_config)

3295

2564

old_client_settings = {}

3296

2565

clients_data = {}

3297

2566

3298

2567

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

3299

2568

global wnull

3300

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

2569

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

3301

2570

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

3302

2571

# mode

3303

2572

if debug or not foreground:

3304

2573

wnull.close()

3305

2574

3306

2575

# Get client data and settings from last running state.

3307

2576

if server_settings["restore"]:

3308

2577

try:

3309

2578

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

3310

if sys.version_info.major == 2:

3311

clients_data, old_client_settings = pickle.load(

3312

stored_state)

3313

else:

3314

bytes_clients_data, bytes_old_client_settings = (

3315

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

3316

# Fix bytes to strings

3317

# clients_data

3318

# .keys()

3319

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

3320

if isinstance(key, bytes)

3321

else key): value

3322

for key, value in

3323

bytes_clients_data.items()}

3324

del bytes_clients_data

3325

for key in clients_data:

3326

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

3327

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

3328

for k, v in

3329

clients_data[key].items()}

3330

clients_data[key] = value

3331

# .client_structure

3332

value["client_structure"] = [

3333

(s.decode("utf-8")

3334

if isinstance(s, bytes)

3335

else s) for s in

3336

value["client_structure"]]

3337

# .name, .host, and .checker_command

3338

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

3339

if isinstance(value[k], bytes):

3340

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

3341

if "key_id" not in value:

3342

value["key_id"] = ""

3343

elif "fingerprint" not in value:

3344

value["fingerprint"] = ""

3345

# old_client_settings

3346

# .keys()

3347

old_client_settings = {

3348

(key.decode("utf-8")

3349

if isinstance(key, bytes)

3350

else key): value

3351

for key, value in

3352

bytes_old_client_settings.items()}

3353

del bytes_old_client_settings

3354

# .host and .checker_command

3355

for value in old_client_settings.values():

3356

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

3357

if isinstance(value[attribute], bytes):

3358

value[attribute] = (value[attribute]

3359

.decode("utf-8"))

2579

clients_data, old_client_settings = (pickle.load

2580

(stored_state))

3360

2581

os.remove(stored_state_path)

3361

2582

except IOError as e:

3362

2583

if e.errno == errno.ENOENT:

3363

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

3364

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

2584

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

2585

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

3365

2586

else:

3366

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

3367

exc_info=e)

2587

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

2588

exc_info=e)

3368

2589

raise

3369

2590

except EOFError as e:

3370

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

3371

exc_info=e)

3372

2591

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

2592

"EOFError:", exc_info=e)

2593

3373

2594

with PGPEngine() as pgp:

3374

2595

for client_name, client in clients_data.items():

3375

2596

# Skip removed clients

3376

2597

if client_name not in client_settings:

3377

2598

continue

3378

2599

3379

2600

# Decide which value to use after restoring saved state.

3380

2601

# We have three different values: Old config file,

3381

2602

# new config file, and saved state.

3386

2607

# For each value in new config, check if it

3387

2608

# differs from the old config value (Except for

3388

2609

# the "secret" attribute)

3389

if (name != "secret"

3390

and (value !=

3391

old_client_settings[client_name][name])):

2610

if (name != "secret" and

2611

value != old_client_settings[client_name]

2612

[name]):

3392

2613

client[name] = value

3393

2614

except KeyError:

3394

2615

pass

3395

2616

3396

2617

# Clients who has passed its expire date can still be

3397

# enabled if its last checker was successful. A Client

2618

# enabled if its last checker was successful. Clients

3398

2619

# whose checker succeeded before we stored its state is

3399

2620

# assumed to have successfully run all checkers during

3400

2621

# downtime.

3401

2622

if client["enabled"]:

3402

2623

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

3403

2624

if not client["last_checked_ok"]:

3404

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

3405

" never performed a successful"

3406

" checker", client_name)

2625

logger.warning(

2626

"disabling client {} - Client never "

2627

"performed a successful checker"

2628

.format(client_name))

3407

2629

client["enabled"] = False

3408

2630

elif client["last_checker_status"] != 0:

3409

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

3410

" last checker failed with error"

3411

" code %s", client_name,

3412

client["last_checker_status"])

2631

logger.warning(

2632

"disabling client {} - Client last"

2633

" checker failed with error code {}"

2634

.format(client_name,

2635

client["last_checker_status"]))

3413

2636

client["enabled"] = False

3414

2637

else:

3415

client["expires"] = (

3416

datetime.datetime.utcnow()

3417

+ client["timeout"])

3418

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

3419

" enabled", client_name)

2638

client["expires"] = (datetime.datetime

2639

.utcnow()

2640

+ client["timeout"])

2641

logger.debug("Last checker succeeded,"

2642

" keeping {} enabled"

2643

.format(client_name))

3420

2644

try:

3421

client["secret"] = pgp.decrypt(

3422

client["encrypted_secret"],

3423

client_settings[client_name]["secret"])

2645

client["secret"] = (

2646

pgp.decrypt(client["encrypted_secret"],

2647

client_settings[client_name]

2648

["secret"]))

3424

2649

except PGPError:

3425

2650

# If decryption fails, we use secret from new settings

3426

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

3427

client_name)

3428

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

3429

["secret"])

3430

2651

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

2652

.format(client_name))

2653

client["secret"] = (

2654

client_settings[client_name]["secret"])

2655

3431

2656

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

3432

2657

for client_name in (set(old_client_settings)

3433

2658

- set(client_settings)):

3435

2660

for client_name in (set(client_settings)

3436

2661

- set(old_client_settings)):

3437

2662

clients_data[client_name] = client_settings[client_name]

3438

2663

3439

2664

# Create all client objects

3440

2665

for client_name, client in clients_data.items():

3441

2666

tcp_server.clients[client_name] = client_class(

3442

name=client_name,

3443

settings=client,

3444

server_settings=server_settings)

3445

2667

name = client_name, settings = client,

2668

server_settings = server_settings)

2669

3446

2670

if not tcp_server.clients:

3447

log.warning("No clients defined")

3448

2671

logger.warning("No clients defined")

2672

3449

2673

if not foreground:

3450

2674

if pidfile is not None:

3451

pid = os.getpid()

3452

2675

try:

3453

2676

with pidfile:

3454

print(pid, file=pidfile)

2677

pid = os.getpid()

2678

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

3455

2679

except IOError:

3456

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

3457

pidfilename, pid)

2680

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

2681

pidfilename, pid)

3458

2682

del pidfile

3459

2683

del pidfilename

3460

3461

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

3462

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3463

lambda: main_loop.quit() and False)

3464

2684

2685

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

2686

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

2687

3465

2688

if use_dbus:

3466

3467

@alternate_dbus_interfaces(

3468

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

3469

class MandosDBusService(DBusObjectWithObjectManager):

2689

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

2690

"se.bsnet.fukt.Mandos"})

2691

class MandosDBusService(DBusObjectWithProperties):

3470

2692

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

3471

3472

2693

def __init__(self):

3473

2694

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

3474

3475

2695

_interface = "se.recompile.Mandos"

3476

2696

2697

@dbus_interface_annotations(_interface)

2698

def _foo(self):

2699

return { "org.freedesktop.DBus.Property"

2700

".EmitsChangedSignal":

2701

"false"}

2702

3477

2703

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

3478

2704

def ClientAdded(self, objpath):

3479

2705

"D-Bus signal"

3480

2706

pass

3481

2707

3482

2708

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

3483

def ClientNotFound(self, key_id, address):

2709

def ClientNotFound(self, fingerprint, address):

3484

2710

"D-Bus signal"

3485

2711

pass

3486

3487

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

3488

"true"})

2712

3489

2713

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

3490

2714

def ClientRemoved(self, objpath, name):

3491

2715

"D-Bus signal"

3492

2716

pass

3493

3494

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

3495

"true"})

2717

3496

2718

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

3497

2719

def GetAllClients(self):

3498

2720

"D-Bus method"

3499

return dbus.Array(c.dbus_object_path for c in

3500

tcp_server.clients.values())

3501

3502

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

3503

"true"})

2721

return dbus.Array(c.dbus_object_path

2722

for c in

2723

tcp_server.clients.itervalues())

2724

3504

2725

@dbus.service.method(_interface,

3505

2726

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

3506

2727

def GetAllClientsWithProperties(self):

3507

2728

"D-Bus method"

3508

2729

return dbus.Dictionary(

3509

{c.dbus_object_path: c.GetAll(

3510

"se.recompile.Mandos.Client")

3511

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

2730

{ c.dbus_object_path: c.GetAll("")

2731

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

3512

2732

signature="oa{sv}")

3513

2733

3514

2734

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

3515

2735

def RemoveClient(self, object_path):

3516

2736

"D-Bus method"

3517

for c in tcp_server.clients.values():

2737

for c in tcp_server.clients.itervalues():

3518

2738

if c.dbus_object_path == object_path:

3519

2739

del tcp_server.clients[c.name]

3520

2740

c.remove_from_connection()

3521

# Don't signal the disabling

2741

# Don't signal anything except ClientRemoved

3522

2742

c.disable(quiet=True)

3523

# Emit D-Bus signal for removal

3524

self.client_removed_signal(c)

2743

# Emit D-Bus signal

2744

self.ClientRemoved(object_path, c.name)

3525

2745

return

3526

2746

raise KeyError(object_path)

3527

2747

3528

2748

del _interface

3529

3530

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3531

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

3532

def GetManagedObjects(self):

3533

"""D-Bus method"""

3534

return dbus.Dictionary(

3535

{client.dbus_object_path:

3536

dbus.Dictionary(

3537

{interface: client.GetAll(interface)

3538

for interface in

3539

client._get_all_interface_names()})

3540

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

3541

3542

def client_added_signal(self, client):

3543

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

3544

if use_dbus:

3545

# New standard signal

3546

self.InterfacesAdded(

3547

client.dbus_object_path,

3548

dbus.Dictionary(

3549

{interface: client.GetAll(interface)

3550

for interface in

3551

client._get_all_interface_names()}))

3552

# Old signal

3553

self.ClientAdded(client.dbus_object_path)

3554

3555

def client_removed_signal(self, client):

3556

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

3557

if use_dbus:

3558

# New standard signal

3559

self.InterfacesRemoved(

3560

client.dbus_object_path,

3561

client._get_all_interface_names())

3562

# Old signal

3563

self.ClientRemoved(client.dbus_object_path,

3564

client.name)

3565

2749

3566

2750

mandos_dbus_service = MandosDBusService()

3567

3568

# Save modules to variables to exempt the modules from being

3569

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

3570

mp = multiprocessing

3571

wn = wnull

3572

2751

3573

2752

def cleanup():

3574

2753

"Cleanup function; run on exit"

3575

2754

if zeroconf:

3576

2755

service.cleanup()

3577

3578

mp.active_children()

3579

wn.close()

2756

2757

multiprocessing.active_children()

2758

wnull.close()

3580

2759

if not (tcp_server.clients or client_settings):

3581

2760

return

3582

2761

3583

2762

# Store client before exiting. Secrets are encrypted with key

3584

2763

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

3585

2764

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

3586

2765

clients = {}

3587

2766

with PGPEngine() as pgp:

3588

for client in tcp_server.clients.values():

2767

for client in tcp_server.clients.itervalues():

3589

2768

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

3590

2769

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

3591

2770

key)

3592

2771

client_dict = {}

3593

2772

3594

2773

# A list of attributes that can not be pickled

3595

2774

# + secret.

3596

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

3597

"checker", "server_settings"}

3598

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

3599

.Object):

2775

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

2776

"checker", "server_settings" }

2777

for name, typ in (inspect.getmembers

2778

(dbus.service.Object)):

3600

2779

exclude.add(name)

3601

2780

3602

2781

client_dict["encrypted_secret"] = (client

3603

2782

.encrypted_secret)

3604

2783

for attr in client.client_structure:

3605

2784

if attr not in exclude:

3606

2785

client_dict[attr] = getattr(client, attr)

3607

2786

3608

2787

clients[client.name] = client_dict

3609

2788

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

3610

2789

3611

2790

try:

3612

with tempfile.NamedTemporaryFile(

3613

mode="wb",

3614

suffix=".pickle",

3615

prefix="clients-",

3616

dir=os.path.dirname(stored_state_path),

3617

delete=False) as stored_state:

3618

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

3619

protocol=2)

3620

tempname = stored_state.name

2791

with (tempfile.NamedTemporaryFile

2792

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

2793

dir=os.path.dirname(stored_state_path),

2794

delete=False)) as stored_state:

2795

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

2796

tempname=stored_state.name

3621

2797

os.rename(tempname, stored_state_path)

3622

2798

except (IOError, OSError) as e:

3623

2799

if not debug:

3626

2802

except NameError:

3627

2803

pass

3628

2804

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

3629

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

3630

os.strerror(e.errno))

2805

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

2806

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

3631

2807

else:

3632

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

3633

exc_info=e)

2808

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

2809

exc_info=e)

3634

2810

raise

3635

2811

3636

2812

# Delete all clients, and settings from config

3637

2813

while tcp_server.clients:

3638

2814

name, client = tcp_server.clients.popitem()

3639

2815

if use_dbus:

3640

2816

client.remove_from_connection()

3641

# Don't signal the disabling

2817

# Don't signal anything except ClientRemoved

3642

2818

client.disable(quiet=True)

3643

# Emit D-Bus signal for removal

3644

2819

if use_dbus:

3645

mandos_dbus_service.client_removed_signal(client)

2820

# Emit D-Bus signal

2821

mandos_dbus_service.ClientRemoved(client

2822

.dbus_object_path,

2823

client.name)

3646

2824

client_settings.clear()

3647

2825

3648

2826

atexit.register(cleanup)

3649

3650

for client in tcp_server.clients.values():

2827

2828

for client in tcp_server.clients.itervalues():

3651

2829

if use_dbus:

3652

# Emit D-Bus signal for adding

3653

mandos_dbus_service.client_added_signal(client)

2830

# Emit D-Bus signal

2831

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3654

2832

# Need to initiate checking of clients

3655

2833

if client.enabled:

3656

client.init_checker(randomize_start=True)

3657

2834

client.init_checker()

2835

3658

2836

tcp_server.enable()

3659

2837

tcp_server.server_activate()

3660

2838

3661

2839

# Find out what port we got

3662

2840

if zeroconf:

3663

2841

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

3664

2842

if use_ipv6:

3665

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

3666

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

2843

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

2844

" flowinfo %d, scope_id %d",

2845

*tcp_server.socket.getsockname())

3667

2846

else: # IPv4

3668

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

3669

*tcp_server.socket.getsockname())

3670

3671

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

3672

2847

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

2848

*tcp_server.socket.getsockname())

2849

2850

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

2851

3673

2852

try:

3674

2853

if zeroconf:

3675

2854

# From the Avahi example code

3676

2855

try:

3677

2856

service.activate()

3678

2857

except dbus.exceptions.DBusException as error:

3679

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

2858

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

3680

2859

cleanup()

3681

2860

sys.exit(1)

3682

2861

# End of Avahi example code

3683

3684

GLib.io_add_watch(

3685

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

3686

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3687

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

3688

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

3689

3690

log.debug("Starting main loop")

2862

2863

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

2864

lambda *args, **kwargs:

2865

(tcp_server.handle_request

2866

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

2867

2868

logger.debug("Starting main loop")

3691

2869

main_loop.run()

3692

2870

except AvahiError as error:

3693

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

2871

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

3694

2872

cleanup()

3695

2873

sys.exit(1)

3696

2874

except KeyboardInterrupt:

3697

2875

if debug:

3698

2876

print("", file=sys.stderr)

3699

log.debug("Server received KeyboardInterrupt")

3700

log.debug("Server exiting")

2877

logger.debug("Server received KeyboardInterrupt")

2878

logger.debug("Server exiting")

3701

2879

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

3702

2880

cleanup()

3703

2881

3704

3705

def parse_test_args():

3706

# type: () -> argparse.Namespace

3707

parser = argparse.ArgumentParser(add_help=False)

3708

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

3709

parser.add_argument("--prefix", )

3710

args, unknown_args = parser.parse_known_args()

3711

if args.check:

3712

# Remove test options from sys.argv

3713

sys.argv[1:] = unknown_args

3714

return args

3715

3716

# Add all tests from doctest strings

3717

def load_tests(loader, tests, none):

3718

import doctest

3719

tests.addTests(doctest.DocTestSuite())

3720

return tests

3721

3722

if __name__ == "__main__":

3723

options = parse_test_args()

3724

try:

3725

if options.check:

3726

extra_test_prefix = options.prefix

3727

if extra_test_prefix is not None:

3728

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

3729

.result.wasSuccessful()):

3730

sys.exit(1)

3731

class ExtraTestLoader(unittest.TestLoader):

3732

testMethodPrefix = extra_test_prefix

3733

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

3734

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

3735

else:

3736

unittest.main(argv=[""])

3737

else:

3738

main()

3739

finally:

3740

logging.shutdown()

3741

3742

# Local Variables:

3743

# run-tests:

3744

# (lambda (&optional extra)

3745

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

3746

# extra))

3747

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

3748

# (funcall remove-test-window)

3749

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

3750

# run-tests-in-test-buffer:

3751

# (lambda (dir &optional extra)

3752

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

3753

# (setq buffer-read-only nil

3754

# default-directory dir)

3755

# (erase-buffer)

3756

# (compilation-mode))

3757

# (let ((process-result

3758

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

3759

# (process-file-shell-command

3760

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

3761

# (and (numberp process-result)

3762

# (= process-result 0))))

3763

# get-command-line:

3764

# (lambda (&optional extra)

3765

# (let ((quoted-script

3766

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

3767

# (format

3768

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

3769

# quoted-script)))

3770

# get-script-name:

3771

# (lambda ()

3772

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

3773

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

3774

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

3775

# (buffer-file-name))))

3776

# remove-test-window:

3777

# (lambda ()

3778

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

3779

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

3780

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

3781

# (lambda ()

3782

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

3783

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

3784

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

3785

# (display-buffer-overriding-action

3786

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

3787

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

3788

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

3789

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

3790

# eval:

3791

# (progn

3792

# (let* ((run-extra-tests (lambda () (interactive)

3793

# (funcall run-tests t)))

3794

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3795

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3796

# (setq minor-mode-overriding-map-alist

3797

# (cons `(run-tests . ,outer-keymap)

3798

# minor-mode-overriding-map-alist)))

3799

# (add-hook 'after-save-hook run-tests 90 t))

3800

# End:

2882

if __name__ == '__main__':

2883

main()