/mandos/release : revision 237.7.350

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

44

import argparse

45

import logging

46

import os

47

39

try:

48

40

import SocketServer as socketserver

49

41

except ImportError:

50

42

import socketserver

51

43

import socket

44

import argparse

52

45

import datetime

53

46

import errno

54

47

try:

55

48

import ConfigParser as configparser

56

49

except ImportError:

57

50

import configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

77

73

import itertools

78

74

import collections

79

75

import codecs

80

import random

81

import shlex

82

76

83

77

import dbus

84

78

import dbus.service

85

import gi

86

from gi.repository import GLib

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

83

import avahi

87

84

from dbus.mainloop.glib import DBusGMainLoop

88

85

import ctypes

89

86

import ctypes.util

90

87

import xml.dom.minidom

91

88

import inspect

92

89

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

90

try:

122

91

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

92

except AttributeError:

124

93

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

94

from IN import SO_BINDTODEVICE

128

95

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

96

SO_BINDTODEVICE = None

97

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

147

102

stored_state_file = "clients.pickle"

148

103

149

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

150

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

104

logger = logging.getLogger()

151

105

syslogger = None

152

106

153

107

try:

154

108

if_nametoindex = ctypes.cdll.LoadLibrary(

155

109

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

156

110

except (OSError, AttributeError):

157

111

158

112

def if_nametoindex(interface):

159

113

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

160

114

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

165

119

return interface_index

166

120

167

121

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

122

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

185

123

"""init logger and add loglevel"""

186

124

187

125

global syslogger

188

126

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

191

129

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

196

134

if debug:

197

135

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

136

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

137

' [%(process)d]:'

138

' %(levelname)s:'

139

' %(message)s'))

140

logger.addHandler(console)

141

logger.setLevel(level)

204

142

205

143

206

144

class PGPError(Exception):

208

146

pass

209

147

210

148

211

class PGPEngine:

149

class PGPEngine(object):

212

150

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

213

151

214

152

def __init__(self):

215

153

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

154

self.gnupgargs = ['--batch',

155

'--home', self.tempdir,

156

'--force-mdc',

157

'--quiet',

158

'--no-use-agent']

159

235

160

def __enter__(self):

236

161

return self

237

162

238

163

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

239

164

self._cleanup()

240

165

return False

241

166

242

167

def __del__(self):

243

168

self._cleanup()

244

169

245

170

def _cleanup(self):

246

171

if self.tempdir is not None:

247

172

# Delete contents of tempdir

248

173

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

249

topdown=False):

174

topdown = False):

250

175

for filename in files:

251

176

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

252

177

for dirname in dirs:

254

179

# Remove tempdir

255

180

os.rmdir(self.tempdir)

256

181

self.tempdir = None

257

182

258

183

def password_encode(self, password):

259

184

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

260

185

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

265

190

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

266

191

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

267

192

return encoded

268

193

269

194

def encrypt(self, data, password):

270

195

passphrase = self.password_encode(password)

271

196

with tempfile.NamedTemporaryFile(

272

197

dir=self.tempdir) as passfile:

273

198

passfile.write(passphrase)

274

199

passfile.flush()

275

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

276

"--passphrase-file",

200

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

201

'--passphrase-file',

277

202

passfile.name]

278

203

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

204

stdin = subprocess.PIPE,

205

stdout = subprocess.PIPE,

206

stderr = subprocess.PIPE)

207

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

283

208

if proc.returncode != 0:

284

209

raise PGPError(err)

285

210

return ciphertext

286

211

287

212

def decrypt(self, data, password):

288

213

passphrase = self.password_encode(password)

289

214

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

215

dir = self.tempdir) as passfile:

291

216

passfile.write(passphrase)

292

217

passfile.flush()

293

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

294

"--passphrase-file",

218

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

219

'--passphrase-file',

295

220

passfile.name]

296

221

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

222

stdin = subprocess.PIPE,

223

stdout = subprocess.PIPE,

224

stderr = subprocess.PIPE)

225

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

301

226

if proc.returncode != 0:

302

227

raise PGPError(err)

303

228

return decrypted_plaintext

304

229

305

230

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

231

class AvahiError(Exception):

333

232

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

334

233

self.value = value

344

243

pass

345

244

346

245

347

class AvahiService:

246

class AvahiService(object):

348

247

"""An Avahi (Zeroconf) service.

349

248

350

249

Attributes:

351

250

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

352

251

Used to optionally bind to the specified interface.

353

name: string; Example: "Mandos"

354

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

252

name: string; Example: 'Mandos'

253

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

355

254

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

356

255

port: integer; what port to announce

357

256

TXT: list of strings; TXT record for the service

364

263

server: D-Bus Server

365

264

bus: dbus.SystemBus()

366

265

"""

367

266

368

267

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

268

interface = avahi.IF_UNSPEC,

269

name = None,

270

servicetype = None,

271

port = None,

272

TXT = None,

273

domain = "",

274

host = "",

275

max_renames = 32768,

276

protocol = avahi.PROTO_UNSPEC,

277

bus = None):

379

278

self.interface = interface

380

279

self.name = name

381

280

self.type = servicetype

390

289

self.server = None

391

290

self.bus = bus

392

291

self.entry_group_state_changed_match = None

393

292

394

293

def rename(self, remove=True):

395

294

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

396

295

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

296

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

297

" after %i retries, exiting.",

298

self.rename_count)

400

299

raise AvahiServiceError("Too many renames")

401

300

self.name = str(

402

301

self.server.GetAlternativeServiceName(self.name))

403

302

self.rename_count += 1

404

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

405

self.name)

303

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

304

self.name)

406

305

if remove:

407

306

self.remove()

408

307

try:

410

309

except dbus.exceptions.DBusException as error:

411

310

if (error.get_dbus_name()

412

311

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

413

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

312

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

414

313

return self.rename(remove=False)

415

314

else:

416

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

315

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

417

316

self.cleanup()

418

317

os._exit(1)

419

318

420

319

def remove(self):

421

320

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

422

321

if self.entry_group_state_changed_match is not None:

424

323

self.entry_group_state_changed_match = None

425

324

if self.group is not None:

426

325

self.group.Reset()

427

326

428

327

def add(self):

429

328

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

430

329

self.remove()

435

334

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

335

self.entry_group_state_changed_match = (

437

336

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

337

'StateChanged', self.entry_group_state_changed))

338

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

339

self.name, self.type)

441

340

self.group.AddService(

442

341

self.interface,

443

342

self.protocol,

447

346

dbus.UInt16(self.port),

448

347

avahi.string_array_to_txt_array(self.TXT))

449

348

self.group.Commit()

450

349

451

350

def entry_group_state_changed(self, state, error):

452

351

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

453

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

454

352

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

353

455

354

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

355

logger.debug("Zeroconf service established.")

457

356

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

357

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

459

358

self.rename()

460

359

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

360

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

361

str(error))

463

362

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

464

363

465

364

def cleanup(self):

466

365

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

467

366

if self.group is not None:

472

371

pass

473

372

self.group = None

474

373

self.remove()

475

374

476

375

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

477

376

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

478

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

377

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

479

378

bad_states = {

480

379

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

380

avahi.SERVER_REGISTERING: None,

485

384

if state in bad_states:

486

385

if bad_states[state] is not None:

487

386

if error is None:

488

log.error(bad_states[state])

387

logger.error(bad_states[state])

489

388

else:

490

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

389

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

491

390

self.cleanup()

492

391

elif state == avahi.SERVER_RUNNING:

493

392

try:

495

394

except dbus.exceptions.DBusException as error:

496

395

if (error.get_dbus_name()

497

396

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

498

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

397

logger.info("Local Zeroconf service name"

398

" collision.")

499

399

return self.rename(remove=False)

500

400

else:

501

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

401

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

502

402

self.cleanup()

503

403

os._exit(1)

504

404

else:

505

405

if error is None:

506

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

406

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

507

407

else:

508

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

509

408

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

409

510

410

def activate(self):

511

411

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

512

412

if self.server is None:

523

423

class AvahiServiceToSyslog(AvahiService):

524

424

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

525

425

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

526

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

527

**kwargs)

426

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

528

427

syslogger.setFormatter(logging.Formatter(

529

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

428

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

530

429

.format(self.name)))

531

430

return ret

532

431

533

534

432

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

433

class GnuTLS(object):

434

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

435

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

436

437

_library = ctypes.cdll.LoadLibrary(

438

ctypes.util.find_library("gnutls"))

439

_need_version = "3.3.0"

440

def __init__(self):

441

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

442

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

443

# happens.

444

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

445

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

446

.format(self._need_version))

447

544

448

# Unless otherwise indicated, the constants and types below are

545

449

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

546

450

547

451

# Constants

548

452

E_SUCCESS = 0

549

453

E_INTERRUPTED = -52

550

454

E_AGAIN = -28

551

455

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

456

CLIENT = 2

554

457

SHUT_RDWR = 0

555

458

CRD_CERTIFICATE = 1

556

459

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

460

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

461

564

462

# Types

565

class _session_int(ctypes.Structure):

463

class session_int(ctypes.Structure):

566

464

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

465

session_t = ctypes.POINTER(session_int)

569

466

class certificate_credentials_st(ctypes.Structure):

570

467

_fields_ = []

571

468

certificate_credentials_t = ctypes.POINTER(

572

469

certificate_credentials_st)

573

470

certificate_type_t = ctypes.c_int

574

575

471

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

472

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

473

('size', ctypes.c_uint)]

474

class openpgp_crt_int(ctypes.Structure):

580

475

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

476

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

477

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

478

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

584

credentials_type_t = ctypes.c_int

479

credentials_type_t = ctypes.c_int #

585

480

transport_ptr_t = ctypes.c_void_p

586

481

close_request_t = ctypes.c_int

587

482

588

483

# Exceptions

589

484

class Error(Exception):

590

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

485

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

486

# exception might be raised from within GnuTLS.__init__,

487

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

488

# global variable has happened.

489

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

591

490

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

592

491

# code is passed, convert it to a string with

593

492

# gnutls.strerror()

594

493

self.code = code

595

494

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

495

message = GnuTLS.strerror(code)

496

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

599

497

message, *args)

600

498

601

499

class CertificateSecurityError(Error):

602

500

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

501

629

502

# Classes

630

class Credentials(With_from_param):

503

class Credentials(object):

631

504

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

505

self._c_object = gnutls.certificate_credentials_t()

506

gnutls.certificate_allocate_credentials(

507

ctypes.byref(self._c_object))

634

508

self.type = gnutls.CRD_CERTIFICATE

635

509

636

510

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

511

gnutls.certificate_free_credentials(self._c_object)

512

513

class ClientSession(object):

514

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

515

self._c_object = gnutls.session_t()

516

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

517

gnutls.set_default_priority(self._c_object)

518

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

519

