/mandos/release : revision 237.7.249

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.5"

147

92

stored_state_file = "clients.pickle"

148

93

149

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

150

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

94

logger = logging.getLogger()

151

95

syslogger = None

152

96

153

97

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

156

101

except (OSError, AttributeError):

157

158

102

def if_nametoindex(interface):

159

103

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

160

104

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

161

105

with contextlib.closing(socket.socket()) as s:

162

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

struct.pack(b"16s16x", interface))

164

interface_index = struct.unpack("I", ifreq[16:20])[0]

107

struct.pack(str("16s16x"),

108

interface))

109

interface_index = struct.unpack(str("I"),

110

ifreq[16:20])[0]

165

111

return interface_index

166

112

167

113

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

114

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

185

115

"""init logger and add loglevel"""

186

116

187

117

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

address = str("/dev/log")))

191

122

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

123

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

124

' %(message)s'))

125

logger.addHandler(syslogger)

126

196

127

if debug:

197

128

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

129

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

130

' [%(process)d]:'

131

' %(levelname)s:'

132

' %(message)s'))

133

logger.addHandler(console)

134

logger.setLevel(level)

204

135

205

136

206

137

class PGPError(Exception):

208

139

pass

209

140

210

141

211

class PGPEngine:

142

class PGPEngine(object):

212

143

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

213

214

144

def __init__(self):

215

145

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

265

182

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

266

183

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

267

184

return encoded

268

185

269

186

def encrypt(self, data, password):

270

187

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

273

190

passfile.write(passphrase)

274

191

passfile.flush()

275

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

276

"--passphrase-file",

192

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

193

'--passphrase-file',

277

194

passfile.name]

278

195

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

283

200

if proc.returncode != 0:

284

201

raise PGPError(err)

285

202

return ciphertext

286

203

287

204

def decrypt(self, data, password):

288

205

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

291

208

passfile.write(passphrase)

292

209

passfile.flush()

293

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

294

"--passphrase-file",

210

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

211

'--passphrase-file',

295

212

passfile.name]

296

213

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

301

219

if proc.returncode != 0:

302

220

raise PGPError(err)

303

221

return decrypted_plaintext

304

222

305

223

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

224

class AvahiError(Exception):

333

225

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

334

226

self.value = value

335

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

336

**kwargs)

337

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

338

230

339

231

class AvahiServiceError(AvahiError):

340

232

pass

341

233

342

343

234

class AvahiGroupError(AvahiError):

344

235

pass

345

236

346

237

347

class AvahiService:

238

class AvahiService(object):

348

239

"""An Avahi (Zeroconf) service.

349

240

350

241

Attributes:

351

242

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

352

243

Used to optionally bind to the specified interface.

353

354

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

244

245

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

355

246

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

356

247

port: integer; what port to announce

357

248

TXT: list of strings; TXT record for the service

364

255

server: D-Bus Server

365

256

bus: dbus.SystemBus()

366

257

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

379

263

self.interface = interface

380

264

self.name = name

381

265

self.type = servicetype

390

274

self.server = None

391

275

self.bus = bus

392

276

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

277

278

def rename(self):

395

279

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

396

280

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

281

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

282

" after %i retries, exiting.",

283

self.rename_count)

400

284

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

287

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

288

self.name)

289

self.remove()

290

try:

291

self.add()

292

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

403

296

self.rename_count += 1

404

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

405

self.name)

406

if remove:

407

self.remove()

408

try:

409

self.add()

410

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

297

420

298

def remove(self):

421

299

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

422

300

if self.entry_group_state_changed_match is not None:

424

302

self.entry_group_state_changed_match = None

425

303

if self.group is not None:

426

304

self.group.Reset()

427

305

428

306

def add(self):

429

307

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

430

308

self.remove()

435

313

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

314

self.entry_group_state_changed_match = (

437

315

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

316

'StateChanged', self.entry_group_state_changed))

317

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

318

self.name, self.type)

441

319

self.group.AddService(

442

320

self.interface,

443

321

self.protocol,

447

325

dbus.UInt16(self.port),

448

326

avahi.string_array_to_txt_array(self.TXT))

449

327

self.group.Commit()

450

328

451

329

def entry_group_state_changed(self, state, error):

452

330

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

453

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

454

331

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

332

455

333

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

334

logger.debug("Zeroconf service established.")

457

335

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

336

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

459

337

self.rename()

460

338

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

463

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

464

339

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

340

unicode(error))

341

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

342

.format(error))

343

465

344

def cleanup(self):

466

345

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

467

346

if self.group is not None:

472

351

pass

473

352

self.group = None

474

353

self.remove()

475

354

476

355

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

477

356

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

478

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

357

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

485

365

if state in bad_states:

486

366

if bad_states[state] is not None:

487

367

if error is None:

488

log.error(bad_states[state])

368

logger.error(bad_states[state])

489

369

else:

490

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

370

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

491

371

self.cleanup()

492

372

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

373

self.add()

504

374

else:

505

375

if error is None:

506

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

376

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

507

377

else:

508

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

509

378

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

379

510

380

def activate(self):

511

381

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

512

382

if self.server is None:

516

386

follow_name_owner_changes=True),

517

387

avahi.DBUS_INTERFACE_SERVER)

518

388

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

389

self.server_state_changed)

520

390

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

521

391

522

392

523

393

class AvahiServiceToSyslog(AvahiService):

524

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

394

def rename(self):

525

395

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

526

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

527

**kwargs)

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

531

401

return ret

532

402

533

403

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

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

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

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

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

return ((td.days * 24 * 60 * 60 * 1000)

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

class Client(object):

875

412

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

876

413

877

414

Attributes:

878

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

415

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

879

416

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

880

417

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

885

422

checker_command: string; External command which is run to check

886

423

if client lives. %() expansions are done at

887

424

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

888

425

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

889

checker_initiator_tag: a GLib event source tag, or None

426

checker_initiator_tag: a gobject event source tag, or None

890

427

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

891

428

client_structure: Object describing what attributes a client has

892

429

and is used for storing the client at exit

893

430

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

431

disable_initiator_tag: a gobject event source tag, or None

895

432

enabled: bool()

896

433

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

434

uniquely identify the client

900

435

host: string; available for use by the checker command

901

436

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

902

437

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

904

439

last_checker_status: integer between 0 and 255 reflecting exit

905

440

status of last checker. -1 reflects crashed

906

441

checker, -2 means no checker completed yet.

907

last_checker_signal: The signal which killed the last checker, if

908

last_checker_status is -1

909

442

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

910

443

911

444

D-Bus identifiers

918

451

disabled, or None

919

452

server_settings: The server_settings dict from main()

920

453

"""

921

454

922

455

runtime_expansions = ("approval_delay", "approval_duration",

923

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

456

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

924

457

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

925

458

"last_approval_request", "last_checked_ok",

926

459

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

927

client_defaults = {

928

"timeout": "PT5M",

929

"extended_timeout": "PT15M",

930

"interval": "PT2M",

931

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

932

"host": "",

933

"approval_delay": "PT0S",

934

"approval_duration": "PT1S",

935

"approved_by_default": "True",

936

"enabled": "True",

937

}

938

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

939

486

@staticmethod

940

487

def config_parser(config):

941

488

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

948

495

for client_name in config.sections():

949

496

section = dict(config.items(client_name))

950

497

client = settings[client_name] = {}

951

498

952

499

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

953

500

# Reformat values from string types to Python types

954

501

client["approved_by_default"] = config.getboolean(

955

502

client_name, "approved_by_default")

956

503

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

957

504

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

964

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

965

"").upper()

505

506

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

966

507

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

972

508

if "secret" in section:

973

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

974

.encode("utf-8"),

975

"base64")

509

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

976

510

elif "secfile" in section:

977

511

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

978

512

(section["secfile"])),

979

513

"rb") as secfile:

980

514

client["secret"] = secfile.read()

981

515

else:

982

raise TypeError("No secret or secfile for section {}"

516

raise TypeError("No secret or secfile for section {0}"

983

517

.format(section))

984

518

client["timeout"] = string_to_delta(section["timeout"])

985

519

client["extended_timeout"] = string_to_delta(

993

527

client["last_approval_request"] = None

994

528

client["last_checked_ok"] = None

995

529

client["last_checker_status"] = -2

996

530

997

531

return settings

998

999

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

532

533

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

1000

534

self.name = name

1001

535

if server_settings is None:

1002

536

server_settings = {}

1003

537

self.server_settings = server_settings

1004

538

# adding all client settings

1005

for setting, value in settings.items():

539

for setting, value in settings.iteritems():

1006

540

setattr(self, setting, value)

1007

541

1008

542

if self.enabled:

1009

543

if not hasattr(self, "last_enabled"):

1010

544

self.last_enabled = datetime.datetime.utcnow()

1014

548

else:

1015

549

self.last_enabled = None

1016

550

self.expires = None

1017

1018

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

1019

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

1020

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

551

552

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

556

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

1021

557

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

1022

558

datetime.datetime.utcnow())

1023

559

1024

560

# attributes specific for this server instance

1025

561

self.checker = None

1026

562

self.checker_initiator_tag = None

1029

565

self.current_checker_command = None

1030

566

self.approved = None

1031

567

self.approvals_pending = 0

1032

self.changedstate = multiprocessing_manager.Condition(

1033

multiprocessing_manager.Lock())

1034

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

1036

573

if not attr.startswith("_")]

1037

574

self.client_structure.append("client_structure")

1038

1039

