/mandos/release : revision 237.7.854

1

#!/usr/bin/python2.7

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

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

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

39

47

try:

40

48

import SocketServer as socketserver

41

49

except ImportError:

42

50

import socketserver

43

51

import socket

44

import argparse

45

52

import datetime

46

53

import errno

47

54

try:

48

55

import ConfigParser as configparser

49

56

except ImportError:

50

57

import configparser

51

import sys

52

58

import re

53

import os

54

59

import signal

55

60

import subprocess

56

61

import atexit

57

62

import stat

58

import logging

59

63

import logging.handlers

60

64

import pwd

61

65

import contextlib

73

77

import itertools

74

78

import collections

75

79

import codecs

80

import random

81

import shlex

76

82

77

83

import dbus

78

84

import dbus.service

79

try:

80

import gobject

81

except ImportError:

82

from gi.repository import GObject as gobject

83

import avahi

85

import gi

86

from gi.repository import GLib

84

87

from dbus.mainloop.glib import DBusGMainLoop

85

88

import ctypes

86

89

import ctypes.util

87

90

import xml.dom.minidom

88

91

import inspect

89

92

90

try:

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:

91

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

92

123

except AttributeError:

93

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

94

127

from IN import SO_BINDTODEVICE

95

128

except ImportError:

96

SO_BINDTODEVICE = None

97

98

if sys.version_info.major == 2:

99

str = unicode

100

101

version = "1.7.1"

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

102

147

stored_state_file = "clients.pickle"

103

148

104

logger = logging.getLogger()

149

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

150

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

105

151

syslogger = None

106

152

107

153

try:

108

154

if_nametoindex = ctypes.cdll.LoadLibrary(

109

155

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

110

156

except (OSError, AttributeError):

111

157

112

158

def if_nametoindex(interface):

113

159

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

114

160

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

119

165

return interface_index

120

166

121

167

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

122

184

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

123

185

"""init logger and add loglevel"""

124

186

125

187

global syslogger

126

188

syslogger = (logging.handlers.SysLogHandler(

127

facility = logging.handlers.SysLogHandler.LOG_DAEMON,

128

address = "/dev/log"))

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

129

191

syslogger.setFormatter(logging.Formatter

130

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

131

' %(message)s'))

132

logger.addHandler(syslogger)

133

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

134

196

if debug:

135

197

console = logging.StreamHandler()

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)

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)

142

204

143

205

144

206

class PGPError(Exception):

146

208

pass

147

209

148

210

149

class PGPEngine(object):

211

class PGPEngine:

150

212

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

151

213

152

214

def __init__(self):

153

215

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

154

self.gnupgargs = ['--batch',

155

'--home', self.tempdir,

156

'--force-mdc',

157

'--quiet',

158

'--no-use-agent']

159

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

160

235

def __enter__(self):

161

236

return self

162

237

163

238

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

164

239

self._cleanup()

165

240

return False

166

241

167

242

def __del__(self):

168

243

self._cleanup()

169

244

170

245

def _cleanup(self):

171

246

if self.tempdir is not None:

172

247

# Delete contents of tempdir

173

248

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

174

topdown = False):

249

topdown=False):

175

250

for filename in files:

176

251

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

177

252

for dirname in dirs:

179

254

# Remove tempdir

180

255

os.rmdir(self.tempdir)

181

256

self.tempdir = None

182

257

183

258

def password_encode(self, password):

184

259

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

185

260

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

190

265

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

191

266

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

192

267

return encoded

193

268

194

269

def encrypt(self, data, password):

195

270

passphrase = self.password_encode(password)

196

271

with tempfile.NamedTemporaryFile(

197

272

dir=self.tempdir) as passfile:

198

273

passfile.write(passphrase)

199

274

passfile.flush()

200

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

201

'--passphrase-file',

275

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

276

"--passphrase-file",

202

277

passfile.name]

203

278

+ self.gnupgargs,

204

stdin = subprocess.PIPE,

205

stdout = subprocess.PIPE,

206

stderr = subprocess.PIPE)

207

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

208

283

if proc.returncode != 0:

209

284

raise PGPError(err)

210

285

return ciphertext

211

286

212

287

def decrypt(self, data, password):

213

288

passphrase = self.password_encode(password)

214

289

with tempfile.NamedTemporaryFile(

215

dir = self.tempdir) as passfile:

290

dir=self.tempdir) as passfile:

216

291

passfile.write(passphrase)

217

292

passfile.flush()

218

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

219

'--passphrase-file',

293

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

294

"--passphrase-file",

220

295

passfile.name]

221

296

+ self.gnupgargs,

222

stdin = subprocess.PIPE,

223

stdout = subprocess.PIPE,

224

stderr = subprocess.PIPE)

225

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

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

226

301

if proc.returncode != 0:

227

302

raise PGPError(err)

228

303

return decrypted_plaintext

229

304

230

305

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

231

332

class AvahiError(Exception):

232

333

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

233

334

self.value = value

243

344

pass

244

345

245

346

246

class AvahiService(object):

347

class AvahiService:

247

348

"""An Avahi (Zeroconf) service.

248

349

249

350

Attributes:

250

351

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

251

352

Used to optionally bind to the specified interface.

252

name: string; Example: 'Mandos'

253

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

353

name: string; Example: "Mandos"

354

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

254

355

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

255

356

port: integer; what port to announce

256

357

TXT: list of strings; TXT record for the service

263

364

server: D-Bus Server

264

365

bus: dbus.SystemBus()

265

366

"""

266

367

267

368

def __init__(self,

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

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

278

379

self.interface = interface

279

380

self.name = name

280

381

self.type = servicetype

289

390

self.server = None

290

391

self.bus = bus

291

392

self.entry_group_state_changed_match = None

292

393

293

394

def rename(self, remove=True):

294

395

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

295

396

if self.rename_count >= self.max_renames:

296

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

297

" after %i retries, exiting.",

298

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

299

400

raise AvahiServiceError("Too many renames")

300

401

self.name = str(

301

402

self.server.GetAlternativeServiceName(self.name))

302

403

self.rename_count += 1

303

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

304

self.name)

404

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

405

self.name)

305

406

if remove:

306

407

self.remove()

307

408

try:

309

410

except dbus.exceptions.DBusException as error:

310

411

if (error.get_dbus_name()

311

412

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

312

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

413

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

313

414

return self.rename(remove=False)

314

415

else:

315

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

416

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

316

417

self.cleanup()

317

418

os._exit(1)

318

419

319

420

def remove(self):

320

421

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

321

422

if self.entry_group_state_changed_match is not None:

323

424

self.entry_group_state_changed_match = None

324

425

if self.group is not None:

325

426

self.group.Reset()

326

427

327

428

def add(self):

328

429

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

329

430

self.remove()

334

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

335

436

self.entry_group_state_changed_match = (

336

437

self.group.connect_to_signal(

337

'StateChanged', self.entry_group_state_changed))

338

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

339

self.name, self.type)

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

340

441

self.group.AddService(

341

442

self.interface,

342

443

self.protocol,

346

447

dbus.UInt16(self.port),

347

448

avahi.string_array_to_txt_array(self.TXT))

348

449

self.group.Commit()

349

450

350

451

def entry_group_state_changed(self, state, error):

351

452

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

352

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

353

453

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

454

354

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

355

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

356

457

elif state == avahi.ENTRY_GROUP_COLLISION:

357

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

458

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

358

459

self.rename()

359

460

elif state == avahi.ENTRY_GROUP_FAILURE:

360

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

361

str(error))

461

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

462

str(error))

362

463

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

363

464

364

465

def cleanup(self):

365

466

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

366

467

if self.group is not None:

371

472

pass

372

473

self.group = None

373

474

self.remove()

374

475

375

476

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

376

477

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

377

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

478

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

378

479

bad_states = {

379

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

380

481

avahi.SERVER_REGISTERING: None,

384

485

if state in bad_states:

385

486

if bad_states[state] is not None:

386

487

if error is None:

387

logger.error(bad_states[state])

488

log.error(bad_states[state])

388

489

else:

389

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

490

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

390

491

self.cleanup()

391

492

elif state == avahi.SERVER_RUNNING:

392

493

try:

394

495

except dbus.exceptions.DBusException as error:

395

496

if (error.get_dbus_name()

396

497

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

397

logger.info("Local Zeroconf service name"

398

" collision.")

498

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

399

499

return self.rename(remove=False)

400

500

else:

401

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

501

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

402

502

self.cleanup()

403

503

os._exit(1)

404

504

else:

405

505

if error is None:

406

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

506

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

407

507

else:

408

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

409

508

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

509

410

510

def activate(self):

411

511

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

412

512

if self.server is None:

423

523

class AvahiServiceToSyslog(AvahiService):

424

524

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

425

525

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

426

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

526

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

527

**kwargs)

427

528

syslogger.setFormatter(logging.Formatter(

428

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

529

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

429

530

.format(self.name)))

430

531

return ret

431

532

533

432

534

# Pretend that we have a GnuTLS module

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

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

448

544

# Unless otherwise indicated, the constants and types below are

449

545

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

450

546

451

547

# Constants

452

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

453

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

454

553

CLIENT = 2

455

554

SHUT_RDWR = 0

456

555

CRD_CERTIFICATE = 1

457

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

458

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

459

563

460

564

# Types

461

class session_int(ctypes.Structure):

565

class _session_int(ctypes.Structure):

462

566

_fields_ = []

463

session_t = ctypes.POINTER(session_int)

567

session_t = ctypes.POINTER(_session_int)

568

464

569

class certificate_credentials_st(ctypes.Structure):

465

570

_fields_ = []

466

571

certificate_credentials_t = ctypes.POINTER(

467

572

certificate_credentials_st)

468

573

certificate_type_t = ctypes.c_int

574

469

575

class datum_t(ctypes.Structure):

470

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

471

('size', ctypes.c_uint)]

472

class openpgp_crt_int(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

473

580

_fields_ = []

474

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

475

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

476

583

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

477

credentials_type_t = ctypes.c_int #

584

credentials_type_t = ctypes.c_int

478

585

transport_ptr_t = ctypes.c_void_p

479

586

close_request_t = ctypes.c_int

480

587

481

588

# Exceptions

482

589

class Error(Exception):

483

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

484

# exception might be raised from within GnuTLS.__init__,

485

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

486

# global variable happens.

487

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

590

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

488

591

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

489

592

# code is passed, convert it to a string with

490

593

# gnutls.strerror()

594

self.code = code

491

595

if message is None and code is not None:

492

message = GnuTLS.strerror(code)

493

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

596

message = gnutls.strerror(code).decode(

597

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

598

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

494

599

message, *args)

495

600

496

601

class CertificateSecurityError(Error):

497

602

pass

498

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

499

629

# Classes

500

class Credentials(object):

630

class Credentials(With_from_param):

501

631

def __init__(self):

502

self._c_object = gnutls.certificate_credentials_t()

503

gnutls.certificate_allocate_credentials(

504

ctypes.byref(self._c_object))

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

505

634

self.type = gnutls.CRD_CERTIFICATE

506

635

507

636

def __del__(self):

508

gnutls.certificate_free_credentials(self._c_object)

509

510

class ClientSession(object):

511

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

512

self._c_object = gnutls.session_t()

513

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

514

gnutls.set_default_priority(self._c_object)

515

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

516

gnutls.handshake_set_private_extensions(self._c_object,

517

True)

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)

518

652

self.socket = socket

519

653

if credentials is None:

520

654

credentials = gnutls.Credentials()

521

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

522

ctypes.cast(credentials._c_object,

523

ctypes.c_void_p))

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

524

657

self.credentials = credentials

525

658

526

659

def __del__(self):

527

gnutls.deinit(self._c_object)

528

660

gnutls.deinit(self)

661

529

662

def handshake(self):

530

return gnutls.handshake(self._c_object)

