/mandos/release : revision 237.25.5

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

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

277

407

278

def rename(self, remove=True):

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

416

287

self.rename_count += 1

417

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

418

self.name)

288

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

289

self.name)

419

290

if remove:

420

291

self.remove()

421

292

try:

423

294

except dbus.exceptions.DBusException as error:

424

295

if (error.get_dbus_name()

425

296

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

426

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

297

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

427

298

return self.rename(remove=False)

428

299

else:

429

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

300

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

430

301

self.cleanup()

431

302

os._exit(1)

432

303

433

304

def remove(self):

434

305

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

435

306

if self.entry_group_state_changed_match is not None:

437

308

self.entry_group_state_changed_match = None

438

309

if self.group is not None:

439

310

self.group.Reset()

440

311

441

312

def add(self):

442

313

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

443

314

self.remove()

448

319

avahi.DBUS_INTERFACE_ENTRY_GROUP)

449

320

self.entry_group_state_changed_match = (

450

321

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)

322

'StateChanged', self.entry_group_state_changed))

323

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

324

self.name, self.type)

454

325

self.group.AddService(

455

326

self.interface,

456

327

self.protocol,

460

331

dbus.UInt16(self.port),

461

332

avahi.string_array_to_txt_array(self.TXT))

462

333

self.group.Commit()

463

334

464

335

def entry_group_state_changed(self, state, error):

465

336

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

466

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

467

337

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

338

468

339

if state == avahi.ENTRY_GROUP_ESTABLISHED:

469

log.debug("Zeroconf service established.")

340

logger.debug("Zeroconf service established.")

470

341

elif state == avahi.ENTRY_GROUP_COLLISION:

471

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

342

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

472

343

self.rename()

473

344

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

345

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

346

str(error))

347

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

348

.format(error))

349

478

350

def cleanup(self):

479

351

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

480

352

if self.group is not None:

485

357

pass

486

358

self.group = None

487

359

self.remove()

488

360

489

361

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

490

362

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

}

363

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

364

bad_states = { avahi.SERVER_INVALID:

365

"Zeroconf server invalid",

366

avahi.SERVER_REGISTERING: None,

367

avahi.SERVER_COLLISION:

368

"Zeroconf server name collision",

369

avahi.SERVER_FAILURE:

370

"Zeroconf server failure" }

498

371

if state in bad_states:

499

372

if bad_states[state] is not None:

500

373

if error is None:

501

log.error(bad_states[state])

374

logger.error(bad_states[state])

502

375

else:

503

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

376

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

504

377

self.cleanup()

505

378

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)

379

self.add()

517

380

else:

518

381

if error is None:

519

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

382

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

520

383

else:

521

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

522

384

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

385

523

386

def activate(self):

524

387

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

525

388

if self.server is None:

529

392

follow_name_owner_changes=True),

530

393

avahi.DBUS_INTERFACE_SERVER)

531

394

self.server.connect_to_signal("StateChanged",

532

self.server_state_changed)

395

self.server_state_changed)

533

396

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

534

397

535

398

536

399

class AvahiServiceToSyslog(AvahiService):

537

400

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

538

401

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

402

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

403

syslogger.setFormatter(logging.Formatter

404

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

405

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

406

.format(self.name)))

544

407

return ret

545

408

546

409

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:

410

class Client(object):

888

411

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

889

412

890

413

Attributes:

891

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

414

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

892

415

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

893

416

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

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

898

421

checker_command: string; External command which is run to check

899

422

if client lives. %() expansions are done at

900

423

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

901

424

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

902

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

903

426

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

904

427

client_structure: Object describing what attributes a client has

905

428

and is used for storing the client at exit

906

429

current_checker_command: string; current running checker_command

907

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

908

431

enabled: bool()

909

432

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

433

uniquely identify the client

913

434

host: string; available for use by the checker command

914

435

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

915

436

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

917

438

last_checker_status: integer between 0 and 255 reflecting exit

918

439

status of last checker. -1 reflects crashed

919

440

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

441

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

923

442

924

443

D-Bus identifiers

931

450

disabled, or None

932

451

server_settings: The server_settings dict from main()

933

452

"""

934

453

935

454

runtime_expansions = ("approval_delay", "approval_duration",

936

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

455

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

937

456

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

938

457

"last_approval_request", "last_checked_ok",

939

458

"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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

952

470

@staticmethod

953

471

def config_parser(config):

954

472

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

961

479

for client_name in config.sections():

962

480

section = dict(config.items(client_name))

963

481

client = settings[client_name] = {}

964

482

965

483

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

966

484

# Reformat values from string types to Python types

967

485

client["approved_by_default"] = config.getboolean(

968

486

client_name, "approved_by_default")

969

487

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

970

488

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

489

490

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

979

491

.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

492

if "secret" in section:

986

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

987

.encode("utf-8"),

988

"base64")

493

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

989

494

elif "secfile" in section:

990

495

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

991

496

(section["secfile"])),

1006

511

client["last_approval_request"] = None

1007

512

client["last_checked_ok"] = None

1008

513

client["last_checker_status"] = -2

1009

514

1010

515

return settings

1011

1012

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

516

517

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

1013

518

self.name = name

1014

519

if server_settings is None:

1015

520

server_settings = {}

1017

522

# adding all client settings

1018

523

for setting, value in settings.items():

1019

524

setattr(self, setting, value)

1020

525

1021

526

if self.enabled:

1022

527

if not hasattr(self, "last_enabled"):

1023

528

self.last_enabled = datetime.datetime.utcnow()

1027

532

else:

1028

533

self.last_enabled = None

1029

534

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)

535

536

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

537

# Uppercase and remove spaces from fingerprint for later

538

# comparison purposes with return value from the fingerprint()

539

# function

540

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

1034

541

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

1035

542

datetime.datetime.utcnow())

1036

543

1037

544

# attributes specific for this server instance

1038

545

self.checker = None

1039

546

self.checker_initiator_tag = None

1042

549

self.current_checker_command = None

1043

550

self.approved = None

1044

551

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

552

self.changedstate = (multiprocessing_manager

553

.Condition(multiprocessing_manager

554

.Lock()))

555

self.client_structure = [attr for attr in

556

self.__dict__.iterkeys()

1049

557

if not attr.startswith("_")]

1050

558

self.client_structure.append("client_structure")

1051

1052

for name, t in inspect.getmembers(

1053

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

559

560

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

561

lambda obj:

562

isinstance(obj,

563

property)):

1054

564

if not name.startswith("_"):

1055

565

self.client_structure.append(name)

1056

566

1057

567

# Send notice to process children that client state has changed

1058

568

def send_changedstate(self):

1059

569

with self.changedstate:

1060

570

self.changedstate.notify_all()

1061

571

1062

572

def enable(self):

1063

573

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

1064

574

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

1065

575

# Already enabled

1066

576

return

577

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

1067

578

self.enabled = True

1068

579

self.last_enabled = datetime.datetime.utcnow()

1069

580

self.init_checker()

1070

581

self.send_changedstate()

1071

582

1072

583

def disable(self, quiet=True):

1073

584

"""Disable this client."""

1074

585

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

1075

586

return False

1076

587

if not quiet:

1077

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

588

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

1078

589

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

1079

GLib.source_remove(self.disable_initiator_tag)

590

gobject.source_remove(self.disable_initiator_tag)

1080

591

self.disable_initiator_tag = None

1081

592

self.expires = None

1082

593

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

1083

GLib.source_remove(self.checker_initiator_tag)

594

gobject.source_remove(self.checker_initiator_tag)

1084

595

self.checker_initiator_tag = None

1085

596

self.stop_checker()

1086

597

self.enabled = False

1087

598

if not quiet:

1088

599

self.send_changedstate()

1089

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

600

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

1090

601

return False

1091

602

1092

603

def __del__(self):

1093

604

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.

605

606

def init_checker(self):

607

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

608

# and every interval from then on.

1100

609

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

610

gobject.source_remove(self.checker_initiator_tag)

611

self.checker_initiator_tag = (gobject.timeout_add

612

(int(self.interval

613

.total_seconds() * 1000),

614

self.start_checker))

615

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

1119

616

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

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(int(self.timeout

620

.total_seconds() * 1000),

621

self.disable))

622

# Also start a new checker *right now*.

623

self.start_checker()

624

625

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

1127

626

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

627

self.checker_callback_tag = None

1134

628

self.checker = None

1135

1136

if returncode >= 0:

1137

self.last_checker_status = returncode

1138

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1139

631

if self.last_checker_status == 0:

1140

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

632

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

633

vars(self))

1141

634

self.checked_ok()

1142

635

else:

1143

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

636

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

637

vars(self))

1144

638

else:

1145

639

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

640

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

641

vars(self))

642

1150

643

def checked_ok(self):

1151

644

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

1152

645

self.last_checked_ok = datetime.datetime.utcnow()

1153

646

self.last_checker_status = 0

1154

self.last_checker_signal = None

1155

647

self.bump_timeout()

1156

648

1157

649

def bump_timeout(self, timeout=None):

1158

650

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

1159

651

if timeout is None:

1160

652

timeout = self.timeout

1161

653

if self.disable_initiator_tag is not None:

1162

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1163

655

self.disable_initiator_tag = None

1164

656

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

1165

self.disable_initiator_tag = GLib.timeout_add(

1166

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(int(timeout.total_seconds()

659

* 1000), self.disable))

1167

660

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

1168

661

1169

662

def need_approval(self):

1170

663

self.last_approval_request = datetime.datetime.utcnow()

1171

1172

def start_checker(self, start_was_randomized=False):

664

665

def start_checker(self):

1173

666

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

1174

667

1175

668

If a checker already exists, leave it running and do

1176

669

nothing."""

1177

670

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

1182

675

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

1183

676

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

1184

677

# 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

678

679

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

680

try:

681

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

682

except AttributeError:

683

pass

684

except OSError as error:

685

if error.errno != errno.ECHILD:

686

raise

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1190

693

# Start a new checker if needed

1191

694

if self.checker is None:

1192

695

# Escape attributes for the shell

1193

escaped_attrs = {

1194

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

1195

for attr in self.runtime_expansions}

696

escaped_attrs = { attr:

697

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

698

for attr in self.runtime_expansions }

1196

699

try:

1197

700

command = self.checker_command % escaped_attrs

1198

701

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

702

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1202