gnutls.handshake_set_private_extensions(self._c_object,

520

True)

652

521

self.socket = socket

653

522

if credentials is None:

654

523

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

524

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

525

ctypes.cast(credentials._c_object,

526

ctypes.c_void_p))

657

527

self.credentials = credentials

658

528

659

529

def __del__(self):

660

gnutls.deinit(self)

661

530

gnutls.deinit(self._c_object)

531

662

532

def handshake(self):

663

return gnutls.handshake(self)

664

533

return gnutls.handshake(self._c_object)

534

665

535

def send(self, data):

666

536

data = bytes(data)

667

537

data_len = len(data)

668

538

while data_len > 0:

669

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

539

data_len -= gnutls.record_send(self._c_object,

540

data[-data_len:],

670

541

data_len)

671

542

672

543

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

544

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

545

675

546

# Error handling functions

676

547

def _error_code(result):

677

548

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

678

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

679

if result >= gnutls.E_SUCCESS:

549

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

550

if result >= 0:

680

551

return result

681

552

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

553

raise gnutls.CertificateSecurityError(code = result)

554

raise gnutls.Error(code = result)

555

556

def _retry_on_error(result, func, arguments):

687

557

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

688

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

689

while result < gnutls.E_SUCCESS:

558

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

559

while result < 0:

690

560

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

691

561

return _error_code(result)

692

562

result = func(*arguments)

693

563

return result

694

564

695

565

# Unless otherwise indicated, the function declarations below are

696

566

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

697

567

698

568

# Functions

699

569

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

570

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

701

571

ctypes.POINTER(ctypes.c_char_p)]

702

572

priority_set_direct.restype = _error_code

703

573

704

574

init = _library.gnutls_init

705

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

575

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

706

576

init.restype = _error_code

707

577

708

578

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

579

set_default_priority.argtypes = [session_t]

710

580

set_default_priority.restype = _error_code

711

581

712

582

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

583

record_send.argtypes = [session_t, ctypes.c_void_p,

714

584

ctypes.c_size_t]

715

585

record_send.restype = ctypes.c_ssize_t

716

586

record_send.errcheck = _retry_on_error

717

587

718

588

certificate_allocate_credentials = (

719

589

_library.gnutls_certificate_allocate_credentials)

720

590

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

591

ctypes.POINTER(certificate_credentials_t)]

722

592

certificate_allocate_credentials.restype = _error_code

723

593

724

594

certificate_free_credentials = (

725

595

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

596

certificate_free_credentials.argtypes = [certificate_credentials_t]

727

597

certificate_free_credentials.restype = None

728

598

729

599

handshake_set_private_extensions = (

730

600

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

601

handshake_set_private_extensions.argtypes = [session_t,

732

602

ctypes.c_int]

733

603

handshake_set_private_extensions.restype = None

734

604

735

605

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

606

credentials_set.argtypes = [session_t, credentials_type_t,

607

ctypes.c_void_p]

738

608

credentials_set.restype = _error_code

739

609

740

610

strerror = _library.gnutls_strerror

741

611

strerror.argtypes = [ctypes.c_int]

742

612

strerror.restype = ctypes.c_char_p

743

613

744

614

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

615

certificate_type_get.argtypes = [session_t]

746

616

certificate_type_get.restype = _error_code

747

617

748

618

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

619

certificate_get_peers.argtypes = [session_t,

750

620

ctypes.POINTER(ctypes.c_uint)]

751

621

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

622

753

623

global_set_log_level = _library.gnutls_global_set_log_level

754

624

global_set_log_level.argtypes = [ctypes.c_int]

755

625

global_set_log_level.restype = None

756

626

757

627

global_set_log_function = _library.gnutls_global_set_log_function

758

628

global_set_log_function.argtypes = [log_func]

759

629

global_set_log_function.restype = None

760

630

761

631

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

632

deinit.argtypes = [session_t]

763

633

deinit.restype = None

764

634

765

635

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

636

handshake.argtypes = [session_t]

637

handshake.restype = _error_code

768

638

handshake.errcheck = _retry_on_error

769

639

770

640

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

641

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

772

642

transport_set_ptr.restype = None

773

643

774

644

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

645

bye.argtypes = [session_t, close_request_t]

646

bye.restype = _error_code

777

647

bye.errcheck = _retry_on_error

778

648

779

649

check_version = _library.gnutls_check_version

780

650

check_version.argtypes = [ctypes.c_char_p]

781

651

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

652

653

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

654

655

openpgp_crt_init = _library.gnutls_openpgp_crt_init

656

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

657

openpgp_crt_init.restype = _error_code

658

659

openpgp_crt_import = _library.gnutls_openpgp_crt_import

660

openpgp_crt_import.argtypes = [openpgp_crt_t,

661

ctypes.POINTER(datum_t),

662

openpgp_crt_fmt_t]

663

openpgp_crt_import.restype = _error_code

664

665

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

666

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

667

ctypes.POINTER(ctypes.c_uint)]

668

openpgp_crt_verify_self.restype = _error_code

669

670

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

671

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

672

openpgp_crt_deinit.restype = None

673

674

openpgp_crt_get_fingerprint = (

675

_library.gnutls_openpgp_crt_get_fingerprint)

676

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

677

ctypes.c_void_p,

678

ctypes.POINTER(

679

ctypes.c_size_t)]

680

openpgp_crt_get_fingerprint.restype = _error_code

681

859

682

# Remove non-public functions

860

683

del _error_code, _retry_on_error

861

684

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

685

gnutls = GnuTLS()

862

686

863

687

def call_pipe(connection, # : multiprocessing.Connection

864

688

func, *args, **kwargs):

865

689

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

866

690

867

691

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

868

692

return value on the provided multiprocessing.Connection.

869

693

"""

870

694

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

871

695

connection.close()

872

696

873

874

class Client:

697

class Client(object):

875

698

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

876

699

877

700

Attributes:

878

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

701

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

879

702

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

880

703

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

704

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

705

to see if the client lives.

706

'None' if no process is running.

707

checker_callback_tag: a gobject event source tag, or None

885

708

checker_command: string; External command which is run to check

886

709

if client lives. %() expansions are done at

887

710

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

888

711

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

889

checker_initiator_tag: a GLib event source tag, or None

712

checker_initiator_tag: a gobject event source tag, or None

890

713

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

891

714

client_structure: Object describing what attributes a client has

892

715

and is used for storing the client at exit

893

716

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

717

disable_initiator_tag: a gobject event source tag, or None

895

718

enabled: bool()

896

719

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

720

uniquely identify the client

900

721

host: string; available for use by the checker command

901

722

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

902

723

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

918

739

disabled, or None

919

740

server_settings: The server_settings dict from main()

920

741

"""

921

742

922

743

runtime_expansions = ("approval_delay", "approval_duration",

923

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

744

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

924

745

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

925

746

"last_approval_request", "last_checked_ok",

926

747

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

935

756

"approved_by_default": "True",

936

757

"enabled": "True",

937

758

}

938

759

939

760

@staticmethod

940

761

def config_parser(config):

941

762

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

948

769

for client_name in config.sections():

949

770

section = dict(config.items(client_name))

950

771

client = settings[client_name] = {}

951

772

952

773

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

953

774

# Reformat values from string types to Python types

954

775

client["approved_by_default"] = config.getboolean(

955

776

client_name, "approved_by_default")

956

777

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

957

778

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

964

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

965

"").upper()

779

780

# Uppercase and remove spaces from fingerprint for later

781

# comparison purposes with return value from the

782

# fingerprint() function

783

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

966

784

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

972

785

if "secret" in section:

973

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

974

.encode("utf-8"),

975

"base64")

786

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

976

787

elif "secfile" in section:

977

788

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

978

789

(section["secfile"])),

993

804

client["last_approval_request"] = None

994

805

client["last_checked_ok"] = None

995

806

client["last_checker_status"] = -2

996

807

997

808

return settings

998

999

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

809

810

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

1000

811

self.name = name

1001

812

if server_settings is None:

1002

813

server_settings = {}

1004

815

# adding all client settings

1005

816

for setting, value in settings.items():

1006

817

setattr(self, setting, value)

1007

818

1008

819

if self.enabled:

1009

820

if not hasattr(self, "last_enabled"):

1010

821

self.last_enabled = datetime.datetime.utcnow()

1014

825

else:

1015

826

self.last_enabled = None

1016

827

self.expires = None

1017

1018

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

1019

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

1020

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

828

829

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

830

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

1021

831

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

1022

832

datetime.datetime.utcnow())

1023

833

1024

834

# attributes specific for this server instance

1025

835

self.checker = None

1026

836

self.checker_initiator_tag = None

1032

842

self.changedstate = multiprocessing_manager.Condition(

1033

843

multiprocessing_manager.Lock())

1034

844

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

845

for attr in self.__dict__.iterkeys()

1036

846

if not attr.startswith("_")]

1037

847

self.client_structure.append("client_structure")

1038

848

1039

849

for name, t in inspect.getmembers(

1040

850

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

1041

851

if not name.startswith("_"):

1042

852

self.client_structure.append(name)

1043

853

1044

854

# Send notice to process children that client state has changed

1045

855

def send_changedstate(self):

1046

856

with self.changedstate:

1047

857

self.changedstate.notify_all()

1048

858

1049

859

def enable(self):

1050

860

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

1051

861

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

1052

862

# Already enabled

1053

863

return

864

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

1054

865

self.enabled = True

1055

866

self.last_enabled = datetime.datetime.utcnow()

1056

867

self.init_checker()

1057

868

self.send_changedstate()

1058

869

1059

870

def disable(self, quiet=True):

1060

871

"""Disable this client."""

1061

872

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

1062

873

return False

1063

874

if not quiet:

1064

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

875

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

1065

876

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

1066

GLib.source_remove(self.disable_initiator_tag)

877

gobject.source_remove(self.disable_initiator_tag)

1067

878

self.disable_initiator_tag = None

1068

879

self.expires = None

1069

880

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

1070

GLib.source_remove(self.checker_initiator_tag)

881

gobject.source_remove(self.checker_initiator_tag)

1071

882

self.checker_initiator_tag = None

1072

883

self.stop_checker()

1073

884

self.enabled = False

1074

885

if not quiet:

1075

886

self.send_changedstate()

1076

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

887

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

1077

888

return False

1078

889

1079

890

def __del__(self):

1080

891

self.disable()

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

892

893

def init_checker(self):

894

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

895

# and every interval from then on.

1087

896

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

897

gobject.source_remove(self.checker_initiator_tag)

898

self.checker_initiator_tag = gobject.timeout_add(

899

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

900

self.start_checker)

901

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

1106

902

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

903

gobject.source_remove(self.disable_initiator_tag)

904

self.disable_initiator_tag = gobject.timeout_add(

905

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

906

# Also start a new checker *right now*.

907

self.start_checker()

908

1112

909

def checker_callback(self, source, condition, connection,

1113

910

command):

1114

911

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

912

self.checker_callback_tag = None

913

self.checker = None

1115

914

# Read return code from connection (see call_pipe)

1116

915

returncode = connection.recv()

1117

916

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

self.checker_callback_tag = None

1121

self.checker = None

1122

917

1123

918

if returncode >= 0:

1124

919

self.last_checker_status = returncode

1125

920

self.last_checker_signal = None

1126

921

if self.last_checker_status == 0:

1127

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

922

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

923

vars(self))

1128

924

self.checked_ok()

1129

925

else:

1130

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

926

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

1131

927

else:

1132

928

self.last_checker_status = -1

1133

929

self.last_checker_signal = -returncode

1134

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

930

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

931

vars(self))