531

663

return gnutls.handshake(self)

664

532

665

def send(self, data):

533

666

data = bytes(data)

534

if not data:

535

return 0

536

return gnutls.record_send(self._c_object, data, len(data))

537

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

538

672

def bye(self):

539

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

540

541

# Error handling function

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

542

676

def _error_code(result):

543

677

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

544

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

545

if result >= 0:

678

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

679

if result >= gnutls.E_SUCCESS:

546

680

return result

547

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

548

raise gnutls.CertificateSecurityError(code = result)

549

raise gnutls.Error(code = result)

550

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

551

695

# Unless otherwise indicated, the function declarations below are

552

696

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

553

697

554

698

# Functions

555

699

priority_set_direct = _library.gnutls_priority_set_direct

556

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

557

701

ctypes.POINTER(ctypes.c_char_p)]

558

702

priority_set_direct.restype = _error_code

559

703

560

704

init = _library.gnutls_init

561

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

705

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

562

706

init.restype = _error_code

563

707

564

708

set_default_priority = _library.gnutls_set_default_priority

565

set_default_priority.argtypes = [session_t]

709

set_default_priority.argtypes = [ClientSession]

566

710

set_default_priority.restype = _error_code

567

711

568

712

record_send = _library.gnutls_record_send

569

record_send.argtypes = [session_t, ctypes.c_void_p,

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

570

714

ctypes.c_size_t]

571

715

record_send.restype = ctypes.c_ssize_t

572

716

record_send.errcheck = _retry_on_error

717

573

718

certificate_allocate_credentials = (

574

719

_library.gnutls_certificate_allocate_credentials)

575

720

certificate_allocate_credentials.argtypes = [

576

ctypes.POINTER(certificate_credentials_t)]

721

PointerTo(Credentials)]

577

722

certificate_allocate_credentials.restype = _error_code

578

723

579

724

certificate_free_credentials = (

580

725

_library.gnutls_certificate_free_credentials)

581

certificate_free_credentials.argtypes = [certificate_credentials_t]

726

certificate_free_credentials.argtypes = [Credentials]

582

727

certificate_free_credentials.restype = None

583

728

584

729

handshake_set_private_extensions = (

585

730

_library.gnutls_handshake_set_private_extensions)

586

handshake_set_private_extensions.argtypes = [session_t,

731

handshake_set_private_extensions.argtypes = [ClientSession,

587

732

ctypes.c_int]

588

733

handshake_set_private_extensions.restype = None

589

734

590

735

credentials_set = _library.gnutls_credentials_set

591

credentials_set.argtypes = [session_t, credentials_type_t,

592

ctypes.c_void_p]

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

593

738

credentials_set.restype = _error_code

594

739

595

740

strerror = _library.gnutls_strerror

596

741

strerror.argtypes = [ctypes.c_int]

597

742

strerror.restype = ctypes.c_char_p

598

743

599

744

certificate_type_get = _library.gnutls_certificate_type_get

600

certificate_type_get.argtypes = [session_t]

745

certificate_type_get.argtypes = [ClientSession]

601

746

certificate_type_get.restype = _error_code

602

747

603

748

certificate_get_peers = _library.gnutls_certificate_get_peers

604

certificate_get_peers.argtypes = [session_t,

749

certificate_get_peers.argtypes = [ClientSession,

605

750

ctypes.POINTER(ctypes.c_uint)]

606

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

607

752

608

753

global_set_log_level = _library.gnutls_global_set_log_level

609

754

global_set_log_level.argtypes = [ctypes.c_int]

610

755

global_set_log_level.restype = None

611

756

612

757

global_set_log_function = _library.gnutls_global_set_log_function

613

758

global_set_log_function.argtypes = [log_func]

614

759

global_set_log_function.restype = None

615

760

616

761

deinit = _library.gnutls_deinit

617

deinit.argtypes = [session_t]

762

deinit.argtypes = [ClientSession]

618

763

deinit.restype = None

619

764

620

765

handshake = _library.gnutls_handshake

621

handshake.argtypes = [session_t]

622

handshake.restype = _error_code

623

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

624

770

transport_set_ptr = _library.gnutls_transport_set_ptr

625

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

626

772

transport_set_ptr.restype = None

627

773

628

774

bye = _library.gnutls_bye

629

bye.argtypes = [session_t, close_request_t]

630

bye.restype = _error_code

631

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

632

779

check_version = _library.gnutls_check_version

633

780

check_version.argtypes = [ctypes.c_char_p]

634

781

check_version.restype = ctypes.c_char_p

635

636

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

637

638

openpgp_crt_init = _library.gnutls_openpgp_crt_init

639

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

640

openpgp_crt_init.restype = _error_code

641

642

openpgp_crt_import = _library.gnutls_openpgp_crt_import

643

openpgp_crt_import.argtypes = [openpgp_crt_t,

644

ctypes.POINTER(datum_t),

645

openpgp_crt_fmt_t]

646

openpgp_crt_import.restype = _error_code

647

648

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

649

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

650

ctypes.POINTER(ctypes.c_uint)]

651

openpgp_crt_verify_self.restype = _error_code

652

653

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

654

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

655

openpgp_crt_deinit.restype = None

656

657

openpgp_crt_get_fingerprint = (

658

_library.gnutls_openpgp_crt_get_fingerprint)

659

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

660

ctypes.c_void_p,

661

ctypes.POINTER(

662

ctypes.c_size_t)]

663

openpgp_crt_get_fingerprint.restype = _error_code

664

665

# Remove non-public function

666

del _error_code

667

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

668

gnutls = GnuTLS()

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

669

862

670

863

def call_pipe(connection, # : multiprocessing.Connection

671

864

func, *args, **kwargs):

672

865

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

673

866

674

867

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

675

868

return value on the provided multiprocessing.Connection.

676

869

"""

677

870

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

678

871

connection.close()

679

872

680

class Client(object):

873

874

class Client:

681

875

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

682

876

683

877

Attributes:

684

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

878

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

685

879

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

686

880

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

687

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

688

to see if the client lives.

689

'None' if no process is running.

690

checker_callback_tag: a gobject event source tag, or None

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

691

885

checker_command: string; External command which is run to check

692

886

if client lives. %() expansions are done at

693

887

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

694

888

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

695

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

696

890

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

697

891

client_structure: Object describing what attributes a client has

698

892

and is used for storing the client at exit

699

893

current_checker_command: string; current running checker_command

700

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

701

895

enabled: bool()

702

896

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

703

uniquely identify the client

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

704

900

host: string; available for use by the checker command

705

901

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

706

902

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

722

918

disabled, or None

723

919

server_settings: The server_settings dict from main()

724

920

"""

725

921

726

922

runtime_expansions = ("approval_delay", "approval_duration",

727

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

923

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

728

924

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

729

925

"last_approval_request", "last_checked_ok",

730

926

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

739

935

"approved_by_default": "True",

740

936

"enabled": "True",

741

937

}

742

938

743

939

@staticmethod

744

940

def config_parser(config):

745

941

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

752

948

for client_name in config.sections():

753

949

section = dict(config.items(client_name))

754

950

client = settings[client_name] = {}

755

951

756

952

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

757

953

# Reformat values from string types to Python types

758

954

client["approved_by_default"] = config.getboolean(

759

955

client_name, "approved_by_default")

760

956

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

761

957

"enabled")

762

763

# Uppercase and remove spaces from fingerprint for later

764

# comparison purposes with return value from the

765

# fingerprint() function

766

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

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

767

966

.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

768

972

if "secret" in section:

769

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

973

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

974

.encode("utf-8"),

975

"base64")

770

976

elif "secfile" in section:

771

977

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

772

978

(section["secfile"])),

787

993

client["last_approval_request"] = None

788

994

client["last_checked_ok"] = None

789

995

client["last_checker_status"] = -2

790

996

791

997

return settings

792

793

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

998

999

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

794

1000

self.name = name

795

1001

if server_settings is None:

796

1002

server_settings = {}

798

1004

# adding all client settings

799

1005

for setting, value in settings.items():

800

1006

setattr(self, setting, value)

801

1007

802

1008

if self.enabled:

803

1009

if not hasattr(self, "last_enabled"):

804

1010

self.last_enabled = datetime.datetime.utcnow()

808

1014

else:

809

1015

self.last_enabled = None

810

1016

self.expires = None

811

812

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

813

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

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)

814

1021

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

815

1022

datetime.datetime.utcnow())

816

1023

817

1024

# attributes specific for this server instance

818

1025

self.checker = None

819

1026

self.checker_initiator_tag = None

825

1032

self.changedstate = multiprocessing_manager.Condition(

826

1033

multiprocessing_manager.Lock())

827

1034

self.client_structure = [attr

828

for attr in self.__dict__.iterkeys()

1035

for attr in self.__dict__.keys()

829

1036

if not attr.startswith("_")]

830

1037

self.client_structure.append("client_structure")

831

1038

832

1039

for name, t in inspect.getmembers(

833

1040

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

834

1041

if not name.startswith("_"):

835

1042

self.client_structure.append(name)

836

1043

837

1044

# Send notice to process children that client state has changed

838

1045

def send_changedstate(self):

839

1046

with self.changedstate:

840

1047

self.changedstate.notify_all()

841

1048

842

1049

def enable(self):

843

1050

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

844

1051

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

845

1052

# Already enabled

846

1053

return

847

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

848

1054

self.enabled = True

849

1055

self.last_enabled = datetime.datetime.utcnow()

850

1056

self.init_checker()

851

1057

self.send_changedstate()

852

1058

853

1059

def disable(self, quiet=True):

854

1060

"""Disable this client."""

855

1061

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

856

1062

return False

857

1063

if not quiet:

858

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

1064

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

859

1065

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

860

gobject.source_remove(self.disable_initiator_tag)

1066

GLib.source_remove(self.disable_initiator_tag)

861

1067

self.disable_initiator_tag = None

862

1068

self.expires = None

863

1069

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

864

gobject.source_remove(self.checker_initiator_tag)

1070

GLib.source_remove(self.checker_initiator_tag)

865

1071

self.checker_initiator_tag = None

866

1072

self.stop_checker()

867

1073

self.enabled = False

868

1074

if not quiet:

869

1075

self.send_changedstate()

870

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

1076

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

871

1077

return False

872

1078

873

1079

def __del__(self):

874

1080

self.disable()

875

876

def init_checker(self):

877

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

878

# and every interval from then on.

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.

879

1087

if self.checker_initiator_tag is not None:

880

gobject.source_remove(self.checker_initiator_tag)

881

self.checker_initiator_tag = gobject.timeout_add(

882

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

883

self.start_checker)

884

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

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

885

1106

if self.disable_initiator_tag is not None:

886

gobject.source_remove(self.disable_initiator_tag)

887

self.disable_initiator_tag = gobject.timeout_add(

888

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

889

# Also start a new checker *right now*.

890

self.start_checker()

891

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

892

1112

def checker_callback(self, source, condition, connection,

893

1113

command):

894

1114

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

895

self.checker_callback_tag = None

896

self.checker = None

897

1115

# Read return code from connection (see call_pipe)

898

1116

returncode = connection.recv()

899

1117

connection.close()

900

1118

if self.checker is not None:

1119

self.checker.join()

1120

self.checker_callback_tag = None

1121

self.checker = None

1122

901

1123

if returncode >= 0:

902

1124

self.last_checker_status = returncode

903

1125

self.last_checker_signal = None

904

1126

if self.last_checker_status == 0:

905

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

906

vars(self))

1127

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

907

1128

self.checked_ok()

908

1129

else:

909

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

1130

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

910

1131

else:

911

1132

self.last_checker_status = -1

912

1133

self.last_checker_signal = -returncode

913

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

914

vars(self))

1134

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

915

1135

return False

916

1136

917

1137

def checked_ok(self):

918

1138

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

919

1139