705

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

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

# The exception is when not debugging but nevertheless

714

# running in the foreground; use the previously

715

# created wnull.

716

popen_args = {}

717

if (not self.server_settings["debug"]

718

and self.server_settings["foreground"]):

719

popen_args.update({"stdout": wnull,

720

"stderr": wnull })

721

self.checker = subprocess.Popen(command,

722

close_fds=True,

723

shell=True, cwd="/",

724

**popen_args)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

return True

729

self.checker_callback_tag = (gobject.child_watch_add

730

(self.checker.pid,

731

self.checker_callback,

732

data=command))

733

# The checker may have completed before the gobject

734

# watch was added. Check for this.

735

try:

736

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

737

except OSError as error:

738

if error.errno == errno.ECHILD:

739

# This should never happen

740

logger.error("Child process vanished",

741

exc_info=error)

742

return True

743

raise

744

if pid:

745

gobject.source_remove(self.checker_callback_tag)

746

self.checker_callback(pid, status, command)

747

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

1240

748

return True

1241

749

1242

750

def stop_checker(self):

1243

751

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

1244

752

if self.checker_callback_tag:

1245

GLib.source_remove(self.checker_callback_tag)

753

gobject.source_remove(self.checker_callback_tag)

1246

754

self.checker_callback_tag = None

1247

755

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

1248

756

return

1249

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

1250

self.checker.terminate()

757

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

758

try:

759

self.checker.terminate()

760

#time.sleep(0.5)

761

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

762

# self.checker.kill()

763

except OSError as error:

764

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

765

raise

1251

766

self.checker = None

1252

767

1253

768

1254

def dbus_service_property(dbus_interface,

1255

signature="v",

1256

access="readwrite",

1257

byte_arrays=False):

769

def dbus_service_property(dbus_interface, signature="v",

770

access="readwrite", byte_arrays=False):

1258

771

"""Decorators for marking methods of a DBusObjectWithProperties to

1259

772

become properties on the D-Bus.

1260

773

1261

774

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

1262

775

and with one argument by "Set".

1263

776

1264

777

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

1265

778

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

1266

779

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

1270

783

if byte_arrays and signature != "ay":

1271

784

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

1272

785

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

1273

1274

786

def decorator(func):

1275

787

func._dbus_is_property = True

1276

788

func._dbus_interface = dbus_interface

1279

791

func._dbus_name = func.__name__

1280

792

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

1281

793

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

1282

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

794

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1283

795

return func

1284

1285

796

return decorator

1286

797

1287

798

1288

799

def dbus_interface_annotations(dbus_interface):

1289

800

"""Decorator for marking functions returning interface annotations

1290

801

1291

802

Usage:

1292

803

1293

804

@dbus_interface_annotations("org.example.Interface")

1294

805

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

1295

806

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

1296

807

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

1297

808

"false"}

1298

809

"""

1299

1300

810

def decorator(func):

1301

811

func._dbus_is_interface = True

1302

812

func._dbus_interface = dbus_interface

1303

813

func._dbus_name = dbus_interface

1304

814

return func

1305

1306

815

return decorator

1307

816

1308

817

1309

818

def dbus_annotations(annotations):

1310

819

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

1311

820

Usage:

1312

821

1313

822

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

1314

823

"org.freedesktop.DBus.Property."

1315

824

"EmitsChangedSignal": "false"})

1317

826

access="r")

1318

827

def Property_dbus_property(self):

1319

828

return dbus.Boolean(False)

1320

1321

See also the DBusObjectWithAnnotations class.

1322

829

"""

1323

1324

830

def decorator(func):

1325

831

func._dbus_annotations = annotations

1326

832

return func

1327

1328

833

return decorator

1329

834

1330

835

1333

838

"""

1334

839

pass

1335

840

1336

1337

841

class DBusPropertyAccessException(DBusPropertyException):

1338

842

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

1339

843

"""

1346

850

pass

1347

851

1348

852

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.

853

class DBusObjectWithProperties(dbus.service.Object):

854

"""A D-Bus object with properties.

855

856

Classes inheriting from this can use the dbus_service_property

857

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

858

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

1354

859

"""

1355

860

1356

861

@staticmethod

1357

862

def _is_dbus_thing(thing):

1358

863

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

1359

864

1360

865

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

1361

866

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

1362

867

"""

1363

868

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

1364

869

False)

1365

870

1366

871

def _get_all_dbus_things(self, thing):

1367

872

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

1368

873

"""

1369

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

874

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

875

name),

1370

876

athing.__get__(self))

1371

877

for cls in self.__class__.__mro__

1372

878

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

879

inspect.getmembers(cls,

880

self._is_dbus_thing(thing)))

881

1446

882

def _get_dbus_property(self, interface_name, property_name):

1447

883

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

1448

884

property with the specified name and interface.

1449

885

"""

1450

for cls in self.__class__.__mro__:

1451

for name, value in inspect.getmembers(

1452

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

886

for cls in self.__class__.__mro__:

887

for name, value in (inspect.getmembers

888

(cls,

889

self._is_dbus_thing("property"))):

1453

890

if (value._dbus_name == property_name

1454

891

and value._dbus_interface == interface_name):

1455

892

return value.__get__(self)

1456

893

1457

894

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

895

raise DBusPropertyNotFound(self.dbus_object_path + ":"

896

+ interface_name + "."

897

+ property_name)

898

899

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

1472

900

out_signature="v")

1473

901

def Get(self, interface_name, property_name):

1474

902

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

1480

908

if not hasattr(value, "variant_level"):

1481

909

return value

1482

910

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

1483

911

1484

912

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

1485

913

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

1486

914

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

1495

923

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

1496

924

"'ay' signature {!r}"

1497

925

.format(prop._dbus_signature))

1498

value = dbus.ByteArray(bytes(value))

926

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

927

for byte in value))

1499

928

prop(value)

1500

1501

@dbus.service.method(dbus.PROPERTIES_IFACE,

1502

in_signature="s",

929

930

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

1503

931

out_signature="a{sv}")

1504

932

def GetAll(self, interface_name):

1505

933

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

1506

934

standard.

1507

935

1508

936

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

1509

937

"""

1510

938

properties = {}

1520

948

if not hasattr(value, "variant_level"):

1521

949

properties[name] = value

1522

950

continue

1523

properties[name] = type(value)(

1524

value, variant_level=value.variant_level + 1)

951

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

952

value.variant_level+1)

1525

953

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

1526

954

1527

955

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

1528

956

def PropertiesChanged(self, interface_name, changed_properties,

1529

957

invalidated_properties):

1531

959

standard.

1532

960

"""

1533

961

pass

1534

962

1535

963

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1536

964

out_signature="s",

1537

path_keyword="object_path",

1538

connection_keyword="connection")

965

path_keyword='object_path',

966

connection_keyword='connection')

1539

967

def Introspect(self, object_path, connection):

1540

968

"""Overloading of standard D-Bus method.

1541

969

1542

970

Inserts property tags and interface annotation tags.

1543

971

"""

1544

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1545

object_path,

1546

connection)

972

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

973

connection)

1547

974

try:

1548

975

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

1549

1550

976

def make_tag(document, name, prop):

1551

977

e = document.createElement("property")

1552

978

e.setAttribute("name", name)

1553

979

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

1554

980

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

1555

981

return e

1556

1557

982

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

1558

983

# Add property tags

1559

984

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

1562

987

if prop._dbus_interface

1563

988

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

1564

989

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)

990

# Add annotation tags

991

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

992

for tag in if_tag.getElementsByTagName(typ):

993

annots = dict()

994

for name, prop in (self.

995

_get_all_dbus_things(typ)):

996

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

997

and prop._dbus_interface

998

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

999

annots.update(getattr

1000

(prop,

1001

"_dbus_annotations",

1002

{}))

1003

for name, value in annots.items():

1004

ann_tag = document.createElement(

1005

"annotation")

1006

ann_tag.setAttribute("name", name)

1007

ann_tag.setAttribute("value", value)

1008

tag.appendChild(ann_tag)

1009

# Add interface annotation tags

1010

for annotation, value in dict(

1011

itertools.chain.from_iterable(

1012

annotations().items()

1013

for name, annotations in

1014

self._get_all_dbus_things("interface")

1015

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

1016

)).items():

1017

ann_tag = document.createElement("annotation")

1018

ann_tag.setAttribute("name", annotation)

1019

ann_tag.setAttribute("value", value)

1020

if_tag.appendChild(ann_tag)

1581

1021

# Add the names to the return values for the

1582

1022

# "org.freedesktop.DBus.Properties" methods

1583

1023

if (if_tag.getAttribute("name")

1597

1037

document.unlink()

1598

1038

except (AttributeError, xml.dom.DOMException,

1599

1039

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)

1040

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

1041

exc_info=error)

1673

1042

return xmlstring

1674

1043

1675

1044

1676

1045

def datetime_to_dbus(dt, variant_level=0):

1677

1046

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

1678

1047

if dt is None:

1679

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

1680

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

1048

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

1049

return dbus.String(dt.isoformat(),

1050

variant_level=variant_level)

1681

1051

1682

1052

1683

1053

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1685

1055

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

1686

1056

interface names according to the "alt_interface_names" mapping.

1687

1057

Usage:

1688

1058

1689

1059

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

1690

1060

"net.example.AlternateInterface"})

1691

1061

class SampleDBusObject(dbus.service.Object):

1692

1062

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

1693

1063

def SampleDBusMethod():

1694

1064

pass

1695

1065

1696

1066

The above "SampleDBusMethod" on "SampleDBusObject" will be

1697

1067

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

1698

1068

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

1699

1069

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

1700

1070

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

1701

1071

1702

1072

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

1703

1073

(from DBusObjectWithProperties) and interfaces (from the

1704

1074

dbus_interface_annotations decorator).

1705

1075

"""

1706

1707

1076

def wrapper(cls):

1708

1077

for orig_interface_name, alt_interface_name in (

1709

alt_interface_names.items()):

1078

alt_interface_names.items()):

1710

1079

attr = {}

1711

1080

interface_names = set()

1712

1081

# Go though all attributes of the class

1714

1083

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

1715

1084

# with the wrong interface name

1716

1085

if (not hasattr(attribute, "_dbus_interface")

1717

or not attribute._dbus_interface.startswith(

1718

orig_interface_name)):