1135

932

return False

1136

933

1137

934

def checked_ok(self):

1138

935

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

1139

936

self.last_checked_ok = datetime.datetime.utcnow()

1140

937

self.last_checker_status = 0

1141

938

self.last_checker_signal = None

1142

939

self.bump_timeout()

1143

940

1144

941

def bump_timeout(self, timeout=None):

1145

942

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

1146

943

if timeout is None:

1147

944

timeout = self.timeout

1148

945

if self.disable_initiator_tag is not None:

1149

GLib.source_remove(self.disable_initiator_tag)

946

gobject.source_remove(self.disable_initiator_tag)

1150

947

self.disable_initiator_tag = None

1151

948

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

1152

self.disable_initiator_tag = GLib.timeout_add(

949

self.disable_initiator_tag = gobject.timeout_add(

1153

950

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

1154

951

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

1155

952

1156

953

def need_approval(self):

1157

954

self.last_approval_request = datetime.datetime.utcnow()

1158

1159

def start_checker(self, start_was_randomized=False):

955

956

def start_checker(self):

1160

957

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

1161

958

1162

959

If a checker already exists, leave it running and do

1163

960

nothing."""

1164

961

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

1169

966

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

1170

967

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

1171

968

# should be.

1172

969

1173

970

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

1174

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

971

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

1175

972

self.checker.join()

1176

973

self.checker = None

1177

974

# Start a new checker if needed

1178

975

if self.checker is None:

1179

976

# Escape attributes for the shell

1180

977

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

978

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

979

for attr in self.runtime_expansions }

1183

980

try:

1184

981

command = self.checker_command % escaped_attrs

1185

982

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

983

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

984

self.checker_command,

985

exc_info=error)

1188

986

return True # Try again later

1189

987

self.current_checker_command = command

1190

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

988

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

989

self.name)

1191

990

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

1192

991

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

1193

992

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

1195

994

# The exception is when not debugging but nevertheless

1196

995

# running in the foreground; use the previously

1197

996

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

997

popen_args = { "close_fds": True,

998

"shell": True,

999

"cwd": "/" }

1201

1000

if (not self.server_settings["debug"]

1202

1001

and self.server_settings["foreground"]):

1203

1002

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

1003

"stderr": wnull })

1004

pipe = multiprocessing.Pipe(duplex = False)

1206

1005

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

1006

target = call_pipe,

1007

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

1008

kwargs = popen_args)

1210

1009

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1010

self.checker_callback_tag = gobject.io_add_watch(

1011

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

1214

1012

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1226

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

1013

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

1227

1014

return True

1228

1015

1229

1016

def stop_checker(self):

1230

1017

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

1231

1018

if self.checker_callback_tag:

1232

GLib.source_remove(self.checker_callback_tag)

1019

gobject.source_remove(self.checker_callback_tag)

1233

1020

self.checker_callback_tag = None

1234

1021

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

1235

1022

return

1236

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

1023

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

1237

1024

self.checker.terminate()

1238

1025

self.checker = None

1239

1026

1244

1031

byte_arrays=False):

1245

1032

"""Decorators for marking methods of a DBusObjectWithProperties to

1246

1033

become properties on the D-Bus.

1247

1034

1248

1035

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

1249

1036

and with one argument by "Set".

1250

1037

1251

1038

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

1252

1039

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

1253

1040

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

1257

1044

if byte_arrays and signature != "ay":

1258

1045

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

1259

1046

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

1260

1047

1261

1048

def decorator(func):

1262

1049

func._dbus_is_property = True

1263

1050

func._dbus_interface = dbus_interface

1266

1053

func._dbus_name = func.__name__

1267

1054

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

1268

1055

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

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

1056

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1270

1057

return func

1271

1058

1272

1059

return decorator

1273

1060

1274

1061

1275

1062

def dbus_interface_annotations(dbus_interface):

1276

1063

"""Decorator for marking functions returning interface annotations

1277

1064

1278

1065

Usage:

1279

1066

1280

1067

@dbus_interface_annotations("org.example.Interface")

1281

1068

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

1282

1069

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

1283

1070

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

1284

1071

"false"}

1285

1072

"""

1286

1073

1287

1074

def decorator(func):

1288

1075

func._dbus_is_interface = True

1289

1076

func._dbus_interface = dbus_interface

1290

1077

func._dbus_name = dbus_interface

1291

1078

return func

1292

1079

1293

1080

return decorator

1294

1081

1295

1082

1296

1083

def dbus_annotations(annotations):

1297

1084

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

1298

1085

Usage:

1299

1086

1300

1087

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

1301

1088

"org.freedesktop.DBus.Property."

1302

1089

"EmitsChangedSignal": "false"})

1304

1091

access="r")

1305

1092

def Property_dbus_property(self):

1306

1093

return dbus.Boolean(False)

1307

1094

1308

1095

See also the DBusObjectWithAnnotations class.

1309

1096

"""

1310

1097

1311

1098

def decorator(func):

1312

1099

func._dbus_annotations = annotations

1313

1100

return func

1314

1101

1315

1102

return decorator

1316

1103

1317

1104

1335

1122

1336

1123

class DBusObjectWithAnnotations(dbus.service.Object):

1337

1124

"""A D-Bus object with annotations.

1338

1125

1339

1126

Classes inheriting from this can use the dbus_annotations

1340

1127

decorator to add annotations to methods or signals.

1341

1128

"""

1342

1129

1343

1130

@staticmethod

1344

1131

def _is_dbus_thing(thing):

1345

1132

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

1346

1133

1347

1134

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

1348

1135

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

1349

1136

"""

1350

1137

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

1351

1138

False)

1352

1139

1353

1140

def _get_all_dbus_things(self, thing):

1354

1141

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

1355

1142

"""

1358

1145

for cls in self.__class__.__mro__

1359

1146

for name, athing in

1360

1147

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

1361

1148

1362

1149

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1150

out_signature = "s",

1151

path_keyword = 'object_path',

1152

connection_keyword = 'connection')

1366

1153

def Introspect(self, object_path, connection):

1367

1154

"""Overloading of standard D-Bus method.

1368

1155

1369

1156

Inserts annotation tags on methods and signals.

1370

1157

"""

1371

1158

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

1372

1159

connection)

1373

1160

try:

1374

1161

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

1375

1162

1376

1163

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

1377

1164

# Add annotation tags

1378

1165

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

1405

1192

if_tag.appendChild(ann_tag)

1406

1193

# Fix argument name for the Introspect method itself

1407

1194

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1195

== dbus.INTROSPECTABLE_IFACE):

1409

1196

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

1410

1197

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

1411

1198

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

1417

1204

document.unlink()

1418

1205

except (AttributeError, xml.dom.DOMException,

1419

1206

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1207

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

1208

exc_info=error)

1422

1209

return xmlstring

1423

1210

1424

1211

1425

1212

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

1213

"""A D-Bus object with properties.

1427

1214

1428

1215

Classes inheriting from this can use the dbus_service_property

1429

1216

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

1430

1217

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

1431

1218

"""

1432

1219

1433

1220

def _get_dbus_property(self, interface_name, property_name):

1434

1221

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

1435

1222

property with the specified name and interface.

1440

1227

if (value._dbus_name == property_name

1441

1228

and value._dbus_interface == interface_name):

1442

1229

return value.__get__(self)

1443

1230

1444

1231

# No such property

1445

1232

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

1446

1233

self.dbus_object_path, interface_name, property_name))

1447

1234

1448

1235

@classmethod

1449

1236

def _get_all_interface_names(cls):

1450

1237

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

1453

1240

for x in (inspect.getmro(cls))

1454

1241

for attr in dir(x))

1455

1242

if name is not None)

1456

1243

1457

1244

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

1245

in_signature="ss",

1459

1246

out_signature="v")

1467

1254

if not hasattr(value, "variant_level"):

1468

1255

return value

1469

1256

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

1470

1257

1471

1258

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

1472

1259

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

1473

1260

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

1482

1269

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

1483

1270

"'ay' signature {!r}"

1484

1271

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

1272

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

1273

for byte in value))

1486

1274

prop(value)

1487

1275

1488

1276

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

1277

in_signature="s",

1490

1278

out_signature="a{sv}")

1491

1279

def GetAll(self, interface_name):

1492

1280

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

1493

1281

standard.

1494

1282

1495

1283

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

1496

1284

"""

1497

1285

properties = {}

1508

1296

properties[name] = value

1509

1297

continue

1510

1298

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

1299

value, variant_level = value.variant_level + 1)

1512

1300

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

1513

1301

1514

1302

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

1515

1303

def PropertiesChanged(self, interface_name, changed_properties,

1516

1304

invalidated_properties):

1518

1306

standard.

1519

1307

"""

1520

1308

pass

1521

1309

1522

1310

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1523

1311

out_signature="s",

1524

path_keyword="object_path",

1525

connection_keyword="connection")

1312

path_keyword='object_path',

1313

connection_keyword='connection')

1526

1314

def Introspect(self, object_path, connection):

1527

1315

"""Overloading of standard D-Bus method.

1528

1316

1529

1317

Inserts property tags and interface annotation tags.

1530

1318

"""

1531

1319

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1533

1321

connection)

1534

1322

try:

1535

1323

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

1536

1324

1537

1325

def make_tag(document, name, prop):

1538

1326

e = document.createElement("property")

1539

1327

e.setAttribute("name", name)

1540

1328

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

1541

1329

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

1542

1330

return e

1543

1331

1544

1332

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

1545

1333

# Add property tags

1546

1334

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

1584

1372

document.unlink()

1585

1373

except (AttributeError, xml.dom.DOMException,

1586

1374

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1375

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

1376

exc_info=error)

1589

1377

return xmlstring

1590

1378

1591

1592

1379

try:

1593

1380

dbus.OBJECT_MANAGER_IFACE

1594

1381

except AttributeError:

1595

1382

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

1596

1383

1597

1598

1384

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

1385

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

1600

1386

1601

1387

Classes inheriting from this exposes the standard

1602

1388

GetManagedObjects call and the InterfacesAdded and

1603

1389

InterfacesRemoved signals on the standard

1604

1390

"org.freedesktop.DBus.ObjectManager" interface.

1605

1391

1606

1392

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

1607

1393

manually.

1608

1394

"""