self.last_checked_ok = datetime.datetime.utcnow()

920

1140

self.last_checker_status = 0

921

1141

self.last_checker_signal = None

922

1142

self.bump_timeout()

923

1143

924

1144

def bump_timeout(self, timeout=None):

925

1145

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

926

1146

if timeout is None:

927

1147

timeout = self.timeout

928

1148

if self.disable_initiator_tag is not None:

929

gobject.source_remove(self.disable_initiator_tag)

1149

GLib.source_remove(self.disable_initiator_tag)

930

1150

self.disable_initiator_tag = None

931

1151

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

932

self.disable_initiator_tag = gobject.timeout_add(

1152

self.disable_initiator_tag = GLib.timeout_add(

933

1153

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

934

1154

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

935

1155

936

1156

def need_approval(self):

937

1157

self.last_approval_request = datetime.datetime.utcnow()

938

939

def start_checker(self):

1158

1159

def start_checker(self, start_was_randomized=False):

940

1160

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

941

1161

942

1162

If a checker already exists, leave it running and do

943

1163

nothing."""

944

1164

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

949

1169

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

950

1170

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

951

1171

# should be.

952

1172

953

1173

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

954

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

1174

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

955

1175

self.checker.join()

956

1176

self.checker = None

957

1177

# Start a new checker if needed

958

1178

if self.checker is None:

959

1179

# Escape attributes for the shell

960

1180

escaped_attrs = {

961

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

962

for attr in self.runtime_expansions }

1181

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

1182

for attr in self.runtime_expansions}

963

1183

try:

964

1184

command = self.checker_command % escaped_attrs

965

1185

except TypeError as error:

966

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

967

self.checker_command,

968

exc_info=error)

1186

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

1187

self.checker_command, exc_info=error)

969

1188

return True # Try again later

970

1189

self.current_checker_command = command

971

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

972

self.name)

1190

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

973

1191

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

974

1192

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

975

1193

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

977

1195

# The exception is when not debugging but nevertheless

978

1196

# running in the foreground; use the previously

979

1197

# created wnull.

980

popen_args = { "close_fds": True,

981

"shell": True,

982

"cwd": "/" }

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

983

1201

if (not self.server_settings["debug"]

984

1202

and self.server_settings["foreground"]):

985

1203

popen_args.update({"stdout": wnull,

986

"stderr": wnull })

987

pipe = multiprocessing.Pipe(duplex = False)

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

988

1206

self.checker = multiprocessing.Process(

989

target = call_pipe,

990

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

991

kwargs = popen_args)

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

992

1210

self.checker.start()

993

self.checker_callback_tag = gobject.io_add_watch(

994

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

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

995

1214

self.checker_callback, pipe[0], command)

996

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

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

997

1227

return True

998

1228

999

1229

def stop_checker(self):

1000

1230

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

1001

1231

if self.checker_callback_tag:

1002

gobject.source_remove(self.checker_callback_tag)

1232

GLib.source_remove(self.checker_callback_tag)

1003

1233

self.checker_callback_tag = None

1004

1234

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

1005

1235

return

1006

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

1236

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

1007

1237

self.checker.terminate()

1008

1238

self.checker = None

1009

1239

1014

1244

byte_arrays=False):

1015

1245

"""Decorators for marking methods of a DBusObjectWithProperties to

1016

1246

become properties on the D-Bus.

1017

1247

1018

1248

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

1019

1249

and with one argument by "Set".

1020

1250

1021

1251

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

1022

1252

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

1023

1253

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

1027

1257

if byte_arrays and signature != "ay":

1028

1258

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

1029

1259

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

1030

1260

1031

1261

def decorator(func):

1032

1262

func._dbus_is_property = True

1033

1263

func._dbus_interface = dbus_interface

1036

1266

func._dbus_name = func.__name__

1037

1267

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

1038

1268

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

1039

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

1040

1270

return func

1041

1271

1042

1272

return decorator

1043

1273

1044

1274

1045

1275

def dbus_interface_annotations(dbus_interface):

1046

1276

"""Decorator for marking functions returning interface annotations

1047

1277

1048

1278

Usage:

1049

1279

1050

1280

@dbus_interface_annotations("org.example.Interface")

1051

1281

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

1052

1282

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

1053

1283

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

1054

1284

"false"}

1055

1285

"""

1056

1286

1057

1287

def decorator(func):

1058

1288

func._dbus_is_interface = True

1059

1289

func._dbus_interface = dbus_interface

1060

1290

func._dbus_name = dbus_interface

1061

1291

return func

1062

1292

1063

1293

return decorator

1064

1294

1065

1295

1066

1296

def dbus_annotations(annotations):

1067

1297

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

1068

1298

Usage:

1069

1299

1070

1300

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

1071

1301

"org.freedesktop.DBus.Property."

1072

1302

"EmitsChangedSignal": "false"})

1074

1304

access="r")

1075

1305

def Property_dbus_property(self):

1076

1306

return dbus.Boolean(False)

1077

1307

1078

1308

See also the DBusObjectWithAnnotations class.

1079

1309

"""

1080

1310

1081

1311

def decorator(func):

1082

1312

func._dbus_annotations = annotations

1083

1313

return func

1084

1314

1085

1315

return decorator

1086

1316

1087

1317

1105

1335

1106

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1107

1337

"""A D-Bus object with annotations.

1108

1338

1109

1339

Classes inheriting from this can use the dbus_annotations

1110

1340

decorator to add annotations to methods or signals.

1111

1341

"""

1112

1342

1113

1343

@staticmethod

1114

1344

def _is_dbus_thing(thing):

1115

1345

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

1116

1346

1117

1347

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

1118

1348

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

1119

1349

"""

1120

1350

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

1121

1351

False)

1122

1352

1123

1353

def _get_all_dbus_things(self, thing):

1124

1354

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

1125

1355

"""

1128

1358

for cls in self.__class__.__mro__

1129

1359

for name, athing in

1130

1360

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

1131

1361

1132

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1133

out_signature = "s",

1134

path_keyword = 'object_path',

1135

connection_keyword = 'connection')

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1136

1366

def Introspect(self, object_path, connection):

1137

1367

"""Overloading of standard D-Bus method.

1138

1368

1139

1369

Inserts annotation tags on methods and signals.

1140

1370

"""

1141

1371

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

1142

1372

connection)

1143

1373

try:

1144

1374

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

1145

1375

1146

1376

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

1147

1377

# Add annotation tags

1148

1378

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

1175

1405

if_tag.appendChild(ann_tag)

1176

1406

# Fix argument name for the Introspect method itself

1177

1407

if (if_tag.getAttribute("name")

1178

== dbus.INTROSPECTABLE_IFACE):

1408

== dbus.INTROSPECTABLE_IFACE):

1179

1409

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

1180

1410

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

1181

1411

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

1187

1417

document.unlink()

1188

1418

except (AttributeError, xml.dom.DOMException,

1189

1419

xml.parsers.expat.ExpatError) as error:

1190

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

1191

exc_info=error)

1420

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

1421

exc_info=error)

1192

1422

return xmlstring

1193

1423

1194

1424

1195

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1196

1426

"""A D-Bus object with properties.

1197

1427

1198

1428

Classes inheriting from this can use the dbus_service_property

1199

1429

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

1200

1430

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

1201

1431

"""

1202

1432

1203

1433

def _get_dbus_property(self, interface_name, property_name):

1204

1434

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

1205

1435

property with the specified name and interface.

1210

1440

if (value._dbus_name == property_name

1211

1441

and value._dbus_interface == interface_name):

1212

1442

return value.__get__(self)

1213

1443

1214

1444

# No such property

1215

1445

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

1216

1446

self.dbus_object_path, interface_name, property_name))

1217

1447

1218

1448

@classmethod

1219

1449

def _get_all_interface_names(cls):

1220

1450

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

1223

1453

for x in (inspect.getmro(cls))

1224

1454

for attr in dir(x))

1225

1455

if name is not None)

1226

1456

1227

1457

@dbus.service.method(dbus.PROPERTIES_IFACE,

1228

1458

in_signature="ss",

1229

1459

out_signature="v")

1237

1467

if not hasattr(value, "variant_level"):

1238

1468

return value

1239

1469

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

1240

1470

1241

1471

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

1242

1472

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

1243

1473

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

1252

1482

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

1253

1483

"'ay' signature {!r}"

1254

1484

.format(prop._dbus_signature))

1255

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

1256

for byte in value))

1485

value = dbus.ByteArray(bytes(value))

1257

1486

prop(value)

1258

1487

1259

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1260

1489

in_signature="s",

1261

1490

out_signature="a{sv}")

1262

1491

def GetAll(self, interface_name):

1263

1492

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

1264

1493

standard.

1265

1494

1266

1495

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

1267

1496

"""

1268

1497

properties = {}

1279

1508

properties[name] = value

1280

1509

continue

1281

1510

properties[name] = type(value)(

1282

value, variant_level = value.variant_level + 1)

1511

value, variant_level=value.variant_level + 1)

1283

1512

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

1284

1513

1285

1514

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

1286

1515

def PropertiesChanged(self, interface_name, changed_properties,

1287

1516

invalidated_properties):

1289

1518

standard.

1290

1519

"""

1291

1520

pass

1292

1521

1293

1522

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

1523

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1524

path_keyword="object_path",

1525

connection_keyword="connection")

1297

1526

def Introspect(self, object_path, connection):

1298

1527

"""Overloading of standard D-Bus method.

1299

1528

1300

1529

Inserts property tags and interface annotation tags.

1301

1530

"""

1302

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1304

1533

connection)

1305

1534

try:

1306

1535

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

1307

1536

1308

1537

def make_tag(document, name, prop):

1309

1538

e = document.createElement("property")

1310

1539

e.setAttribute("name", name)

1311

1540

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

1312

1541

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

1313

1542

return e

1314

1543

1315

1544

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

1316

1545

# Add property tags

1317

1546

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

1355

1584

document.unlink()

1356

1585

except (AttributeError, xml.dom.DOMException,

1357

1586

xml.parsers.expat.ExpatError) as error:

1358

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

1359

exc_info=error)

1587

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

1588

exc_info=error)

1360

1589

return xmlstring

1361

1590

1591

1362

1592

try:

1363

1593

dbus.OBJECT_MANAGER_IFACE

1364

1594

except AttributeError:

1365

1595

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

1366

1596

1597

1367

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1368

1599

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

1369

1600

1370

1601

Classes inheriting from this exposes the standard

1371

1602

GetManagedObjects call and the InterfacesAdded and

1372

1603

InterfacesRemoved signals on the standard

1373

1604

"org.freedesktop.DBus.ObjectManager" interface.

1374

1605

1375

1606

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

1376

1607

manually.

1377

1608

"""

1378

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1379

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

1610

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

1380

1611

def GetManagedObjects(self):

1381

1612

"""This function must be overridden"""

1382

1613

raise NotImplementedError()

1383

1614

1384

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1385

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

1616

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

1386

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1387

1618

pass

1388

1389

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

1619

1620

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

1390

1621

def InterfacesRemoved(self, object_path, interfaces):

1391

1622

pass

1392

1623

1393

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1394

out_signature = "s",

1395

path_keyword = 'object_path',

1396

connection_keyword = 'connection')

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1397

1628

def Introspect(self, object_path, connection):

1398

1629

"""Overloading of standard D-Bus method.

1399

1630

1400

1631

Override return argument name of GetManagedObjects to be

1401

1632

"objpath_interfaces_and_properties"

1402

1633

"""

1405

1636

connection)

1406

1637

try:

1407

1638

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

1408

1639

1409

1640

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

1410

1641

# Fix argument name for the GetManagedObjects method

1411

1642

if (if_tag.getAttribute("name")

1412

== dbus.OBJECT_MANAGER_IFACE):

1643

== dbus.OBJECT_MANAGER_IFACE):