for name, t in inspect.getmembers(

1040

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

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

1041

580

if not name.startswith("_"):

1042

581

self.client_structure.append(name)

1043

582

1044

583

# Send notice to process children that client state has changed

1045

584

def send_changedstate(self):

1046

585

with self.changedstate:

1047

586

self.changedstate.notify_all()

1048

587

1049

588

def enable(self):

1050

589

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

1051

590

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

1052

591

# Already enabled

1053

592

return

593

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

1054

594

self.enabled = True

1055

595

self.last_enabled = datetime.datetime.utcnow()

1056

596

self.init_checker()

1057

597

self.send_changedstate()

1058

598

1059

599

def disable(self, quiet=True):

1060

600

"""Disable this client."""

1061

601

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

1062

602

return False

1063

603

if not quiet:

1064

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

604

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

1065

605

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

1066

GLib.source_remove(self.disable_initiator_tag)

606

gobject.source_remove(self.disable_initiator_tag)

1067

607

self.disable_initiator_tag = None

1068

608

self.expires = None

1069

609

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

1070

GLib.source_remove(self.checker_initiator_tag)

610

gobject.source_remove(self.checker_initiator_tag)

1071

611

self.checker_initiator_tag = None

1072

612

self.stop_checker()

1073

613

self.enabled = False

1074

614

if not quiet:

1075

615

self.send_changedstate()

1076

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

616

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

1077

617

return False

1078

618

1079

619

def __del__(self):

1080

620

self.disable()

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

621

622

def init_checker(self):

623

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

624

# and every interval from then on.

1087

625

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

630

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

1106

631

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

1112

def checker_callback(self, source, condition, connection,

1113

command):

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

636

# Also start a new checker *right now*.

637

self.start_checker()

638

639

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

1114

640

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

1115

# Read return code from connection (see call_pipe)

1116

returncode = connection.recv()

1117

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

641

self.checker_callback_tag = None

1121

642

self.checker = None

1122

1123

if returncode >= 0:

1124

self.last_checker_status = returncode

1125

self.last_checker_signal = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1126

645

if self.last_checker_status == 0:

1127

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

646

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

647

vars(self))

1128

648

self.checked_ok()

1129

649

else:

1130

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

650

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

651

vars(self))

1131

652

else:

1132

653

self.last_checker_status = -1

1133

self.last_checker_signal = -returncode

1134

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

1135

return False

1136

654

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

655

vars(self))

656

1137

657

def checked_ok(self):

1138

658

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

1139

659

self.last_checked_ok = datetime.datetime.utcnow()

1140

660

self.last_checker_status = 0

1141

self.last_checker_signal = None

1142

661

self.bump_timeout()

1143

662

1144

663

def bump_timeout(self, timeout=None):

1145

664

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

1146

665

if timeout is None:

1147

666

timeout = self.timeout

1148

667

if self.disable_initiator_tag is not None:

1149

GLib.source_remove(self.disable_initiator_tag)

668

gobject.source_remove(self.disable_initiator_tag)

1150

669

self.disable_initiator_tag = None

1151

670

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

1152

self.disable_initiator_tag = GLib.timeout_add(

1153

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1154

674

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

1155

675

1156

676

def need_approval(self):

1157

677

self.last_approval_request = datetime.datetime.utcnow()

1158

1159

def start_checker(self, start_was_randomized=False):

678

679

def start_checker(self):

1160

680

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

1161

681

1162

682

If a checker already exists, leave it running and do

1163

683

nothing."""

1164

684

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

1169

689

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

1170

690

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

1171

691

# should be.

1172

1173

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

1174

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

1175

self.checker.join()

1176

self.checker = None

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1177

707

# Start a new checker if needed

1178

708

if self.checker is None:

1179

709

# Escape attributes for the shell

1180

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1183

714

try:

1184

715

command = self.checker_command % escaped_attrs

1185

716

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

1188

return True # Try again later

717

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1189

720

self.current_checker_command = command

1190

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

1191

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

1192

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

1193

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

1194

# always replaced by /dev/null.)

1195

# The exception is when not debugging but nevertheless

1196

# running in the foreground; use the previously

1197

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

1201

if (not self.server_settings["debug"]

1202

and self.server_settings["foreground"]):

1203

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

1206

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

1210

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1214

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1226

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

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1227

763

return True

1228

764

1229

765

def stop_checker(self):

1230

766

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

1231

767

if self.checker_callback_tag:

1232

GLib.source_remove(self.checker_callback_tag)

768

gobject.source_remove(self.checker_callback_tag)

1233

769

self.checker_callback_tag = None

1234

770

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

1235

771

return

1236

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

1237

self.checker.terminate()

772

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1238

781

self.checker = None

1239

782

1240

783

1241

def dbus_service_property(dbus_interface,

1242

signature="v",

1243

access="readwrite",

1244

byte_arrays=False):

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1245

786

"""Decorators for marking methods of a DBusObjectWithProperties to

1246

787

become properties on the D-Bus.

1247

788

1248

789

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

1249

790

and with one argument by "Set".

1250

791

1251

792

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

1252

793

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

1253

794

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

1256

797

# "Set" method, so we fail early here:

1257

798

if byte_arrays and signature != "ay":

1258

799

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

1259

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

1260

800

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

1261

801

def decorator(func):

1262

802

func._dbus_is_property = True

1263

803

func._dbus_interface = dbus_interface

1266

806

func._dbus_name = func.__name__

1267

807

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

1268

808

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

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1270

810

return func

1271

1272

811

return decorator

1273

812

1274

813

1275

814

def dbus_interface_annotations(dbus_interface):

1276

815

"""Decorator for marking functions returning interface annotations

1277

816

1278

817

Usage:

1279

818

1280

819

@dbus_interface_annotations("org.example.Interface")

1281

820

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

1282

821

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

1283

822

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

1284

823

"false"}

1285

824

"""

1286

1287

825

def decorator(func):

1288

826

func._dbus_is_interface = True

1289

827

func._dbus_interface = dbus_interface

1290

828

func._dbus_name = dbus_interface

1291

829

return func

1292

1293

830

return decorator

1294

831

1295

832

1296

833

def dbus_annotations(annotations):

1297

834

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

1298

835

Usage:

1299

1300

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

1301

"org.freedesktop.DBus.Property."

1302

"EmitsChangedSignal": "false"})

836

1303

837

@dbus_service_property("org.example.Interface", signature="b",

1304

838

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

1305

842

def Property_dbus_property(self):

1306

843

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

1309

844

"""

1310

1311

845

def decorator(func):

1312

846

func._dbus_annotations = annotations

1313

847

return func

1314

1315

848

return decorator

1316

849

1317

850

1318

851

class DBusPropertyException(dbus.exceptions.DBusException):

1319

852

"""A base class for D-Bus property-related exceptions

1320

853

"""

1321

pass

854

def __unicode__(self):

855

return unicode(str(self))

1322

856

1323

857

1324

858

class DBusPropertyAccessException(DBusPropertyException):

1333

867

pass

1334

868

1335

869

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1337

"""A D-Bus object with annotations.

1338

1339

Classes inheriting from this can use the dbus_annotations

1340

decorator to add annotations to methods or signals.

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1341

876

"""

1342

877

1343

878

@staticmethod

1344

879

def _is_dbus_thing(thing):

1345

880

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

1346

881

1347

882

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

1348

883

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

1349

884

"""

1350

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

885

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

1351

886

False)

1352

887

1353

888

def _get_all_dbus_things(self, thing):

1354

889

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

1355

890

"""

1356

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

891

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

892

name),

1357

893

athing.__get__(self))

1358

894

for cls in self.__class__.__mro__

1359

895

for name, athing in

1360

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

1361

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1366

def Introspect(self, object_path, connection):

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts annotation tags on methods and signals.

1370

"""

1371

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

1372

connection)

1373

try:

1374

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

1375

1376

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

1377

# Add annotation tags

1378

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

1379

for tag in if_tag.getElementsByTagName(typ):

1380

annots = dict()

1381

for name, prop in (self.

1382

_get_all_dbus_things(typ)):

1383

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

1384

and prop._dbus_interface

1385

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

1386

annots.update(getattr(

1387

prop, "_dbus_annotations", {}))

1388

for name, value in annots.items():

1389

ann_tag = document.createElement(

1390

"annotation")

1391

ann_tag.setAttribute("name", name)

1392

ann_tag.setAttribute("value", value)

1393

tag.appendChild(ann_tag)

1394

# Add interface annotation tags

1395

for annotation, value in dict(

1396

itertools.chain.from_iterable(

1397

annotations().items()

1398

for name, annotations

1399

in self._get_all_dbus_things("interface")

1400

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

1401

)).items():

1402

ann_tag = document.createElement("annotation")

1403

ann_tag.setAttribute("name", annotation)

1404

ann_tag.setAttribute("value", value)

1405

if_tag.appendChild(ann_tag)

1406

# Fix argument name for the Introspect method itself

1407

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1409

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

1410

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

1411

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

1412

if (arg.getAttribute("direction")

1413

== "out"):

1414

arg.setAttribute("name",

1415

"xml_data")

1416

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

1417

document.unlink()

1418

except (AttributeError, xml.dom.DOMException,

1419

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1422

return xmlstring

1423

1424

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

"""A D-Bus object with properties.

1427

1428

Classes inheriting from this can use the dbus_service_property

1429

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

1430

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

1431

"""

1432

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1433

899

def _get_dbus_property(self, interface_name, property_name):

1434

900

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

1435

901

property with the specified name and interface.

1436

902

"""

1437

for cls in self.__class__.__mro__:

1438

for name, value in inspect.getmembers(

1439

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

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1440

907

if (value._dbus_name == property_name

1441

908

and value._dbus_interface == interface_name):

1442

909

return value.__get__(self)

1443

910

1444

911

# No such property

1445

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

1446

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

1457

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

in_signature="ss",

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1459

917

out_signature="v")

1460

918

def Get(self, interface_name, property_name):

1461

919

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

1467

925

if not hasattr(value, "variant_level"):

1468

926

return value

1469

927

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

1470

928

1471

929

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

1472

930

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

1473

931

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

1480

938

# signatures other than "ay".

1481

939

if prop._dbus_signature != "ay":

1482

940

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

1483

"'ay' signature {!r}"

941

"'ay' signature {0!r}"

1484

942

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

943

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

944

for byte in value))

1486

945

prop(value)

1487

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

in_signature="s",

946

947

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

1490

948

out_signature="a{sv}")

1491

949

def GetAll(self, interface_name):

1492

950

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

1493

951

standard.

1494

952

1495

953

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

1496

954

"""

1497

955

properties = {}

1507

965

if not hasattr(value, "variant_level"):

1508

966

properties[name] = value

1509

967

continue

1510

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

968

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

969

value.variant_level+1)