1609

1395

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1396

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

1611

1397

def GetManagedObjects(self):

1612

1398

"""This function must be overridden"""

1613

1399

raise NotImplementedError()

1614

1400

1615

1401

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1402

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

1617

1403

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

1404

pass

1619

1620

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

1405

1406

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

1621

1407

def InterfacesRemoved(self, object_path, interfaces):

1622

1408

pass

1623

1409

1624

1410

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1411

out_signature = "s",

1412

path_keyword = 'object_path',

1413

connection_keyword = 'connection')

1628

1414

def Introspect(self, object_path, connection):

1629

1415

"""Overloading of standard D-Bus method.

1630

1416

1631

1417

Override return argument name of GetManagedObjects to be

1632

1418

"objpath_interfaces_and_properties"

1633

1419

"""

1636

1422

connection)

1637

1423

try:

1638

1424

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

1639

1425

1640

1426

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

1641

1427

# Fix argument name for the GetManagedObjects method

1642

1428

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1429

== dbus.OBJECT_MANAGER_IFACE):

1644

1430

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

1645

1431

if (cn.getAttribute("name")

1646

1432

== "GetManagedObjects"):

1655

1441

document.unlink()

1656

1442

except (AttributeError, xml.dom.DOMException,

1657

1443

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1444

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

1445

exc_info = error)

1660

1446

return xmlstring

1661

1447

1662

1663

1448

def datetime_to_dbus(dt, variant_level=0):

1664

1449

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

1665

1450

if dt is None:

1666

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

1451

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

1667

1452

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

1668

1453

1669

1454

1672

1457

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

1673

1458

interface names according to the "alt_interface_names" mapping.

1674

1459

Usage:

1675

1460

1676

1461

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

1677

1462

"net.example.AlternateInterface"})

1678

1463

class SampleDBusObject(dbus.service.Object):

1679

1464

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

1680

1465

def SampleDBusMethod():

1681

1466

pass

1682

1467

1683

1468

The above "SampleDBusMethod" on "SampleDBusObject" will be

1684

1469

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

1685

1470

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

1686

1471

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

1687

1472

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

1688

1473

1689

1474

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

1690

1475

(from DBusObjectWithProperties) and interfaces (from the

1691

1476

dbus_interface_annotations decorator).

1692

1477

"""

1693

1478

1694

1479

def wrapper(cls):

1695

1480

for orig_interface_name, alt_interface_name in (

1696

1481

alt_interface_names.items()):

1711

1496

interface_names.add(alt_interface)

1712

1497

# Is this a D-Bus signal?

1713

1498

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

1714

# Extract the original non-method undecorated

1715

# function by black magic

1716

1499

if sys.version_info.major == 2:

1500

# Extract the original non-method undecorated

1501

# function by black magic

1717

1502

nonmethod_func = (dict(

1718

1503

zip(attribute.func_code.co_freevars,

1719

1504

attribute.__closure__))

1720

1505

["func"].cell_contents)

1721

1506

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1507

nonmethod_func = attribute

1726

1508

# Create a new, but exactly alike, function

1727

1509

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

1728

1510

# with the alternate D-Bus interface name

1729

new_function = copy_function(nonmethod_func)

1511

if sys.version_info.major == 2:

1512

new_function = types.FunctionType(

1513

nonmethod_func.func_code,

1514

nonmethod_func.func_globals,

1515

nonmethod_func.func_name,

1516

nonmethod_func.func_defaults,

1517

nonmethod_func.func_closure)

1518

else:

1519

new_function = types.FunctionType(

1520

nonmethod_func.__code__,

1521

nonmethod_func.__globals__,

1522

nonmethod_func.__name__,

1523

nonmethod_func.__defaults__,

1524

nonmethod_func.__closure__)

1730

1525

new_function = (dbus.service.signal(

1731

1526

alt_interface,

1732

1527

attribute._dbus_signature)(new_function))

1736

1531

attribute._dbus_annotations)

1737

1532

except AttributeError:

1738

1533

pass

1739

1740

1534

# Define a creator of a function to call both the

1741

1535

# original and alternate functions, so both the

1742

1536

# original and alternate signals gets sent when

1745

1539

"""This function is a scope container to pass

1746

1540

func1 and func2 to the "call_both" function

1747

1541

outside of its arguments"""

1748

1542

1749

1543

@functools.wraps(func2)

1750

1544

def call_both(*args, **kwargs):

1751

1545

"""This function will emit two D-Bus

1752

1546

signals by calling func1 and func2"""

1753

1547

func1(*args, **kwargs)

1754

1548

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1549

# Make wrapper function look like a D-Bus signal

1757

1550

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

1758

1551

if name.startswith("_dbus_"):

1759

1552

setattr(call_both, name, attr)

1760

1553

1761

1554

return call_both

1762

1555

# Create the "call_both" function and add it to

1763

1556

# the class

1773

1566

alt_interface,

1774

1567

attribute._dbus_in_signature,

1775

1568

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1569

(types.FunctionType(attribute.func_code,

1570

attribute.func_globals,

1571

attribute.func_name,

1572

attribute.func_defaults,

1573

attribute.func_closure)))

1777

1574

# Copy annotations, if any

1778

1575

try:

1779

1576

attr[attrname]._dbus_annotations = dict(

1791

1588

attribute._dbus_access,

1792

1589

attribute._dbus_get_args_options

1793

1590

["byte_arrays"])

1794

(copy_function(attribute)))

1591

(types.FunctionType(

1592

attribute.func_code,

1593

attribute.func_globals,

1594

attribute.func_name,

1595

attribute.func_defaults,

1596

attribute.func_closure)))

1795

1597

# Copy annotations, if any

1796

1598

try:

1797

1599

attr[attrname]._dbus_annotations = dict(

1806

1608

# to the class.

1807

1609

attr[attrname] = (

1808

1610

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1611

(types.FunctionType(attribute.func_code,

1612

attribute.func_globals,

1613

attribute.func_name,

1614

attribute.func_defaults,

1615

attribute.func_closure)))

1810

1616

if deprecate:

1811

1617

# Deprecate all alternate interfaces

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1618

iname="_AlternateDBusNames_interface_annotation{}"

1813

1619

for interface_name in interface_names:

1814

1620

1815

1621

@dbus_interface_annotations(interface_name)

1816

1622

def func(self):

1817

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

1818

"true"}

1623

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

1624

"true" }

1819

1625

# Find an unused name

1820

1626

for aname in (iname.format(i)

1821

1627

for i in itertools.count()):

1825

1631

if interface_names:

1826

1632

# Replace the class with a new subclass of it with

1827

1633

# methods, signals, etc. as created above.

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1634

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

1635

(cls, ), attr)

1834

1636

return cls

1835

1637

1836

1638

return wrapper

1837

1639

1838

1640

1840

1642

"se.bsnet.fukt.Mandos"})

1841

1643

class ClientDBus(Client, DBusObjectWithProperties):

1842

1644

"""A Client class using D-Bus

1843

1645

1844

1646

Attributes:

1845

1647

dbus_object_path: dbus.ObjectPath

1846

1648

bus: dbus.SystemBus()

1847

1649

"""

1848

1650

1849

1651

runtime_expansions = (Client.runtime_expansions

1850

1652

+ ("dbus_object_path", ))

1851

1653

1852

1654

_interface = "se.recompile.Mandos.Client"

1853

1655

1854

1656

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

1855

1856

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

1657

1658

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

1857

1659

self.bus = bus

1858

1660

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

1859

1661

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

1865

1667

"/clients/" + client_object_name)

1866

1668

DBusObjectWithProperties.__init__(self, self.bus,

1867

1669

self.dbus_object_path)

1868

1670

1869

1671

def notifychangeproperty(transform_func, dbus_name,

1870

1672

type_func=lambda x: x,

1871

1673

variant_level=1,

1873

1675

_interface=_interface):

1874

1676

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

1875

1677

its changes to DBus.

1876

1678

1877

1679

transform_fun: Function that takes a value and a variant_level

1878

1680

and transforms it to a D-Bus type.

1879

1681

dbus_name: D-Bus name of the variable

1882

1684

variant_level: D-Bus variant level. Default: 1

1883

1685

"""

1884

1686

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

1885

1687

1886

1688

def setter(self, value):

1887

1689

if hasattr(self, "dbus_object_path"):

1888

1690

if (not hasattr(self, attrname) or

1895

1697

else:

1896

1698

dbus_value = transform_func(

1897

1699

type_func(value),

1898

variant_level=variant_level)

1700

variant_level = variant_level)

1899

1701

self.PropertyChanged(dbus.String(dbus_name),

1900

1702

dbus_value)

1901

1703

self.PropertiesChanged(

1902

1704

_interface,

1903

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

1904

dbus_value}),

1705

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

1706

dbus_value }),

1905

1707

dbus.Array())

1906

1708

setattr(self, attrname, value)

1907

1709

1908

1710

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

1909

1711

1910

1712

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1911

1713

approvals_pending = notifychangeproperty(dbus.Boolean,

1912

1714

"ApprovalPending",

1913

type_func=bool)

1715

type_func = bool)

1914

1716

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

1915

1717

last_enabled = notifychangeproperty(datetime_to_dbus,

1916

1718

"LastEnabled")

1917

1719

checker = notifychangeproperty(

1918

1720

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1721

type_func = lambda checker: checker is not None)

1920

1722

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1921

1723

"LastCheckedOK")

1922

1724

last_checker_status = notifychangeproperty(dbus.Int16,

1927

1729

"ApprovedByDefault")

1928

1730

approval_delay = notifychangeproperty(

1929

1731

dbus.UInt64, "ApprovalDelay",

1930

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

1732

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

1931

1733

approval_duration = notifychangeproperty(

1932

1734

dbus.UInt64, "ApprovalDuration",

1933

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

1735

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

1934

1736

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

1935

1737

timeout = notifychangeproperty(

1936

1738

dbus.UInt64, "Timeout",

1937

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

1739

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

1938

1740

extended_timeout = notifychangeproperty(

1939

1741

dbus.UInt64, "ExtendedTimeout",

1940

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

1742

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

1941

1743

interval = notifychangeproperty(

1942

1744

dbus.UInt64, "Interval",

1943

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

1745

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

1944

1746

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

1945

1747

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

1946

1748

invalidate_only=True)

1947

1749

1948

1750

del notifychangeproperty

1949

1751

1950

1752

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

1951

1753

try:

1952

1754

self.remove_from_connection()

1955

1757

if hasattr(DBusObjectWithProperties, "__del__"):

1956

1758

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

1957

1759

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

1958

1760

1959

1761

def checker_callback(self, source, condition,

1960

1762

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

1961

1763

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

1977

1779

| self.last_checker_signal),

1978

1780

dbus.String(command))

1979

1781

return ret

1980

1782

1981

1783

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

1982

1784

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

1983

1785

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

1987

1789

# Emit D-Bus signal

1988

1790

self.CheckerStarted(self.current_checker_command)

1989

1791

return r

1990

1792

1991

1793

def _reset_approved(self):

1992

1794

self.approved = None

1993

1795

return False

1994

1796

1995

1797

def approve(self, value=True):

1996

1798

self.approved = value

1997

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

1998

* 1000), self._reset_approved)

1799

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

1800

* 1000), self._reset_approved)