1413

1644

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

1414

1645

if (cn.getAttribute("name")

1415

1646

== "GetManagedObjects"):

1424

1655

document.unlink()

1425

1656

except (AttributeError, xml.dom.DOMException,

1426

1657

xml.parsers.expat.ExpatError) as error:

1427

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

1428

exc_info = error)

1658

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

1659

exc_info=error)

1429

1660

return xmlstring

1430

1661

1662

1431

1663

def datetime_to_dbus(dt, variant_level=0):

1432

1664

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

1433

1665

if dt is None:

1434

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

1666

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

1435

1667

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

1436

1668

1437

1669

1440

1672

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

1441

1673

interface names according to the "alt_interface_names" mapping.

1442

1674

Usage:

1443

1675

1444

1676

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

1445

1677

"net.example.AlternateInterface"})

1446

1678

class SampleDBusObject(dbus.service.Object):

1447

1679

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

1448

1680

def SampleDBusMethod():

1449

1681

pass

1450

1682

1451

1683

The above "SampleDBusMethod" on "SampleDBusObject" will be

1452

1684

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

1453

1685

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

1454

1686

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

1455

1687

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

1456

1688

1457

1689

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

1458

1690

(from DBusObjectWithProperties) and interfaces (from the

1459

1691

dbus_interface_annotations decorator).

1460

1692

"""

1461

1693

1462

1694

def wrapper(cls):

1463

1695

for orig_interface_name, alt_interface_name in (

1464

1696

alt_interface_names.items()):

1479

1711

interface_names.add(alt_interface)

1480

1712

# Is this a D-Bus signal?

1481

1713

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

1714

# Extract the original non-method undecorated

1715

# function by black magic

1482

1716

if sys.version_info.major == 2:

1483

# Extract the original non-method undecorated

1484

# function by black magic

1485

1717

nonmethod_func = (dict(

1486

1718

zip(attribute.func_code.co_freevars,

1487

1719

attribute.__closure__))

1488

1720

["func"].cell_contents)

1489

1721

else:

1490

nonmethod_func = attribute

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1491

1726

# Create a new, but exactly alike, function

1492

1727

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

1493

1728

# with the alternate D-Bus interface name

1494

if sys.version_info.major == 2:

1495

new_function = types.FunctionType(

1496

nonmethod_func.func_code,

1497

nonmethod_func.func_globals,

1498

nonmethod_func.func_name,

1499

nonmethod_func.func_defaults,

1500

nonmethod_func.func_closure)

1501

else:

1502

new_function = types.FunctionType(

1503

nonmethod_func.__code__,

1504

nonmethod_func.__globals__,

1505

nonmethod_func.__name__,

1506

nonmethod_func.__defaults__,

1507

nonmethod_func.__closure__)

1729

new_function = copy_function(nonmethod_func)

1508

1730

new_function = (dbus.service.signal(

1509

1731

alt_interface,

1510

1732

attribute._dbus_signature)(new_function))

1514

1736

attribute._dbus_annotations)

1515

1737

except AttributeError:

1516

1738

pass

1739

1517

1740

# Define a creator of a function to call both the

1518

1741

# original and alternate functions, so both the

1519

1742

# original and alternate signals gets sent when

1522

1745

"""This function is a scope container to pass

1523

1746

func1 and func2 to the "call_both" function

1524

1747

outside of its arguments"""

1525

1748

1526

1749

@functools.wraps(func2)

1527

1750

def call_both(*args, **kwargs):

1528

1751

"""This function will emit two D-Bus

1529

1752

signals by calling func1 and func2"""

1530

1753

func1(*args, **kwargs)

1531

1754

func2(*args, **kwargs)

1532

# Make wrapper function look like a D-Bus signal

1755

# Make wrapper function look like a D-Bus

1756

# signal

1533

1757

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

1534

1758

if name.startswith("_dbus_"):

1535

1759

setattr(call_both, name, attr)

1536

1760

1537

1761

return call_both

1538

1762

# Create the "call_both" function and add it to

1539

1763

# the class

1549

1773

alt_interface,

1550

1774

attribute._dbus_in_signature,

1551

1775

attribute._dbus_out_signature)

1552

(types.FunctionType(attribute.func_code,

1553

attribute.func_globals,

1554

attribute.func_name,

1555

attribute.func_defaults,

1556

attribute.func_closure)))

1776

(copy_function(attribute)))

1557

1777

# Copy annotations, if any

1558

1778

try:

1559

1779

attr[attrname]._dbus_annotations = dict(

1571

1791

attribute._dbus_access,

1572

1792

attribute._dbus_get_args_options

1573

1793

["byte_arrays"])

1574

(types.FunctionType(

1575

attribute.func_code,

1576

attribute.func_globals,

1577

attribute.func_name,

1578

attribute.func_defaults,

1579

attribute.func_closure)))

1794

(copy_function(attribute)))

1580

1795

# Copy annotations, if any

1581

1796

try:

1582

1797

attr[attrname]._dbus_annotations = dict(

1591

1806

# to the class.

1592

1807

attr[attrname] = (

1593

1808

dbus_interface_annotations(alt_interface)

1594

(types.FunctionType(attribute.func_code,

1595

attribute.func_globals,

1596

attribute.func_name,

1597

attribute.func_defaults,

1598

attribute.func_closure)))

1809

(copy_function(attribute)))

1599

1810

if deprecate:

1600

1811

# Deprecate all alternate interfaces

1601

iname="_AlternateDBusNames_interface_annotation{}"

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1602

1813

for interface_name in interface_names:

1603

1814

1604

1815

@dbus_interface_annotations(interface_name)

1605

1816

def func(self):

1606

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

1607

"true" }

1817

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

1818

"true"}

1608

1819

# Find an unused name

1609

1820

for aname in (iname.format(i)

1610

1821

for i in itertools.count()):

1614

1825

if interface_names:

1615

1826

# Replace the class with a new subclass of it with

1616

1827

# methods, signals, etc. as created above.

1617

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

1618

(cls, ), attr)

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)

1619

1834

return cls

1620

1835

1621

1836

return wrapper

1622

1837

1623

1838

1625

1840

"se.bsnet.fukt.Mandos"})

1626

1841

class ClientDBus(Client, DBusObjectWithProperties):

1627

1842

"""A Client class using D-Bus

1628

1843

1629

1844

Attributes:

1630

1845

dbus_object_path: dbus.ObjectPath

1631

1846

bus: dbus.SystemBus()

1632

1847

"""

1633

1848

1634

1849

runtime_expansions = (Client.runtime_expansions

1635

1850

+ ("dbus_object_path", ))

1636

1851

1637

1852

_interface = "se.recompile.Mandos.Client"

1638

1853

1639

1854

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

1640

1641

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

1855

1856

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

1642

1857

self.bus = bus

1643

1858

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

1644

1859

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

1650

1865

"/clients/" + client_object_name)

1651

1866

DBusObjectWithProperties.__init__(self, self.bus,

1652

1867

self.dbus_object_path)

1653

1868

1654

1869

def notifychangeproperty(transform_func, dbus_name,

1655

1870

type_func=lambda x: x,

1656

1871

variant_level=1,

1658

1873

_interface=_interface):

1659

1874

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

1660

1875

its changes to DBus.

1661

1876

1662

1877

transform_fun: Function that takes a value and a variant_level

1663

1878

and transforms it to a D-Bus type.

1664

1879

dbus_name: D-Bus name of the variable

1667

1882

variant_level: D-Bus variant level. Default: 1

1668

1883

"""

1669

1884

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

1670

1885

1671

1886

def setter(self, value):

1672

1887

if hasattr(self, "dbus_object_path"):

1673

1888

if (not hasattr(self, attrname) or

1680

1895

else:

1681

1896

dbus_value = transform_func(

1682

1897

type_func(value),

1683

variant_level = variant_level)

1898

variant_level=variant_level)

1684

1899

self.PropertyChanged(dbus.String(dbus_name),

1685

1900

dbus_value)

1686

1901

self.PropertiesChanged(

1687

1902

_interface,

1688

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

1689

dbus_value }),

1903

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

1904

dbus_value}),

1690

1905

dbus.Array())

1691

1906

setattr(self, attrname, value)

1692

1907

1693

1908

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

1694

1909

1695

1910

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1696

1911

approvals_pending = notifychangeproperty(dbus.Boolean,

1697

1912

"ApprovalPending",

1698

type_func = bool)

1913

type_func=bool)

1699

1914

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

1700

1915

last_enabled = notifychangeproperty(datetime_to_dbus,

1701

1916

"LastEnabled")

1702

1917

checker = notifychangeproperty(

1703

1918

dbus.Boolean, "CheckerRunning",

1704

type_func = lambda checker: checker is not None)

1919

type_func=lambda checker: checker is not None)

1705

1920

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1706

1921

"LastCheckedOK")

1707

1922

last_checker_status = notifychangeproperty(dbus.Int16,

1712

1927

"ApprovedByDefault")

1713

1928

approval_delay = notifychangeproperty(

1714

1929

dbus.UInt64, "ApprovalDelay",

1715

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

1930

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

1716

1931

approval_duration = notifychangeproperty(

1717

1932

dbus.UInt64, "ApprovalDuration",

1718

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

1933

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

1719

1934

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

1720

1935

timeout = notifychangeproperty(

1721

1936

dbus.UInt64, "Timeout",

1722

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

1937

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

1723

1938

extended_timeout = notifychangeproperty(

1724

1939

dbus.UInt64, "ExtendedTimeout",

1725

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

1940

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

1726

1941

interval = notifychangeproperty(

1727

1942

dbus.UInt64, "Interval",

1728

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

1943

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

1729

1944

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

1730

1945

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

1731

1946

invalidate_only=True)

1732

1947

1733

1948

del notifychangeproperty

1734

1949

1735

1950

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

1736

1951

try:

1737

1952

self.remove_from_connection()

1740

1955

if hasattr(DBusObjectWithProperties, "__del__"):

1741

1956

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

1742

1957

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

1743

1958

1744

1959

def checker_callback(self, source, condition,

1745

1960

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

1746

1961

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

1762

1977

| self.last_checker_signal),

1763

1978

dbus.String(command))

1764

1979

return ret

1765

1980

1766

1981

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

1767

1982

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

1768

1983

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

1772

1987

# Emit D-Bus signal

1773

1988

self.CheckerStarted(self.current_checker_command)

1774

1989

return r

1775

1990

1776

1991

def _reset_approved(self):

1777

1992

self.approved = None

1778

1993

return False

1779

1994

1780

1995

def approve(self, value=True):

1781

1996

self.approved = value

1782

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

1783

* 1000), self._reset_approved)

1997

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

1998

* 1000), self._reset_approved)

1784

1999

self.send_changedstate()

1785

1786

## D-Bus methods, signals & properties

1787

1788

## Interfaces

1789

1790

## Signals

1791

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1792

2007

# CheckerCompleted - signal

1793

2008

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

1794

2009

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

1795

2010

"D-Bus signal"

1796

2011

pass

1797

2012

1798

2013

# CheckerStarted - signal

1799

2014

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

1800

2015

def CheckerStarted(self, command):

1801

2016

"D-Bus signal"

1802

2017

pass

1803

2018

1804

2019

# PropertyChanged - signal

1805

2020

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

1806

2021

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

1807

2022

def PropertyChanged(self, property, value):

1808

2023

"D-Bus signal"

1809

2024

pass

1810

2025

1811

2026

# GotSecret - signal

1812

2027

@dbus.service.signal(_interface)

1813

2028

def GotSecret(self):

1816

2031

server to mandos-client

1817

2032