1086

or not attribute._dbus_interface

1087

.startswith(orig_interface_name)):

1719

1088

continue

1720

1089

# Create an alternate D-Bus interface name based on

1721

1090

# the current name

1722

alt_interface = attribute._dbus_interface.replace(

1723

orig_interface_name, alt_interface_name)

1091

alt_interface = (attribute._dbus_interface

1092

.replace(orig_interface_name,

1093

alt_interface_name))

1724

1094

interface_names.add(alt_interface)

1725

1095

# Is this a D-Bus signal?

1726

1096

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

1727

1097

# Extract the original non-method undecorated

1728

1098

# function by black magic

1729

if sys.version_info.major == 2:

1730

nonmethod_func = (dict(

1099

nonmethod_func = (dict(

1731

1100

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)

1101

attribute.__closure__))["func"]

1102

.cell_contents)

1739

1103

# Create a new, but exactly alike, function

1740

1104

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

1741

1105

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

1106

new_function = (dbus.service.signal

1107

(alt_interface,

1108

attribute._dbus_signature)

1109

(types.FunctionType(

1110

nonmethod_func.func_code,

1111

nonmethod_func.func_globals,

1112

nonmethod_func.func_name,

1113

nonmethod_func.func_defaults,

1114

nonmethod_func.func_closure)))

1746

1115

# Copy annotations, if any

1747

1116

try:

1748

new_function._dbus_annotations = dict(

1749

attribute._dbus_annotations)

1117

new_function._dbus_annotations = (

1118

dict(attribute._dbus_annotations))

1750

1119

except AttributeError:

1751

1120

pass

1752

1753

1121

# Define a creator of a function to call both the

1754

1122

# original and alternate functions, so both the

1755

1123

# original and alternate signals gets sent when

1758

1126

"""This function is a scope container to pass

1759

1127

func1 and func2 to the "call_both" function

1760

1128

outside of its arguments"""

1761

1762

@functools.wraps(func2)

1763

1129

def call_both(*args, **kwargs):

1764

1130

"""This function will emit two D-Bus

1765

1131

signals by calling func1 and func2"""

1766

1132

func1(*args, **kwargs)

1767

1133

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

1134

return call_both

1775

1135

# Create the "call_both" function and add it to

1776

1136

# the class

1781

1141

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

1782

1142

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

1783

1143

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

1144

attr[attrname] = (dbus.service.method

1145

(alt_interface,

1146

attribute._dbus_in_signature,

1147

attribute._dbus_out_signature)

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1790

1154

# Copy annotations, if any

1791

1155

try:

1792

attr[attrname]._dbus_annotations = dict(

1793

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1794

1158

except AttributeError:

1795

1159

pass

1796

1160

# Is this a D-Bus property?

1799

1163

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

1800

1164

# property with the alternate D-Bus interface

1801

1165

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

1166

attr[attrname] = (dbus_service_property

1167

(alt_interface,

1168

attribute._dbus_signature,

1169

attribute._dbus_access,

1170

attribute

1171

._dbus_get_args_options

1172

["byte_arrays"])

1173

(types.FunctionType

1174

(attribute.func_code,

1175

attribute.func_globals,

1176

attribute.func_name,

1177

attribute.func_defaults,

1178

attribute.func_closure)))

1808

1179

# Copy annotations, if any

1809

1180

try:

1810

attr[attrname]._dbus_annotations = dict(

1811

attribute._dbus_annotations)

1181

attr[attrname]._dbus_annotations = (

1182

dict(attribute._dbus_annotations))

1812

1183

except AttributeError:

1813

1184

pass

1814

1185

# Is this a D-Bus interface?

1817

1188

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

1818

1189

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

1819

1190

# to the class.

1820

attr[attrname] = (

1821

dbus_interface_annotations(alt_interface)

1822

(copy_function(attribute)))

1191

attr[attrname] = (dbus_interface_annotations

1192

(alt_interface)

1193

(types.FunctionType

1194

(attribute.func_code,

1195

attribute.func_globals,

1196

attribute.func_name,

1197

attribute.func_defaults,

1198

attribute.func_closure)))

1823

1199

if deprecate:

1824

1200

# Deprecate all alternate interfaces

1825

iname = "_AlternateDBusNames_interface_annotation{}"

1201

iname="_AlternateDBusNames_interface_annotation{}"

1826

1202

for interface_name in interface_names:

1827

1828

1203

@dbus_interface_annotations(interface_name)

1829

1204

def func(self):

1830

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

1831

"true"}

1205

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

1206

"true" }

1832

1207

# Find an unused name

1833

1208

for aname in (iname.format(i)

1834

1209

for i in itertools.count()):

1838

1213

if interface_names:

1839

1214

# Replace the class with a new subclass of it with

1840

1215

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

1216

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

1217

(cls,), attr)

1847

1218

return cls

1848

1849

1219

return wrapper

1850

1220

1851

1221

1852

1222

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

1853

"se.bsnet.fukt.Mandos"})

1223

"se.bsnet.fukt.Mandos"})

1854

1224

class ClientDBus(Client, DBusObjectWithProperties):

1855

1225

"""A Client class using D-Bus

1856

1226

1857

1227

Attributes:

1858

1228

dbus_object_path: dbus.ObjectPath

1859

1229

bus: dbus.SystemBus()

1860

1230

"""

1861

1231

1862

1232

runtime_expansions = (Client.runtime_expansions

1863

+ ("dbus_object_path", ))

1864

1233

+ ("dbus_object_path",))

1234

1865

1235

_interface = "se.recompile.Mandos.Client"

1866

1236

1867

1237

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

1868

1869

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

1238

1239

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

1870

1240

self.bus = bus

1871

1241

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

1872

1242

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

1874

1244