1512

970

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

1513

1514

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

1515

def PropertiesChanged(self, interface_name, changed_properties,

1516

invalidated_properties):

1517

"""Standard D-Bus PropertiesChanged() signal, see D-Bus

1518

standard.

1519

"""

1520

pass

1521

971

1522

972

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1523

973

out_signature="s",

1524

path_keyword="object_path",

1525

connection_keyword="connection")

974

path_keyword='object_path',

975

connection_keyword='connection')

1526

976

def Introspect(self, object_path, connection):

1527

977

"""Overloading of standard D-Bus method.

1528

978

1529

979

Inserts property tags and interface annotation tags.

1530

980

"""

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

981

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

982

connection)

1534

983

try:

1535

984

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

1536

1537

985

def make_tag(document, name, prop):

1538

986

e = document.createElement("property")

1539

987

e.setAttribute("name", name)

1540

988

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

1541

989

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

1542

990

return e

1543

1544

991

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

1545

992

# Add property tags

1546

993

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

1549

996

if prop._dbus_interface

1550

997

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

1551

998

if_tag.appendChild(tag)

1552

# Add annotation tags for properties

1553

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

1554

annots = dict()

1555

for name, prop in self._get_all_dbus_things(

1556

"property"):

1557

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

1558

and prop._dbus_interface

1559

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

1560

annots.update(getattr(

1561

prop, "_dbus_annotations", {}))

1562

for name, value in annots.items():

1563

ann_tag = document.createElement(

1564

"annotation")

1565

ann_tag.setAttribute("name", name)

1566

ann_tag.setAttribute("value", value)

1567

tag.appendChild(ann_tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1568

1030

# Add the names to the return values for the

1569

1031

# "org.freedesktop.DBus.Properties" methods

1570

1032

if (if_tag.getAttribute("name")

1584

1046

document.unlink()

1585

1047

except (AttributeError, xml.dom.DOMException,

1586

1048

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1049

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

1050

exc_info=error)

1660

1051

return xmlstring

1661

1052

1662

1053

1663

1054

def datetime_to_dbus(dt, variant_level=0):

1664

1055

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

1665

1056

if dt is None:

1666

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

1667

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

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1668

1060

1669

1061

1670

1062

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1672

1064

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

1673

1065

interface names according to the "alt_interface_names" mapping.

1674

1066

Usage:

1675

1067

1676

1068

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

1677

1069

"net.example.AlternateInterface"})

1678

1070

class SampleDBusObject(dbus.service.Object):

1679

1071

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

1680

1072

def SampleDBusMethod():

1681

1073

pass

1682

1074

1683

1075

The above "SampleDBusMethod" on "SampleDBusObject" will be

1684

1076

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

1685

1077

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

1686

1078

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

1687

1079

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

1688

1080

1689

1081

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

1690

1082

(from DBusObjectWithProperties) and interfaces (from the

1691

1083

dbus_interface_annotations decorator).

1692

1084

"""

1693

1694

1085

def wrapper(cls):

1695

1086

for orig_interface_name, alt_interface_name in (

1696

alt_interface_names.items()):

1087

alt_interface_names.iteritems()):

1697

1088

attr = {}

1698

1089

interface_names = set()

1699

1090

# Go though all attributes of the class

1701

1092

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

1702

1093

# with the wrong interface name

1703

1094

if (not hasattr(attribute, "_dbus_interface")

1704

or not attribute._dbus_interface.startswith(

1705

orig_interface_name)):

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1706

1097

continue

1707

1098

# Create an alternate D-Bus interface name based on

1708

1099

# the current name

1709

alt_interface = attribute._dbus_interface.replace(

1710

orig_interface_name, alt_interface_name)

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1711

1103

interface_names.add(alt_interface)

1712

1104

# Is this a D-Bus signal?

1713

1105

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

1714

1106

# Extract the original non-method undecorated

1715

1107

# function by black magic

1716

if sys.version_info.major == 2:

1717

nonmethod_func = (dict(

1108

nonmethod_func = (dict(

1718

1109

zip(attribute.func_code.co_freevars,

1719

attribute.__closure__))

1720

["func"].cell_contents)

1721

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1726

1112

# Create a new, but exactly alike, function

1727

1113

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

1728

1114

# with the alternate D-Bus interface name

1729

new_function = copy_function(nonmethod_func)

1730

new_function = (dbus.service.signal(

1731

alt_interface,

1732

attribute._dbus_signature)(new_function))

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1733

1124

# Copy annotations, if any

1734

1125

try:

1735

new_function._dbus_annotations = dict(

1736

attribute._dbus_annotations)

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1737

1128

except AttributeError:

1738

1129

pass

1739

1740

1130

# Define a creator of a function to call both the

1741

1131

# original and alternate functions, so both the

1742

1132

# original and alternate signals gets sent when

1745

1135

"""This function is a scope container to pass

1746

1136

func1 and func2 to the "call_both" function

1747

1137

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1750

1138

def call_both(*args, **kwargs):

1751

1139

"""This function will emit two D-Bus

1752

1140

signals by calling func1 and func2"""

1753

1141

func1(*args, **kwargs)

1754

1142

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1761

1143

return call_both

1762

1144

# Create the "call_both" function and add it to

1763

1145

# the class

1768

1150

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

1769

1151

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

1770

1152

# to the class.

1771

attr[attrname] = (

1772

dbus.service.method(

1773

alt_interface,

1774

attribute._dbus_in_signature,

1775

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1777

1163

# Copy annotations, if any

1778

1164

try:

1779

attr[attrname]._dbus_annotations = dict(

1780

attribute._dbus_annotations)

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1781

1167

except AttributeError:

1782

1168

pass

1783

1169

# Is this a D-Bus property?

1786

1172

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

1787

1173

# property with the alternate D-Bus interface

1788

1174

# name. Add it to the class.

1789

attr[attrname] = (dbus_service_property(

1790

alt_interface, attribute._dbus_signature,

1791

attribute._dbus_access,

1792

attribute._dbus_get_args_options

1793

["byte_arrays"])

1794

(copy_function(attribute)))

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1795

1188

# Copy annotations, if any

1796

1189

try:

1797

attr[attrname]._dbus_annotations = dict(

1798

attribute._dbus_annotations)

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1799

1192

except AttributeError:

1800

1193

pass

1801

1194

# Is this a D-Bus interface?

1804

1197

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

1805

1198

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

1806

1199

# to the class.

1807

attr[attrname] = (

1808

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1810

1208

if deprecate:

1811

1209

# Deprecate all alternate interfaces

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1813

1211

for interface_name in interface_names:

1814

1815

1212

@dbus_interface_annotations(interface_name)

1816

1213

def func(self):

1817

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

1818

"true"}

1214

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

1215

"true" }

1819

1216

# Find an unused name

1820

1217

for aname in (iname.format(i)

1821

1218

for i in itertools.count()):

1825

1222

if interface_names:

1826

1223

# Replace the class with a new subclass of it with

1827

1224

# methods, signals, etc. as created above.

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1225

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

1226

(cls,), attr)

1834

1227

return cls

1835

1836

1228

return wrapper

1837

1229

1838

1230

1839

1231

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

1840

"se.bsnet.fukt.Mandos"})

1232

"se.bsnet.fukt.Mandos"})

1841

1233

class ClientDBus(Client, DBusObjectWithProperties):

1842

1234

"""A Client class using D-Bus

1843

1235

1844

1236

Attributes:

1845

1237

dbus_object_path: dbus.ObjectPath

1846

1238

bus: dbus.SystemBus()

1847

1239

"""

1848

1240

1849

1241

runtime_expansions = (Client.runtime_expansions

1850

+ ("dbus_object_path", ))

1851

1852

_interface = "se.recompile.Mandos.Client"

1853

1242

+ ("dbus_object_path",))

1243

1854

1244

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

1855

1856

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

1245

1246

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

1857

1247

self.bus = bus

1858

1248

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

1859

1249

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

1860

1250

# the D-Bus

1861