"""

1818

2033

pass

1819

2034

1820

2035

# Rejected - signal

1821

2036

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

1822

2037

def Rejected(self, reason):

1823

2038

"D-Bus signal"

1824

2039

pass

1825

2040

1826

2041

# NeedApproval - signal

1827

2042

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

1828

2043

def NeedApproval(self, timeout, default):

1829

2044

"D-Bus signal"

1830

2045

return self.need_approval()

1831

1832

## Methods

1833

2046

2047

# Methods

2048

1834

2049

# Approve - method

1835

2050

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

1836

2051

def Approve(self, value):

1837

2052

self.approve(value)

1838

2053

1839

2054

# CheckedOK - method

1840

2055

@dbus.service.method(_interface)

1841

2056

def CheckedOK(self):

1842

2057

self.checked_ok()

1843

2058

1844

2059

# Enable - method

1845

2060

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

1846

2061

@dbus.service.method(_interface)

1847

2062

def Enable(self):

1848

2063

"D-Bus method"

1849

2064

self.enable()

1850

2065

1851

2066

# StartChecker - method

1852

2067

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

1853

2068

@dbus.service.method(_interface)

1854

2069

def StartChecker(self):

1855

2070

"D-Bus method"

1856

2071

self.start_checker()

1857

2072

1858

2073

# Disable - method

1859

2074

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

1860

2075

@dbus.service.method(_interface)

1861

2076

def Disable(self):

1862

2077

"D-Bus method"

1863

2078

self.disable()

1864

2079

1865

2080

# StopChecker - method

1866

2081

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

1867

2082

@dbus.service.method(_interface)

1868

2083

def StopChecker(self):

1869

2084

self.stop_checker()

1870

1871

## Properties

1872

2085

2086

# Properties

2087

1873

2088

# ApprovalPending - property

1874

2089

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

1875

2090

def ApprovalPending_dbus_property(self):

1876

2091

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

1877

2092

1878

2093

# ApprovedByDefault - property

1879

2094

@dbus_service_property(_interface,

1880

2095

signature="b",

1883

2098

if value is None: # get

1884

2099

return dbus.Boolean(self.approved_by_default)

1885

2100

self.approved_by_default = bool(value)

1886

2101

1887

2102

# ApprovalDelay - property

1888

2103

@dbus_service_property(_interface,

1889

2104

signature="t",

1893

2108

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

1894

2109

* 1000)

1895

2110

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

1896

2111

1897

2112

# ApprovalDuration - property

1898

2113

@dbus_service_property(_interface,

1899

2114

signature="t",

1903

2118

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

1904

2119

* 1000)

1905

2120

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

1906

2121

1907

2122

# Name - property

1908

2123

@dbus_annotations(

1909

2124

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

1910

2125

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

1911

2126

def Name_dbus_property(self):

1912

2127

return dbus.String(self.name)

1913

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

1914

2136

# Fingerprint - property

1915

2137

@dbus_annotations(

1916

2138

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

1917

2139

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

1918

2140

def Fingerprint_dbus_property(self):

1919

2141

return dbus.String(self.fingerprint)

1920

2142

1921

2143

# Host - property

1922

2144

@dbus_service_property(_interface,

1923

2145

signature="s",

1926

2148

if value is None: # get

1927

2149

return dbus.String(self.host)

1928

2150

self.host = str(value)

1929

2151

1930

2152

# Created - property

1931

2153

@dbus_annotations(

1932

2154

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

1933

2155

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

1934

2156

def Created_dbus_property(self):

1935

2157

return datetime_to_dbus(self.created)

1936

2158

1937

2159

# LastEnabled - property

1938

2160

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

1939

2161

def LastEnabled_dbus_property(self):

1940

2162

return datetime_to_dbus(self.last_enabled)

1941

2163

1942

2164

# Enabled - property

1943

2165

@dbus_service_property(_interface,

1944

2166

signature="b",

1950

2172

self.enable()

1951

2173

else:

1952

2174

self.disable()

1953

2175

1954

2176

# LastCheckedOK - property

1955

2177

@dbus_service_property(_interface,

1956

2178

signature="s",

1960

2182

self.checked_ok()

1961

2183

return

1962

2184

return datetime_to_dbus(self.last_checked_ok)

1963

2185

1964

2186

# LastCheckerStatus - property

1965

2187

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

1966

2188

def LastCheckerStatus_dbus_property(self):

1967

2189

return dbus.Int16(self.last_checker_status)

1968

2190

1969

2191

# Expires - property

1970

2192

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

1971

2193

def Expires_dbus_property(self):

1972

2194

return datetime_to_dbus(self.expires)

1973

2195

1974

2196

# LastApprovalRequest - property

1975

2197

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

1976

2198

def LastApprovalRequest_dbus_property(self):

1977

2199

return datetime_to_dbus(self.last_approval_request)

1978

2200

1979

2201

# Timeout - property

1980

2202

@dbus_service_property(_interface,

1981

2203

signature="t",

1996

2218

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

1997

2219

is None):

1998

2220

return

1999

gobject.source_remove(self.disable_initiator_tag)

2000

self.disable_initiator_tag = gobject.timeout_add(

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2001

2223

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

2002

2224

self.disable)

2003

2225

2004

2226

# ExtendedTimeout - property

2005

2227

@dbus_service_property(_interface,

2006

2228

signature="t",

2010

2232

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

2011

2233

* 1000)

2012

2234

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

2013

2235

2014

2236

# Interval - property

2015

2237

@dbus_service_property(_interface,

2016

2238

signature="t",

2023

2245

return

2024

2246

if self.enabled:

2025

2247

# Reschedule checker run

2026

gobject.source_remove(self.checker_initiator_tag)

2027

self.checker_initiator_tag = gobject.timeout_add(

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2028

2250

value, self.start_checker)

2029

self.start_checker() # Start one now, too

2030

2251

self.start_checker() # Start one now, too

2252

2031

2253

# Checker - property

2032

2254

@dbus_service_property(_interface,

2033

2255

signature="s",

2036

2258

if value is None: # get

2037

2259

return dbus.String(self.checker_command)

2038

2260

self.checker_command = str(value)

2039

2261

2040

2262

# CheckerRunning - property

2041

2263

@dbus_service_property(_interface,

2042

2264

signature="b",

2048

2270

self.start_checker()

2049

2271

else:

2050

2272

self.stop_checker()

2051

2273

2052

2274

# ObjectPath - property

2053

2275

@dbus_annotations(

2054

2276

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

2055

2277

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

2056

2278

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

2057

2279

def ObjectPath_dbus_property(self):

2058

return self.dbus_object_path # is already a dbus.ObjectPath

2059

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

2060

2282

# Secret = property

2061

2283

@dbus_annotations(

2062

2284

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

2067

2289

byte_arrays=True)

2068

2290

def Secret_dbus_property(self, value):

2069

2291

self.secret = bytes(value)

2070

2292

2071

2293

del _interface

2072

2294

2073

2295

2074

class ProxyClient(object):

2075

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

2296

class ProxyClient:

2297

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

2076

2298

self._pipe = child_pipe

2077

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

2299

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

2078

2300

if not self._pipe.recv():

2079

raise KeyError(fpr)

2080

2301

raise KeyError(key_id or fpr)

2302

2081

2303

def __getattribute__(self, name):

2082

if name == '_pipe':

2304

if name == "_pipe":

2083

2305

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

2084

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

2306

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

2085

2307

data = self._pipe.recv()

2086

if data[0] == 'data':

2308

if data[0] == "data":

2087

2309

return data[1]

2088

if data[0] == 'function':

2089

2310

if data[0] == "function":

2311

2090

2312

def func(*args, **kwargs):

2091

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

2313

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

2092

2314

return self._pipe.recv()[1]

2093

2315

2094

2316

return func

2095

2317

2096

2318

def __setattr__(self, name, value):

2097

if name == '_pipe':

2319

if name == "_pipe":

2098

2320

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

2099

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

2321

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

2100

2322

2101

2323

2102

2324

class ClientHandler(socketserver.BaseRequestHandler, object):

2103

2325

"""A class to handle client connections.

2104

2326

2105

2327

Instantiated once for each connection to handle it.

2106

2328

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

2107

2329

2108

2330

def handle(self):

2109

2331

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

2110

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

2111

str(self.client_address))

2112

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

2113

self.server.child_pipe.fileno())

2114

2332

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

2333

str(self.client_address))

2334

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

2335

2115

2336

session = gnutls.ClientSession(self.request)

2116

2117

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

2118

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

2119

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

2120

# "+DHE-DSS"))

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

2121

2342

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

2122

2343

priority = self.server.gnutls_priority

2123

2344

if priority is None:

2124

2345

priority = "NORMAL"

2125

gnutls.priority_set_direct(session._c_object, priority,

2126

None)

2127

2346

gnutls.priority_set_direct(session,

2347

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

2348

2128

2349

# Start communication using the Mandos protocol

2129

2350

# Get protocol number

2130

2351

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

2131

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

2352

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

2132

2353

try:

2133

2354

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

2134

2355

raise RuntimeError(line)

2135

2356

except (ValueError, IndexError, RuntimeError) as error:

2136

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

2357

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

2137

2358

return

2138

2359

2139

2360

# Start GnuTLS connection

2140

2361

try:

2141

2362

session.handshake()

2142

2363

except gnutls.Error as error:

2143

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

2364

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

2144

2365

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

2145

2366

# established. Just abandon the request.

2146

2367

return

2147

logger.debug("Handshake succeeded")

2148

2368

log.debug("Handshake succeeded")

2369

2149

2370

approval_required = False

2150

2371

try:

2151

try:

2152

fpr = self.fingerprint(

2153

self.peer_certificate(session))

2154

except (TypeError, gnutls.Error) as error:

2155

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

2156

return

2157

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

2158

2159

try:

2160

client = ProxyClient(child_pipe, fpr,

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,

2161

2396

self.client_address)

2162

2397

except KeyError:

2163

2398

return

2164

2399

2165

2400

if client.approval_delay:

2166

2401

delay = client.approval_delay

2167

2402

client.approvals_pending += 1

2168

2403

approval_required = True

2169

2404

2170

2405

while True:

2171

2406

if not client.enabled:

2172

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

2173

client.name)

2407

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

2174

2408

if self.server.use_dbus:

2175

2409

# Emit D-Bus signal

2176

2410

client.Rejected("Disabled")

2177

2411

return

2178

2412

2179

2413

if client.approved or not client.approval_delay:

2180

#We are approved or approval is disabled

2414

# We are approved or approval is disabled

2181

2415

break

2182

2416

elif client.approved is None:

2183

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

2184

client.name)

2417

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

2418

client.name)

2185

2419

if self.server.use_dbus:

2186

2420

# Emit D-Bus signal

2187

2421

client.NeedApproval(

2188

2422

client.approval_delay.total_seconds()

2189

2423

* 1000, client.approved_by_default)

2190

2424

else:

2191

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

2192

client.name)

2425

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

2426

client.name)

2193

2427

if self.server.use_dbus:

2194

2428

# Emit D-Bus signal

2195

2429

client.Rejected("Denied")

2196

2430

return

2197

2198

#wait until timeout or approved

2431

2432

# wait until timeout or approved

2199

2433

time = datetime.datetime.now()

2200

2434

client.changedstate.acquire()

2201

2435

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

2203

2437

time2 = datetime.datetime.now()

2204

2438

if (time2 - time) >= delay:

2205

2439

if not client.approved_by_default:

2206

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

2207

" waiting for approval",

2208

client.name)

2440

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

2441

" waiting for approval",

2442

client.name)

2209

2443

if self.server.use_dbus:

2210

2444

# Emit D-Bus signal

2211

2445

client.Rejected("Approval timed out")

2214

2448

break

2215

2449

else:

2216

2450

delay -= time2 - time

2217

2218

sent_size = 0

2219

while sent_size < len(client.secret):

2220

try:

2221

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

2222

except gnutls.Error as error:

2223

logger.warning("gnutls send failed",

2224

exc_info=error)

2225

return

2226

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

2227