1999

1801

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1802

1803

## D-Bus methods, signals & properties

1804

1805

## Interfaces

1806

1807

## Signals

1808

2007

1809

# CheckerCompleted - signal

2008

1810

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

2009

1811

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

2010

1812

"D-Bus signal"

2011

1813

pass

2012

1814

2013

1815

# CheckerStarted - signal

2014

1816

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

2015

1817

def CheckerStarted(self, command):

2016

1818

"D-Bus signal"

2017

1819

pass

2018

1820

2019

1821

# PropertyChanged - signal

2020

1822

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

2021

1823

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

2022

1824

def PropertyChanged(self, property, value):

2023

1825

"D-Bus signal"

2024

1826

pass

2025

1827

2026

1828

# GotSecret - signal

2027

1829

@dbus.service.signal(_interface)

2028

1830

def GotSecret(self):

2031

1833

server to mandos-client

2032

1834

"""

2033

1835

pass

2034

1836

2035

1837

# Rejected - signal

2036

1838

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

2037

1839

def Rejected(self, reason):

2038

1840

"D-Bus signal"

2039

1841

pass

2040

1842

2041

1843

# NeedApproval - signal

2042

1844

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

2043

1845

def NeedApproval(self, timeout, default):

2044

1846

"D-Bus signal"

2045

1847

return self.need_approval()

2046

2047

# Methods

2048

1848

1849

## Methods

1850

2049

1851

# Approve - method

2050

1852

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

2051

1853

def Approve(self, value):

2052

1854

self.approve(value)

2053

1855

2054

1856

# CheckedOK - method

2055

1857

@dbus.service.method(_interface)

2056

1858

def CheckedOK(self):

2057

1859

self.checked_ok()

2058

1860

2059

1861

# Enable - method

2060

1862

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

2061

1863

@dbus.service.method(_interface)

2062

1864

def Enable(self):

2063

1865

"D-Bus method"

2064

1866

self.enable()

2065

1867

2066

1868

# StartChecker - method

2067

1869

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

2068

1870

@dbus.service.method(_interface)

2069

1871

def StartChecker(self):

2070

1872

"D-Bus method"

2071

1873

self.start_checker()

2072

1874

2073

1875

# Disable - method

2074

1876

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

2075

1877

@dbus.service.method(_interface)

2076

1878

def Disable(self):

2077

1879

"D-Bus method"

2078

1880

self.disable()

2079

1881

2080

1882

# StopChecker - method

2081

1883

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

2082

1884

@dbus.service.method(_interface)

2083

1885

def StopChecker(self):

2084

1886

self.stop_checker()

2085

2086

# Properties

2087

1887

1888

## Properties

1889

2088

1890

# ApprovalPending - property

2089

1891

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

2090

1892

def ApprovalPending_dbus_property(self):

2091

1893

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

2092

1894

2093

1895

# ApprovedByDefault - property

2094

1896

@dbus_service_property(_interface,

2095

1897

signature="b",

2098

1900

if value is None: # get

2099

1901

return dbus.Boolean(self.approved_by_default)

2100

1902

self.approved_by_default = bool(value)

2101

1903

2102

1904

# ApprovalDelay - property

2103

1905

@dbus_service_property(_interface,

2104

1906

signature="t",

2108

1910

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

2109

1911

* 1000)

2110

1912

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

2111

1913

2112

1914

# ApprovalDuration - property

2113

1915

@dbus_service_property(_interface,

2114

1916

signature="t",

2118

1920

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

2119

1921

* 1000)

2120

1922

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

2121

1923

2122

1924

# Name - property

2123

1925

@dbus_annotations(

2124

1926

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

2125

1927

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

2126

1928

def Name_dbus_property(self):

2127

1929

return dbus.String(self.name)

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1930

2136

1931

# Fingerprint - property

2137

1932

@dbus_annotations(

2138

1933

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

2139

1934

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

2140

1935

def Fingerprint_dbus_property(self):

2141

1936

return dbus.String(self.fingerprint)

2142

1937

2143

1938

# Host - property

2144

1939

@dbus_service_property(_interface,

2145

1940

signature="s",

2148

1943

if value is None: # get

2149

1944

return dbus.String(self.host)

2150

1945

self.host = str(value)

2151

1946

2152

1947

# Created - property

2153

1948

@dbus_annotations(

2154

1949

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

2155

1950

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

2156

1951

def Created_dbus_property(self):

2157

1952

return datetime_to_dbus(self.created)

2158

1953

2159

1954

# LastEnabled - property

2160

1955

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

2161

1956

def LastEnabled_dbus_property(self):

2162

1957

return datetime_to_dbus(self.last_enabled)

2163

1958

2164

1959

# Enabled - property

2165

1960

@dbus_service_property(_interface,

2166

1961

signature="b",

2172

1967

self.enable()

2173

1968

else:

2174

1969

self.disable()

2175

1970

2176

1971

# LastCheckedOK - property

2177

1972

@dbus_service_property(_interface,

2178

1973

signature="s",

2182

1977

self.checked_ok()

2183

1978

return

2184

1979

return datetime_to_dbus(self.last_checked_ok)

2185

1980

2186

1981

# LastCheckerStatus - property

2187

1982

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

2188

1983

def LastCheckerStatus_dbus_property(self):

2189

1984

return dbus.Int16(self.last_checker_status)

2190

1985

2191

1986

# Expires - property

2192

1987

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

2193

1988

def Expires_dbus_property(self):

2194

1989

return datetime_to_dbus(self.expires)

2195

1990

2196

1991

# LastApprovalRequest - property

2197

1992

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

2198

1993

def LastApprovalRequest_dbus_property(self):

2199

1994

return datetime_to_dbus(self.last_approval_request)

2200

1995

2201

1996

# Timeout - property

2202

1997

@dbus_service_property(_interface,

2203

1998

signature="t",

2218

2013

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

2219

2014

is None):

2220

2015

return

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2016

gobject.source_remove(self.disable_initiator_tag)

2017

self.disable_initiator_tag = gobject.timeout_add(

2223

2018

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

2224

2019

self.disable)

2225

2020

2226

2021

# ExtendedTimeout - property

2227

2022

@dbus_service_property(_interface,

2228

2023

signature="t",

2232

2027

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

2233

2028

* 1000)

2234

2029

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

2235

2030

2236

2031

# Interval - property

2237

2032

@dbus_service_property(_interface,

2238

2033

signature="t",

2245

2040

return

2246

2041

if self.enabled:

2247

2042

# Reschedule checker run

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2043

gobject.source_remove(self.checker_initiator_tag)

2044

self.checker_initiator_tag = gobject.timeout_add(

2250

2045

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

2046

self.start_checker() # Start one now, too

2047

2253

2048

# Checker - property

2254

2049

@dbus_service_property(_interface,

2255

2050

signature="s",

2258

2053

if value is None: # get

2259

2054

return dbus.String(self.checker_command)

2260

2055

self.checker_command = str(value)

2261

2056

2262

2057

# CheckerRunning - property

2263

2058

@dbus_service_property(_interface,

2264

2059

signature="b",

2270

2065

self.start_checker()

2271

2066

else:

2272

2067

self.stop_checker()

2273

2068

2274

2069

# ObjectPath - property

2275

2070

@dbus_annotations(

2276

2071

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

2277

2072

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

2278

2073

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

2279

2074

def ObjectPath_dbus_property(self):

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

2075

return self.dbus_object_path # is already a dbus.ObjectPath

2076

2282

2077

# Secret = property

2283

2078

@dbus_annotations(

2284

2079

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

2289

2084

byte_arrays=True)

2290

2085

def Secret_dbus_property(self, value):

2291

2086

self.secret = bytes(value)

2292

2087

2293

2088

del _interface

2294

2089

2295

2090

2296

class ProxyClient:

2297

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

2091

class ProxyClient(object):

2092

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

2298

2093

self._pipe = child_pipe

2299

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

2094

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

2300

2095

if not self._pipe.recv():

2301

raise KeyError(key_id or fpr)

2302

2096

raise KeyError(fpr)

2097

2303

2098

def __getattribute__(self, name):

2304

if name == "_pipe":

2099

if name == '_pipe':

2305

2100

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

2306

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

2101

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

2307

2102

data = self._pipe.recv()

2308

if data[0] == "data":

2103

if data[0] == 'data':

2309

2104

return data[1]

2310

if data[0] == "function":

2311

2105

if data[0] == 'function':

2106

2312

2107

def func(*args, **kwargs):

2313

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

2108

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

2314

2109

return self._pipe.recv()[1]

2315

2110

2316

2111

return func

2317

2112

2318

2113

def __setattr__(self, name, value):

2319

if name == "_pipe":

2114

if name == '_pipe':

2320

2115

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

2321

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

2116

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

2322

2117

2323

2118

2324

2119

class ClientHandler(socketserver.BaseRequestHandler, object):

2325

2120

"""A class to handle client connections.

2326

2121

2327

2122

Instantiated once for each connection to handle it.

2328

2123

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

2329

2124

2330

2125

def handle(self):

2331

2126

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

2332

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

2333

str(self.client_address))

2334

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

2335

2127

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

2128

str(self.client_address))

2129

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

2130

self.server.child_pipe.fileno())

2131

2336

2132

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

2133

2134

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

2135

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

2136

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

2137

# "+DHE-DSS"))

2342

2138

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

2343

2139

priority = self.server.gnutls_priority

2344

2140

if priority is None:

2345

2141

priority = "NORMAL"

2346