client_object_name = str(self.name).translate(

1251

client_object_name = unicode(self.name).translate(

1862

1252

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

1863

1253

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

1864

self.dbus_object_path = dbus.ObjectPath(

1865

"/clients/" + client_object_name)

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1866

1256

DBusObjectWithProperties.__init__(self, self.bus,

1867

1257

self.dbus_object_path)

1868

1869

def notifychangeproperty(transform_func, dbus_name,

1870

type_func=lambda x: x,

1871

variant_level=1,

1872

invalidate_only=False,

1873

_interface=_interface):

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1874

1262

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

1875

1263

its changes to DBus.

1876

1264

1877

1265

transform_fun: Function that takes a value and a variant_level

1878

1266

and transforms it to a D-Bus type.

1879

1267

dbus_name: D-Bus name of the variable

1881

1269

to the D-Bus. Default: no transform

1882

1270

variant_level: D-Bus variant level. Default: 1

1883

1271

"""

1884

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

1885

1272

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

1886

1273

def setter(self, value):

1887

1274

if hasattr(self, "dbus_object_path"):

1888

1275

if (not hasattr(self, attrname) or

1889

1276

type_func(getattr(self, attrname, None))

1890

1277

!= type_func(value)):

1891

if invalidate_only:

1892

self.PropertiesChanged(

1893

_interface, dbus.Dictionary(),

1894

dbus.Array((dbus_name, )))

1895

else:

1896

dbus_value = transform_func(

1897

type_func(value),

1898

variant_level=variant_level)

1899

self.PropertyChanged(dbus.String(dbus_name),

1900

dbus_value)

1901

self.PropertiesChanged(

1902

_interface,

1903

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

1904

dbus_value}),

1905

dbus.Array())

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1906

1283

setattr(self, attrname, value)

1907

1284

1908

1285

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

1909

1286

1910

1287

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1911

1288

approvals_pending = notifychangeproperty(dbus.Boolean,

1912

1289

"ApprovalPending",

1913

type_func=bool)

1290

type_func = bool)

1914

1291

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

1915

1292

last_enabled = notifychangeproperty(datetime_to_dbus,

1916

1293

"LastEnabled")

1917

checker = notifychangeproperty(

1918

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1920

1297

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1921

1298

"LastCheckedOK")

1922

1299

last_checker_status = notifychangeproperty(dbus.Int16,

1925

1302

datetime_to_dbus, "LastApprovalRequest")

1926

1303

approved_by_default = notifychangeproperty(dbus.Boolean,

1927

1304

"ApprovedByDefault")

1928

approval_delay = notifychangeproperty(

1929

dbus.UInt64, "ApprovalDelay",

1930

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

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1931

1309

approval_duration = notifychangeproperty(

1932

1310

dbus.UInt64, "ApprovalDuration",

1933

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

1311

type_func = timedelta_to_milliseconds)

1934

1312

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

1935

timeout = notifychangeproperty(

1936

dbus.UInt64, "Timeout",

1937

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1938

1316

extended_timeout = notifychangeproperty(

1939

1317

dbus.UInt64, "ExtendedTimeout",

1940

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

1941

interval = notifychangeproperty(

1942

dbus.UInt64, "Interval",

1943

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

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1944

1323

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

1945

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

1946

invalidate_only=True)

1947

1324

1948

1325

del notifychangeproperty

1949

1326

1950

1327

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

1951

1328

try:

1952

1329

self.remove_from_connection()

1955

1332

if hasattr(DBusObjectWithProperties, "__del__"):

1956

1333

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

1957

1334

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

1958

1959

def checker_callback(self, source, condition,

1960

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

1961

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

1962

connection, command, *args,

1963

**kwargs)

1964

exitstatus = self.last_checker_status

1965

if exitstatus >= 0:

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1966

1342

# Emit D-Bus signal

1967

1343

self.CheckerCompleted(dbus.Int16(exitstatus),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1344

dbus.Int64(condition),

1970

1345

dbus.String(command))

1971

1346

else:

1972

1347

# Emit D-Bus signal

1973

1348

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

1974

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1349

dbus.Int64(condition),

1978

1350

dbus.String(command))

1979

return ret

1980

1351

1352

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

1353

*args, **kwargs)

1354

1981

1355

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

1982

1356

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

1983

1357

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

1987

1361

# Emit D-Bus signal

1988

1362

self.CheckerStarted(self.current_checker_command)

1989

1363

return r

1990

1364

1991

1365

def _reset_approved(self):

1992

1366

self.approved = None

1993

1367

return False

1994

1368

1995

1369

def approve(self, value=True):

1996

1370

self.approved = value

1997

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

1998

* 1000), self._reset_approved)

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1999

1374

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

2007

1388

# CheckerCompleted - signal

2008

1389

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

2009

1390

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

2010

1391

"D-Bus signal"

2011

1392

pass

2012

1393

2013

1394

# CheckerStarted - signal

2014

1395

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

2015

1396

def CheckerStarted(self, command):

2016

1397

"D-Bus signal"

2017

1398

pass

2018

1399

2019

1400

# PropertyChanged - signal

2020

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

2021

1401

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

2022

1402

def PropertyChanged(self, property, value):

2023

1403

"D-Bus signal"

2024

1404

pass

2025

1405

2026

1406

# GotSecret - signal

2027

1407

@dbus.service.signal(_interface)

2028

1408

def GotSecret(self):

2031

1411

server to mandos-client

2032

1412

"""

2033

1413

pass

2034

1414

2035

1415

# Rejected - signal

2036

1416

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

2037

1417

def Rejected(self, reason):

2038

1418

"D-Bus signal"

2039

1419

pass

2040

1420

2041

1421

# NeedApproval - signal

2042

1422

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

2043

1423

def NeedApproval(self, timeout, default):

2044

1424

"D-Bus signal"

2045

1425

return self.need_approval()

2046

2047

# Methods

2048

1426

1427

## Methods

1428

2049

1429

# Approve - method

2050

1430

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

2051

1431

def Approve(self, value):

2052

1432

self.approve(value)

2053

1433

2054

1434

# CheckedOK - method

2055

1435

@dbus.service.method(_interface)

2056

1436

def CheckedOK(self):

2057

1437

self.checked_ok()

2058

1438

2059

1439

# Enable - method

2060

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

2061

1440

@dbus.service.method(_interface)

2062

1441

def Enable(self):

2063

1442

"D-Bus method"

2064

1443

self.enable()

2065

1444

2066

1445

# StartChecker - method

2067

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

2068

1446

@dbus.service.method(_interface)

2069

1447

def StartChecker(self):

2070

1448

"D-Bus method"

2071

1449

self.start_checker()

2072

1450

2073

1451

# Disable - method

2074

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

2075

1452

@dbus.service.method(_interface)

2076

1453

def Disable(self):

2077

1454

"D-Bus method"

2078

1455

self.disable()

2079

1456

2080

1457

# StopChecker - method

2081

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

2082

1458

@dbus.service.method(_interface)

2083

1459

def StopChecker(self):

2084

1460

self.stop_checker()

2085

2086

# Properties

2087

1461

1462

## Properties

1463

2088

1464

# ApprovalPending - property

2089

1465

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

2090

1466

def ApprovalPending_dbus_property(self):

2091

1467

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

2092

1468

2093

1469

# ApprovedByDefault - property

2094

@dbus_service_property(_interface,

2095

signature="b",

1470

@dbus_service_property(_interface, signature="b",

2096

1471

access="readwrite")

2097

1472

def ApprovedByDefault_dbus_property(self, value=None):

2098

1473

if value is None: # get

2099

1474

return dbus.Boolean(self.approved_by_default)

2100

1475

self.approved_by_default = bool(value)

2101

1476

2102

1477

# ApprovalDelay - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2105

1479

access="readwrite")

2106

1480

def ApprovalDelay_dbus_property(self, value=None):

2107

1481

if value is None: # get

2108

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

2109

* 1000)

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2110

1483

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

2111

1484

2112

1485

# ApprovalDuration - property

2113

@dbus_service_property(_interface,

2114

signature="t",

1486

@dbus_service_property(_interface, signature="t",

2115

1487

access="readwrite")

2116

1488

def ApprovalDuration_dbus_property(self, value=None):

2117

1489

if value is None: # get

2118

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

2119

* 1000)

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2120

1492

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

2121

1493

2122

1494

# Name - property

2123

@dbus_annotations(

2124

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

2125

1495

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

2126

1496

def Name_dbus_property(self):

2127

1497

return dbus.String(self.name)

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1498

2136

1499

# Fingerprint - property

2137

@dbus_annotations(

2138

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

2139

1500

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

2140

1501

def Fingerprint_dbus_property(self):

2141

1502

return dbus.String(self.fingerprint)

2142

1503

2143

1504

# Host - property

2144

@dbus_service_property(_interface,

2145

signature="s",

1505

@dbus_service_property(_interface, signature="s",

2146

1506

access="readwrite")

2147

1507

def Host_dbus_property(self, value=None):

2148

1508

if value is None: # get

2149

1509

return dbus.String(self.host)

2150

self.host = str(value)

2151

1510

self.host = unicode(value)

1511

2152

1512

# Created - property

2153

@dbus_annotations(

2154

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

2155

1513

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

2156

1514

def Created_dbus_property(self):

2157

1515

return datetime_to_dbus(self.created)

2158

1516

2159

1517

# LastEnabled - property

2160

1518

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

2161

1519

def LastEnabled_dbus_property(self):

2162

1520

return datetime_to_dbus(self.last_enabled)

2163

1521

2164

1522

# Enabled - property

2165

@dbus_service_property(_interface,

2166

signature="b",

1523

@dbus_service_property(_interface, signature="b",

2167

1524

access="readwrite")

2168

1525

def Enabled_dbus_property(self, value=None):

2169

1526

if value is None: # get

2172

1529

self.enable()

2173

1530

else:

2174

1531

self.disable()

2175

1532

2176

1533

# LastCheckedOK - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1534

@dbus_service_property(_interface, signature="s",

2179

1535

access="readwrite")

2180

1536

def LastCheckedOK_dbus_property(self, value=None):

2181

1537

if value is not None:

2182

1538

self.checked_ok()

2183

1539

return

2184

1540

return datetime_to_dbus(self.last_checked_ok)

2185

1541

2186

1542

# LastCheckerStatus - property

2187

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

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2188

1545

def LastCheckerStatus_dbus_property(self):

2189

1546

return dbus.Int16(self.last_checker_status)

2190

1547

2191

1548

# Expires - property

2192

1549

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

2193

1550

def Expires_dbus_property(self):

2194

1551

return datetime_to_dbus(self.expires)

2195

1552

2196

1553

# LastApprovalRequest - property

2197

1554

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

2198

1555

def LastApprovalRequest_dbus_property(self):

2199

1556

return datetime_to_dbus(self.last_approval_request)

2200

1557

2201

1558

# Timeout - property

2202

@dbus_service_property(_interface,

2203

signature="t",

1559

@dbus_service_property(_interface, signature="t",

2204

1560

access="readwrite")

2205

1561

def Timeout_dbus_property(self, value=None):

2206

1562

if value is None: # get

2207

return dbus.UInt64(self.timeout.total_seconds() * 1000)

1563

return dbus.UInt64(self.timeout_milliseconds())

2208

1564

old_timeout = self.timeout

2209

1565

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

2210

1566

# Reschedule disabling

2218

1574

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

2219

1575

is None):

2220

1576

return

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2223

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

2224

self.disable)

2225

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2226

1583

# ExtendedTimeout - property

2227

@dbus_service_property(_interface,

2228

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2229

1585

access="readwrite")

2230

1586

def ExtendedTimeout_dbus_property(self, value=None):

2231

1587

if value is None: # get

2232

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

2233

* 1000)

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2234

1589

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

2235

1590

2236

1591

# Interval - property

2237

@dbus_service_property(_interface,

2238

signature="t",

1592

@dbus_service_property(_interface, signature="t",

2239

1593

access="readwrite")

2240

1594

def Interval_dbus_property(self, value=None):

2241

1595

if value is None: # get

2242

return dbus.UInt64(self.interval.total_seconds() * 1000)

1596

return dbus.UInt64(self.interval_milliseconds())

2243

1597

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

2244

1598

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

2245

1599

return

2246

1600

if self.enabled:

2247

1601

# Reschedule checker run

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2250

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2253

1607

# Checker - property

2254

@dbus_service_property(_interface,

2255

signature="s",

1608

@dbus_service_property(_interface, signature="s",

2256

1609

access="readwrite")

2257

1610

def Checker_dbus_property(self, value=None):

2258

1611

if value is None: # get

2259

1612

return dbus.String(self.checker_command)

2260

self.checker_command = str(value)

2261

1613

self.checker_command = unicode(value)

1614

2262

1615

# CheckerRunning - property

2263

@dbus_service_property(_interface,

2264

signature="b",

1616

@dbus_service_property(_interface, signature="b",

2265

1617

access="readwrite")

2266

1618

def CheckerRunning_dbus_property(self, value=None):

2267

1619

if value is None: # get

2270

1622

self.start_checker()

2271

1623

else:

2272

1624

self.stop_checker()

2273

1625

2274

1626

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

2278

1627

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

2279

1628

def ObjectPath_dbus_property(self):

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2282

1631

# Secret = property

2283

@dbus_annotations(

2284

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

2285

"invalidates"})

2286

@dbus_service_property(_interface,

2287

signature="ay",

2288

access="write",

2289

byte_arrays=True)

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2290

1634

def Secret_dbus_property(self, value):

2291

self.secret = bytes(value)

2292

1635

self.secret = str(value)

1636

2293

1637

del _interface

2294

1638

2295

1639

2296

class ProxyClient:

2297

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

1640

class ProxyClient(object):

1641

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

2298

1642

self._pipe = child_pipe

2299

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

1643

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

2300

1644

if not self._pipe.recv():

2301

raise KeyError(key_id or fpr)

2302

1645

raise KeyError()

1646

2303

1647

def __getattribute__(self, name):

2304

if name == "_pipe":

1648

if name == '_pipe':

2305

1649

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

2306

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

1650

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

2307

1651

data = self._pipe.recv()

2308

if data[0] == "data":

1652

if data[0] == 'data':

2309

1653

return data[1]

2310

if data[0] == "function":

2311

1654

if data[0] == 'function':

2312

1655

def func(*args, **kwargs):

2313

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

1656

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

2314

1657

return self._pipe.recv()[1]

2315

2316

1658

return func

2317

1659

2318

1660

def __setattr__(self, name, value):

2319

if name == "_pipe":

1661

if name == '_pipe':

2320

1662

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

2321

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

1663

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

2322

1664

2323

1665

2324

1666

class ClientHandler(socketserver.BaseRequestHandler, object):

2325

1667

"""A class to handle client connections.

2326

1668

2327

1669

Instantiated once for each connection to handle it.

2328

1670

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

2329

1671

2330

1672

def handle(self):

2331

1673

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

2332

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

2333

str(self.client_address))

2334

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

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1674

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

1675

unicode(self.client_address))

1676

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

1677

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2342

1693

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

2343

1694

priority = self.server.gnutls_priority

2344

1695

if priority is None:

2345

1696

priority = "NORMAL"

2346

gnutls.priority_set_direct(session,

2347

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

2348

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2349

1701

# Start communication using the Mandos protocol

2350

1702

# Get protocol number

2351

1703

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

2352

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

1704

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

2353

1705

try:

2354

1706

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

2355

1707

raise RuntimeError(line)

2356

1708

except (ValueError, IndexError, RuntimeError) as error:

2357

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

1709

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

2358

1710

return

2359

1711

2360

1712

# Start GnuTLS connection

2361

1713

try:

2362

1714

session.handshake()

2363

except gnutls.Error as error:

2364

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

1715

except gnutls.errors.GNUTLSError as error:

1716

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

2365

1717

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

2366

1718

# established. Just abandon the request.

2367

1719

return

2368

log.debug("Handshake succeeded")

2369

1720

logger.debug("Handshake succeeded")

1721

2370

1722

approval_required = False

2371

1723

try:

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2396

1735

self.client_address)

2397

1736

except KeyError:

2398

1737

return

2399

1738

2400

1739

if client.approval_delay:

2401

1740

delay = client.approval_delay

2402

1741

client.approvals_pending += 1

2403

1742

approval_required = True

2404

1743

2405

1744

while True:

2406

1745

if not client.enabled:

2407

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

1746

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

1747

client.name)

2408

1748

if self.server.use_dbus:

2409

1749

# Emit D-Bus signal

2410

1750

client.Rejected("Disabled")

2411

1751

return

2412

1752

2413

1753

if client.approved or not client.approval_delay:

2414

# We are approved or approval is disabled

1754

#We are approved or approval is disabled

2415

1755

break

2416

1756

elif client.approved is None:

2417

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

2418

client.name)

1757

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

1758

client.name)

2419

1759

if self.server.use_dbus:

2420

1760

# Emit D-Bus signal

2421

1761

client.NeedApproval(

2422

client.approval_delay.total_seconds()

2423

* 1000, client.approved_by_default)

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2424

1764

else:

2425

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

2426

client.name)

1765

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

1766

client.name)

2427

1767

if self.server.use_dbus:

2428

1768

# Emit D-Bus signal

2429

1769

client.Rejected("Denied")

2430

1770

return

2431

2432

# wait until timeout or approved

1771

1772

#wait until timeout or approved

2433

1773

time = datetime.datetime.now()

2434

1774

client.changedstate.acquire()

2435

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

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2436

1778

client.changedstate.release()

2437

1779

time2 = datetime.datetime.now()

2438

1780

if (time2 - time) >= delay:

2439

1781

if not client.approved_by_default:

2440

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

2441

" waiting for approval",

2442

client.name)

1782

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

1783

" waiting for approval",

1784

client.name)

2443

1785

if self.server.use_dbus:

2444

1786

# Emit D-Bus signal

2445

1787

client.Rejected("Approval timed out")

2448

1790

break

2449

1791

else:

2450

1792

delay -= time2 - time

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)

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

1807

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

2459

1808

# bump the timeout using extended_timeout

2460

1809

client.bump_timeout(client.extended_timeout)

2461

1810

if self.server.use_dbus:

2462

1811

# Emit D-Bus signal

2463

1812

client.GotSecret()

2464

1813

2465

1814

finally:

2466

1815

if approval_required:

2467

1816

client.approvals_pending -= 1

2468

1817

try:

2469

1818

session.bye()

2470

except gnutls.Error as error:

2471

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

2472

1819

except gnutls.errors.GNUTLSError as error:

1820

logger.warning("GnuTLS bye failed",

1821

exc_info=error)

1822

2473

1823

@staticmethod

2474

1824

def peer_certificate(session):

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2491

1832

list_size = ctypes.c_uint(1)

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

1835

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

2494

1836

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

2495

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

1837

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

1838

" certificate")

2496

1839

if list_size.value == 0:

2497

1840

return None

2498

1841

cert = cert_list[0]

2499

1842

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

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

1843

2536

1844

@staticmethod

2537

1845

def fingerprint(openpgp):

2538

1846

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2539

1847

# New GnuTLS "datum" with the OpenPGP public key

2540

datum = gnutls.datum_t(

2541

ctypes.cast(ctypes.c_char_p(openpgp),

2542

ctypes.POINTER(ctypes.c_ubyte)),

2543

ctypes.c_uint(len(openpgp)))

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2544

1853

# New empty GnuTLS certificate

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2547

1857

# Import the OpenPGP public key into the certificate

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2550

1862

# Verify the self signature in the key

2551

1863

crtverify = ctypes.c_uint()

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2554

1867

if crtverify.value != 0:

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2558

1871

# New buffer for the fingerprint

2559

1872

buf = ctypes.create_string_buffer(20)

2560

1873

buf_len = ctypes.c_size_t()

2561

1874

# Get the fingerprint from the certificate into the buffer

2562

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

2563

ctypes.byref(buf_len))

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2564

1878

# Deinit the certificate

2565

gnutls.openpgp_crt_deinit(crt)

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2566

1880

# Convert the buffer to a Python bytestring

2567

1881

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

2568

1882

# Convert the bytestring to hexadecimal notation

2570

1884

return hex_fpr

2571

1885

2572

1886

2573

class MultiprocessingMixIn:

1887

class MultiprocessingMixIn(object):

2574

1888

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

2575

2576

1889

def sub_process_main(self, request, address):

2577

1890

try:

2578

1891

self.finish_request(request, address)

2579

1892

except Exception:

2580

1893

self.handle_error(request, address)

2581

1894

self.close_request(request)

2582

1895

2583

1896

def process_request(self, request, address):

2584

1897

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

2585

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

2586

args=(request, address))

1898

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

1899

args = (request, address))

2587

1900

proc.start()

2588

1901

return proc

2589

1902

2590

1903

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2592

1905

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

2593

2594

1906

def process_request(self, request, client_address):

2595

1907

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

2596

1908

2597

1909

This function creates a new pipe in self.pipe

2598

1910

"""

2599

1911

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2600

1912

2601

1913

proc = MultiprocessingMixIn.process_request(self, request,

2602

1914

client_address)

2603

1915

self.child_pipe.close()

2604

1916

self.add_pipe(parent_pipe, proc)

2605

1917

2606

1918

def add_pipe(self, parent_pipe, proc):

2607

1919

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

2608

1920

raise NotImplementedError()

2609

1921

2610

1922

2611

1923

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2612

socketserver.TCPServer):

2613

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

2614

1924

socketserver.TCPServer, object):

1925

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

1926

2615

1927

Attributes:

2616

1928

enabled: Boolean; whether this server is activated yet

2617

1929

interface: None or a network interface name (string)

2618

1930

use_ipv6: Boolean; to use IPv6 or not

2619

1931

"""

2620

2621

1932

def __init__(self, server_address, RequestHandlerClass,

2622

interface=None,

2623

use_ipv6=True,

2624

socketfd=None):

1933

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

2625

1934

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

2626

1935

creating a new one with socket.socket().

2627

1936

"""

2633

1942

self.socketfd = socketfd

2634

1943

# Save the original socket.socket() function

2635

1944

self.socket_socket = socket.socket

2636

2637

1945

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

2638

#

1946

#

2639

1947

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

2640

1948

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

2641

1949

# patching socket.socket.)

2642

#

1950

#

2643

1951

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

2644

1952

@functools.wraps(socket.socket)

2645

1953

def socket_wrapper(*args, **kwargs):

2657

1965

# socket_wrapper(), if socketfd was set.

2658

1966

socketserver.TCPServer.__init__(self, server_address,

2659

1967

RequestHandlerClass)

2660

1968

2661

1969

def server_bind(self):

2662

1970

"""This overrides the normal server_bind() function

2663

1971

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

2664

1972

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

2665

global SO_BINDTODEVICE

2666

1973

if self.interface is not None:

2667

1974

if SO_BINDTODEVICE is None:

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

str(self.interface + '\0'))

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2688

1996

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

2689

1997

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2692

1998

if not self.server_address[0]:

2693

1999

if self.address_family == socket.AF_INET6:

2694

any_address = "::" # in6addr_any

2000

any_address = "::" # in6addr_any

2695

2001

else:

2696

any_address = "0.0.0.0" # INADDR_ANY

2002

any_address = "0.0.0.0" # INADDR_ANY

2697

2003

self.server_address = (any_address,

2698

2004

self.server_address[1])

2699

2005

elif not self.server_address[1]:

2700

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

2006

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

2007

0)

2701

2008

# if self.interface:

2702

2009

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

2703

2010

# 0, # port

2709

2016

2710

2017

class MandosServer(IPv6_TCPServer):

2711

2018

"""Mandos server.

2712

2019

2713

2020

Attributes:

2714

2021

clients: set of Client objects

2715

2022

gnutls_priority GnuTLS priority string

2716

2023

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

2717

2718

Assumes a GLib.MainLoop event loop.

2024

2025

Assumes a gobject.MainLoop event loop.

2719

2026

"""

2720

2721

2027

def __init__(self, server_address, RequestHandlerClass,

2722

interface=None,

2723

use_ipv6=True,

2724

clients=None,

2725

gnutls_priority=None,

2726

use_dbus=True,

2727

socketfd=None):

2028

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

2029

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

2728

2030

self.enabled = False

2729

2031

self.clients = clients

2730

2032

if self.clients is None:

2733

2035

self.gnutls_priority = gnutls_priority

2734

2036

IPv6_TCPServer.__init__(self, server_address,

2735

2037

RequestHandlerClass,

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2740

2041

def server_activate(self):

2741

2042

if self.enabled:

2742

2043

return socketserver.TCPServer.server_activate(self)

2743

2044

2744

2045

def enable(self):

2745

2046

self.enabled = True

2746

2047

2747

2048

def add_pipe(self, parent_pipe, proc):

2748

2049

# Call "handle_ipc" for both data and EOF events

2749

GLib.io_add_watch(

2750

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

2751

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

2752

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2756

def handle_ipc(self, source, condition,

2757

parent_pipe=None,

2758

proc=None,

2759

client_object=None):

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2760

2059

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

2761

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

2060

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

2762

2061

# Wait for other process to exit

2763

2062

proc.join()

2764

2063

return False

2765

2064

2766

2065

# Read a request from the child

2767

2066

request = parent_pipe.recv()

2768

2067

command = request[0]

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2068

2069

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2783

2075

client = c

2784

2076

break

2785

2077

else:

2786

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

2787

" %s", key_id or fpr, address)

2078

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

2079

"dress: %s", fpr, address)

2788

2080

if self.use_dbus:

2789

2081

# Emit D-Bus signal

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2082

mandos_dbus_service.ClientNotFound(fpr,

2791

2083

address[0])

2792

2084

parent_pipe.send(False)

2793

2085

return False

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2798

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2802

2095

parent_pipe.send(True)

2803

2096

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

2804

2097

# same fileno

2805

2098

return False

2806

if command == "funcall":

2099

if command == 'funcall':

2807

2100

funcname = request[1]

2808

2101

args = request[2]

2809

2102

kwargs = request[3]

2810

2811

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

2103

2104

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

2812

2105

funcname)(*args,

2813

**kwargs)))

2814

2815

if command == "getattr":

2106

**kwargs)))

2107

2108

if command == 'getattr':

2816

2109

attrname = request[1]

2817

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2820

2112

else:

2821

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2116

if command == 'setattr':

2825

2117

attrname = request[1]

2826

2118

value = request[2]

2827

2119

setattr(client_object, attrname, value)

2828

2120

2829

2121

return True

2830

2122

2831

2123

2832

2124

def rfc3339_duration_to_delta(duration):

2833

2125

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

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2851

2141

"""

2852

2142

2853

2143

# Parsing an RFC 3339 duration with regular expressions is not

2854

2144

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

2855

2145

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

2856

2146

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

2857

2147

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

2858

2148

# avoid excessive use of external libraries.

2859

2149

2860

2150

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

2861

Token = collections.namedtuple("Token", (

2862

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

2863

# a "group" containing digits

2864

"value", # datetime.timedelta or None

2865

"followers")) # Tokens valid after this token

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2866

2160

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

2867

2161

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

2868

2162

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

2869

2163

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

2870

2164

datetime.timedelta(seconds=1),

2871

frozenset((token_end, )))

2165

frozenset((token_end,)))

2872

2166

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

2873

2167

datetime.timedelta(minutes=1),

2874

2168

frozenset((token_second, token_end)))

2890

2184

frozenset((token_month, token_end)))