client_object_name = str(self.name).translate(

1875

1245

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

1876

1246

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

1877

self.dbus_object_path = dbus.ObjectPath(

1878

"/clients/" + client_object_name)

1247

self.dbus_object_path = (dbus.ObjectPath

1248

("/clients/" + client_object_name))

1879

1249

DBusObjectWithProperties.__init__(self, self.bus,

1880

1250

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,

1251

1252

def notifychangeproperty(transform_func,

1253

dbus_name, type_func=lambda x: x,

1254

variant_level=1, invalidate_only=False,

1886

1255

_interface=_interface):

1887

1256

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

1888

1257

its changes to DBus.

1889

1258

1890

1259

transform_fun: Function that takes a value and a variant_level

1891

1260

and transforms it to a D-Bus type.

1892

1261

dbus_name: D-Bus name of the variable

1895

1264

variant_level: D-Bus variant level. Default: 1

1896

1265

"""

1897

1266

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

1898

1899

1267

def setter(self, value):

1900

1268

if hasattr(self, "dbus_object_path"):

1901

1269

if (not hasattr(self, attrname) or

1902

1270

type_func(getattr(self, attrname, None))

1903

1271

!= type_func(value)):

1904

1272

if invalidate_only:

1905

self.PropertiesChanged(

1906

_interface, dbus.Dictionary(),

1907

dbus.Array((dbus_name, )))

1273

self.PropertiesChanged(_interface,

1274

dbus.Dictionary(),

1275

dbus.Array

1276

((dbus_name,)))

1908

1277

else:

1909

dbus_value = transform_func(

1910

type_func(value),

1911

variant_level=variant_level)

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1912

1281

self.PropertyChanged(dbus.String(dbus_name),

1913

1282

dbus_value)

1914

self.PropertiesChanged(

1915

_interface,

1916

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

1917

dbus_value}),

1918

dbus.Array())

1283

self.PropertiesChanged(_interface,

1284

dbus.Dictionary({

1285

dbus.String(dbus_name):

1286

dbus_value }), dbus.Array())

1919

1287

setattr(self, attrname, value)

1920

1288

1921

1289

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

1922

1290

1923

1291

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1924

1292

approvals_pending = notifychangeproperty(dbus.Boolean,

1925

1293

"ApprovalPending",

1926

type_func=bool)

1294

type_func = bool)

1927

1295

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

1928

1296

last_enabled = notifychangeproperty(datetime_to_dbus,

1929

1297

"LastEnabled")

1930

checker = notifychangeproperty(

1931

dbus.Boolean, "CheckerRunning",

1932

type_func=lambda checker: checker is not None)

1298

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

1299

type_func = lambda checker:

1300

checker is not None)

1933

1301

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1934

1302

"LastCheckedOK")

1935

1303

last_checker_status = notifychangeproperty(dbus.Int16,

1938

1306

datetime_to_dbus, "LastApprovalRequest")

1939

1307

approved_by_default = notifychangeproperty(dbus.Boolean,

1940

1308

"ApprovedByDefault")

1941

approval_delay = notifychangeproperty(

1942

dbus.UInt64, "ApprovalDelay",

1943

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

1309

approval_delay = notifychangeproperty(dbus.UInt64,

1310

"ApprovalDelay",

1311

type_func =

1312

lambda td: td.total_seconds()

1313

* 1000)

1944

1314

approval_duration = notifychangeproperty(

1945

1315

dbus.UInt64, "ApprovalDuration",

1946

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

1316

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

1947

1317

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

1948

timeout = notifychangeproperty(

1949

dbus.UInt64, "Timeout",

1950

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

1318

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

1319

type_func = lambda td:

1320

td.total_seconds() * 1000)

1951

1321

extended_timeout = notifychangeproperty(

1952

1322

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)

1323

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

1324

interval = notifychangeproperty(dbus.UInt64,

1325

"Interval",

1326

type_func =

1327

lambda td: td.total_seconds()

1328

* 1000)

1957

1329

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

1958

1330

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

1959

1331

invalidate_only=True)

1960

1332

1961

1333

del notifychangeproperty

1962

1334

1963

1335

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

1964

1336

try:

1965

1337

self.remove_from_connection()

1968

1340

if hasattr(DBusObjectWithProperties, "__del__"):

1969

1341

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

1970

1342

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:

1343

1344

def checker_callback(self, pid, condition, command,

1345

*args, **kwargs):

1346

self.checker_callback_tag = None

1347

self.checker = None

1348

if os.WIFEXITED(condition):

1349

exitstatus = os.WEXITSTATUS(condition)

1979

1350

# Emit D-Bus signal

1980

1351

self.CheckerCompleted(dbus.Int16(exitstatus),

1981

# This is specific to GNU libC

1982

dbus.Int64(exitstatus << 8),

1352

dbus.Int64(condition),

1983

1353

dbus.String(command))

1984

1354

else:

1985

1355

# Emit D-Bus signal

1986

1356

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

1987

dbus.Int64(

1988

# This is specific to GNU libC

1989

(exitstatus << 8)

1990

| self.last_checker_signal),

1357

dbus.Int64(condition),

1991

1358

dbus.String(command))

1992

return ret

1993

1359

1360

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

1361

*args, **kwargs)

1362

1994

1363

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

1995

1364

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

1996

1365

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

2000

1369

# Emit D-Bus signal

2001

1370

self.CheckerStarted(self.current_checker_command)

2002

1371

return r

2003

1372

2004

1373

def _reset_approved(self):

2005

1374

self.approved = None

2006

1375

return False

2007

1376

2008

1377

def approve(self, value=True):

2009

1378

self.approved = value

2010

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

2011

* 1000), self._reset_approved)

1379

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

1380

* 1000), self._reset_approved)

2012

1381

self.send_changedstate()

2013

2014

# D-Bus methods, signals & properties

2015

2016

# Interfaces

2017

2018

# Signals

2019

1382

1383

## D-Bus methods, signals & properties

1384

1385

## Interfaces

1386

1387

## Signals

1388

2020

1389

# CheckerCompleted - signal

2021

1390

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

2022

1391

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

2023

1392

"D-Bus signal"

2024

1393

pass

2025

1394

2026

1395

# CheckerStarted - signal

2027

1396

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

2028

1397

def CheckerStarted(self, command):

2029

1398

"D-Bus signal"

2030

1399

pass

2031

1400

2032

1401

# PropertyChanged - signal

2033

1402

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

2034

1403

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

2035

1404

def PropertyChanged(self, property, value):

2036

1405

"D-Bus signal"

2037

1406

pass

2038

1407

2039

1408

# GotSecret - signal

2040

1409

@dbus.service.signal(_interface)

2041

1410

def GotSecret(self):

2044

1413

server to mandos-client

2045

1414

"""

2046

1415

pass

2047

1416

2048

1417

# Rejected - signal

2049

1418

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

2050

1419

def Rejected(self, reason):

2051

1420

"D-Bus signal"

2052

1421

pass

2053

1422

2054

1423

# NeedApproval - signal

2055

1424

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

2056

1425

def NeedApproval(self, timeout, default):

2057

1426

"D-Bus signal"

2058

1427

return self.need_approval()

2059

2060

# Methods

2061

1428

1429

## Methods

1430

2062

1431

# Approve - method

2063

1432

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

2064

1433

def Approve(self, value):

2065

1434

self.approve(value)

2066

1435

2067

1436

# CheckedOK - method

2068

1437

@dbus.service.method(_interface)

2069

1438

def CheckedOK(self):

2070

1439

self.checked_ok()

2071

1440

2072

1441

# Enable - method

2073

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

2074

1442

@dbus.service.method(_interface)

2075

1443

def Enable(self):

2076

1444

"D-Bus method"

2077

1445

self.enable()

2078

1446

2079

1447

# StartChecker - method

2080

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

2081

1448

@dbus.service.method(_interface)

2082

1449

def StartChecker(self):

2083

1450

"D-Bus method"

2084

1451

self.start_checker()

2085

1452

2086

1453

# Disable - method

2087

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

2088

1454

@dbus.service.method(_interface)

2089

1455

def Disable(self):

2090

1456

"D-Bus method"

2091

1457

self.disable()

2092

1458

2093

1459

# StopChecker - method

2094

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

2095

1460

@dbus.service.method(_interface)

2096

1461

def StopChecker(self):

2097

1462

self.stop_checker()

2098

2099

# Properties

2100

1463

1464

## Properties

1465

2101

1466

# ApprovalPending - property

2102

1467

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

2103

1468

def ApprovalPending_dbus_property(self):

2104

1469

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

2105

1470

2106

1471

# ApprovedByDefault - property

2107

@dbus_service_property(_interface,

2108

signature="b",

1472

@dbus_service_property(_interface, signature="b",

2109

1473

access="readwrite")

2110

1474

def ApprovedByDefault_dbus_property(self, value=None):

2111

1475

if value is None: # get

2112

1476

return dbus.Boolean(self.approved_by_default)

2113

1477

self.approved_by_default = bool(value)

2114

1478

2115

1479

# ApprovalDelay - property

2116

@dbus_service_property(_interface,

2117

signature="t",

1480

@dbus_service_property(_interface, signature="t",

2118

1481

access="readwrite")

2119

1482

def ApprovalDelay_dbus_property(self, value=None):

2120

1483

if value is None: # get

2121

1484

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

2122

1485

* 1000)

2123

1486

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

2124

1487

2125

1488

# ApprovalDuration - property

2126

@dbus_service_property(_interface,

2127

signature="t",

1489

@dbus_service_property(_interface, signature="t",

2128

1490

access="readwrite")

2129

1491

def ApprovalDuration_dbus_property(self, value=None):

2130

1492

if value is None: # get

2131

1493

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

2132

1494

* 1000)

2133

1495

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

2134

1496

2135

1497

# Name - property

2136

@dbus_annotations(

2137

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

2138

1498

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

2139

1499

def Name_dbus_property(self):

2140

1500

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

1501

2149

1502

# Fingerprint - property

2150

@dbus_annotations(

2151

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

2152

1503

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

2153

1504

def Fingerprint_dbus_property(self):

2154

1505

return dbus.String(self.fingerprint)

2155

1506

2156

1507

# Host - property

2157

@dbus_service_property(_interface,

2158

signature="s",

1508

@dbus_service_property(_interface, signature="s",

2159

1509

access="readwrite")

2160

1510

def Host_dbus_property(self, value=None):

2161

1511

if value is None: # get

2162

1512

return dbus.String(self.host)

2163

1513

self.host = str(value)

2164

1514

2165

1515

# Created - property

2166

@dbus_annotations(

2167

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

2168

1516

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

2169

1517

def Created_dbus_property(self):

2170

1518

return datetime_to_dbus(self.created)

2171

1519

2172

1520

# LastEnabled - property

2173

1521

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

2174

1522

def LastEnabled_dbus_property(self):

2175

1523

return datetime_to_dbus(self.last_enabled)

2176

1524

2177

1525

# Enabled - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1526

@dbus_service_property(_interface, signature="b",

2180

1527

access="readwrite")

2181

1528

def Enabled_dbus_property(self, value=None):

2182

1529

if value is None: # get

2185

1532

self.enable()

2186

1533

else:

2187

1534

self.disable()

2188

1535

2189

1536

# LastCheckedOK - property

2190

@dbus_service_property(_interface,

2191

signature="s",

1537

@dbus_service_property(_interface, signature="s",

2192

1538

access="readwrite")

2193

1539

def LastCheckedOK_dbus_property(self, value=None):

2194

1540

if value is not None:

2195

1541

self.checked_ok()

2196

1542

return

2197

1543

return datetime_to_dbus(self.last_checked_ok)

2198

1544

2199

1545

# LastCheckerStatus - property

2200

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

1546

@dbus_service_property(_interface, signature="n",

1547

access="read")

2201

1548

def LastCheckerStatus_dbus_property(self):

2202

1549

return dbus.Int16(self.last_checker_status)

2203

1550

2204

1551

# Expires - property

2205

1552

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

2206

1553

def Expires_dbus_property(self):

2207

1554

return datetime_to_dbus(self.expires)

2208

1555

2209

1556

# LastApprovalRequest - property

2210

1557

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

2211

1558

def LastApprovalRequest_dbus_property(self):

2212

1559

return datetime_to_dbus(self.last_approval_request)

2213

1560

2214

1561

# Timeout - property

2215

@dbus_service_property(_interface,

2216

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2217

1563

access="readwrite")

2218

1564

def Timeout_dbus_property(self, value=None):

2219

1565

if value is None: # get

2231

1577

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

2232

1578

is None):

2233

1579

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

1580

gobject.source_remove(self.disable_initiator_tag)

1581

self.disable_initiator_tag = (

1582

gobject.timeout_add(

1583

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

1584

* 1000), self.disable))

1585

2239

1586

# ExtendedTimeout - property

2240

@dbus_service_property(_interface,

2241

signature="t",

1587

@dbus_service_property(_interface, signature="t",

2242

1588

access="readwrite")

2243

1589

def ExtendedTimeout_dbus_property(self, value=None):

2244

1590

if value is None: # get

2245

1591

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

2246

1592

* 1000)

2247

1593

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

2248

1594

2249

1595

# Interval - property

2250

@dbus_service_property(_interface,

2251

signature="t",

1596

@dbus_service_property(_interface, signature="t",

2252

1597

access="readwrite")

2253

1598

def Interval_dbus_property(self, value=None):

2254

1599

if value is None: # get

2258

1603

return

2259

1604

if self.enabled:

2260

1605

# 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

1606

gobject.source_remove(self.checker_initiator_tag)

1607

self.checker_initiator_tag = (gobject.timeout_add

1608

(value, self.start_checker))

1609

self.start_checker() # Start one now, too

1610

2266

1611

# Checker - property

2267

@dbus_service_property(_interface,

2268

signature="s",

1612

@dbus_service_property(_interface, signature="s",

2269

1613

access="readwrite")

2270

1614

def Checker_dbus_property(self, value=None):

2271

1615

if value is None: # get

2272

1616

return dbus.String(self.checker_command)

2273

1617

self.checker_command = str(value)

2274

1618

2275

1619

# CheckerRunning - property

2276

@dbus_service_property(_interface,

2277

signature="b",

1620

@dbus_service_property(_interface, signature="b",

2278

1621

access="readwrite")

2279

1622

def CheckerRunning_dbus_property(self, value=None):

2280

1623

if value is None: # get

2283

1626

self.start_checker()

2284

1627

else:

2285

1628

self.stop_checker()

2286

1629

2287

1630

# ObjectPath - property

2288

@dbus_annotations(

2289

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

2290

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

2291

1631

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

2292

1632

def ObjectPath_dbus_property(self):

2293

return self.dbus_object_path # is already a dbus.ObjectPath

2294

1633

return self.dbus_object_path # is already a dbus.ObjectPath

1634

2295

1635

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

1636

@dbus_service_property(_interface, signature="ay",

1637

access="write", byte_arrays=True)

2303

1638

def Secret_dbus_property(self, value):

2304

1639

self.secret = bytes(value)

2305

1640

2306

1641

del _interface

2307

1642

2308

1643

2309

class ProxyClient:

2310

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

1644

class ProxyClient(object):

1645

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

2311

1646

self._pipe = child_pipe

2312

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

1647

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

2313

1648

if not self._pipe.recv():

2314

raise KeyError(key_id or fpr)

2315

1649

raise KeyError()

1650

2316

1651

def __getattribute__(self, name):

2317

if name == "_pipe":

1652

if name == '_pipe':

2318

1653

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

2319

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

1654

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

2320

1655

data = self._pipe.recv()

2321

if data[0] == "data":

1656

if data[0] == 'data':

2322

1657

return data[1]

2323

if data[0] == "function":

2324

1658

if data[0] == 'function':

2325

1659

def func(*args, **kwargs):

2326

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

1660

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

2327

1661

return self._pipe.recv()[1]

2328

2329

1662

return func

2330

1663

2331

1664

def __setattr__(self, name, value):

2332

if name == "_pipe":

1665

if name == '_pipe':

2333

1666

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

2334

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

1667

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

2335

1668

2336

1669

2337

1670

class ClientHandler(socketserver.BaseRequestHandler, object):

2338

1671

"""A class to handle client connections.

2339

1672

2340

1673

Instantiated once for each connection to handle it.

2341

1674

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

2342

1675

2343

1676

def handle(self):

2344

1677

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

1678

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

1679

str(self.client_address))

1680

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

1681

self.server.child_pipe.fileno())

1682

1683

session = (gnutls.connection

1684

.ClientSession(self.request,

1685

gnutls.connection

1686

.X509Credentials()))

1687

1688

# Note: gnutls.connection.X509Credentials is really a

1689

# generic GnuTLS certificate credentials object so long as

1690

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

1691

# here despite using OpenPGP certificates.

1692

1693

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

1694

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

1695

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

1696

# "+DHE-DSS"))

2355

1697

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

2356

1698

priority = self.server.gnutls_priority

2357

1699

if priority is None:

2358

1700

priority = "NORMAL"

2359

gnutls.priority_set_direct(session,

2360

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

2361

1701

(gnutls.library.functions

1702

.gnutls_priority_set_direct(session._c_object,

1703

priority, None))

1704

2362

1705

# Start communication using the Mandos protocol

2363

1706

# Get protocol number

2364

1707

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

2365

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

1708

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

2366

1709

try:

2367

1710

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

2368

1711

raise RuntimeError(line)

2369

1712

except (ValueError, IndexError, RuntimeError) as error:

2370

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

1713

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

2371

1714

return

2372

1715

2373

1716

# Start GnuTLS connection

2374

1717

try:

2375

1718

session.handshake()

2376

except gnutls.Error as error:

2377

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

1719

except gnutls.errors.GNUTLSError as error:

1720

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

2378

1721

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

2379

1722

# established. Just abandon the request.

2380

1723

return

2381

log.debug("Handshake succeeded")

2382

1724

logger.debug("Handshake succeeded")

1725

2383

1726

approval_required = False

2384

1727

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,

1728

try:

1729

fpr = self.fingerprint(self.peer_certificate

1730

(session))

1731

except (TypeError,

1732

gnutls.errors.GNUTLSError) as error:

1733

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

1734

return

1735

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

1736

1737

try:

1738

client = ProxyClient(child_pipe, fpr,

2409

1739

self.client_address)

2410

1740

except KeyError:

2411

1741

return

2412

1742

2413

1743

if client.approval_delay:

2414

1744

delay = client.approval_delay

2415

1745

client.approvals_pending += 1

2416

1746

approval_required = True

2417

1747

2418

1748

while True:

2419

1749

if not client.enabled:

2420

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

1750

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

1751

client.name)

2421

1752

if self.server.use_dbus:

2422

1753

# Emit D-Bus signal

2423

1754

client.Rejected("Disabled")

2424

1755

return

2425

1756

2426

1757

if client.approved or not client.approval_delay:

2427

# We are approved or approval is disabled

1758

#We are approved or approval is disabled

2428

1759

break

2429

1760

elif client.approved is None:

2430

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

2431

client.name)

1761

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

1762

client.name)

2432

1763

if self.server.use_dbus:

2433

1764

# Emit D-Bus signal

2434

1765

client.NeedApproval(

2435

1766

client.approval_delay.total_seconds()

2436

1767

* 1000, client.approved_by_default)

2437

1768

else:

2438

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

2439

client.name)

1769

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

1770

client.name)

2440

1771

if self.server.use_dbus:

2441

1772

# Emit D-Bus signal

2442

1773

client.Rejected("Denied")

2443

1774

return

2444

2445

# wait until timeout or approved

1775

1776

#wait until timeout or approved

2446

1777

time = datetime.datetime.now()

2447

1778

client.changedstate.acquire()

2448

1779

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

2450

1781

time2 = datetime.datetime.now()

2451

1782

if (time2 - time) >= delay:

2452

1783

if not client.approved_by_default:

2453

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

2454

" waiting for approval",

2455

client.name)

1784

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

1785

" waiting for approval",

1786

client.name)

2456

1787

if self.server.use_dbus:

2457

1788

# Emit D-Bus signal

2458

1789

client.Rejected("Approval timed out")

2461

1792

break

2462

1793

else:

2463

1794

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)

1795

1796

sent_size = 0

1797

while sent_size < len(client.secret):

1798

try:

1799

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

1800

except gnutls.errors.GNUTLSError as error:

1801

logger.warning("gnutls send failed",

1802

exc_info=error)

1803

return

1804

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

1805

sent, len(client.secret)

1806

- (sent_size + sent))

1807

sent_size += sent

1808

1809

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

2472

1810

# bump the timeout using extended_timeout

2473

1811

client.bump_timeout(client.extended_timeout)

2474

1812

if self.server.use_dbus:

2475

1813

# Emit D-Bus signal

2476

1814

client.GotSecret()

2477

1815

2478

1816

finally:

2479

1817

if approval_required:

2480

1818

client.approvals_pending -= 1

2481

1819

try:

2482

1820

session.bye()

2483

except gnutls.Error as error:

2484

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

2485

1821

except gnutls.errors.GNUTLSError as error:

1822

logger.warning("GnuTLS bye failed",

1823

exc_info=error)

1824

2486

1825

@staticmethod

2487

1826

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

1827

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

1828

# If not an OpenPGP certificate...

1829

if (gnutls.library.functions

1830

.gnutls_certificate_type_get(session._c_object)

1831

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1832

# ...do the normal thing

1833

return session.peer_certificate

2504

1834

list_size = ctypes.c_uint(1)

2505

cert_list = (gnutls.certificate_get_peers

2506

(session, ctypes.byref(list_size)))

1835

cert_list = (gnutls.library.functions

1836

.gnutls_certificate_get_peers

1837

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

2507

1838

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

2508

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

1839

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

1840

" certificate")

2509

1841

if list_size.value == 0:

2510

1842

return None

2511

1843

cert = cert_list[0]

2512

1844

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

1845

2549

1846

@staticmethod

2550

1847

def fingerprint(openpgp):

2551

1848

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2552

1849

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

1850

datum = (gnutls.library.types

1851

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

1852

ctypes.POINTER

1853

(ctypes.c_ubyte)),

1854

ctypes.c_uint(len(openpgp))))

2557

1855

# New empty GnuTLS certificate

2558

crt = gnutls.openpgp_crt_t()

2559

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1857

(gnutls.library.functions

1858

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2560

1859

# Import the OpenPGP public key into the certificate

2561

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

2562

gnutls.OPENPGP_FMT_RAW)

1860

(gnutls.library.functions

1861

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

1862

gnutls.library.constants

1863

.GNUTLS_OPENPGP_FMT_RAW))

2563

1864

# Verify the self signature in the key

2564

1865

crtverify = ctypes.c_uint()

2565

gnutls.openpgp_crt_verify_self(crt, 0,

2566

ctypes.byref(crtverify))

1866

(gnutls.library.functions

1867

.gnutls_openpgp_crt_verify_self(crt, 0,

1868

ctypes.byref(crtverify)))

2567

1869

if crtverify.value != 0:

2568

gnutls.openpgp_crt_deinit(crt)

2569

raise gnutls.CertificateSecurityError(code

2570

=crtverify.value)

1870

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1871

raise (gnutls.errors.CertificateSecurityError

1872

("Verify failed"))

2571

1873

# New buffer for the fingerprint

2572

1874

buf = ctypes.create_string_buffer(20)

2573

1875

buf_len = ctypes.c_size_t()

2574

1876

# Get the fingerprint from the certificate into the buffer

2575

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

2576

ctypes.byref(buf_len))

1877

(gnutls.library.functions

1878

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

1879

ctypes.byref(buf_len)))

2577

1880

# Deinit the certificate

2578

gnutls.openpgp_crt_deinit(crt)

1881

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2579

1882

# Convert the buffer to a Python bytestring

2580

1883

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

2581

1884

# Convert the bytestring to hexadecimal notation

2583

1886

return hex_fpr

2584

1887

2585

1888

2586

class MultiprocessingMixIn:

1889

class MultiprocessingMixIn(object):

2587

1890

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

2588

2589

1891

def sub_process_main(self, request, address):

2590

1892

try:

2591

1893

self.finish_request(request, address)

2592

1894

except Exception:

2593

1895

self.handle_error(request, address)

2594

1896

self.close_request(request)

2595

1897

2596

1898

def process_request(self, request, address):

2597

1899

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

2598

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

2599

args=(request, address))

1900

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

1901

args = (request, address))

2600

1902

proc.start()

2601

1903

return proc

2602

1904

2603

1905

2604

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2605

1907

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

2606

2607

1908

def process_request(self, request, client_address):

2608

1909

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

2609

1910

2610

1911

This function creates a new pipe in self.pipe

2611

1912

"""

2612

1913

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2613

1914

2614

1915

proc = MultiprocessingMixIn.process_request(self, request,

2615

1916

client_address)

2616

1917

self.child_pipe.close()

2617

1918

self.add_pipe(parent_pipe, proc)

2618

1919

2619

1920

def add_pipe(self, parent_pipe, proc):

2620

1921

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

2621

1922

raise NotImplementedError()

2622

1923

2623

1924

2624

1925

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2625

socketserver.TCPServer):

2626

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

2627

1926

socketserver.TCPServer, object):

1927

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

1928

2628

1929

Attributes:

2629

1930

enabled: Boolean; whether this server is activated yet

2630

1931

interface: None or a network interface name (string)

2631

1932

use_ipv6: Boolean; to use IPv6 or not

2632

1933

"""

2633

2634

1934

def __init__(self, server_address, RequestHandlerClass,

2635

interface=None,

2636

use_ipv6=True,

2637

socketfd=None):

1935

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

2638

1936

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

2639

1937

creating a new one with socket.socket().

2640

1938

"""

2646

1944

self.socketfd = socketfd

2647

1945

# Save the original socket.socket() function

2648

1946

self.socket_socket = socket.socket

2649

2650

1947

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

2651

#

1948

#

2652

1949

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

2653

1950

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

2654

1951

# patching socket.socket.)

2655

#

1952

#

2656

1953

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

2657

1954

@functools.wraps(socket.socket)

2658

1955

def socket_wrapper(*args, **kwargs):

2670

1967

# socket_wrapper(), if socketfd was set.

2671

1968

socketserver.TCPServer.__init__(self, server_address,

2672

1969

RequestHandlerClass)

2673

1970

2674

1971

def server_bind(self):

2675

1972

"""This overrides the normal server_bind() function

2676

1973

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

2677

1974

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

2678

global SO_BINDTODEVICE

2679

1975

if self.interface is not None:

2680

1976

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

1977

logger.error("SO_BINDTODEVICE does not exist;"

1978

" cannot bind to interface %s",

1979

self.interface)

1980

else:

1981

try:

1982

self.socket.setsockopt(socket.SOL_SOCKET,

1983

SO_BINDTODEVICE,

1984

(self.interface + "\0")

1985

.encode("utf-8"))

1986

except socket.error as error:

1987

if error.errno == errno.EPERM:

1988

logger.error("No permission to bind to"

1989

" interface %s", self.interface)

1990

elif error.errno == errno.ENOPROTOOPT:

1991

logger.error("SO_BINDTODEVICE not available;"

1992

" cannot bind to interface %s",

1993

self.interface)

1994

elif error.errno == errno.ENODEV:

1995

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

1996

" cannot bind", self.interface)

1997

else:

1998

raise

2701

1999

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

2702

2000

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

2703

if self.server_address[1]:

2704

self.allow_reuse_address = True

2705

2001

if not self.server_address[0]:

2706

2002

if self.address_family == socket.AF_INET6:

2707

any_address = "::" # in6addr_any

2003

any_address = "::" # in6addr_any

2708

2004

else:

2709

any_address = "0.0.0.0" # INADDR_ANY

2005

any_address = "0.0.0.0" # INADDR_ANY

2710

2006

self.server_address = (any_address,

2711

2007

self.server_address[1])

2712

2008

elif not self.server_address[1]:

2713

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

2009

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

2010

0)

2714

2011

# if self.interface:

2715

2012

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

2716

2013

# 0, # port

2722

2019

2723

2020

class MandosServer(IPv6_TCPServer):

2724

2021

"""Mandos server.

2725

2022

2726

2023

Attributes:

2727

2024

clients: set of Client objects

2728

2025

gnutls_priority GnuTLS priority string

2729

2026

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

2730

2731

Assumes a GLib.MainLoop event loop.

2027

2028

Assumes a gobject.MainLoop event loop.

2732

2029

"""

2733

2734

2030

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

2031

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

2032

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

2741

2033

self.enabled = False

2742

2034

self.clients = clients

2743

2035

if self.clients is None:

2746

2038

self.gnutls_priority = gnutls_priority

2747

2039

IPv6_TCPServer.__init__(self, server_address,

2748

2040

RequestHandlerClass,

2749

interface=interface,

2750

use_ipv6=use_ipv6,

2751

socketfd=socketfd)

2752

2041

interface = interface,

2042

use_ipv6 = use_ipv6,

2043

socketfd = socketfd)

2753

2044

def server_activate(self):

2754

2045

if self.enabled:

2755

2046

return socketserver.TCPServer.server_activate(self)

2756

2047

2757

2048

def enable(self):

2758

2049

self.enabled = True

2759

2050

2760

2051

def add_pipe(self, parent_pipe, proc):

2761

2052

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

2053

gobject.io_add_watch(parent_pipe.fileno(),

2054

gobject.IO_IN | gobject.IO_HUP,

2055

functools.partial(self.handle_ipc,

2056

parent_pipe =

2057

parent_pipe,

2058

proc = proc))

2059

2060

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

2061

proc = None, client_object=None):

2773

2062

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

2774

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

2063

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

2775

2064

# Wait for other process to exit

2776

2065

proc.join()

2777

2066

return False

2778

2067

2779

2068

# Read a request from the child

2780

2069

request = parent_pipe.recv()

2781

2070

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:

2071

2072

if command == 'init':

2073

fpr = request[1]

2074

address = request[2]

2075

2076

for c in self.clients.itervalues():

2077

if c.fingerprint == fpr:

2796

2078

client = c

2797

2079

break

2798

2080

else:

2799

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

2800

" %s", key_id or fpr, address)

2081

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

2082

"dress: %s", fpr, address)

2801

2083

if self.use_dbus:

2802

2084

# Emit D-Bus signal

2803

mandos_dbus_service.ClientNotFound(key_id or fpr,

2085

mandos_dbus_service.ClientNotFound(fpr,

2804

2086

address[0])

2805

2087

parent_pipe.send(False)

2806

2088

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

2089

2090

gobject.io_add_watch(parent_pipe.fileno(),

2091

gobject.IO_IN | gobject.IO_HUP,

2092

functools.partial(self.handle_ipc,

2093

parent_pipe =

2094

parent_pipe,

2095

proc = proc,

2096

client_object =

2097

client))

2815

2098

parent_pipe.send(True)

2816

2099

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

2817

2100

# same fileno

2818

2101

return False

2819

if command == "funcall":

2102

if command == 'funcall':

2820

2103

funcname = request[1]

2821

2104

args = request[2]

2822

2105

kwargs = request[3]

2823

2824

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

2106

2107

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

2825

2108

funcname)(*args,

2826

**kwargs)))

2827

2828

if command == "getattr":

2109

**kwargs)))

2110

2111

if command == 'getattr':

2829

2112

attrname = request[1]

2830

if isinstance(client_object.__getattribute__(attrname),

2831

collections.abc.Callable):

2832

parent_pipe.send(("function", ))

2113

if callable(client_object.__getattribute__(attrname)):

2114

parent_pipe.send(('function',))

2833

2115

else:

2834

parent_pipe.send((

2835

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

2836

2837

if command == "setattr":

2116

parent_pipe.send(('data', client_object

2117

.__getattribute__(attrname)))

2118

2119

if command == 'setattr':

2838

2120

attrname = request[1]

2839

2121

value = request[2]

2840

2122

setattr(client_object, attrname, value)

2841

2123

2842

2124

return True

2843

2125

2844

2126

2845

2127

def rfc3339_duration_to_delta(duration):

2846

2128

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

2129

2130

>>> rfc3339_duration_to_delta("P7D")

2131

datetime.timedelta(7)

2132

>>> rfc3339_duration_to_delta("PT60S")

2133

datetime.timedelta(0, 60)

2134

>>> rfc3339_duration_to_delta("PT60M")

2135

datetime.timedelta(0, 3600)

2136

>>> rfc3339_duration_to_delta("PT24H")

2137

datetime.timedelta(1)

2138

>>> rfc3339_duration_to_delta("P1W")

2139

datetime.timedelta(7)

2140

>>> rfc3339_duration_to_delta("PT5M30S")

2141

datetime.timedelta(0, 330)

2142

>>> rfc3339_duration_to_delta("P1DT3M20S")

2143

datetime.timedelta(1, 200)

2864

2144

"""

2865

2145

2866

2146

# Parsing an RFC 3339 duration with regular expressions is not

2867

2147

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

2868

2148

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

2869

2149

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

2870

2150

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

2871

2151

# avoid excessive use of external libraries.

2872

2152

2873

2153

# 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

2154

Token = collections.namedtuple("Token",

2155

("regexp", # To match token; if

2156

# "value" is not None,

2157

# must have a "group"

2158

# containing digits

2159

"value", # datetime.timedelta or

2160

# None

2161

"followers")) # Tokens valid after

2162

# this token

2879

2163

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

2880

2164

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

2881

2165

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

2882

2166

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

2883

2167

datetime.timedelta(seconds=1),

2884

frozenset((token_end, )))

2168

frozenset((token_end,)))

2885

2169

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

2886

2170

datetime.timedelta(minutes=1),

2887

2171

frozenset((token_second, token_end)))

2903

2187

frozenset((token_month, token_end)))

2904

2188

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

2905

2189

datetime.timedelta(weeks=1),

2906

frozenset((token_end, )))

2190

frozenset((token_end,)))

2907

2191

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

2908

2192

frozenset((token_year, token_month,

2909

2193

token_day, token_time,

2910

2194

token_week)))

2911

# Define starting values:

2912

# Value so far

2913

value = datetime.timedelta()

2195

# Define starting values

2196

value = datetime.timedelta() # Value so far

2914

2197

found_token = None

2915

# Following valid tokens

2916

followers = frozenset((token_duration, ))

2917

# String left to parse

2918

s = duration

2198

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

2199

s = duration # String left to parse

2919

2200

# Loop until end token is found

2920

2201

while found_token is not token_end:

2921

2202

# Search for any currently valid tokens

2937

2218

break

2938

2219

else:

2939

2220

# No currently valid tokens were found

2940

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

2941

.format(duration))