gnutls.priority_set_direct(session,

2347

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

2348

2142

gnutls.priority_set_direct(session._c_object, priority,

2143

None)

2144

2349

2145

# Start communication using the Mandos protocol

2350

2146

# Get protocol number

2351

2147

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

2352

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

2148

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

2353

2149

try:

2354

2150

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

2355

2151

raise RuntimeError(line)

2356

2152

except (ValueError, IndexError, RuntimeError) as error:

2357

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

2153

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

2358

2154

return

2359

2155

2360

2156

# Start GnuTLS connection

2361

2157

try:

2362

2158

session.handshake()

2363

2159

except gnutls.Error as error:

2364

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

2160

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

2365

2161

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

2366

2162

# established. Just abandon the request.

2367

2163

return

2368

log.debug("Handshake succeeded")

2369

2164

logger.debug("Handshake succeeded")

2165

2370

2166

approval_required = False

2371

2167

try:

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

2168

try:

2169

fpr = self.fingerprint(

2170

self.peer_certificate(session))

2171

except (TypeError, gnutls.Error) as error:

2172

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

2173

return

2174

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

2175

2176

try:

2177

client = ProxyClient(child_pipe, fpr,

2396

2178

self.client_address)

2397

2179

except KeyError:

2398

2180

return

2399

2181

2400

2182

if client.approval_delay:

2401

2183

delay = client.approval_delay

2402

2184

client.approvals_pending += 1

2403

2185

approval_required = True

2404

2186

2405

2187

while True:

2406

2188

if not client.enabled:

2407

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

2189

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

2190

client.name)

2408

2191

if self.server.use_dbus:

2409

2192

# Emit D-Bus signal

2410

2193

client.Rejected("Disabled")

2411

2194

return

2412

2195

2413

2196

if client.approved or not client.approval_delay:

2414

# We are approved or approval is disabled

2197

#We are approved or approval is disabled

2415

2198

break

2416

2199

elif client.approved is None:

2417

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

2418

client.name)

2200

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

2201

client.name)

2419

2202

if self.server.use_dbus:

2420

2203

# Emit D-Bus signal

2421

2204

client.NeedApproval(

2422

2205

client.approval_delay.total_seconds()

2423

2206

* 1000, client.approved_by_default)

2424

2207

else:

2425

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

2426

client.name)

2208

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

2209

client.name)

2427

2210

if self.server.use_dbus:

2428

2211

# Emit D-Bus signal

2429

2212

client.Rejected("Denied")

2430

2213

return

2431

2432

# wait until timeout or approved

2214

2215

#wait until timeout or approved

2433

2216

time = datetime.datetime.now()

2434

2217

client.changedstate.acquire()

2435

2218

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

2437

2220

time2 = datetime.datetime.now()

2438

2221

if (time2 - time) >= delay:

2439

2222

if not client.approved_by_default:

2440

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

2441

" waiting for approval",

2442

client.name)

2223

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

2224

" waiting for approval",

2225

client.name)

2443

2226

if self.server.use_dbus:

2444

2227

# Emit D-Bus signal

2445

2228

client.Rejected("Approval timed out")

2448

2231

break

2449

2232

else:

2450

2233

delay -= time2 - time

2451

2234

2452

2235

try:

2453

2236

session.send(client.secret)

2454

2237

except gnutls.Error as error:

2455

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

2238

logger.warning("gnutls send failed",

2239

exc_info = error)

2456

2240

return

2457

2458

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

2241

2242

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

2459

2243

# bump the timeout using extended_timeout

2460

2244

client.bump_timeout(client.extended_timeout)

2461

2245

if self.server.use_dbus:

2462

2246

# Emit D-Bus signal

2463

2247

client.GotSecret()

2464

2248

2465

2249

finally:

2466

2250

if approval_required:

2467

2251

client.approvals_pending -= 1

2468

2252

try:

2469

2253

session.bye()

2470

2254

except gnutls.Error as error:

2471

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

2472

2255

logger.warning("GnuTLS bye failed",

2256

exc_info=error)

2257

2473

2258

@staticmethod

2474

2259

def peer_certificate(session):

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2260

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

2261

# If not an OpenPGP certificate...

2262

if (gnutls.certificate_type_get(session._c_object)

2263

!= gnutls.CRT_OPENPGP):

2489

2264

# ...return invalid data

2490

2265

return b""

2491

2266

list_size = ctypes.c_uint(1)

2492

2267

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

2268

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

2494

2269

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

2495

2270

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

2496

2271

if list_size.value == 0:

2497

2272

return None

2498

2273

cert = cert_list[0]

2499

2274

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

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

2275

2536

2276

@staticmethod

2537

2277

def fingerprint(openpgp):

2538

2278

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2553

2293

ctypes.byref(crtverify))

2554

2294

if crtverify.value != 0:

2555

2295

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

2296

raise gnutls.CertificateSecurityError("Verify failed")

2558

2297

# New buffer for the fingerprint

2559

2298

buf = ctypes.create_string_buffer(20)

2560

2299

buf_len = ctypes.c_size_t()

2570

2309

return hex_fpr

2571

2310

2572

2311

2573

class MultiprocessingMixIn:

2312

class MultiprocessingMixIn(object):

2574

2313

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

2575

2314

2576

2315

def sub_process_main(self, request, address):

2577

2316

try:

2578

2317

self.finish_request(request, address)

2579

2318

except Exception:

2580

2319

self.handle_error(request, address)

2581

2320

self.close_request(request)

2582

2321

2583

2322

def process_request(self, request, address):

2584

2323

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

2585

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

2586

args=(request, address))

2324

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

2325

args = (request, address))

2587

2326

proc.start()

2588

2327

return proc

2589

2328

2590

2329

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

2330

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2592

2331

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

2593

2332

2594

2333

def process_request(self, request, client_address):

2595

2334

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

2596

2335

2597

2336

This function creates a new pipe in self.pipe

2598

2337

"""

2599

2338

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2600

2339

2601

2340

proc = MultiprocessingMixIn.process_request(self, request,

2602

2341

client_address)

2603

2342

self.child_pipe.close()

2604

2343

self.add_pipe(parent_pipe, proc)

2605

2344

2606

2345

def add_pipe(self, parent_pipe, proc):

2607

2346

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

2608

2347

raise NotImplementedError()

2609

2348

2610

2349

2611

2350

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2612

socketserver.TCPServer):

2613

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

2614

2351

socketserver.TCPServer, object):

2352

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

2353

2615

2354

Attributes:

2616

2355

enabled: Boolean; whether this server is activated yet

2617

2356

interface: None or a network interface name (string)

2618

2357

use_ipv6: Boolean; to use IPv6 or not

2619

2358

"""

2620

2359

2621

2360