2891

2185

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

2892

2186

datetime.timedelta(weeks=1),

2893

frozenset((token_end, )))

2187

frozenset((token_end,)))

2894

2188

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

2895

2189

frozenset((token_year, token_month,

2896

2190

token_day, token_time,

2897

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2901

2194

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2906

2197

# Loop until end token is found

2907

2198

while found_token is not token_end:

2908

2199

# Search for any currently valid tokens

2924

2215

break

2925

2216

else:

2926

2217

# No currently valid tokens were found

2927

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

2928

.format(duration))

2218

raise ValueError("Invalid RFC 3339 duration")

2929

2219

# End token found

2930

2220

return value

2931

2221

2932

2222

2933

2223

def string_to_delta(interval):

2934

2224

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

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2225

2226

>>> string_to_delta('7d')

2227

datetime.timedelta(7)

2228

>>> string_to_delta('60s')

2229

datetime.timedelta(0, 60)

2230

>>> string_to_delta('60m')

2231

datetime.timedelta(0, 3600)

2232

>>> string_to_delta('24h')

2233

datetime.timedelta(1)

2234

>>> string_to_delta('1w')

2235

datetime.timedelta(7)

2236

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

2237

datetime.timedelta(0, 330)

2948

2238

"""

2949

2239

2950

2240

try:

2951

2241

return rfc3339_duration_to_delta(interval)

2952

2242

except ValueError:

2953

2243

pass

2954

2244

2955

2245

timevalue = datetime.timedelta(0)

2956

2246

for s in interval.split():

2957

2247

try:

2958

suffix = s[-1]

2248

suffix = unicode(s[-1])

2959

2249

value = int(s[:-1])

2960

2250

if suffix == "d":

2961

2251

delta = datetime.timedelta(value)

2968

2258

elif suffix == "w":

2969

2259

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

2970

2260

else:

2971

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

2261

raise ValueError("Unknown suffix {0!r}"

2262

.format(suffix))

2972

2263

except IndexError as e:

2973

2264

raise ValueError(*(e.args))

2974

2265

timevalue += delta

2975

2266

return timevalue

2976

2267

2977

2268

2978

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

2269

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

2979

2270

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

2980

2271

2981

2272

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

2982

2273

if os.fork():

2983

2274

sys.exit()

2991

2282

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

2992

2283

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

2993

2284

raise OSError(errno.ENODEV,

2994

"{} not a character device"

2285

"{0} not a character device"

2995

2286

.format(os.devnull))

2996

2287

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

2997

2288

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

3001

2292

3002

2293

3003

2294

def main():

3004

2295

3005

2296

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

3006

2297

# Parsing of options, both command line and config file

3007

2298

3008

2299

parser = argparse.ArgumentParser()

3009

2300

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

3010

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

2301

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

3011

2302

help="show version number and exit")

3012

2303

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

3013

2304

help="Bind to interface IF")

3046

2337

help="Directory to save/restore state in")

3047

2338

parser.add_argument("--foreground", action="store_true",

3048

2339

help="Run in foreground", default=None)

3049

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

3050

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

3051

default=None)

3052

2340

3053

2341

options = parser.parse_args()

3054

2342

2343

if options.check:

2344

import doctest

2345

fail_count, test_count = doctest.testmod()

2346

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

2347

3055

2348

# Default values for config file for server-global settings

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2349

server_defaults = { "interface": "",

2350

"address": "",

2351

"port": "",

2352

"debug": "False",

2353

"priority":

2354

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

2355

"servicename": "Mandos",

2356

"use_dbus": "True",

2357

"use_ipv6": "True",

2358

"debuglevel": "",

2359

"restore": "True",

2360

"socket": "",

2361

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

2362

"foreground": "False",

2363

}

2364

3079

2365

# Parse config file for server-global settings

3080

server_config = configparser.ConfigParser(server_defaults)

2366

server_config = configparser.SafeConfigParser(server_defaults)

3081

2367

del server_defaults

3082

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

3083

# Convert the ConfigParser object to a dict

2368

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

2369

"mandos.conf"))

2370

# Convert the SafeConfigParser object to a dict

3084

2371

server_settings = server_config.defaults()

3085

2372

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

3086

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

3087

"foreground", "zeroconf"):

2373

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

3088

2374

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

3089

2375

option)

3090

2376

if server_settings["port"]:

3100

2386

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

3101

2387

["socket"])

3102

2388

del server_config

3103

2389

3104

2390

# Override the settings from the config file with command line

3105

2391

# options, if set.

3106

2392

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

3107

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

3108

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

3109

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

2393

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

2394

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

2395

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

3110

2396

value = getattr(options, option)

3111

2397

if value is not None:

3112

2398

server_settings[option] = value

3113

2399

del options

3114

2400

# Force all strings to be unicode

3115

2401

for option in server_settings.keys():

3116

if isinstance(server_settings[option], bytes):

3117

server_settings[option] = (server_settings[option]

3118

.decode("utf-8"))

2402

if type(server_settings[option]) is str:

2403

server_settings[option] = unicode(server_settings[option])

3119

2404

# Force all boolean options to be boolean

3120

2405

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

3121

"foreground", "zeroconf"):

2406

"foreground"):

3122

2407

server_settings[option] = bool(server_settings[option])

3123

2408

# Debug implies foreground

3124

2409

if server_settings["debug"]:

3125

2410

server_settings["foreground"] = True

3126

2411

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

3127

2412

3128

2413

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

3129

3130

if (not server_settings["zeroconf"]

3131

and not (server_settings["port"]

3132

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

3133

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

3134

2414

3135

2415

# For convenience

3136

2416

debug = server_settings["debug"]

3137

2417

debuglevel = server_settings["debuglevel"]

3140

2420

stored_state_path = os.path.join(server_settings["statedir"],

3141

2421

stored_state_file)

3142

2422

foreground = server_settings["foreground"]

3143

zeroconf = server_settings["zeroconf"]

3144

2423

3145

2424

if debug:

3146

2425

initlogger(debug, logging.DEBUG)

3147

2426

else:

3150

2429

else:

3151

2430

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

3152

2431

initlogger(debug, level)

3153

2432

3154

2433

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

3155

syslogger.setFormatter(

3156

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

3157

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

3158

server_settings["servicename"])))

3159

2434

syslogger.setFormatter(logging.Formatter

2435

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

2436

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

2437

.format(server_settings

2438

["servicename"])))

2439

3160

2440

# Parse config file with clients

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2441

client_config = configparser.SafeConfigParser(Client

2442

.client_defaults)

3162

2443

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

3163

2444

"clients.conf"))

3164

2445

3165

2446

global mandos_dbus_service

3166

2447

mandos_dbus_service = None

3167

3168

socketfd = None

3169

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

3170

socketfd = server_settings["socket"]

3171

tcp_server = MandosServer(

3172

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

3173

ClientHandler,

3174

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

3175

use_ipv6=use_ipv6,

3176

gnutls_priority=server_settings["priority"],

3177

use_dbus=use_dbus,

3178

socketfd=socketfd)

2448

2449

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

2450

server_settings["port"]),

2451

ClientHandler,

2452

interface=(server_settings["interface"]

2453

or None),

2454

use_ipv6=use_ipv6,

2455

gnutls_priority=

2456

server_settings["priority"],

2457

use_dbus=use_dbus,

2458

socketfd=(server_settings["socket"]

2459

or None))

3179

2460

if not foreground:

3180

2461

pidfilename = "/run/mandos.pid"

3181

2462

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

3182

2463

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

3183

2464

pidfile = None

3184

2465

try:

3185

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

2466

pidfile = open(pidfilename, "w")

3186

2467

except IOError as e:

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2468

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

2469

exc_info=e)

2470

2471

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

3193

2472

try:

3194

2473

uid = pwd.getpwnam(name).pw_uid

3195

gid = pwd.getpwnam(group).pw_gid

2474

gid = pwd.getpwnam(name).pw_gid

3196

2475

break

3197

2476

except KeyError:

3198

2477

continue

3202

2481

try:

3203

2482

os.setgid(gid)

3204

2483

os.setuid(uid)

3205

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

3206

2484

except OSError as error:

3207

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

3208

os.strerror(error.errno))

3209

2485

if error.errno != errno.EPERM:

3210

2486

raise

3211

2487

3212

2488

if debug:

3213

2489

# Enable all possible GnuTLS debugging

3214

2490

3215

2491

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

3216

2492

# - GnuTLS manual

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2493

gnutls.library.functions.gnutls_global_set_log_level(11)

2494

2495

@gnutls.library.types.gnutls_log_func

3220

2496

def debug_gnutls(level, string):

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2497

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

2498

2499

(gnutls.library.functions

2500

.gnutls_global_set_log_function(debug_gnutls))

2501

3226

2502

# Redirect stdin so all checkers get /dev/null

3227

2503

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

3228

2504

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

3229

2505

if null > 2:

3230

2506

os.close(null)

3231

2507

3232

2508

# Need to fork before connecting to D-Bus

3233

2509

if not foreground:

3234

2510

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

3235

2511

daemon()

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2512

2513

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

2514

# need to inform gobject that threads will be used.

2515

gobject.threads_init()

2516

3242

2517

global main_loop

3243

2518

# From the Avahi example code

3244

2519

DBusGMainLoop(set_as_default=True)

3245

main_loop = GLib.MainLoop()

2520

main_loop = gobject.MainLoop()

3246

2521

bus = dbus.SystemBus()

3247

2522

# End of Avahi example code

3248

2523

if use_dbus:

3249

2524

try:

3250

2525

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

3251

bus,

3252

do_not_queue=True)

3253

old_bus_name = dbus.service.BusName(

3254

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

3255

do_not_queue=True)

3256

except dbus.exceptions.DBusException as e:

3257

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

2526

bus, do_not_queue=True)

2527

old_bus_name = (dbus.service.BusName

2528

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

2529

do_not_queue=True))

2530

except dbus.exceptions.NameExistsException as e:

2531

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

3258

2532

use_dbus = False

3259

2533

server_settings["use_dbus"] = False

3260

2534

tcp_server.use_dbus = False

3261

if zeroconf:

3262

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

3268

if server_settings["interface"]:

3269

service.interface = if_nametoindex(

3270

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

3271

2535

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2536

service = AvahiServiceToSyslog(name =

2537

server_settings["servicename"],

2538

servicetype = "_mandos._tcp",

2539

protocol = protocol, bus = bus)

2540

if server_settings["interface"]:

2541

service.interface = (if_nametoindex

2542

(str(server_settings["interface"])))

2543

3272

2544

global multiprocessing_manager

3273

2545

multiprocessing_manager = multiprocessing.Manager()

3274

2546

3275

2547

client_class = Client

3276

2548

if use_dbus:

3277

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

3278

2549

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

2550

3279

2551

client_settings = Client.config_parser(client_config)

3280

2552

old_client_settings = {}

3281

2553

clients_data = {}

3282

2554

3283

2555

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

3284

2556

global wnull

3285

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

2557

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

3286

2558

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

3287

2559

# mode

3288

2560

if debug or not foreground:

3289

2561

wnull.close()

3290

2562

3291

2563

# Get client data and settings from last running state.

3292

2564

if server_settings["restore"]:

3293

2565

try:

3294

2566

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

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2567

clients_data, old_client_settings = (pickle.load

2568

(stored_state))

3345

2569

os.remove(stored_state_path)

3346

2570

except IOError as e:

3347

2571

if e.errno == errno.ENOENT:

3348

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

3349

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

2572

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

2573

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

3350

2574

else:

3351

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

3352

exc_info=e)

2575

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

2576

exc_info=e)

3353

2577

raise

3354

2578

except EOFError as e:

3355

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

3356

exc_info=e)

3357

2579

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

2580

"EOFError:", exc_info=e)

2581

3358

2582

with PGPEngine() as pgp:

3359

for client_name, client in clients_data.items():

2583

for client_name, client in clients_data.iteritems():

3360

2584

# Skip removed clients

3361

2585

if client_name not in client_settings:

3362

2586

continue

3363

2587

3364

2588

# Decide which value to use after restoring saved state.

3365

2589

# We have three different values: Old config file,

3366

2590

# new config file, and saved state.

3371

2595

# For each value in new config, check if it

3372

2596

# differs from the old config value (Except for

3373

2597

# the "secret" attribute)

3374

if (name != "secret"

3375

and (value !=

3376

old_client_settings[client_name][name])):

2598

if (name != "secret" and

2599

value != old_client_settings[client_name]

2600

[name]):

3377

2601

client[name] = value

3378

2602

except KeyError:

3379

2603

pass

3380

2604

3381

2605

# Clients who has passed its expire date can still be

3382

# enabled if its last checker was successful. A Client

2606

# enabled if its last checker was successful. Clients

3383

2607

# whose checker succeeded before we stored its state is

3384

2608

# assumed to have successfully run all checkers during

3385

2609

# downtime.

3386

2610

if client["enabled"]:

3387

2611

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

3388

2612

if not client["last_checked_ok"]:

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

2613

logger.warning(

2614

"disabling client {0} - Client never "

2615

"performed a successful checker"

2616

.format(client_name))

3392

2617

client["enabled"] = False

3393

2618

elif client["last_checker_status"] != 0:

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2619

logger.warning(

2620

"disabling client {0} - Client "

2621

"last checker failed with error code {1}"

2622

.format(client_name,

2623

client["last_checker_status"]))

3398

2624

client["enabled"] = False

3399

2625

else:

3400

client["expires"] = (

3401

datetime.datetime.utcnow()

3402

+ client["timeout"])

3403

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

3404

" enabled", client_name)

2626

client["expires"] = (datetime.datetime

2627

.utcnow()

2628

+ client["timeout"])

2629

logger.debug("Last checker succeeded,"

2630

" keeping {0} enabled"

2631

.format(client_name))

3405

2632

try:

3406

client["secret"] = pgp.decrypt(

3407

client["encrypted_secret"],

3408

client_settings[client_name]["secret"])

2633

client["secret"] = (

2634

pgp.decrypt(client["encrypted_secret"],

2635

client_settings[client_name]

2636

["secret"]))

3409

2637

except PGPError:

3410

2638

# If decryption fails, we use secret from new settings

3411

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

3412

client_name)

3413

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

3414

["secret"])

3415

2639

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

2640

.format(client_name))

2641

client["secret"] = (

2642

client_settings[client_name]["secret"])

2643

3416

2644

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

3417

2645

for client_name in (set(old_client_settings)

3418

2646

- set(client_settings)):

3420

2648

for client_name in (set(client_settings)

3421

2649

- set(old_client_settings)):

3422

2650

clients_data[client_name] = client_settings[client_name]

3423

2651

3424

2652

# Create all client objects

3425

for client_name, client in clients_data.items():

2653

for client_name, client in clients_data.iteritems():

3426

2654

tcp_server.clients[client_name] = client_class(

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2655

name = client_name, settings = client,

2656

server_settings = server_settings)

2657

3431

2658

if not tcp_server.clients:

3432

log.warning("No clients defined")

3433

2659

logger.warning("No clients defined")

2660

3434

2661

if not foreground:

3435

2662

if pidfile is not None:

3436

pid = os.getpid()

3437

2663

try:

3438

2664

with pidfile:

3439

print(pid, file=pidfile)

2665

pid = os.getpid()

2666

pidfile.write(str(pid) + "\n".encode("utf-8"))

3440

2667

except IOError:

3441

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

3442

pidfilename, pid)

2668

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

2669

pidfilename, pid)

3443

2670

del pidfile

3444

2671

del pidfilename

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2672

2673

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

2674

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

2675

3450

2676

if use_dbus:

3451

3452

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2677

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

2678

"se.bsnet.fukt.Mandos"})

2679

class MandosDBusService(DBusObjectWithProperties):

3455

2680

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

3456

3457

2681

def __init__(self):

3458

2682

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

3459

3460

2683

_interface = "se.recompile.Mandos"

3461

2684

2685

@dbus_interface_annotations(_interface)

2686

def _foo(self):

2687

return { "org.freedesktop.DBus.Property"

2688

".EmitsChangedSignal":

2689

"false"}

2690

3462

2691

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

3463

2692

def ClientAdded(self, objpath):

3464

2693

"D-Bus signal"

3465

2694

pass

3466

2695

3467

2696

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

3468

def ClientNotFound(self, key_id, address):

2697

def ClientNotFound(self, fingerprint, address):

3469

2698

"D-Bus signal"

3470

2699

pass

3471

3472

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

3473

"true"})

2700

3474

2701

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

3475

2702

def ClientRemoved(self, objpath, name):

3476

2703

"D-Bus signal"

3477

2704

pass

3478

3479

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

3480

"true"})

2705

3481

2706

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

3482

2707

def GetAllClients(self):

3483

2708

"D-Bus method"

3484

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2709

return dbus.Array(c.dbus_object_path

2710

for c in

2711

tcp_server.clients.itervalues())

2712

3489

2713

@dbus.service.method(_interface,

3490

2714

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

3491

2715

def GetAllClientsWithProperties(self):

3492

2716

"D-Bus method"

3493

2717

return dbus.Dictionary(

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2718

((c.dbus_object_path, c.GetAll(""))

2719

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

3497

2720

signature="oa{sv}")

3498

2721

3499

2722

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

3500

2723

def RemoveClient(self, object_path):

3501

2724

"D-Bus method"

3502

for c in tcp_server.clients.values():

2725

for c in tcp_server.clients.itervalues():

3503

2726

if c.dbus_object_path == object_path:

3504

2727

del tcp_server.clients[c.name]

3505

2728

c.remove_from_connection()

3506

# Don't signal the disabling

2729

# Don't signal anything except ClientRemoved

3507

2730

c.disable(quiet=True)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2731

# Emit D-Bus signal

2732

self.ClientRemoved(object_path, c.name)

3510

2733

return

3511

2734

raise KeyError(object_path)

3512

2735

3513

2736

del _interface

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2737

3551

2738

mandos_dbus_service = MandosDBusService()

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2739

3558

2740

def cleanup():

3559

2741

"Cleanup function; run on exit"

3560

if zeroconf:

3561

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

2742

service.cleanup()

2743

2744

multiprocessing.active_children()

2745

wnull.close()

3565

2746

if not (tcp_server.clients or client_settings):

3566

2747

return

3567

2748

3568

2749

# Store client before exiting. Secrets are encrypted with key

3569

2750

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

3570

2751

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

3571

2752

clients = {}

3572

2753

with PGPEngine() as pgp:

3573

for client in tcp_server.clients.values():

2754

for client in tcp_server.clients.itervalues():

3574

2755

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

3575

2756

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

3576

2757

key)

3577

2758

client_dict = {}

3578

2759

3579

2760

# A list of attributes that can not be pickled

3580

2761

# + secret.

3581

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

3582

"checker", "server_settings"}

3583

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

3584

.Object):

2762

exclude = set(("bus", "changedstate", "secret",

2763

"checker", "server_settings"))

2764

for name, typ in (inspect.getmembers

2765

(dbus.service.Object)):

3585

2766

exclude.add(name)

3586

2767

3587

2768

client_dict["encrypted_secret"] = (client

3588

2769

.encrypted_secret)

3589

2770

for attr in client.client_structure:

3590

2771

if attr not in exclude:

3591

2772

client_dict[attr] = getattr(client, attr)

3592

2773

3593

2774

clients[client.name] = client_dict

3594

2775

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

3595

2776

3596

2777

try:

3597

with tempfile.NamedTemporaryFile(

3598

mode="wb",

3599

suffix=".pickle",

3600

prefix="clients-",

3601

dir=os.path.dirname(stored_state_path),

3602

delete=False) as stored_state:

3603

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

3604

protocol=2)

3605

tempname = stored_state.name

2778

with (tempfile.NamedTemporaryFile

2779

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

2780

dir=os.path.dirname(stored_state_path),

2781

delete=False)) as stored_state:

2782

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

2783

tempname=stored_state.name

3606

2784

os.rename(tempname, stored_state_path)

3607

2785

except (IOError, OSError) as e:

3608

2786

if not debug:

3611

2789

except NameError:

3612

2790

pass

3613

2791

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

3614

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

3615

os.strerror(e.errno))

2792

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

2793

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

3616

2794

else:

3617

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

3618

exc_info=e)

2795

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

2796

exc_info=e)

3619

2797

raise

3620

2798

3621

2799

# Delete all clients, and settings from config

3622

2800

while tcp_server.clients:

3623

2801

name, client = tcp_server.clients.popitem()

3624

2802

if use_dbus:

3625

2803

client.remove_from_connection()

3626

# Don't signal the disabling

2804

# Don't signal anything except ClientRemoved

3627

2805

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

3629

2806

if use_dbus:

3630

mandos_dbus_service.client_removed_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientRemoved(client

2809

.dbus_object_path,

2810

client.name)

3631

2811

client_settings.clear()

3632

2812

3633

2813

atexit.register(cleanup)

3634

3635

for client in tcp_server.clients.values():

2814

2815

for client in tcp_server.clients.itervalues():

3636

2816

if use_dbus:

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2817

# Emit D-Bus signal

2818

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3639

2819

# Need to initiate checking of clients

3640

2820

if client.enabled:

3641

client.init_checker(randomize_start=True)

3642

2821

client.init_checker()

2822

3643

2823

tcp_server.enable()

3644

2824

tcp_server.server_activate()

3645

2825

3646

2826

# Find out what port we got

3647

if zeroconf:

3648

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

2827

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

3649

2828

if use_ipv6:

3650

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

3651

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

2829

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

2830

" flowinfo %d, scope_id %d",

2831

*tcp_server.socket.getsockname())

3652

2832

else: # IPv4

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

2833

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

2834

*tcp_server.socket.getsockname())

2835

2836

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

2837

3658

2838

try:

3659

if zeroconf:

3660

# From the Avahi example code

3661

try:

3662

service.activate()

3663

except dbus.exceptions.DBusException as error:

3664

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

3665

cleanup()

3666

sys.exit(1)

3667

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3674

3675

log.debug("Starting main loop")

2839

# From the Avahi example code

2840

try:

2841

service.activate()

2842

except dbus.exceptions.DBusException as error:

2843

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

2844

cleanup()

2845

sys.exit(1)

2846

# End of Avahi example code

2847

2848

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

2849

lambda *args, **kwargs:

2850

(tcp_server.handle_request

2851

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

2852

2853

logger.debug("Starting main loop")

3676

2854

main_loop.run()

3677

2855

except AvahiError as error:

3678

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

2856

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

3679

2857

cleanup()

3680

2858

sys.exit(1)

3681

2859

except KeyboardInterrupt:

3682

2860

if debug:

3683

2861

print("", file=sys.stderr)

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2862

logger.debug("Server received KeyboardInterrupt")

2863

logger.debug("Server exiting")

3686

2864

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

3687

2865

cleanup()

3688

2866

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

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

3782

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

3783

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

3784

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

3785

# End:

2867

if __name__ == '__main__':

2868

main()