2221

raise ValueError("Invalid RFC 3339 duration")

2942

2222

# End token found

2943

2223

return value

2944

2224

2945

2225

2946

2226

def string_to_delta(interval):

2947

2227

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

2228

2229

>>> string_to_delta('7d')

2230

datetime.timedelta(7)

2231

>>> string_to_delta('60s')

2232

datetime.timedelta(0, 60)

2233

>>> string_to_delta('60m')

2234

datetime.timedelta(0, 3600)

2235

>>> string_to_delta('24h')

2236

datetime.timedelta(1)

2237

>>> string_to_delta('1w')

2238

datetime.timedelta(7)

2239

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

2240

datetime.timedelta(0, 330)

2961

2241

"""

2962

2242

2963

2243

try:

2964

2244

return rfc3339_duration_to_delta(interval)

2965

2245

except ValueError:

2966

2246

pass

2967

2247

2968

2248

timevalue = datetime.timedelta(0)

2969

2249

for s in interval.split():

2970

2250

try:

2981

2261

elif suffix == "w":

2982

2262

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

2983

2263

else:

2984

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

2264

raise ValueError("Unknown suffix {!r}"

2265

.format(suffix))

2985

2266

except IndexError as e:

2986

2267

raise ValueError(*(e.args))

2987

2268

timevalue += delta

2988

2269

return timevalue

2989

2270

2990

2271

2991

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

2272

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

2992

2273

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

2993

2274

2994

2275

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

2995

2276

if os.fork():

2996

2277

sys.exit()

3003

2284

# Close all standard open file descriptors

3004

2285

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

3005

2286

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

3006

raise OSError(errno.ENODEV,

3007

"{} not a character device"

2287

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

3008

2288

.format(os.devnull))

3009

2289

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

3010

2290

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

3014

2294

3015

2295

3016

2296

def main():

3017

2297

3018

2298

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

3019

2299

# Parsing of options, both command line and config file

3020

2300

3021

2301

parser = argparse.ArgumentParser()

3022

2302

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

3023

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

2303

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

3024

2304

help="show version number and exit")

3025

2305

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

3026

2306

help="Bind to interface IF")

3062

2342

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

3063

2343

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

3064

2344

default=None)

3065

2345

3066

2346

options = parser.parse_args()

3067

2347

2348

if options.check:

2349

import doctest

2350

fail_count, test_count = doctest.testmod()

2351

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

2352

3068

2353

# 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

2354

server_defaults = { "interface": "",

2355

"address": "",

2356

"port": "",

2357

"debug": "False",

2358

"priority":

2359

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

2360

"servicename": "Mandos",

2361

"use_dbus": "True",

2362

"use_ipv6": "True",

2363

"debuglevel": "",

2364

"restore": "True",

2365

"socket": "",

2366

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

2367

"foreground": "False",

2368

"zeroconf": "True",

2369

}

2370

3092

2371

# Parse config file for server-global settings

3093

server_config = configparser.ConfigParser(server_defaults)

2372

server_config = configparser.SafeConfigParser(server_defaults)

3094

2373

del server_defaults

3095

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

3096

# Convert the ConfigParser object to a dict

2374

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

2375

"mandos.conf"))

2376

# Convert the SafeConfigParser object to a dict

3097

2377

server_settings = server_config.defaults()

3098

2378

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

3099

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

3100

"foreground", "zeroconf"):

2379

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

3101

2380

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

3102

2381

option)

3103

2382

if server_settings["port"]:

3109

2388

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

3110

2389

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

3111

2390

# happen with a supplied network socket.

3112

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

2391

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

3113

2392

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

3114

2393

["socket"])

3115

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

3116

2394

del server_config

3117

2395

3118

2396

# Override the settings from the config file with command line

3119

2397

# options, if set.

3120

2398

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

3121

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

3122

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

3123

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

2399

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

2400

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

2401

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

3124

2402

value = getattr(options, option)

3125

2403

if value is not None:

3126

2404

server_settings[option] = value

3138

2416

if server_settings["debug"]:

3139

2417

server_settings["foreground"] = True

3140

2418

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

3141

2419

3142

2420

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

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

2421

2422

if (not server_settings["zeroconf"] and

2423

not (server_settings["port"]

2424

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

2425

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

2426

" Zeroconf")

2427

3149

2428

# For convenience

3150

2429

debug = server_settings["debug"]

3151

2430

debuglevel = server_settings["debuglevel"]

3155

2434

stored_state_file)

3156

2435

foreground = server_settings["foreground"]

3157

2436

zeroconf = server_settings["zeroconf"]

3158

2437

3159

2438

if debug:

3160

2439

initlogger(debug, logging.DEBUG)

3161

2440

else:

3164

2443

else:

3165

2444

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

3166

2445

initlogger(debug, level)

3167

2446

3168

2447

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

2448

syslogger.setFormatter(logging.Formatter

2449

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

2450

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

2451

.format(server_settings

2452

["servicename"])))

2453

3174

2454

# Parse config file with clients

3175

client_config = configparser.ConfigParser(Client.client_defaults)

2455

client_config = configparser.SafeConfigParser(Client

2456

.client_defaults)

3176

2457

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

3177

2458

"clients.conf"))

3178

2459

3179

2460

global mandos_dbus_service

3180

2461

mandos_dbus_service = None

3181

2462

3182

2463

socketfd = None

3183

2464

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

3184

2465

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)

2466

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

2467

server_settings["port"]),

2468

ClientHandler,

2469

interface=(server_settings["interface"]

2470

or None),

2471

use_ipv6=use_ipv6,

2472

gnutls_priority=

2473

server_settings["priority"],

2474

use_dbus=use_dbus,

2475

socketfd=socketfd)

3193

2476

if not foreground:

3194

2477

pidfilename = "/run/mandos.pid"

3195

2478

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

3196

2479

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

3197

2480

pidfile = None

3198

2481

try:

3199

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

2482

pidfile = open(pidfilename, "w")

3200

2483

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

2484

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

2485

exc_info=e)

2486

2487

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

3207

2488

try:

3208

2489

uid = pwd.getpwnam(name).pw_uid

3209

gid = pwd.getpwnam(group).pw_gid

2490

gid = pwd.getpwnam(name).pw_gid

3210

2491

break

3211

2492

except KeyError:

3212

2493

continue

3216

2497

try:

3217

2498

os.setgid(gid)

3218

2499

os.setuid(uid)

3219

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

3220

2500

except OSError as error:

3221

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

3222

os.strerror(error.errno))

3223

2501

if error.errno != errno.EPERM:

3224

2502

raise

3225

2503

3226

2504

if debug:

3227

2505

# Enable all possible GnuTLS debugging

3228

2506

3229

2507

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

3230

2508

# - GnuTLS manual

3231

gnutls.global_set_log_level(11)

3232

3233

@gnutls.log_func

2509

gnutls.library.functions.gnutls_global_set_log_level(11)

2510

2511

@gnutls.library.types.gnutls_log_func

3234

2512

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

2513

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

2514

2515

(gnutls.library.functions

2516

.gnutls_global_set_log_function(debug_gnutls))

2517

3240

2518

# Redirect stdin so all checkers get /dev/null

3241

2519

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

3242

2520

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

3243

2521

if null > 2:

3244

2522

os.close(null)

3245

2523

3246

2524

# Need to fork before connecting to D-Bus

3247

2525

if not foreground:

3248

2526

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

3249

2527

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

2528

2529

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

2530

# need to inform gobject that threads will be used.

2531

gobject.threads_init()

2532

3256

2533

global main_loop

3257

2534

# From the Avahi example code

3258

2535

DBusGMainLoop(set_as_default=True)

3259

main_loop = GLib.MainLoop()

3260

if use_dbus or zeroconf:

3261

bus = dbus.SystemBus()

2536

main_loop = gobject.MainLoop()

2537

bus = dbus.SystemBus()

3262

2538

# End of Avahi example code

3263

2539

if use_dbus:

3264

2540

try:

3265

2541

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)

2542

bus, do_not_queue=True)

2543

old_bus_name = (dbus.service.BusName

2544

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

2545

do_not_queue=True))

2546

except dbus.exceptions.NameExistsException as e:

2547

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

3273

2548

use_dbus = False

3274

2549

server_settings["use_dbus"] = False

3275

2550

tcp_server.use_dbus = False

3276

2551

if zeroconf:

3277

2552

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)

2553

service = AvahiServiceToSyslog(name =

2554

server_settings["servicename"],

2555

servicetype = "_mandos._tcp",

2556

protocol = protocol, bus = bus)

3283

2557

if server_settings["interface"]:

3284

service.interface = if_nametoindex(

3285

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

3286

2558

service.interface = (if_nametoindex

2559

(server_settings["interface"]

2560

.encode("utf-8")))

2561

3287

2562

global multiprocessing_manager

3288

2563

multiprocessing_manager = multiprocessing.Manager()

3289

2564

3290

2565

client_class = Client

3291

2566

if use_dbus:

3292

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

3293

2567

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

2568

3294

2569

client_settings = Client.config_parser(client_config)

3295

2570

old_client_settings = {}

3296

2571

clients_data = {}

3297

2572

3298

2573

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

3299

2574

global wnull

3300

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

2575

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

3301

2576

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

3302

2577

# mode

3303

2578

if debug or not foreground:

3304

2579

wnull.close()

3305

2580

3306

2581

# Get client data and settings from last running state.

3307

2582

if server_settings["restore"]:

3308

2583

try:

3309

2584

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

2585

clients_data, old_client_settings = (pickle.load

2586

(stored_state))

3360

2587

os.remove(stored_state_path)

3361

2588

except IOError as e:

3362

2589

if e.errno == errno.ENOENT:

3363

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

3364

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

2590

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

2591

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

3365

2592

else:

3366

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

3367

exc_info=e)

2593

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

2594

exc_info=e)

3368

2595

raise

3369

2596

except EOFError as e:

3370

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

3371

exc_info=e)

3372

2597

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

2598

"EOFError:", exc_info=e)

2599

3373

2600

with PGPEngine() as pgp:

3374

2601

for client_name, client in clients_data.items():

3375

2602

# Skip removed clients

3376

2603

if client_name not in client_settings:

3377

2604

continue

3378

2605

3379

2606

# Decide which value to use after restoring saved state.

3380

2607

# We have three different values: Old config file,

3381

2608

# new config file, and saved state.

3386

2613

# For each value in new config, check if it

3387

2614

# differs from the old config value (Except for

3388

2615

# the "secret" attribute)

3389

if (name != "secret"

3390

and (value !=

3391

old_client_settings[client_name][name])):

2616

if (name != "secret" and

2617

value != old_client_settings[client_name]

2618

[name]):

3392

2619

client[name] = value

3393

2620

except KeyError:

3394

2621

pass

3395

2622

3396

2623

# Clients who has passed its expire date can still be

3397

# enabled if its last checker was successful. A Client

2624

# enabled if its last checker was successful. Clients

3398

2625

# whose checker succeeded before we stored its state is

3399

2626

# assumed to have successfully run all checkers during

3400

2627

# downtime.

3401

2628

if client["enabled"]:

3402

2629

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

3403

2630

if not client["last_checked_ok"]:

3404

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

3405

" never performed a successful"

3406

" checker", client_name)

2631

logger.warning(

2632

"disabling client {} - Client never "

2633

"performed a successful checker"

2634

.format(client_name))

3407

2635

client["enabled"] = False

3408

2636

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

2637

logger.warning(

2638

"disabling client {} - Client last"

2639

" checker failed with error code {}"

2640

.format(client_name,

2641

client["last_checker_status"]))

3413

2642

client["enabled"] = False

3414

2643

else:

3415

client["expires"] = (

3416

datetime.datetime.utcnow()

3417

+ client["timeout"])

3418

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

3419

" enabled", client_name)

2644

client["expires"] = (datetime.datetime

2645

.utcnow()

2646

+ client["timeout"])

2647

logger.debug("Last checker succeeded,"

2648

" keeping {} enabled"

2649

.format(client_name))

3420

2650

try:

3421

client["secret"] = pgp.decrypt(

3422

client["encrypted_secret"],

3423

client_settings[client_name]["secret"])

2651

client["secret"] = (

2652

pgp.decrypt(client["encrypted_secret"],

2653

client_settings[client_name]

2654

["secret"]))

3424

2655

except PGPError:

3425

2656

# 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

2657

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

2658

.format(client_name))

2659

client["secret"] = (

2660

client_settings[client_name]["secret"])

2661

3431

2662

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

3432

2663

for client_name in (set(old_client_settings)

3433

2664

- set(client_settings)):

3435

2666

for client_name in (set(client_settings)

3436

2667

- set(old_client_settings)):

3437

2668

clients_data[client_name] = client_settings[client_name]

3438

2669

3439

2670

# Create all client objects

3440

2671

for client_name, client in clients_data.items():

3441

2672

tcp_server.clients[client_name] = client_class(

3442

name=client_name,

3443

settings=client,

3444

server_settings=server_settings)

3445

2673

name = client_name, settings = client,

2674

server_settings = server_settings)

2675

3446

2676

if not tcp_server.clients:

3447

log.warning("No clients defined")

3448

2677

logger.warning("No clients defined")

2678

3449

2679

if not foreground:

3450

2680

if pidfile is not None:

3451

pid = os.getpid()

3452

2681

try:

3453

2682

with pidfile:

3454

print(pid, file=pidfile)

2683

pid = os.getpid()

2684

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

3455

2685

except IOError:

3456

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

3457

pidfilename, pid)

2686

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

2687

pidfilename, pid)

3458

2688

del pidfile

3459

2689

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

2690

2691

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

2692

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

2693

3465

2694

if use_dbus:

3466

3467

@alternate_dbus_interfaces(

3468

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

3469

class MandosDBusService(DBusObjectWithObjectManager):

2695

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

2696

"se.bsnet.fukt.Mandos"})

2697

class MandosDBusService(DBusObjectWithProperties):

3470

2698

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

3471

3472

2699

def __init__(self):

3473

2700

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

3474

3475

2701

_interface = "se.recompile.Mandos"

3476

2702

2703

@dbus_interface_annotations(_interface)

2704

def _foo(self):

2705

return { "org.freedesktop.DBus.Property"

2706

".EmitsChangedSignal":

2707

"false"}

2708

3477

2709

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

3478

2710

def ClientAdded(self, objpath):

3479

2711

"D-Bus signal"

3480

2712

pass

3481

2713

3482

2714

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

3483

def ClientNotFound(self, key_id, address):

2715

def ClientNotFound(self, fingerprint, address):

3484

2716

"D-Bus signal"

3485

2717

pass

3486

3487

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

3488

"true"})

2718

3489

2719

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

3490

2720

def ClientRemoved(self, objpath, name):

3491

2721

"D-Bus signal"

3492

2722

pass

3493

3494

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

3495

"true"})

2723

3496

2724

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

3497

2725

def GetAllClients(self):

3498

2726

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

2727

return dbus.Array(c.dbus_object_path

2728

for c in

2729

tcp_server.clients.itervalues())

2730

3504

2731

@dbus.service.method(_interface,

3505

2732

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

3506

2733

def GetAllClientsWithProperties(self):

3507

2734

"D-Bus method"

3508

2735

return dbus.Dictionary(

3509

{c.dbus_object_path: c.GetAll(

3510

"se.recompile.Mandos.Client")

3511

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

2736

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

2737

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

3512

2738

signature="oa{sv}")

3513

2739

3514

2740

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

3515

2741

def RemoveClient(self, object_path):

3516

2742

"D-Bus method"

3517

for c in tcp_server.clients.values():

2743

for c in tcp_server.clients.itervalues():

3518

2744

if c.dbus_object_path == object_path:

3519

2745

del tcp_server.clients[c.name]

3520

2746

c.remove_from_connection()

3521

# Don't signal the disabling

2747

# Don't signal anything except ClientRemoved

3522

2748

c.disable(quiet=True)

3523

# Emit D-Bus signal for removal

3524

self.client_removed_signal(c)

2749

# Emit D-Bus signal

2750

self.ClientRemoved(object_path, c.name)

3525

2751

return

3526

2752

raise KeyError(object_path)

3527

2753

3528

2754

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

2755

3566

2756

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

2757

3573

2758

def cleanup():

3574

2759

"Cleanup function; run on exit"

3575

2760

if zeroconf:

3576

2761

service.cleanup()

3577

3578

mp.active_children()

3579

wn.close()

2762

2763

multiprocessing.active_children()

2764

wnull.close()

3580

2765

if not (tcp_server.clients or client_settings):

3581

2766

return

3582

2767

3583

2768

# Store client before exiting. Secrets are encrypted with key

3584

2769

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

3585

2770

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

3586

2771

clients = {}

3587

2772

with PGPEngine() as pgp:

3588

for client in tcp_server.clients.values():

2773

for client in tcp_server.clients.itervalues():

3589

2774

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

3590

2775

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

3591

2776

key)

3592

2777

client_dict = {}

3593

2778

3594

2779

# A list of attributes that can not be pickled

3595

2780

# + secret.

3596

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

3597

"checker", "server_settings"}

3598

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

3599

.Object):

2781

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

2782

"checker", "server_settings" }

2783

for name, typ in (inspect.getmembers

2784

(dbus.service.Object)):

3600

2785

exclude.add(name)

3601

2786

3602

2787

client_dict["encrypted_secret"] = (client

3603

2788

.encrypted_secret)

3604

2789

for attr in client.client_structure:

3605

2790

if attr not in exclude:

3606

2791

client_dict[attr] = getattr(client, attr)

3607

2792

3608

2793

clients[client.name] = client_dict

3609

2794

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

3610

2795

3611

2796

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

2797

with (tempfile.NamedTemporaryFile

2798

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

2799

dir=os.path.dirname(stored_state_path),

2800

delete=False)) as stored_state:

2801

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

2802

tempname=stored_state.name

3621

2803

os.rename(tempname, stored_state_path)

3622

2804

except (IOError, OSError) as e:

3623

2805

if not debug:

3626

2808

except NameError:

3627

2809

pass

3628

2810

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

3629

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

3630

os.strerror(e.errno))

2811

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

2812

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

3631

2813

else:

3632

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

3633

exc_info=e)

2814

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

2815

exc_info=e)

3634

2816

raise

3635

2817

3636

2818

# Delete all clients, and settings from config

3637

2819

while tcp_server.clients:

3638

2820

name, client = tcp_server.clients.popitem()

3639

2821

if use_dbus:

3640

2822

client.remove_from_connection()

3641

# Don't signal the disabling

2823

# Don't signal anything except ClientRemoved

3642

2824

client.disable(quiet=True)

3643

# Emit D-Bus signal for removal

3644

2825

if use_dbus:

3645

mandos_dbus_service.client_removed_signal(client)

2826

# Emit D-Bus signal

2827

mandos_dbus_service.ClientRemoved(client

2828

.dbus_object_path,

2829

client.name)

3646

2830

client_settings.clear()

3647

2831

3648

2832

atexit.register(cleanup)

3649

3650

for client in tcp_server.clients.values():

2833

2834

for client in tcp_server.clients.itervalues():

3651

2835

if use_dbus:

3652

# Emit D-Bus signal for adding

3653

mandos_dbus_service.client_added_signal(client)

2836

# Emit D-Bus signal

2837

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3654

2838

# Need to initiate checking of clients

3655

2839

if client.enabled:

3656

client.init_checker(randomize_start=True)

3657

2840

client.init_checker()

2841

3658

2842

tcp_server.enable()

3659

2843

tcp_server.server_activate()

3660

2844

3661

2845

# Find out what port we got

3662

2846

if zeroconf:

3663

2847

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

3664

2848

if use_ipv6:

3665

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

3666

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

2849

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

2850

" flowinfo %d, scope_id %d",

2851

*tcp_server.socket.getsockname())

3667

2852

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

2853

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

2854

*tcp_server.socket.getsockname())

2855

2856

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

2857

3673

2858

try:

3674

2859

if zeroconf:

3675

2860

# From the Avahi example code

3676

2861

try:

3677

2862

service.activate()

3678

2863

except dbus.exceptions.DBusException as error:

3679

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

2864

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

3680

2865

cleanup()

3681

2866

sys.exit(1)

3682

2867

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

2868

2869

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

2870

lambda *args, **kwargs:

2871

(tcp_server.handle_request

2872

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

2873

2874

logger.debug("Starting main loop")

3691

2875

main_loop.run()

3692

2876

except AvahiError as error:

3693

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

2877

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

3694

2878

cleanup()

3695

2879

sys.exit(1)

3696

2880

except KeyboardInterrupt:

3697

2881

if debug:

3698

2882

print("", file=sys.stderr)

3699

log.debug("Server received KeyboardInterrupt")

3700

log.debug("Server exiting")

2883

logger.debug("Server received KeyboardInterrupt")

2884

logger.debug("Server exiting")

3701

2885

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

3702

2886

cleanup()

3703

2887

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:

2888

if __name__ == '__main__':

2889

main()