def __init__(self, server_address, RequestHandlerClass,

2622

2361

interface=None,

2623

2362

use_ipv6=True,

2633

2372

self.socketfd = socketfd

2634

2373

# Save the original socket.socket() function

2635

2374

self.socket_socket = socket.socket

2636

2637

2375

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

2638

#

2376

#

2639

2377

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

2640

2378

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

2641

2379

# patching socket.socket.)

2642

#

2380

#

2643

2381

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

2644

2382

@functools.wraps(socket.socket)

2645

2383

def socket_wrapper(*args, **kwargs):

2657

2395

# socket_wrapper(), if socketfd was set.

2658

2396

socketserver.TCPServer.__init__(self, server_address,

2659

2397

RequestHandlerClass)

2660

2398

2661

2399

def server_bind(self):

2662

2400

"""This overrides the normal server_bind() function

2663

2401

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

2664

2402

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

2665

global SO_BINDTODEVICE

2666

2403

if self.interface is not None:

2667

2404

if SO_BINDTODEVICE is None:

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

2405

logger.error("SO_BINDTODEVICE does not exist;"

2406

" cannot bind to interface %s",

2407

self.interface)

2408

else:

2409

try:

2410

self.socket.setsockopt(

2411

socket.SOL_SOCKET, SO_BINDTODEVICE,

2412

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

2413

except socket.error as error:

2414

if error.errno == errno.EPERM:

2415

logger.error("No permission to bind to"

2416

" interface %s", self.interface)

2417

elif error.errno == errno.ENOPROTOOPT:

2418

logger.error("SO_BINDTODEVICE not available;"

2419

" cannot bind to interface %s",

2420

self.interface)

2421

elif error.errno == errno.ENODEV:

2422

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

2423

" cannot bind", self.interface)

2424

else:

2425

raise

2688

2426

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

2689

2427

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2692

2428

if not self.server_address[0]:

2693

2429

if self.address_family == socket.AF_INET6:

2694

any_address = "::" # in6addr_any

2430

any_address = "::" # in6addr_any

2695

2431

else:

2696

any_address = "0.0.0.0" # INADDR_ANY

2432

any_address = "0.0.0.0" # INADDR_ANY

2697

2433

self.server_address = (any_address,

2698

2434

self.server_address[1])

2699

2435

elif not self.server_address[1]:

2709

2445

2710

2446

class MandosServer(IPv6_TCPServer):

2711

2447

"""Mandos server.

2712

2448

2713

2449

Attributes:

2714

2450

clients: set of Client objects

2715

2451

gnutls_priority GnuTLS priority string

2716

2452

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

2717

2718

Assumes a GLib.MainLoop event loop.

2453

2454

Assumes a gobject.MainLoop event loop.

2719

2455

"""

2720

2456

2721

2457

def __init__(self, server_address, RequestHandlerClass,

2722

2458

interface=None,

2723

2459

use_ipv6=True,

2733

2469

self.gnutls_priority = gnutls_priority

2734

2470

IPv6_TCPServer.__init__(self, server_address,

2735

2471

RequestHandlerClass,

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2472

interface = interface,

2473

use_ipv6 = use_ipv6,

2474

socketfd = socketfd)

2475

2740

2476

def server_activate(self):

2741

2477

if self.enabled:

2742

2478

return socketserver.TCPServer.server_activate(self)

2743

2479

2744

2480

def enable(self):

2745

2481

self.enabled = True

2746

2482

2747

2483

def add_pipe(self, parent_pipe, proc):

2748

2484

# Call "handle_ipc" for both data and EOF events

2749

GLib.io_add_watch(

2750

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

2751

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

2485

gobject.io_add_watch(

2486

parent_pipe.fileno(),

2487

gobject.IO_IN | gobject.IO_HUP,

2752

2488

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2489

parent_pipe = parent_pipe,

2490

proc = proc))

2491

2756

2492

def handle_ipc(self, source, condition,

2757

2493

parent_pipe=None,

2758

proc=None,

2494

proc = None,

2759

2495

client_object=None):

2760

2496

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

2761

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

2497

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

2762

2498

# Wait for other process to exit

2763

2499

proc.join()

2764

2500

return False

2765

2501

2766

2502

# Read a request from the child

2767

2503

request = parent_pipe.recv()

2768

2504

command = request[0]

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2505

2506

if command == 'init':

2507

fpr = request[1]

2508

address = request[2]

2509

2510

for c in self.clients.itervalues():

2511

if c.fingerprint == fpr:

2783

2512

client = c

2784

2513

break

2785

2514

else:

2786

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

2787

" %s", key_id or fpr, address)

2515

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

2516

"dress: %s", fpr, address)

2788

2517

if self.use_dbus:

2789

2518

# Emit D-Bus signal

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2519

mandos_dbus_service.ClientNotFound(fpr,

2791

2520

address[0])

2792

2521

parent_pipe.send(False)

2793

2522

return False

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2523

2524

gobject.io_add_watch(

2525

parent_pipe.fileno(),

2526

gobject.IO_IN | gobject.IO_HUP,

2798

2527

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2528

parent_pipe = parent_pipe,

2529

proc = proc,

2530

client_object = client))

2802

2531

parent_pipe.send(True)

2803

2532

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

2804

2533

# same fileno

2805

2534

return False

2806

if command == "funcall":

2535

if command == 'funcall':

2807

2536

funcname = request[1]

2808

2537

args = request[2]

2809

2538

kwargs = request[3]

2810

2811

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

2539

2540

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

2812

2541

funcname)(*args,

2813

2542

**kwargs)))

2814

2815

if command == "getattr":

2543

2544

if command == 'getattr':

2816

2545

attrname = request[1]

2817

2546

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2547

collections.Callable):

2548

parent_pipe.send(('function', ))

2820

2549

else:

2821

2550

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2551

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

2552

2553

if command == 'setattr':

2825

2554

attrname = request[1]

2826

2555

value = request[2]

2827

2556

setattr(client_object, attrname, value)

2828

2557

2829

2558

return True

2830

2559

2831

2560

2832

2561

def rfc3339_duration_to_delta(duration):

2833

2562

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

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2563

2564

>>> rfc3339_duration_to_delta("P7D")

2565

datetime.timedelta(7)

2566

>>> rfc3339_duration_to_delta("PT60S")

2567

datetime.timedelta(0, 60)

2568

>>> rfc3339_duration_to_delta("PT60M")

2569

datetime.timedelta(0, 3600)

2570

>>> rfc3339_duration_to_delta("PT24H")

2571

datetime.timedelta(1)

2572

>>> rfc3339_duration_to_delta("P1W")

2573

datetime.timedelta(7)

2574

>>> rfc3339_duration_to_delta("PT5M30S")

2575

datetime.timedelta(0, 330)

2576

>>> rfc3339_duration_to_delta("P1DT3M20S")

2577

datetime.timedelta(1, 200)

2851

2578

"""

2852

2579

2853

2580

# Parsing an RFC 3339 duration with regular expressions is not

2854

2581

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

2855

2582

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

2856

2583

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

2857

2584

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

2858

2585

# avoid excessive use of external libraries.

2859

2586

2860

2587

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

2861

2588

Token = collections.namedtuple("Token", (

2862

2589

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

2895

2622

frozenset((token_year, token_month,

2896

2623

token_day, token_time,

2897

2624

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2625

# Define starting values

2626

value = datetime.timedelta() # Value so far

2901

2627

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2628

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

2629

s = duration # String left to parse

2906

2630

# Loop until end token is found

2907

2631

while found_token is not token_end:

2908

2632

# Search for any currently valid tokens

2932

2656

2933

2657

def string_to_delta(interval):

2934

2658

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

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2659

2660

>>> string_to_delta('7d')

2661

datetime.timedelta(7)

2662

>>> string_to_delta('60s')

2663

datetime.timedelta(0, 60)

2664

>>> string_to_delta('60m')

2665

datetime.timedelta(0, 3600)

2666

>>> string_to_delta('24h')

2667

datetime.timedelta(1)

2668

>>> string_to_delta('1w')

2669

datetime.timedelta(7)

2670

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

2671

datetime.timedelta(0, 330)

2948

2672

"""

2949

2673

2950

2674

try:

2951

2675

return rfc3339_duration_to_delta(interval)

2952

2676

except ValueError:

2953

2677

pass

2954

2678

2955

2679

timevalue = datetime.timedelta(0)

2956

2680

for s in interval.split():

2957

2681

try:

2975

2699

return timevalue

2976

2700

2977

2701

2978

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

2702

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

2979

2703

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

2980

2704

2981

2705

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

2982

2706

if os.fork():

2983

2707

sys.exit()

3001

2725

3002

2726

3003

2727

def main():

3004

2728

3005

2729

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

3006

2730

# Parsing of options, both command line and config file

3007

2731

3008

2732

parser = argparse.ArgumentParser()

3009

2733

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

3010

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

2734

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

3011

2735

help="show version number and exit")

3012

2736

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

3013

2737

help="Bind to interface IF")

3049

2773

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

3050

2774

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

3051

2775

default=None)

3052

2776

3053

2777

options = parser.parse_args()

3054

2778

2779

if options.check:

2780

import doctest

2781

fail_count, test_count = doctest.testmod()

2782

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

2783

3055

2784

# Default values for config file for server-global settings

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2785

server_defaults = { "interface": "",

2786

"address": "",

2787

"port": "",

2788

"debug": "False",

2789

"priority":

2790

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

2791

":+SIGN-DSA-SHA256",

2792

"servicename": "Mandos",

2793

"use_dbus": "True",

2794

"use_ipv6": "True",

2795

"debuglevel": "",

2796

"restore": "True",

2797

"socket": "",

2798

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

2799

"foreground": "False",

2800

"zeroconf": "True",

2801

}

2802

3079

2803

# Parse config file for server-global settings

3080

server_config = configparser.ConfigParser(server_defaults)

2804

server_config = configparser.SafeConfigParser(server_defaults)

3081

2805

del server_defaults

3082

2806

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

3083

# Convert the ConfigParser object to a dict

2807

# Convert the SafeConfigParser object to a dict

3084

2808

server_settings = server_config.defaults()

3085

2809

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

3086

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

3087

"foreground", "zeroconf"):

2810

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

3088

2811

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

3089

2812

option)

3090

2813

if server_settings["port"]:

3100

2823

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

3101

2824

["socket"])

3102

2825

del server_config

3103

2826

3104

2827

# Override the settings from the config file with command line

3105

2828

# options, if set.

3106

2829

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

3124

2847

if server_settings["debug"]:

3125

2848

server_settings["foreground"] = True

3126

2849

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

3127

2850

3128

2851

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

3129

2852

3130

2853

if (not server_settings["zeroconf"]

3131

2854

and not (server_settings["port"]

3132

2855

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

3133

2856

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

3134

2857

3135

2858

# For convenience

3136

2859

debug = server_settings["debug"]

3137

2860

debuglevel = server_settings["debuglevel"]

3141

2864

stored_state_file)

3142

2865

foreground = server_settings["foreground"]

3143

2866

zeroconf = server_settings["zeroconf"]

3144

2867

3145

2868

if debug:

3146

2869

initlogger(debug, logging.DEBUG)

3147

2870

else:

3150

2873

else:

3151

2874

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

3152

2875

initlogger(debug, level)

3153

2876

3154

2877

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

3155

2878

syslogger.setFormatter(

3156

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

3157

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

2879

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

2880

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

3158

2881

server_settings["servicename"])))

3159

2882

3160

2883

# Parse config file with clients

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2884

client_config = configparser.SafeConfigParser(Client

2885

.client_defaults)

3162

2886

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

3163

2887

"clients.conf"))

3164

2888

3165

2889

global mandos_dbus_service

3166

2890

mandos_dbus_service = None

3167

2891

3168

2892

socketfd = None

3169

2893

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

3170

2894

socketfd = server_settings["socket"]

3184

2908

try:

3185

2909

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

3186

2910

except IOError as e:

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2911

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

2912

exc_info=e)

2913

2914

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

3193

2915

try:

3194

2916

uid = pwd.getpwnam(name).pw_uid

3195

gid = pwd.getpwnam(group).pw_gid

2917

gid = pwd.getpwnam(name).pw_gid

3196

2918

break

3197

2919

except KeyError:

3198

2920

continue

3202

2924

try:

3203

2925

os.setgid(gid)

3204

2926

os.setuid(uid)

3205

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

3206

2927

except OSError as error:

3207

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

3208

os.strerror(error.errno))

3209

2928

if error.errno != errno.EPERM:

3210

2929

raise

3211

2930

3212

2931

if debug:

3213

2932

# Enable all possible GnuTLS debugging

3214

2933

3215

2934

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

3216

2935

# - GnuTLS manual

3217

2936

gnutls.global_set_log_level(11)

3218

2937

3219

2938

@gnutls.log_func

3220

2939

def debug_gnutls(level, string):

3221

log.debug("GnuTLS: %s",

3222

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

3223

2940

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

2941

3224

2942

gnutls.global_set_log_function(debug_gnutls)

3225

2943

3226

2944

# Redirect stdin so all checkers get /dev/null

3227

2945

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

3228

2946

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

3229

2947

if null > 2:

3230

2948

os.close(null)

3231

2949

3232

2950

# Need to fork before connecting to D-Bus

3233

2951

if not foreground:

3234

2952

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

3235

2953

daemon()

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2954

2955

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

2956

# need to inform gobject that threads will be used.

2957

gobject.threads_init()

2958

3242

2959

global main_loop

3243

2960

# From the Avahi example code

3244

2961

DBusGMainLoop(set_as_default=True)

3245

main_loop = GLib.MainLoop()

2962

main_loop = gobject.MainLoop()

3246

2963

bus = dbus.SystemBus()

3247

2964

# End of Avahi example code

3248

2965

if use_dbus:

3254

2971

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

3255

2972

do_not_queue=True)

3256

2973

except dbus.exceptions.DBusException as e:

3257

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

2974

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

3258

2975

use_dbus = False

3259

2976

server_settings["use_dbus"] = False

3260

2977

tcp_server.use_dbus = False

3261

2978

if zeroconf:

3262

2979

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

2980

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

2981

name = server_settings["servicename"],

2982

servicetype = "_mandos._tcp",

2983

protocol = protocol,

2984

bus = bus)

3268

2985

if server_settings["interface"]:

3269

2986

service.interface = if_nametoindex(

3270

2987

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

3271

2988

3272

2989

global multiprocessing_manager

3273

2990

multiprocessing_manager = multiprocessing.Manager()

3274

2991

3275

2992

client_class = Client

3276

2993

if use_dbus:

3277

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

3278

2994

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

2995

3279

2996

client_settings = Client.config_parser(client_config)

3280

2997

old_client_settings = {}

3281

2998

clients_data = {}

3282

2999

3283

3000

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

3284

3001

global wnull

3285

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

3002

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

3286

3003

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

3287

3004

# mode

3288

3005

if debug or not foreground:

3289

3006

wnull.close()

3290

3007

3291

3008

# Get client data and settings from last running state.

3292

3009

if server_settings["restore"]:

3293

3010

try:

3294

3011

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

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

3012

clients_data, old_client_settings = pickle.load(

3013

stored_state)

3345

3014

os.remove(stored_state_path)

3346

3015

except IOError as e:

3347

3016

if e.errno == errno.ENOENT:

3348

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

3349

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

3017

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

3018

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

3350

3019

else:

3351

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

3352

exc_info=e)

3020

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

3021

exc_info=e)

3353

3022

raise

3354

3023

except EOFError as e:

3355

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

3356

exc_info=e)

3357

3024

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

3025

"EOFError:",

3026

exc_info=e)

3027

3358

3028

with PGPEngine() as pgp:

3359

3029

for client_name, client in clients_data.items():

3360

3030

# Skip removed clients

3361

3031

if client_name not in client_settings:

3362

3032

continue

3363

3033

3364

3034

# Decide which value to use after restoring saved state.

3365

3035

# We have three different values: Old config file,

3366

3036

# new config file, and saved state.

3377

3047

client[name] = value

3378

3048

except KeyError:

3379

3049

pass

3380

3050

3381

3051

# Clients who has passed its expire date can still be

3382

3052

# enabled if its last checker was successful. A Client

3383

3053

# whose checker succeeded before we stored its state is

3386

3056

if client["enabled"]:

3387

3057

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

3388

3058

if not client["last_checked_ok"]:

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

3059

logger.warning(

3060

"disabling client {} - Client never "

3061

"performed a successful checker".format(

3062

client_name))

3392

3063

client["enabled"] = False

3393

3064

elif client["last_checker_status"] != 0:

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

3065

logger.warning(

3066

"disabling client {} - Client last"

3067

" checker failed with error code"

3068

" {}".format(

3069

client_name,

3070

client["last_checker_status"]))

3398

3071

client["enabled"] = False

3399

3072

else:

3400

3073

client["expires"] = (

3401

3074

datetime.datetime.utcnow()

3402

3075

+ client["timeout"])

3403

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

3404

" enabled", client_name)

3076

logger.debug("Last checker succeeded,"

3077

" keeping {} enabled".format(

3078

client_name))

3405

3079

try:

3406

3080

client["secret"] = pgp.decrypt(

3407

3081

client["encrypted_secret"],

3408

3082

client_settings[client_name]["secret"])

3409

3083

except PGPError:

3410

3084

# If decryption fails, we use secret from new settings

3411

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

3412

client_name)

3085

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

3086

client_name))

3413

3087

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

3414

3088

["secret"])

3415

3089

3416

3090

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

3417

3091

for client_name in (set(old_client_settings)

3418

3092

- set(client_settings)):

3420

3094

for client_name in (set(client_settings)

3421

3095

- set(old_client_settings)):

3422

3096

clients_data[client_name] = client_settings[client_name]

3423

3097

3424

3098

# Create all client objects

3425

3099

for client_name, client in clients_data.items():

3426

3100

tcp_server.clients[client_name] = client_class(

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

3101

name = client_name,

3102

settings = client,

3103

server_settings = server_settings)

3104

3431

3105

if not tcp_server.clients:

3432

log.warning("No clients defined")

3433

3106

logger.warning("No clients defined")

3107

3434

3108

if not foreground:

3435

3109

if pidfile is not None:

3436

3110

pid = os.getpid()

3438

3112

with pidfile:

3439

3113

print(pid, file=pidfile)

3440

3114

except IOError:

3441

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

3442

pidfilename, pid)

3115

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

3116

pidfilename, pid)

3443

3117

del pidfile

3444

3118

del pidfilename

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

3119

3120

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

3121

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

3122

3450

3123

if use_dbus:

3451

3124

3452

3125

@alternate_dbus_interfaces(

3453

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

3126

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

3454

3127

class MandosDBusService(DBusObjectWithObjectManager):

3455

3128

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

3456

3129

3457

3130

def __init__(self):

3458

3131

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

3459

3132

3460

3133

_interface = "se.recompile.Mandos"

3461

3134

3462

3135

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

3463

3136

def ClientAdded(self, objpath):

3464

3137

"D-Bus signal"

3465

3138

pass

3466

3139

3467

3140

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

3468

def ClientNotFound(self, key_id, address):

3141

def ClientNotFound(self, fingerprint, address):

3469

3142

"D-Bus signal"

3470

3143

pass

3471

3144

3472

3145

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

3473

3146

"true"})

3474

3147

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

3475

3148

def ClientRemoved(self, objpath, name):

3476

3149

"D-Bus signal"

3477

3150

pass

3478

3151

3479

3152

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

3480

3153

"true"})

3481

3154

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

3482

3155

def GetAllClients(self):

3483

3156

"D-Bus method"

3484

3157

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3158

tcp_server.clients.itervalues())

3159

3487

3160

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

3488

3161

"true"})

3489

3162

@dbus.service.method(_interface,

3491

3164

def GetAllClientsWithProperties(self):

3492

3165

"D-Bus method"

3493

3166

return dbus.Dictionary(

3494

{c.dbus_object_path: c.GetAll(

3167

{ c.dbus_object_path: c.GetAll(

3495

3168

"se.recompile.Mandos.Client")

3496

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

3169

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

3497

3170

signature="oa{sv}")

3498

3171

3499

3172

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

3500

3173

def RemoveClient(self, object_path):

3501

3174

"D-Bus method"

3502

for c in tcp_server.clients.values():

3175

for c in tcp_server.clients.itervalues():

3503

3176

if c.dbus_object_path == object_path:

3504

3177

del tcp_server.clients[c.name]

3505

3178

c.remove_from_connection()

3509

3182

self.client_removed_signal(c)

3510

3183

return

3511

3184

raise KeyError(object_path)

3512

3185

3513

3186

del _interface

3514

3187

3515

3188

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3189

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

3517

3190

def GetManagedObjects(self):

3518

3191

"""D-Bus method"""

3519

3192

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3193

{ client.dbus_object_path:

3194

dbus.Dictionary(

3195

{ interface: client.GetAll(interface)

3196

for interface in

3197

client._get_all_interface_names()})

3198

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

3199

3527

3200

def client_added_signal(self, client):

3528

3201

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

3529

3202

if use_dbus:

3531

3204

self.InterfacesAdded(

3532

3205

client.dbus_object_path,

3533

3206

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3207

{ interface: client.GetAll(interface)

3208

for interface in

3209

client._get_all_interface_names()}))

3537

3210

# Old signal

3538

3211

self.ClientAdded(client.dbus_object_path)

3539

3212

3540

3213

def client_removed_signal(self, client):

3541

3214

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

3542

3215

if use_dbus:

3547

3220

# Old signal

3548

3221

self.ClientRemoved(client.dbus_object_path,

3549

3222

client.name)

3550

3223

3551

3224

mandos_dbus_service = MandosDBusService()

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

3225

3558

3226

def cleanup():

3559

3227

"Cleanup function; run on exit"

3560

3228

if zeroconf:

3561

3229

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

3230

3231

multiprocessing.active_children()

3232

wnull.close()

3565

3233

if not (tcp_server.clients or client_settings):

3566

3234

return

3567

3235

3568

3236

# Store client before exiting. Secrets are encrypted with key

3569

3237

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

3570

3238

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

3571

3239

clients = {}

3572

3240

with PGPEngine() as pgp:

3573

for client in tcp_server.clients.values():

3241

for client in tcp_server.clients.itervalues():

3574

3242

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

3575

3243

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

3576

3244

key)

3577

3245

client_dict = {}

3578

3246

3579

3247

# A list of attributes that can not be pickled

3580

3248

# + secret.

3581

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

3582

"checker", "server_settings"}

3249

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

3250

"checker", "server_settings" }

3583

3251

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

3584

3252

.Object):

3585

3253

exclude.add(name)

3586

3254

3587

3255

client_dict["encrypted_secret"] = (client

3588

3256

.encrypted_secret)

3589

3257

for attr in client.client_structure:

3590

3258

if attr not in exclude:

3591

3259

client_dict[attr] = getattr(client, attr)

3592

3260

3593

3261

clients[client.name] = client_dict

3594

3262

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

3595

3263

3596

3264

try:

3597

3265

with tempfile.NamedTemporaryFile(

3598

mode="wb",

3266

mode='wb',

3599

3267

suffix=".pickle",

3600

prefix="clients-",

3268

prefix='clients-',

3601

3269

dir=os.path.dirname(stored_state_path),

3602

3270

delete=False) as stored_state:

3603

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

3604

protocol=2)

3271

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

3605

3272

tempname = stored_state.name

3606

3273

os.rename(tempname, stored_state_path)

3607

3274

except (IOError, OSError) as e:

3611

3278

except NameError:

3612

3279

pass

3613

3280

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

3614

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

3615

os.strerror(e.errno))

3281

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

3282

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

3616

3283

else:

3617

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

3618

exc_info=e)

3284

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

3285

exc_info=e)

3619

3286

raise

3620

3287

3621

3288

# Delete all clients, and settings from config

3622

3289

while tcp_server.clients:

3623

3290

name, client = tcp_server.clients.popitem()

3629

3296

if use_dbus:

3630

3297

mandos_dbus_service.client_removed_signal(client)

3631

3298

client_settings.clear()

3632

3299

3633

3300

atexit.register(cleanup)

3634

3635

for client in tcp_server.clients.values():

3301

3302

for client in tcp_server.clients.itervalues():

3636

3303

if use_dbus:

3637

3304

# Emit D-Bus signal for adding

3638

3305

mandos_dbus_service.client_added_signal(client)

3639

3306

# Need to initiate checking of clients

3640

3307

if client.enabled:

3641

client.init_checker(randomize_start=True)

3642

3308

client.init_checker()

3309

3643

3310

tcp_server.enable()

3644

3311

tcp_server.server_activate()

3645

3312

3646

3313

# Find out what port we got

3647

3314

if zeroconf:

3648

3315

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

3649

3316

if use_ipv6:

3650

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

3651

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

3317

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

3318

" flowinfo %d, scope_id %d",

3319

*tcp_server.socket.getsockname())

3652

3320

else: # IPv4

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

3321

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

3322

*tcp_server.socket.getsockname())

3323

3324

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

3325

3658

3326

try:

3659

3327

if zeroconf:

3660

3328

# From the Avahi example code

3661

3329

try:

3662

3330

service.activate()

3663

3331

except dbus.exceptions.DBusException as error:

3664

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

3332

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

3665

3333

cleanup()

3666

3334

sys.exit(1)

3667

3335

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3674

3675

log.debug("Starting main loop")

3336

3337

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

3338

lambda *args, **kwargs:

3339

(tcp_server.handle_request

3340

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

3341

3342

logger.debug("Starting main loop")

3676

3343

main_loop.run()

3677

3344

except AvahiError as error:

3678

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

3345

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

3679

3346

cleanup()

3680

3347

sys.exit(1)

3681

3348

except KeyboardInterrupt:

3682

3349

if debug:

3683

3350

print("", file=sys.stderr)

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

3351

logger.debug("Server received KeyboardInterrupt")

3352

logger.debug("Server exiting")

3686

3353

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

3687

3354

cleanup()

3688

3355

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

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

3782

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

3783

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

3784

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

3785

# End:

3356

3357

if __name__ == '__main__':

3358

main()