len(client.secret) - (sent_size

2228

+ sent))

2229

sent_size += sent

2230

2231

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

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

2232

2459

# bump the timeout using extended_timeout

2233

2460

client.bump_timeout(client.extended_timeout)

2234

2461

if self.server.use_dbus:

2235

2462

# Emit D-Bus signal

2236

2463

client.GotSecret()

2237

2464

2238

2465

finally:

2239

2466

if approval_required:

2240

2467

client.approvals_pending -= 1

2241

2468

try:

2242

2469

session.bye()

2243

2470

except gnutls.Error as error:

2244

logger.warning("GnuTLS bye failed",

2245

exc_info=error)

2246

2471

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

2472

2247

2473

@staticmethod

2248

2474

def peer_certificate(session):

2249

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

2250

# If not an OpenPGP certificate...

2251

if (gnutls.certificate_type_get(session._c_object)

2252

!= gnutls.CRT_OPENPGP):

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)

2253

2489

# ...return invalid data

2254

2490

return b""

2255

2491

list_size = ctypes.c_uint(1)

2256

2492

cert_list = (gnutls.certificate_get_peers

2257

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

2493

(session, ctypes.byref(list_size)))

2258

2494

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

2259

2495

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

2260

2496

if list_size.value == 0:

2261

2497

return None

2262

2498

cert = cert_list[0]

2263

2499

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

2264

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

2265

2536

@staticmethod

2266

2537

def fingerprint(openpgp):

2267

2538

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2282

2553

ctypes.byref(crtverify))

2283

2554

if crtverify.value != 0:

2284

2555

gnutls.openpgp_crt_deinit(crt)

2285

raise gnutls.CertificateSecurityError("Verify failed")

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

2286

2558

# New buffer for the fingerprint

2287

2559

buf = ctypes.create_string_buffer(20)

2288

2560

buf_len = ctypes.c_size_t()

2298

2570

return hex_fpr

2299

2571

2300

2572

2301

class MultiprocessingMixIn(object):

2573

class MultiprocessingMixIn:

2302

2574

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

2303

2575

2304

2576

def sub_process_main(self, request, address):

2305

2577

try:

2306

2578

self.finish_request(request, address)

2307

2579

except Exception:

2308

2580

self.handle_error(request, address)

2309

2581

self.close_request(request)

2310

2582

2311

2583

def process_request(self, request, address):

2312

2584

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

2313

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

2314

args = (request, address))

2585

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

2586

args=(request, address))

2315

2587

proc.start()

2316

2588

return proc

2317

2589

2318

2590

2319

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

2320

2592

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

2321

2593

2322

2594

def process_request(self, request, client_address):

2323

2595

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

2324

2596

2325

2597

This function creates a new pipe in self.pipe

2326

2598

"""

2327

2599

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2328

2600

2329

2601

proc = MultiprocessingMixIn.process_request(self, request,

2330

2602

client_address)

2331

2603

self.child_pipe.close()

2332

2604

self.add_pipe(parent_pipe, proc)

2333

2605

2334

2606

def add_pipe(self, parent_pipe, proc):

2335

2607

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

2336

2608

raise NotImplementedError()

2337

2609

2338

2610

2339

2611

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2340

socketserver.TCPServer, object):

2341

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

2342

2612

socketserver.TCPServer):

2613

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

2614

2343

2615

Attributes:

2344

2616

enabled: Boolean; whether this server is activated yet

2345

2617

interface: None or a network interface name (string)

2346

2618

use_ipv6: Boolean; to use IPv6 or not

2347

2619

"""

2348

2620

2349

2621

def __init__(self, server_address, RequestHandlerClass,

2350

2622

interface=None,

2351

2623

use_ipv6=True,

2361

2633

self.socketfd = socketfd

2362

2634

# Save the original socket.socket() function

2363

2635

self.socket_socket = socket.socket

2636

2364

2637

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

2365

#

2638

#

2366

2639

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

2367

2640

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

2368

2641

# patching socket.socket.)

2369

#

2642

#

2370

2643

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

2371

2644

@functools.wraps(socket.socket)

2372

2645

def socket_wrapper(*args, **kwargs):

2384

2657

# socket_wrapper(), if socketfd was set.

2385

2658

socketserver.TCPServer.__init__(self, server_address,

2386

2659

RequestHandlerClass)

2387

2660

2388

2661

def server_bind(self):

2389

2662

"""This overrides the normal server_bind() function

2390

2663

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

2391

2664

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

2665

global SO_BINDTODEVICE

2392

2666

if self.interface is not None:

2393

2667

if SO_BINDTODEVICE is None:

2394

logger.error("SO_BINDTODEVICE does not exist;"

2395

" cannot bind to interface %s",

2396

self.interface)

2397

else:

2398

try:

2399

self.socket.setsockopt(

2400

socket.SOL_SOCKET, SO_BINDTODEVICE,

2401

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

2402

except socket.error as error:

2403

if error.errno == errno.EPERM:

2404

logger.error("No permission to bind to"

2405

" interface %s", self.interface)

2406

elif error.errno == errno.ENOPROTOOPT:

2407

logger.error("SO_BINDTODEVICE not available;"

2408

" cannot bind to interface %s",

2409

self.interface)

2410

elif error.errno == errno.ENODEV:

2411

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

2412

" cannot bind", self.interface)

2413

else:

2414

raise

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

2415

2688

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

2416

2689

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2417

2692

if not self.server_address[0]:

2418

2693

if self.address_family == socket.AF_INET6:

2419

any_address = "::" # in6addr_any

2694

any_address = "::" # in6addr_any

2420

2695

else:

2421

any_address = "0.0.0.0" # INADDR_ANY

2696

any_address = "0.0.0.0" # INADDR_ANY

2422

2697

self.server_address = (any_address,

2423

2698

self.server_address[1])

2424

2699

elif not self.server_address[1]:

2434

2709

2435

2710

class MandosServer(IPv6_TCPServer):

2436

2711

"""Mandos server.

2437

2712

2438

2713

Attributes:

2439

2714

clients: set of Client objects

2440

2715

gnutls_priority GnuTLS priority string

2441

2716

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

2442

2443

Assumes a gobject.MainLoop event loop.

2717

2718

Assumes a GLib.MainLoop event loop.

2444

2719

"""

2445

2720

2446

2721

def __init__(self, server_address, RequestHandlerClass,

2447

2722

interface=None,

2448

2723

use_ipv6=True,

2458

2733

self.gnutls_priority = gnutls_priority

2459

2734

IPv6_TCPServer.__init__(self, server_address,

2460

2735

RequestHandlerClass,

2461

interface = interface,

2462

use_ipv6 = use_ipv6,

2463

socketfd = socketfd)

2464

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2465

2740

def server_activate(self):

2466

2741

if self.enabled:

2467

2742

return socketserver.TCPServer.server_activate(self)

2468

2743

2469

2744

def enable(self):

2470

2745

self.enabled = True

2471

2746

2472

2747

def add_pipe(self, parent_pipe, proc):

2473

2748

# Call "handle_ipc" for both data and EOF events

2474

gobject.io_add_watch(

2475

parent_pipe.fileno(),

2476

gobject.IO_IN | gobject.IO_HUP,

2749

GLib.io_add_watch(

2750

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

2751

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

2477

2752

functools.partial(self.handle_ipc,

2478

parent_pipe = parent_pipe,

2479

proc = proc))

2480

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2481

2756

def handle_ipc(self, source, condition,

2482

2757

parent_pipe=None,

2483

proc = None,

2758

proc=None,

2484

2759

client_object=None):

2485

2760

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

2486

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

2761

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

2487

2762

# Wait for other process to exit

2488

2763

proc.join()

2489

2764

return False

2490

2765

2491

2766

# Read a request from the child

2492

2767

request = parent_pipe.recv()

2493

2768

command = request[0]

2494

2495

if command == 'init':

2496

fpr = request[1]

2497

address = request[2]

2498

2499

for c in self.clients.itervalues():

2500

if c.fingerprint == fpr:

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:

2501

2783

client = c

2502

2784

break

2503

2785

else:

2504

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

2505

"dress: %s", fpr, address)

2786

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

2787

" %s", key_id or fpr, address)

2506

2788

if self.use_dbus:

2507

2789

# Emit D-Bus signal

2508

mandos_dbus_service.ClientNotFound(fpr,

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2509

2791

address[0])

2510

2792

parent_pipe.send(False)

2511

2793

return False

2512

2513

gobject.io_add_watch(

2514

parent_pipe.fileno(),

2515

gobject.IO_IN | gobject.IO_HUP,

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2516

2798

functools.partial(self.handle_ipc,

2517

parent_pipe = parent_pipe,

2518

proc = proc,

2519

client_object = client))

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2520

2802

parent_pipe.send(True)

2521

2803

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

2522

2804

# same fileno

2523

2805

return False

2524

if command == 'funcall':

2806

if command == "funcall":

2525

2807

funcname = request[1]

2526

2808

args = request[2]

2527

2809

kwargs = request[3]

2528

2529

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

2810

2811

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

2530

2812

funcname)(*args,

2531

2813

**kwargs)))

2532

2533

if command == 'getattr':

2814

2815

if command == "getattr":

2534

2816

attrname = request[1]

2535

2817

if isinstance(client_object.__getattribute__(attrname),

2536

collections.Callable):

2537

parent_pipe.send(('function', ))

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2538

2820

else:

2539

2821

parent_pipe.send((

2540

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

2541

2542

if command == 'setattr':

2822

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

2823

2824

if command == "setattr":

2543

2825

attrname = request[1]

2544

2826

value = request[2]

2545

2827

setattr(client_object, attrname, value)

2546

2828

2547

2829

return True

2548

2830

2549

2831

2550

2832

def rfc3339_duration_to_delta(duration):

2551

2833

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

2552

2553

>>> rfc3339_duration_to_delta("P7D")

2554

datetime.timedelta(7)

2555

>>> rfc3339_duration_to_delta("PT60S")

2556

datetime.timedelta(0, 60)

2557

>>> rfc3339_duration_to_delta("PT60M")

2558

datetime.timedelta(0, 3600)

2559

>>> rfc3339_duration_to_delta("PT24H")

2560

datetime.timedelta(1)

2561

>>> rfc3339_duration_to_delta("P1W")

2562

datetime.timedelta(7)

2563

>>> rfc3339_duration_to_delta("PT5M30S")

2564

datetime.timedelta(0, 330)

2565

>>> rfc3339_duration_to_delta("P1DT3M20S")

2566

datetime.timedelta(1, 200)

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

2567

2851

"""

2568

2852

2569

2853

# Parsing an RFC 3339 duration with regular expressions is not

2570

2854

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

2571

2855

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

2572

2856

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

2573

2857

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

2574

2858

# avoid excessive use of external libraries.

2575

2859

2576

2860

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

2577

2861

Token = collections.namedtuple("Token", (

2578

2862

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

2611

2895

frozenset((token_year, token_month,

2612

2896

token_day, token_time,

2613

2897

token_week)))

2614

# Define starting values

2615

value = datetime.timedelta() # Value so far

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2616

2901

found_token = None

2617

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

2618

s = duration # String left to parse

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2619

2906

# Loop until end token is found

2620

2907

while found_token is not token_end:

2621

2908

# Search for any currently valid tokens

2645

2932

2646

2933

def string_to_delta(interval):

2647

2934

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

2648

2649

>>> string_to_delta('7d')

2650

datetime.timedelta(7)

2651

>>> string_to_delta('60s')

2652

datetime.timedelta(0, 60)

2653

>>> string_to_delta('60m')

2654

datetime.timedelta(0, 3600)

2655

>>> string_to_delta('24h')

2656

datetime.timedelta(1)

2657

>>> string_to_delta('1w')

2658

datetime.timedelta(7)

2659

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

2660

datetime.timedelta(0, 330)

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

2661

2948

"""

2662

2949

2663

2950

try:

2664

2951

return rfc3339_duration_to_delta(interval)

2665

2952

except ValueError:

2666

2953

pass

2667

2954

2668

2955

timevalue = datetime.timedelta(0)

2669

2956

for s in interval.split():

2670

2957

try:

2688

2975

return timevalue

2689

2976

2690

2977

2691

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

2978

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

2692

2979

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

2693

2980

2694

2981

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

2695

2982

if os.fork():

2696

2983

sys.exit()

2714

3001

2715

3002

2716

3003

def main():

2717

3004

2718

3005

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

2719

3006

# Parsing of options, both command line and config file

2720

3007

2721

3008

parser = argparse.ArgumentParser()

2722

3009

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

2723

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

3010

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

2724

3011

help="show version number and exit")

2725

3012

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

2726

3013

help="Bind to interface IF")

2762

3049

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

2763

3050

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

2764

3051

default=None)

2765

3052

2766

3053

options = parser.parse_args()

2767

2768

if options.check:

2769

import doctest

2770

fail_count, test_count = doctest.testmod()

2771

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

2772

3054

2773

3055

# Default values for config file for server-global settings

2774

server_defaults = { "interface": "",

2775

"address": "",

2776

"port": "",

2777

"debug": "False",

2778

"priority":

2779

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

2780

":+SIGN-DSA-SHA256",

2781

"servicename": "Mandos",

2782

"use_dbus": "True",

2783

"use_ipv6": "True",

2784

"debuglevel": "",

2785

"restore": "True",

2786

"socket": "",

2787

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

2788

"foreground": "False",

2789

"zeroconf": "True",

2790

}

2791

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

2792

3079

# Parse config file for server-global settings

2793

server_config = configparser.SafeConfigParser(server_defaults)

3080

server_config = configparser.ConfigParser(server_defaults)

2794

3081

del server_defaults

2795

3082

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

2796

# Convert the SafeConfigParser object to a dict

3083

# Convert the ConfigParser object to a dict

2797

3084

server_settings = server_config.defaults()

2798

3085

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

2799

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

3086

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

3087

"foreground", "zeroconf"):

2800

3088

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

2801

3089

option)

2802

3090

if server_settings["port"]:

2812

3100

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

2813

3101

["socket"])

2814

3102

del server_config

2815

3103

2816

3104

# Override the settings from the config file with command line

2817

3105

# options, if set.

2818

3106

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

2836

3124

if server_settings["debug"]:

2837

3125

server_settings["foreground"] = True

2838

3126

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

2839

3127

2840

3128

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

2841

3129

2842

3130

if (not server_settings["zeroconf"]

2843

3131

and not (server_settings["port"]

2844

3132

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

2845

3133

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

2846

3134

2847

3135

# For convenience

2848

3136

debug = server_settings["debug"]

2849

3137

debuglevel = server_settings["debuglevel"]

2853

3141

stored_state_file)

2854

3142

foreground = server_settings["foreground"]

2855

3143

zeroconf = server_settings["zeroconf"]

2856

3144

2857

3145

if debug:

2858

3146

initlogger(debug, logging.DEBUG)

2859

3147

else:

2862

3150

else:

2863

3151

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

2864

3152

initlogger(debug, level)

2865

3153

2866

3154

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

2867

3155

syslogger.setFormatter(

2868

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

2869

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

3156

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

3157

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

2870

3158

server_settings["servicename"])))

2871

3159

2872

3160

# Parse config file with clients

2873

client_config = configparser.SafeConfigParser(Client

2874

.client_defaults)

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2875

3162

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

2876

3163

"clients.conf"))

2877

3164

2878

3165

global mandos_dbus_service

2879

3166

mandos_dbus_service = None

2880

3167

2881

3168

socketfd = None

2882

3169

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

2883

3170

socketfd = server_settings["socket"]

2897

3184

try:

2898

3185

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

2899

3186

except IOError as e:

2900

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

2901

exc_info=e)

2902

2903

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

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

2904

3193

try:

2905

3194

uid = pwd.getpwnam(name).pw_uid

2906

gid = pwd.getpwnam(name).pw_gid

3195

gid = pwd.getpwnam(group).pw_gid

2907

3196

break

2908

3197

except KeyError:

2909

3198

continue

2913

3202

try:

2914

3203

os.setgid(gid)

2915

3204

os.setuid(uid)

3205

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

2916

3206

except OSError as error:

3207

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

3208

os.strerror(error.errno))

2917

3209

if error.errno != errno.EPERM:

2918

3210

raise

2919

3211

2920

3212

if debug:

2921

3213

# Enable all possible GnuTLS debugging

2922

3214

2923

3215

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

2924

3216

# - GnuTLS manual

2925

3217

gnutls.global_set_log_level(11)

2926

3218

2927

3219

@gnutls.log_func

2928

3220

def debug_gnutls(level, string):

2929

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

2930

3221

log.debug("GnuTLS: %s",

3222

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

3223

2931

3224

gnutls.global_set_log_function(debug_gnutls)

2932

3225

2933

3226

# Redirect stdin so all checkers get /dev/null

2934

3227

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

2935

3228

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

2936

3229

if null > 2:

2937

3230

os.close(null)

2938

3231

2939

3232

# Need to fork before connecting to D-Bus

2940

3233

if not foreground:

2941

3234

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

2942

3235

daemon()

2943

2944

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

2945

# need to inform gobject that threads will be used.

2946

gobject.threads_init()

2947

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

2948

3242

global main_loop

2949

3243

# From the Avahi example code

2950

3244

DBusGMainLoop(set_as_default=True)

2951

main_loop = gobject.MainLoop()

2952

bus = dbus.SystemBus()

3245

main_loop = GLib.MainLoop()

3246

if use_dbus or zeroconf:

3247

bus = dbus.SystemBus()

2953

3248

# End of Avahi example code

2954

3249

if use_dbus:

2955

3250

try:

2960

3255

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

2961

3256

do_not_queue=True)

2962

3257

except dbus.exceptions.DBusException as e:

2963

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

3258

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

2964

3259

use_dbus = False

2965

3260

server_settings["use_dbus"] = False

2966

3261

tcp_server.use_dbus = False

2967

3262

if zeroconf:

2968

3263

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2969

3264

service = AvahiServiceToSyslog(

2970

name = server_settings["servicename"],

2971

servicetype = "_mandos._tcp",

2972

protocol = protocol,

2973

bus = bus)

3265

name=server_settings["servicename"],

3266

servicetype="_mandos._tcp",

3267

protocol=protocol,

3268

bus=bus)

2974

3269

if server_settings["interface"]:

2975

3270

service.interface = if_nametoindex(

2976

3271

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

2977

3272

2978

3273

global multiprocessing_manager

2979

3274

multiprocessing_manager = multiprocessing.Manager()

2980

3275

2981

3276

client_class = Client

2982

3277

if use_dbus:

2983

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

2984

3278

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

3279

2985

3280

client_settings = Client.config_parser(client_config)

2986

3281

old_client_settings = {}

2987

3282

clients_data = {}

2988

3283

2989

3284

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

2990

3285

global wnull

2991

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

3286

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

2992

3287

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

2993

3288

# mode

2994

3289

if debug or not foreground:

2995

3290

wnull.close()

2996

3291

2997

3292

# Get client data and settings from last running state.

2998

3293

if server_settings["restore"]:

2999

3294

try:

3000

3295

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

3001

clients_data, old_client_settings = pickle.load(

3002

stored_state)

3296

if sys.version_info.major == 2:

3297

clients_data, old_client_settings = pickle.load(

3298

stored_state)

3299

else:

3300

bytes_clients_data, bytes_old_client_settings = (

3301

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

3302

# Fix bytes to strings

3303

# clients_data

3304

# .keys()

3305

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

3306

if isinstance(key, bytes)

3307

else key): value

3308

for key, value in

3309

bytes_clients_data.items()}

3310

del bytes_clients_data

3311

for key in clients_data:

3312

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

3313

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

3314

for k, v in

3315

clients_data[key].items()}

3316

clients_data[key] = value

3317

# .client_structure

3318

value["client_structure"] = [

3319

(s.decode("utf-8")

3320

if isinstance(s, bytes)

3321

else s) for s in

3322

value["client_structure"]]

3323

# .name, .host, and .checker_command

3324

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

3325

if isinstance(value[k], bytes):

3326

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

3327

if "key_id" not in value:

3328

value["key_id"] = ""

3329

elif "fingerprint" not in value:

3330

value["fingerprint"] = ""

3331

# old_client_settings

3332

# .keys()

3333

old_client_settings = {

3334

(key.decode("utf-8")

3335

if isinstance(key, bytes)

3336

else key): value

3337

for key, value in

3338

bytes_old_client_settings.items()}

3339

del bytes_old_client_settings

3340

# .host and .checker_command

3341

for value in old_client_settings.values():

3342

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

3343

if isinstance(value[attribute], bytes):

3344

value[attribute] = (value[attribute]

3345

.decode("utf-8"))

3003

3346

os.remove(stored_state_path)

3004

3347

except IOError as e:

3005

3348

if e.errno == errno.ENOENT:

3006

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

3007

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

3349

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

3350

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

3008

3351

else:

3009

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

3010

exc_info=e)

3352

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

3353

exc_info=e)

3011

3354

raise

3012

3355

except EOFError as e:

3013

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

3014

"EOFError:",

3015

exc_info=e)

3016

3356

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

3357

exc_info=e)

3358

3017

3359

with PGPEngine() as pgp:

3018

3360

for client_name, client in clients_data.items():

3019

3361

# Skip removed clients

3020

3362

if client_name not in client_settings:

3021

3363

continue

3022

3364

3023

3365

# Decide which value to use after restoring saved state.

3024

3366

# We have three different values: Old config file,

3025

3367

# new config file, and saved state.

3036

3378

client[name] = value

3037

3379

except KeyError:

3038

3380

pass

3039

3381

3040

3382

# Clients who has passed its expire date can still be

3041

3383

# enabled if its last checker was successful. A Client

3042

3384

# whose checker succeeded before we stored its state is

3045

3387

if client["enabled"]:

3046

3388

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

3047

3389

if not client["last_checked_ok"]:

3048

logger.warning(

3049

"disabling client {} - Client never "

3050

"performed a successful checker".format(

3051

client_name))

3390

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

3391

" never performed a successful"

3392

" checker", client_name)

3052

3393

client["enabled"] = False

3053

3394

elif client["last_checker_status"] != 0:

3054

logger.warning(

3055

"disabling client {} - Client last"

3056

" checker failed with error code"

3057

" {}".format(

3058

client_name,

3059

client["last_checker_status"]))

3395

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

3396

" last checker failed with error"

3397

" code %s", client_name,

3398

client["last_checker_status"])

3060

3399

client["enabled"] = False

3061

3400

else:

3062

3401

client["expires"] = (

3063

3402

datetime.datetime.utcnow()

3064

3403

+ client["timeout"])

3065

logger.debug("Last checker succeeded,"

3066

" keeping {} enabled".format(

3067

client_name))

3404

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

3405

" enabled", client_name)

3068

3406

try:

3069

3407

client["secret"] = pgp.decrypt(

3070

3408

client["encrypted_secret"],

3071

3409

client_settings[client_name]["secret"])

3072

3410

except PGPError:

3073

3411

# If decryption fails, we use secret from new settings

3074

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

3075

client_name))

3412

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

3413

client_name)

3076

3414

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

3077

3415

["secret"])

3078

3416

3079

3417

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

3080

3418

for client_name in (set(old_client_settings)

3081

3419

- set(client_settings)):

3083

3421

for client_name in (set(client_settings)

3084

3422

- set(old_client_settings)):

3085

3423

clients_data[client_name] = client_settings[client_name]

3086

3424

3087

3425

# Create all client objects

3088

3426

for client_name, client in clients_data.items():

3089

3427

tcp_server.clients[client_name] = client_class(

3090

name = client_name,

3091

settings = client,

3092

server_settings = server_settings)

3093

3428

name=client_name,

3429

settings=client,

3430

server_settings=server_settings)

3431

3094

3432

if not tcp_server.clients:

3095

logger.warning("No clients defined")

3096

3433

log.warning("No clients defined")

3434

3097

3435

if not foreground:

3098

3436

if pidfile is not None:

3099

3437

pid = os.getpid()

3101

3439

with pidfile:

3102

3440

print(pid, file=pidfile)

3103

3441

except IOError:

3104

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

3105

pidfilename, pid)

3442

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

3443

pidfilename, pid)

3106

3444

del pidfile

3107

3445

del pidfilename

3108

3109

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

3110

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

3111

3446

3447

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

3448

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3449

lambda: main_loop.quit() and False)

3450

3112

3451

if use_dbus:

3113

3452

3114

3453

@alternate_dbus_interfaces(

3115

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

3454

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

3116

3455

class MandosDBusService(DBusObjectWithObjectManager):

3117

3456

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

3118

3457

3119

3458

def __init__(self):

3120

3459

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

3121

3460

3122

3461

_interface = "se.recompile.Mandos"

3123

3462

3124

3463

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

3125

3464

def ClientAdded(self, objpath):

3126

3465

"D-Bus signal"

3127

3466

pass

3128

3467

3129

3468

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

3130

def ClientNotFound(self, fingerprint, address):

3469

def ClientNotFound(self, key_id, address):

3131

3470

"D-Bus signal"

3132

3471

pass

3133

3472

3134

3473

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

3135

3474

"true"})

3136

3475

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

3137

3476

def ClientRemoved(self, objpath, name):

3138

3477

"D-Bus signal"

3139

3478

pass

3140

3479

3141

3480

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

3142

3481

"true"})

3143

3482

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

3144

3483

def GetAllClients(self):

3145

3484

"D-Bus method"

3146

3485

return dbus.Array(c.dbus_object_path for c in

3147

tcp_server.clients.itervalues())

3148

3486

tcp_server.clients.values())

3487

3149

3488

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

3150

3489

"true"})

3151

3490

@dbus.service.method(_interface,

3153

3492

def GetAllClientsWithProperties(self):

3154

3493

"D-Bus method"

3155

3494

return dbus.Dictionary(

3156

{ c.dbus_object_path: c.GetAll(

3495

{c.dbus_object_path: c.GetAll(

3157

3496

"se.recompile.Mandos.Client")

3158

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

3497

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

3159

3498

signature="oa{sv}")

3160

3499

3161

3500

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

3162

3501

def RemoveClient(self, object_path):

3163

3502

"D-Bus method"

3164

for c in tcp_server.clients.itervalues():

3503

for c in tcp_server.clients.values():

3165

3504

if c.dbus_object_path == object_path:

3166

3505

del tcp_server.clients[c.name]

3167

3506

c.remove_from_connection()

3171

3510

self.client_removed_signal(c)

3172

3511

return

3173

3512

raise KeyError(object_path)

3174

3513

3175

3514

del _interface

3176

3515

3177

3516

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3178

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

3517

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

3179

3518

def GetManagedObjects(self):

3180

3519

"""D-Bus method"""

3181

3520

return dbus.Dictionary(

3182

{ client.dbus_object_path:

3183

dbus.Dictionary(

3184

{ interface: client.GetAll(interface)

3185

for interface in

3186

client._get_all_interface_names()})

3187

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

3188

3521

{client.dbus_object_path:

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()})

3526

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

3527

3189

3528

def client_added_signal(self, client):

3190

3529

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

3191

3530

if use_dbus:

3193

3532

self.InterfacesAdded(

3194

3533

client.dbus_object_path,

3195

3534

dbus.Dictionary(

3196

{ interface: client.GetAll(interface)

3197

for interface in

3198

client._get_all_interface_names()}))

3535

{interface: client.GetAll(interface)

3536

for interface in

3537

client._get_all_interface_names()}))

3199

3538

# Old signal

3200

3539

self.ClientAdded(client.dbus_object_path)

3201

3540

3202

3541

def client_removed_signal(self, client):

3203

3542

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

3204

3543

if use_dbus:

3209

3548

# Old signal

3210

3549

self.ClientRemoved(client.dbus_object_path,

3211

3550

client.name)

3212

3551

3213

3552

mandos_dbus_service = MandosDBusService()

3214

3553

3554

# Save modules to variables to exempt the modules from being

3555

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

3556

mp = multiprocessing

3557

wn = wnull

3558

3215

3559

def cleanup():

3216

3560

"Cleanup function; run on exit"

3217

3561

if zeroconf:

3218

3562

service.cleanup()

3219

3220

multiprocessing.active_children()

3221

wnull.close()

3563

3564

mp.active_children()

3565

wn.close()

3222

3566

if not (tcp_server.clients or client_settings):

3223

3567

return

3224

3568

3225

3569

# Store client before exiting. Secrets are encrypted with key

3226

3570

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

3227

3571

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

3228

3572

clients = {}

3229

3573

with PGPEngine() as pgp:

3230

for client in tcp_server.clients.itervalues():

3574

for client in tcp_server.clients.values():

3231

3575

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

3232

3576

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

3233

3577

key)

3234

3578

client_dict = {}

3235

3579

3236

3580

# A list of attributes that can not be pickled

3237

3581

# + secret.

3238

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

3239

"checker", "server_settings" }

3582

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

3583

"checker", "server_settings"}

3240

3584

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

3241

3585

.Object):

3242

3586

exclude.add(name)

3243

3587

3244

3588

client_dict["encrypted_secret"] = (client

3245

3589

.encrypted_secret)

3246

3590

for attr in client.client_structure:

3247

3591

if attr not in exclude:

3248

3592

client_dict[attr] = getattr(client, attr)

3249

3593

3250

3594

clients[client.name] = client_dict

3251

3595

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

3252

3596

3253

3597

try:

3254

3598

with tempfile.NamedTemporaryFile(

3255

mode='wb',

3599

mode="wb",

3256

3600

suffix=".pickle",

3257

prefix='clients-',

3601

prefix="clients-",

3258

3602

dir=os.path.dirname(stored_state_path),

3259

3603

delete=False) as stored_state:

3260

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

3604

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

3605

protocol=2)

3261

3606

tempname = stored_state.name

3262

3607

os.rename(tempname, stored_state_path)

3263

3608

except (IOError, OSError) as e:

3267

3612

except NameError:

3268

3613

pass

3269

3614

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

3270

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

3271

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

3615

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

3616

os.strerror(e.errno))

3272

3617

else:

3273

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

3274

exc_info=e)

3618

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

3619

exc_info=e)

3275

3620

raise

3276

3621

3277

3622

# Delete all clients, and settings from config

3278

3623

while tcp_server.clients:

3279

3624

name, client = tcp_server.clients.popitem()

3285

3630

if use_dbus:

3286

3631

mandos_dbus_service.client_removed_signal(client)

3287

3632

client_settings.clear()

3288

3633

3289

3634

atexit.register(cleanup)

3290

3291

for client in tcp_server.clients.itervalues():

3635

3636

for client in tcp_server.clients.values():

3292

3637

if use_dbus:

3293

3638

# Emit D-Bus signal for adding

3294

3639

mandos_dbus_service.client_added_signal(client)

3295

3640

# Need to initiate checking of clients

3296

3641

if client.enabled:

3297

client.init_checker()

3298

3642

client.init_checker(randomize_start=True)

3643

3299

3644

tcp_server.enable()

3300

3645

tcp_server.server_activate()

3301

3646

3302

3647

# Find out what port we got

3303

3648

if zeroconf:

3304

3649

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

3305

3650

if use_ipv6:

3306

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

3307

" flowinfo %d, scope_id %d",

3308

*tcp_server.socket.getsockname())

3651

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

3652

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

3309

3653

else: # IPv4

3310

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

3311

*tcp_server.socket.getsockname())

3312

3313

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

3314

3654

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

3655

*tcp_server.socket.getsockname())

3656

3657

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

3658

3315

3659

try:

3316

3660

if zeroconf:

3317

3661

# From the Avahi example code

3318

3662

try:

3319

3663

service.activate()

3320

3664

except dbus.exceptions.DBusException as error:

3321

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

3665

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

3322

3666

cleanup()

3323

3667

sys.exit(1)

3324

3668

# End of Avahi example code

3325

3326

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

3327

lambda *args, **kwargs:

3328

(tcp_server.handle_request

3329

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

3330

3331

logger.debug("Starting main loop")

3669

3670

GLib.io_add_watch(

3671

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

3672

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3673

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

3674

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

3675

3676

log.debug("Starting main loop")

3332

3677

main_loop.run()

3333

3678

except AvahiError as error:

3334

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

3679

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

3335

3680

cleanup()

3336

3681

sys.exit(1)

3337

3682

except KeyboardInterrupt:

3338

3683

if debug:

3339

3684

print("", file=sys.stderr)

3340

logger.debug("Server received KeyboardInterrupt")

3341

logger.debug("Server exiting")

3685

log.debug("Server received KeyboardInterrupt")

3686

log.debug("Server exiting")

3342

3687

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

3343

3688

cleanup()

3344

3689

3345

3346

if __name__ == '__main__':

3347

main()

3690

3691

def parse_test_args():

3692

# type: () -> argparse.Namespace

3693

parser = argparse.ArgumentParser(add_help=False)

3694

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

3695

parser.add_argument("--prefix", )

3696

args, unknown_args = parser.parse_known_args()

3697

if args.check:

3698

# Remove test options from sys.argv

3699

sys.argv[1:] = unknown_args

3700

return args

3701

3702

# Add all tests from doctest strings

3703

def load_tests(loader, tests, none):

3704

import doctest

3705

tests.addTests(doctest.DocTestSuite())

3706

return tests

3707

3708

if __name__ == "__main__":

3709

options = parse_test_args()

3710

try:

3711

if options.check:

3712

extra_test_prefix = options.prefix

3713

if extra_test_prefix is not None:

3714

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

3715

.result.wasSuccessful()):

3716

sys.exit(1)

3717

class ExtraTestLoader(unittest.TestLoader):

3718

testMethodPrefix = extra_test_prefix

3719

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

3720

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

3721

else:

3722

unittest.main(argv=[""])

3723

else:

3724

main()

3725

finally:

3726

logging.shutdown()

3727

3728

# Local Variables:

3729

# run-tests:

3730

# (lambda (&optional extra)

3731

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

3732

# extra))

3733

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

3734

# (funcall remove-test-window)

3735

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

3736

# run-tests-in-test-buffer:

3737

# (lambda (dir &optional extra)

3738

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

3739

# (setq buffer-read-only nil

3740

# default-directory dir)

3741

# (erase-buffer)

3742

# (compilation-mode))

3743

# (let ((process-result

3744

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

3745

# (process-file-shell-command

3746

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

3747

# (and (numberp process-result)

3748

# (= process-result 0))))

3749

# get-command-line:

3750

# (lambda (&optional extra)

3751

# (let ((quoted-script

3752

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

3753

# (format

3754

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

3755

# quoted-script)))

3756

# get-script-name:

3757

# (lambda ()

3758

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

3759

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

3760

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

3761

# (buffer-file-name))))

3762

# remove-test-window:

3763

# (lambda ()

3764

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

3765

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

3766

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

3767

# (lambda ()

3768

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

3769

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

3770

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

3771

# (display-buffer-overriding-action

3772

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

3773

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

3774

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

3775

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

3776

# eval:

3777

# (progn

3778

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

3779

# (funcall run-tests t)))

3780

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

3781

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

3782

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

3783

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

3784

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

3785

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

3786

# End: