/mandos/release : revision 237.7.854

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

39

import SocketServer as socketserver

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

40

51

import socket

41

import argparse

42

52

import datetime

43

53

import errno

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

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

52

58

import re

53

import os

54

59

import signal

55

60

import subprocess

56

61

import atexit

57

62

import stat

58

import logging

59

63

import logging.handlers

60

64

import pwd

61

65

import contextlib

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import random

81

import shlex

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

76

import avahi

85

import gi

86

from gi.repository import GLib

77

87

from dbus.mainloop.glib import DBusGMainLoop

78

88

import ctypes

79

89

import ctypes.util

80

90

import xml.dom.minidom

81

91

import inspect

82

92

83

try:

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.17"

92

147

stored_state_file = "clients.pickle"

93

148

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

149

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

150

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

151

syslogger = None

98

152

99

153

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

103

156

except (OSError, AttributeError):

157

104

158

def if_nametoindex(interface):

105

159

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

106

160

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

107

161

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

108

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

163

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

164

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

113

165

return interface_index

114

166

115

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

116

184

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

117

185

"""init logger and add loglevel"""

118

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

syslogger.setFormatter(logging.Formatter

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

124

196

if debug:

125

197

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

132

204

133

205

134

206

class PGPError(Exception):

136

208

pass

137

209

138

210

139

class PGPEngine(object):

211

class PGPEngine:

140

212

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

213

141

214

def __init__(self):

142

215

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

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

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

149

235

def __enter__(self):

150

236

return self

151

237

152

238

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

153

239

self._cleanup()

154

240

return False

155

241

156

242

def __del__(self):

157

243

self._cleanup()

158

244

159

245

def _cleanup(self):

160

246

if self.tempdir is not None:

161

247

# Delete contents of tempdir

162

248

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

163

topdown = False):

249

topdown=False):

164

250

for filename in files:

165

251

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

166

252

for dirname in dirs:

168

254

# Remove tempdir

169

255

os.rmdir(self.tempdir)

170

256

self.tempdir = None

171

257

172

258

def password_encode(self, password):

173

259

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

174

260

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

175

return b"mandos" + binascii.hexlify(password)

176

261

encoded = b"mandos" + binascii.hexlify(password)

262

if len(encoded) > 2048:

263

# GnuPG can't handle long passwords, so encode differently

264

encoded = (b"mandos" + password.replace(b"\\", b"\\\\")

265

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

266

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

267

return encoded

268

177

269

def encrypt(self, data, password):

178

270

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

181

273

passfile.write(passphrase)

182

274

passfile.flush()

183

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

184

'--passphrase-file',

275

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

276

"--passphrase-file",

185

277

passfile.name]

186

278

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

191

283

if proc.returncode != 0:

192

284

raise PGPError(err)

193

285

return ciphertext

194

286

195

287

def decrypt(self, data, password):

196

288

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

199

291

passfile.write(passphrase)

200

292

passfile.flush()

201

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

202

'--passphrase-file',

293

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

294

"--passphrase-file",

203

295

passfile.name]

204

296

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

210

301

if proc.returncode != 0:

211

302

raise PGPError(err)

212

303

return decrypted_plaintext

213

304

214

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

215

332

class AvahiError(Exception):

216

333

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

217

334

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

335

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

336

**kwargs)

337

221

338

222

339

class AvahiServiceError(AvahiError):

223

340

pass

224

341

342

225

343

class AvahiGroupError(AvahiError):

226

344

pass

227

345

228

346

229

class AvahiService(object):

347

class AvahiService:

230

348

"""An Avahi (Zeroconf) service.

231

349

232

350

Attributes:

233

351

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

234

352

Used to optionally bind to the specified interface.

235

236

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

353

354

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

237

355

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

238

356

port: integer; what port to announce

239

357

TXT: list of strings; TXT record for the service

246

364

server: D-Bus Server

247

365

bus: dbus.SystemBus()

248

366

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

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

254

379

self.interface = interface

255

380

self.name = name

256

381

self.type = servicetype

265

390

self.server = None

266

391

self.bus = bus

267

392

self.entry_group_state_changed_match = None

268

269

def rename(self):

393

394

def rename(self, remove=True):

270

395

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

271

396

if self.rename_count >= self.max_renames:

272

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

273

" after %i retries, exiting.",

274

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

275

400

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

278

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

279

self.name)

280

self.remove()

281

try:

282

self.add()

283

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

287

403

self.rename_count += 1

288

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

289

420

def remove(self):

290

421

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

291

422

if self.entry_group_state_changed_match is not None:

293

424

self.entry_group_state_changed_match = None

294

425

if self.group is not None:

295

426

self.group.Reset()

296

427

297

428

def add(self):

298

429

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

299

430

self.remove()

304

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

305

436

self.entry_group_state_changed_match = (

306

437

self.group.connect_to_signal(

307

'StateChanged', self.entry_group_state_changed))

308

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

309

self.name, self.type)

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

310

441

self.group.AddService(

311

442

self.interface,

312

443

self.protocol,

316

447

dbus.UInt16(self.port),

317

448

avahi.string_array_to_txt_array(self.TXT))

318

449

self.group.Commit()

319

450

320

451

def entry_group_state_changed(self, state, error):

321

452

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

322

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

323

453

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

454

324

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

326

457

elif state == avahi.ENTRY_GROUP_COLLISION:

327

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

458

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

328

459

self.rename()

329

460

elif state == avahi.ENTRY_GROUP_FAILURE:

330

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

331

unicode(error))

332

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

333

.format(error))

334

461

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

462

str(error))

463

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

464

335

465

def cleanup(self):

336

466

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

337

467

if self.group is not None:

342

472

pass

343

473

self.group = None

344

474

self.remove()

345

475

346

476

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

347

477

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

348

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

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

}

356

485

if state in bad_states:

357

486

if bad_states[state] is not None:

358

487

if error is None:

359

logger.error(bad_states[state])

488

log.error(bad_states[state])

360

489

else:

361

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

490

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

362

491

self.cleanup()

363

492

elif state == avahi.SERVER_RUNNING:

364

self.add()

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)

365

504

else:

366

505

if error is None:

367

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

506

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

368

507

else:

369

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

370

508

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

509

371

510

def activate(self):

372

511

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

373

512

if self.server is None:

377

516

follow_name_owner_changes=True),

378

517

avahi.DBUS_INTERFACE_SERVER)

379

518

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

519

self.server_state_changed)

381

520

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

382

521

383

522

384

523

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

524

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

386

525

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

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

392

531

return ret

393

532

394

533

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

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:

403

875

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

404

876

405

877

Attributes:

406

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

878

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

407

879

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

408

880

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

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

413

885

checker_command: string; External command which is run to check

414

886

if client lives. %() expansions are done at

415

887

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

416

888

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

417

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

418

890

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

419

891

client_structure: Object describing what attributes a client has

420

892

and is used for storing the client at exit

421

893

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

423

895

enabled: bool()

424

896

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

425

uniquely identify the client

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

426

900

host: string; available for use by the checker command

427

901

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

428

902

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

430

904

last_checker_status: integer between 0 and 255 reflecting exit

431

905

status of last checker. -1 reflects crashed

432

906

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

433

909

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

434

910

435

911

D-Bus identifiers

442

918

disabled, or None

443

919

server_settings: The server_settings dict from main()

444

920

"""

445

921

446

922

runtime_expansions = ("approval_delay", "approval_duration",

447

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

923

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

448

924

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

449

925

"last_approval_request", "last_checked_ok",

450

926

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

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

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

477

939

@staticmethod

478

940

def config_parser(config):

479

941

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

486

948

for client_name in config.sections():

487

949

section = dict(config.items(client_name))

488

950

client = settings[client_name] = {}

489

951

490

952

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

491

953

# Reformat values from string types to Python types

492

954

client["approved_by_default"] = config.getboolean(

493

955

client_name, "approved_by_default")

494

956

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

495

957

"enabled")

496

497

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

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

964

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

965

"").upper()

498

966

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

499

972

if "secret" in section:

500

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

973

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

974

.encode("utf-8"),

975

"base64")

501

976

elif "secfile" in section:

502

977

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

503

978

(section["secfile"])),

504

979

"rb") as secfile:

505

980

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

506

981

else:

507

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

982

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

508

983

.format(section))

509

984

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

510

985

client["extended_timeout"] = string_to_delta(

518

993

client["last_approval_request"] = None

519

994

client["last_checked_ok"] = None

520

995

client["last_checker_status"] = -2

521

996

522

997

return settings

523

524

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

998

999

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

525

1000

self.name = name

526

1001

if server_settings is None:

527

1002

server_settings = {}

528

1003

self.server_settings = server_settings

529

1004

# adding all client settings

530

for setting, value in settings.iteritems():

1005

for setting, value in settings.items():

531

1006

setattr(self, setting, value)

532

1007

533

1008

if self.enabled:

534

1009

if not hasattr(self, "last_enabled"):

535

1010

self.last_enabled = datetime.datetime.utcnow()

539

1014

else:

540

1015

self.last_enabled = None

541

1016

self.expires = None

542

543

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

547

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

1017

1018

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

1019

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

1020

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

548

1021

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

549

1022

datetime.datetime.utcnow())

550

1023

551

1024

# attributes specific for this server instance

552

1025

self.checker = None

553

1026

self.checker_initiator_tag = None

556

1029

self.current_checker_command = None

557

1030

self.approved = None

558

1031

self.approvals_pending = 0

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

1032

self.changedstate = multiprocessing_manager.Condition(

1033

multiprocessing_manager.Lock())

1034

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

564

1036

if not attr.startswith("_")]

565

1037

self.client_structure.append("client_structure")

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

1038

1039

for name, t in inspect.getmembers(

1040

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

571

1041

if not name.startswith("_"):

572

1042

self.client_structure.append(name)

573

1043

574

1044

# Send notice to process children that client state has changed

575

1045

def send_changedstate(self):

576

1046

with self.changedstate:

577

1047

self.changedstate.notify_all()

578

1048

579

1049

def enable(self):

580

1050

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

581

1051

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

582

1052

# Already enabled

583

1053

return

584

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

585

1054

self.enabled = True

586

1055

self.last_enabled = datetime.datetime.utcnow()

587

1056

self.init_checker()

588

1057

self.send_changedstate()

589

1058

590

1059

def disable(self, quiet=True):

591

1060

"""Disable this client."""

592

1061

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

593

1062

return False

594

1063

if not quiet:

595

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

1064

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

596

1065

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

597

gobject.source_remove(self.disable_initiator_tag)

1066

GLib.source_remove(self.disable_initiator_tag)

598

1067

self.disable_initiator_tag = None

599

1068

self.expires = None

600

1069

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

601

gobject.source_remove(self.checker_initiator_tag)

1070

GLib.source_remove(self.checker_initiator_tag)

602

1071

self.checker_initiator_tag = None

603

1072

self.stop_checker()

604

1073

self.enabled = False

605

1074

if not quiet:

606

1075

self.send_changedstate()

607

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

1076

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

608

1077

return False

609

1078

610

1079

def __del__(self):

611

1080

self.disable()

612

613

def init_checker(self):

614

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

615

# and every interval from then on.

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

616

1087

if self.checker_initiator_tag is not None:

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

621

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

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

622

1106

if self.disable_initiator_tag is not None:

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

627

# Also start a new checker *right now*.

628

self.start_checker()

629

630

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

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

631

1114

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

632

1120

self.checker_callback_tag = None

633

1121

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1122

1123

if returncode >= 0:

1124

self.last_checker_status = returncode

1125

self.last_checker_signal = None

636

1126

if self.last_checker_status == 0:

637

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

638

vars(self))

1127

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

639

1128

self.checked_ok()

640

1129

else:

641

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

642

vars(self))

1130

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

643

1131

else:

644

1132

self.last_checker_status = -1

645

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

646

vars(self))

647

1133

self.last_checker_signal = -returncode

1134

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

1135

return False

1136

648

1137

def checked_ok(self):

649

1138

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

650

1139

self.last_checked_ok = datetime.datetime.utcnow()

651

1140

self.last_checker_status = 0

1141

self.last_checker_signal = None

652

1142

self.bump_timeout()

653

1143

654

1144

def bump_timeout(self, timeout=None):

655

1145

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

656

1146

if timeout is None:

657

1147

timeout = self.timeout

658

1148

if self.disable_initiator_tag is not None:

659

gobject.source_remove(self.disable_initiator_tag)

1149

GLib.source_remove(self.disable_initiator_tag)

660

1150

self.disable_initiator_tag = None

661

1151

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1152

self.disable_initiator_tag = GLib.timeout_add(

1153

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

665

1154

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

666

1155

667

1156

def need_approval(self):

668

1157

self.last_approval_request = datetime.datetime.utcnow()

669

670

def start_checker(self):

1158

1159

def start_checker(self, start_was_randomized=False):

671

1160

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

672

1161

673

1162

If a checker already exists, leave it running and do

674

1163

nothing."""

675

1164

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

680

1169

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

681

1170

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

682

1171

# should be.

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

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

697

1177

# Start a new checker if needed

698

1178

if self.checker is None:

699

1179

# Escape attributes for the shell

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1180

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

704

1183

try:

705

1184

command = self.checker_command % escaped_attrs

706

1185

except TypeError as error:

707

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1186

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

1187

self.checker_command, exc_info=error)

1188

return True # Try again later

710

1189

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

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

753

1227

return True

754

1228

755

1229

def stop_checker(self):

756

1230

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

757

1231

if self.checker_callback_tag:

758

gobject.source_remove(self.checker_callback_tag)

1232

GLib.source_remove(self.checker_callback_tag)

759

1233

self.checker_callback_tag = None

760

1234

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

761

1235

return

762

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1236

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

1237

self.checker.terminate()

771

1238

self.checker = None

772

1239

773

1240

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1241

def dbus_service_property(dbus_interface,

1242

signature="v",

1243

access="readwrite",

1244

byte_arrays=False):

776

1245

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1246

become properties on the D-Bus.

778

1247

779

1248

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

780

1249

and with one argument by "Set".

781

1250

782

1251

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

783

1252

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

784

1253

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

787

1256

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

788

1257

if byte_arrays and signature != "ay":

789

1258

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

790

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

1259

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

1260

791

1261

def decorator(func):

792

1262

func._dbus_is_property = True

793

1263

func._dbus_interface = dbus_interface

796

1266

func._dbus_name = func.__name__

797

1267

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

798

1268

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

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

800

1270

return func

1271

801

1272

return decorator

802

1273

803

1274

804

1275

def dbus_interface_annotations(dbus_interface):

805

1276

"""Decorator for marking functions returning interface annotations

806

1277

807

1278

Usage:

808

1279

809

1280

@dbus_interface_annotations("org.example.Interface")

810

1281

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

811

1282

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

812

1283

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

813

1284

"false"}

814

1285

"""

1286

815

1287

def decorator(func):

816

1288

func._dbus_is_interface = True

817

1289

func._dbus_interface = dbus_interface

818

1290

func._dbus_name = dbus_interface

819

1291

return func

1292

820

1293

return decorator

821

1294

822

1295

823

1296

def dbus_annotations(annotations):

824

1297

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

825

1298

Usage:

826

1299

1300

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

1301

"org.freedesktop.DBus.Property."

1302

"EmitsChangedSignal": "false"})

827

1303

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

828

1304

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1305

def Property_dbus_property(self):

833

1306

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

834

1309

"""

1310

835

1311

def decorator(func):

836

1312

func._dbus_annotations = annotations

837

1313

return func

1314

838

1315

return decorator

839

1316

840

1317

841

1318

class DBusPropertyException(dbus.exceptions.DBusException):

842

1319

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

843

1320

"""

844

def __unicode__(self):

845

return unicode(str(self))

1321

pass

846

1322

847

1323

848

1324

class DBusPropertyAccessException(DBusPropertyException):

857

1333

pass

858

1334

859

1335

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

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.

866

1341

"""

867

1342

868

1343

@staticmethod

869

1344

def _is_dbus_thing(thing):

870

1345

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

871

1346

872

1347

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

873

1348

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

874

1349

"""

875

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

1350

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

876

1351

False)

877

1352

878

1353

def _get_all_dbus_things(self, thing):

879

1354

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

880

1355

"""

881

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

882

name),

1356

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

883

1357

athing.__get__(self))

884

1358

for cls in self.__class__.__mro__

885

1359

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

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

889

1433

def _get_dbus_property(self, interface_name, property_name):

890

1434

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

891

1435

property with the specified name and interface.

892

1436

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1437

for cls in self.__class__.__mro__:

1438

for name, value in inspect.getmembers(

1439

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

897

1440

if (value._dbus_name == property_name

898

1441

and value._dbus_interface == interface_name):

899

1442

return value.__get__(self)

900

1443

901

1444

# No such property

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

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

907

1459

out_signature="v")

908

1460

def Get(self, interface_name, property_name):

909

1461

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

915

1467

if not hasattr(value, "variant_level"):

916

1468

return value

917

1469

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

918

1470

919

1471

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

920

1472

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

921

1473

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

927

1479

# The byte_arrays option is not supported yet on

928

1480

# signatures other than "ay".

929

1481

if prop._dbus_signature != "ay":

930

raise ValueError

931

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

932

for byte in value))

1482

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

1483

"'ay' signature {!r}"

1484

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

933

1486

prop(value)

934

935

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

1487

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

in_signature="s",

936

1490

out_signature="a{sv}")

937

1491

def GetAll(self, interface_name):

938

1492

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

939

1493

standard.

940

1494

941

1495

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

942

1496

"""

943

1497

properties = {}

953

1507

if not hasattr(value, "variant_level"):

954

1508

properties[name] = value

955

1509

continue

956

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

957

value.variant_level+1)

1510

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

958

1512

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

959

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

960

1522

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1523

out_signature="s",

962

path_keyword='object_path',

963

connection_keyword='connection')

1524

path_keyword="object_path",

1525

connection_keyword="connection")

964

1526

def Introspect(self, object_path, connection):

965

1527

"""Overloading of standard D-Bus method.

966

1528

967

1529

Inserts property tags and interface annotation tags.

968

1530

"""

969

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

970

connection)

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

971

1534

try:

972

1535

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

1536

973

1537

def make_tag(document, name, prop):

974

1538

e = document.createElement("property")

975

1539

e.setAttribute("name", name)

976

1540

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

977

1541

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

978

1542

return e

1543

979

1544

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

980

1545

# Add property tags

981

1546

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

984

1549

if prop._dbus_interface

985

1550

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

986

1551

if_tag.appendChild(tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_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)

1018

1568

# Add the names to the return values for the

1019

1569

# "org.freedesktop.DBus.Properties" methods

1020

1570

if (if_tag.getAttribute("name")

1034

1584

document.unlink()

1035

1585

except (AttributeError, xml.dom.DOMException,

1036

1586

xml.parsers.expat.ExpatError) as error:

1037

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

1038

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

1039

1660

return xmlstring

1040

1661

1041

1662

1042

1663

def datetime_to_dbus(dt, variant_level=0):

1043

1664

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

1044

1665

if dt is None:

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1666

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

1667

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

1048

1668

1049

1669

1050

1670

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1052

1672

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

1053

1673

interface names according to the "alt_interface_names" mapping.

1054

1674

Usage:

1055

1675

1056

1676

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

1057

1677

"net.example.AlternateInterface"})

1058

1678

class SampleDBusObject(dbus.service.Object):

1059

1679

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

1060

1680

def SampleDBusMethod():

1061

1681

pass

1062

1682

1063

1683

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

1684

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

1065

1685

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

1066

1686

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

1067

1687

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

1068

1688

1069

1689

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

1070

1690

(from DBusObjectWithProperties) and interfaces (from the

1071

1691

dbus_interface_annotations decorator).

1072

1692

"""

1693

1073

1694

def wrapper(cls):

1074

1695

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1696

alt_interface_names.items()):

1076

1697

attr = {}

1077

1698

interface_names = set()

1078

1699

# Go though all attributes of the class

1080

1701

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

1081

1702

# with the wrong interface name

1082

1703

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1704

or not attribute._dbus_interface.startswith(

1705

orig_interface_name)):

1085

1706

continue

1086

1707

# Create an alternate D-Bus interface name based on

1087

1708

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1709

alt_interface = attribute._dbus_interface.replace(

1710

orig_interface_name, alt_interface_name)

1091

1711

interface_names.add(alt_interface)

1092

1712

# Is this a D-Bus signal?

1093

1713

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

1094

1714

# Extract the original non-method undecorated

1095

1715

# function by black magic

1096

nonmethod_func = (dict(

1716

if sys.version_info.major == 2:

1717

nonmethod_func = (dict(

1097

1718

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

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)

1100

1726

# Create a new, but exactly alike, function

1101

1727

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

1102

1728

# with the alternate D-Bus interface name

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1729

new_function = copy_function(nonmethod_func)

1730

new_function = (dbus.service.signal(

1731

alt_interface,

1732

attribute._dbus_signature)(new_function))

1112

1733

# Copy annotations, if any

1113

1734

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1735

new_function._dbus_annotations = dict(

1736

attribute._dbus_annotations)

1116

1737

except AttributeError:

1117

1738

pass

1739

1118

1740

# Define a creator of a function to call both the

1119

1741

# original and alternate functions, so both the

1120

1742

# original and alternate signals gets sent when

1123

1745

"""This function is a scope container to pass

1124

1746

func1 and func2 to the "call_both" function

1125

1747

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1126

1750

def call_both(*args, **kwargs):

1127

1751

"""This function will emit two D-Bus

1128

1752

signals by calling func1 and func2"""

1129

1753

func1(*args, **kwargs)

1130

1754

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

1131

1761

return call_both

1132

1762

# Create the "call_both" function and add it to

1133

1763

# the class

1138

1768

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

1139

1769

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

1140

1770

# to the class.

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1771

attr[attrname] = (

1772

dbus.service.method(

1773

alt_interface,

1774

attribute._dbus_in_signature,

1775

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1151

1777

# Copy annotations, if any

1152

1778

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1779

attr[attrname]._dbus_annotations = dict(

1780

attribute._dbus_annotations)

1155

1781

except AttributeError:

1156

1782

pass

1157

1783

# Is this a D-Bus property?

1160

1786

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

1161

1787

# property with the alternate D-Bus interface

1162

1788

# name. Add it to the class.

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

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

1176

1795

# Copy annotations, if any

1177

1796

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1797

attr[attrname]._dbus_annotations = dict(

1798

attribute._dbus_annotations)

1180

1799

except AttributeError:

1181

1800

pass

1182

1801

# Is this a D-Bus interface?

1185

1804

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

1186

1805

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

1187

1806

# to the class.

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1807

attr[attrname] = (

1808

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1196

1810

if deprecate:

1197

1811

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1199

1813

for interface_name in interface_names:

1814

1200

1815

@dbus_interface_annotations(interface_name)

1201

1816

def func(self):

1202

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

1203

"true" }

1817

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

1818

"true"}

1204

1819

# Find an unused name

1205

1820

for aname in (iname.format(i)

1206

1821

for i in itertools.count()):

1210

1825

if interface_names:

1211

1826

# Replace the class with a new subclass of it with

1212

1827

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1215

1834

return cls

1835

1216

1836

return wrapper

1217

1837

1218

1838

1219

1839

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

1220

"se.bsnet.fukt.Mandos"})

1840

"se.bsnet.fukt.Mandos"})

1221

1841

class ClientDBus(Client, DBusObjectWithProperties):

1222

1842

"""A Client class using D-Bus

1223

1843

1224

1844

Attributes:

1225

1845

dbus_object_path: dbus.ObjectPath

1226

1846

bus: dbus.SystemBus()

1227

1847

"""

1228

1848

1229

1849

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1231

1850

+ ("dbus_object_path", ))

1851

1852

_interface = "se.recompile.Mandos.Client"

1853

1232

1854

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

1233

1234

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

1855

1856

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

1235

1857

self.bus = bus

1236

1858

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

1237

1859

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

1238

1860

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1861

client_object_name = str(self.name).translate(

1240

1862

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

1241

1863

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1864

self.dbus_object_path = dbus.ObjectPath(

1865

"/clients/" + client_object_name)

1244

1866

DBusObjectWithProperties.__init__(self, self.bus,

1245

1867

self.dbus_object_path)

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

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

1250

1874

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

1251

1875

its changes to DBus.

1252

1876

1253

1877

transform_fun: Function that takes a value and a variant_level

1254

1878

and transforms it to a D-Bus type.

1255

1879

dbus_name: D-Bus name of the variable

1257

1881

to the D-Bus. Default: no transform

1258

1882

variant_level: D-Bus variant level. Default: 1

1259

1883

"""

1260

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

1884

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

1885

1261

1886

def setter(self, value):

1262

1887

if hasattr(self, "dbus_object_path"):

1263

1888

if (not hasattr(self, attrname) or

1264

1889

type_func(getattr(self, attrname, None))

1265

1890

!= type_func(value)):

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

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

1271

1906

setattr(self, attrname, value)

1272

1907

1273

1908

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

1274

1909

1275

1910

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1276

1911

approvals_pending = notifychangeproperty(dbus.Boolean,

1277

1912

"ApprovalPending",

1278

type_func = bool)

1913

type_func=bool)

1279

1914

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

1280

1915

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1916

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1917

checker = notifychangeproperty(

1918

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1285

1920

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1921

"LastCheckedOK")

1287

1922

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1925

datetime_to_dbus, "LastApprovalRequest")

1291

1926

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1927

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1928

approval_delay = notifychangeproperty(

1929

dbus.UInt64, "ApprovalDelay",

1930

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

1297

1931

approval_duration = notifychangeproperty(

1298

1932

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1933

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

1300

1934

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1935

timeout = notifychangeproperty(

1936

dbus.UInt64, "Timeout",

1937

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

1304

1938

extended_timeout = notifychangeproperty(

1305

1939

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

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)

1311

1944

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

1312

1945

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

1946

invalidate_only=True)

1947

1313

1948

del notifychangeproperty

1314

1949

1315

1950

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

1316

1951

try:

1317

1952

self.remove_from_connection()

1320

1955

if hasattr(DBusObjectWithProperties, "__del__"):

1321

1956

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

1322

1957

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

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

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:

1330

1966

# Emit D-Bus signal

1331

1967

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1333

1970

dbus.String(command))

1334

1971

else:

1335

1972

# Emit D-Bus signal

1336

1973

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

1337

dbus.Int64(condition),

1974

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1338

1978

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1342

1979

return ret

1980

1343

1981

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1982

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

1349

1983

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

1350

1984

# Only if new checker process was started

1351

1985

if (self.checker is not None

1353

1987

# Emit D-Bus signal

1354

1988

self.CheckerStarted(self.current_checker_command)

1355

1989

return r

1356

1990

1357

1991

def _reset_approved(self):

1358

1992

self.approved = None

1359

1993

return False

1360

1994

1361

1995

def approve(self, value=True):

1362

1996

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1997

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

1998

* 1000), self._reset_approved)

1366

1999

self.send_changedstate()

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1380

2007

# CheckerCompleted - signal

1381

2008

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

1382

2009

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

1383

2010

"D-Bus signal"

1384

2011

pass

1385

2012

1386

2013

# CheckerStarted - signal

1387

2014

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

1388

2015

def CheckerStarted(self, command):

1389

2016

"D-Bus signal"

1390

2017

pass

1391

2018

1392

2019

# PropertyChanged - signal

2020

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

1393

2021

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

1394

2022

def PropertyChanged(self, property, value):

1395

2023

"D-Bus signal"

1396

2024

pass

1397

2025

1398

2026

# GotSecret - signal

1399

2027

@dbus.service.signal(_interface)

1400

2028

def GotSecret(self):

1403

2031

server to mandos-client

1404

2032

"""

1405

2033

pass

1406

2034

1407

2035

# Rejected - signal

1408

2036

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

1409

2037

def Rejected(self, reason):

1410

2038

"D-Bus signal"

1411

2039

pass

1412

2040

1413

2041

# NeedApproval - signal

1414

2042

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

1415

2043

def NeedApproval(self, timeout, default):

1416

2044

"D-Bus signal"

1417

2045

return self.need_approval()

1418

1419

## Methods

1420

2046

2047

# Methods

2048

1421

2049

# Approve - method

1422

2050

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

1423

2051

def Approve(self, value):

1424

2052

self.approve(value)

1425

2053

1426

2054

# CheckedOK - method

1427

2055

@dbus.service.method(_interface)

1428

2056

def CheckedOK(self):

1429

2057

self.checked_ok()

1430

2058

1431

2059

# Enable - method

2060

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

1432

2061

@dbus.service.method(_interface)

1433

2062

def Enable(self):

1434

2063

"D-Bus method"

1435

2064

self.enable()

1436

2065

1437

2066

# StartChecker - method

2067

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

1438

2068

@dbus.service.method(_interface)

1439

2069

def StartChecker(self):

1440

2070

"D-Bus method"

1441

2071

self.start_checker()

1442

2072

1443

2073

# Disable - method

2074

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

1444

2075

@dbus.service.method(_interface)

1445

2076

def Disable(self):

1446

2077

"D-Bus method"

1447

2078

self.disable()

1448

2079

1449

2080

# StopChecker - method

2081

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

1450

2082

@dbus.service.method(_interface)

1451

2083

def StopChecker(self):

1452

2084

self.stop_checker()

1453

1454

## Properties

1455

2085

2086

# Properties

2087

1456

2088

# ApprovalPending - property

1457

2089

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

1458

2090

def ApprovalPending_dbus_property(self):

1459

2091

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

1460

2092

1461

2093

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

2094

@dbus_service_property(_interface,

2095

signature="b",

1463

2096

access="readwrite")

1464

2097

def ApprovedByDefault_dbus_property(self, value=None):

1465

2098

if value is None: # get

1466

2099

return dbus.Boolean(self.approved_by_default)

1467

2100

self.approved_by_default = bool(value)

1468

2101

1469

2102

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1471

2105

access="readwrite")

1472

2106

def ApprovalDelay_dbus_property(self, value=None):

1473

2107

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2108

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

2109

* 1000)

1475

2110

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

1476

2111

1477

2112

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

2113

@dbus_service_property(_interface,

2114

signature="t",

1479

2115

access="readwrite")

1480

2116

def ApprovalDuration_dbus_property(self, value=None):

1481

2117

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2118

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

2119

* 1000)

1484

2120

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

1485

2121

1486

2122

# Name - property

2123

@dbus_annotations(

2124

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

1487

2125

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

1488

2126

def Name_dbus_property(self):

1489

2127

return dbus.String(self.name)

1490

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

1491

2136

# Fingerprint - property

2137

@dbus_annotations(

2138

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

1492

2139

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

1493

2140

def Fingerprint_dbus_property(self):

1494

2141

return dbus.String(self.fingerprint)

1495

2142

1496

2143

# Host - property

1497

@dbus_service_property(_interface, signature="s",

2144

@dbus_service_property(_interface,

2145

signature="s",

1498

2146

access="readwrite")

1499

2147

def Host_dbus_property(self, value=None):

1500

2148

if value is None: # get

1501

2149

return dbus.String(self.host)

1502

self.host = unicode(value)

1503

2150

self.host = str(value)

2151

1504

2152

# Created - property

2153

@dbus_annotations(

2154

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

1505

2155

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

1506

2156

def Created_dbus_property(self):

1507

2157

return datetime_to_dbus(self.created)

1508

2158

1509

2159

# LastEnabled - property

1510

2160

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

1511

2161

def LastEnabled_dbus_property(self):

1512

2162

return datetime_to_dbus(self.last_enabled)

1513

2163

1514

2164

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

2165

@dbus_service_property(_interface,

2166

signature="b",

1516

2167

access="readwrite")

1517

2168

def Enabled_dbus_property(self, value=None):

1518

2169

if value is None: # get

1521

2172

self.enable()

1522

2173

else:

1523

2174

self.disable()

1524

2175

1525

2176

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

2177

@dbus_service_property(_interface,

2178

signature="s",

1527

2179

access="readwrite")

1528

2180

def LastCheckedOK_dbus_property(self, value=None):

1529

2181

if value is not None:

1530

2182

self.checked_ok()

1531

2183

return

1532

2184

return datetime_to_dbus(self.last_checked_ok)

1533

2185

1534

2186

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2187

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

1537

2188

def LastCheckerStatus_dbus_property(self):

1538

2189

return dbus.Int16(self.last_checker_status)

1539

2190

1540

2191

# Expires - property

1541

2192

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

1542

2193

def Expires_dbus_property(self):

1543

2194

return datetime_to_dbus(self.expires)

1544

2195

1545

2196

# LastApprovalRequest - property

1546

2197

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

1547

2198

def LastApprovalRequest_dbus_property(self):

1548

2199

return datetime_to_dbus(self.last_approval_request)

1549

2200

1550

2201

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

2202

@dbus_service_property(_interface,

2203

signature="t",

1552

2204

access="readwrite")

1553

2205

def Timeout_dbus_property(self, value=None):

1554

2206

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

2207

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

1556

2208

old_timeout = self.timeout

1557

2209

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

1558

2210

# Reschedule disabling

1566

2218

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

1567

2219

is None):

1568

2220

return

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

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

1575

2226

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2227

@dbus_service_property(_interface,

2228

signature="t",

1577

2229

access="readwrite")

1578

2230

def ExtendedTimeout_dbus_property(self, value=None):

1579

2231

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2232

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

2233

* 1000)

1581

2234

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

1582

2235

1583

2236

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2237

@dbus_service_property(_interface,

2238

signature="t",

1585

2239

access="readwrite")

1586

2240

def Interval_dbus_property(self, value=None):

1587

2241

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2242

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

1589

2243

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

1590

2244

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

1591

2245

return

1592

2246

if self.enabled:

1593

2247

# Reschedule checker run

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

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

1599

2253

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2254

@dbus_service_property(_interface,

2255

signature="s",

1601

2256

access="readwrite")

1602

2257

def Checker_dbus_property(self, value=None):

1603

2258

if value is None: # get

1604

2259

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

1606

2260

self.checker_command = str(value)

2261

1607

2262

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2263

@dbus_service_property(_interface,

2264

signature="b",

1609

2265

access="readwrite")

1610

2266

def CheckerRunning_dbus_property(self, value=None):

1611

2267

if value is None: # get

1614

2270

self.start_checker()

1615

2271

else:

1616

2272

self.stop_checker()

1617

2273

1618

2274

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

1619

2278

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

1620

2279

def ObjectPath_dbus_property(self):

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1623

2282

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

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)

1626

2290

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

1628

2291

self.secret = bytes(value)

2292

1629

2293

del _interface

1630

2294

1631

2295

1632

class ProxyClient(object):

1633

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

2296

class ProxyClient:

2297

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

1634

2298

self._pipe = child_pipe

1635

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

2299

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

1636

2300

if not self._pipe.recv():

1637

raise KeyError()

1638

2301

raise KeyError(key_id or fpr)

2302

1639

2303

def __getattribute__(self, name):

1640

if name == '_pipe':

2304

if name == "_pipe":

1641

2305

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

1642

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

2306

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

1643

2307

data = self._pipe.recv()

1644

if data[0] == 'data':

2308

if data[0] == "data":

1645

2309

return data[1]

1646

if data[0] == 'function':

2310

if data[0] == "function":

2311

1647

2312

def func(*args, **kwargs):

1648

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

2313

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

1649

2314

return self._pipe.recv()[1]

2315

1650

2316

return func

1651

2317

1652

2318

def __setattr__(self, name, value):

1653

if name == '_pipe':

2319

if name == "_pipe":

1654

2320

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

1655

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

2321

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

1656

2322

1657

2323

1658

2324

class ClientHandler(socketserver.BaseRequestHandler, object):

1659

2325

"""A class to handle client connections.

1660

2326

1661

2327

Instantiated once for each connection to handle it.

1662

2328

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

1663

2329

1664

2330

def handle(self):

1665

2331

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

1666

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

1667

unicode(self.client_address))

1668

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

1669

self.server.child_pipe.fileno())

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

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

1685

2342

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

1686

2343

priority = self.server.gnutls_priority

1687

2344

if priority is None:

1688

2345

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2346

gnutls.priority_set_direct(session,

2347

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

2348

1693

2349

# Start communication using the Mandos protocol

1694

2350

# Get protocol number

1695

2351

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

1696

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

2352

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

1697

2353

try:

1698

2354

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

1699

raise RuntimeError

2355

raise RuntimeError(line)

1700

2356

except (ValueError, IndexError, RuntimeError) as error:

1701

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

2357

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

1702

2358

return

1703

2359

1704

2360

# Start GnuTLS connection

1705

2361

try:

1706

2362

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

1708

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

2363

except gnutls.Error as error:

2364

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

1709

2365

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

1710

2366

# established. Just abandon the request.

1711

2367

return

1712

logger.debug("Handshake succeeded")

1713

2368

log.debug("Handshake succeeded")

2369

1714

2370

approval_required = False

1715

2371

try:

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1727

2396

self.client_address)

1728

2397

except KeyError:

1729

2398

return

1730

2399

1731

2400

if client.approval_delay:

1732

2401

delay = client.approval_delay

1733

2402

client.approvals_pending += 1

1734

2403

approval_required = True

1735

2404

1736

2405

while True:

1737

2406

if not client.enabled:

1738

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

1739

client.name)

2407

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

1740

2408

if self.server.use_dbus:

1741

2409

# Emit D-Bus signal

1742

2410

client.Rejected("Disabled")

1743

2411

return

1744

2412

1745

2413

if client.approved or not client.approval_delay:

1746

#We are approved or approval is disabled

2414

# We are approved or approval is disabled

1747

2415

break

1748

2416

elif client.approved is None:

1749

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

2417

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

2418

client.name)

2419

if self.server.use_dbus:

2420

# Emit D-Bus signal

2421

client.NeedApproval(

2422

client.approval_delay.total_seconds()

2423

* 1000, client.approved_by_default)

2424

else:

2425

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

1750

2426

client.name)

1751

2427

if self.server.use_dbus:

1752

2428

# Emit D-Bus signal

1753

client.NeedApproval(

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

1756

else:

1757

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

1758

client.name)

1759

if self.server.use_dbus:

1760

# Emit D-Bus signal

1761

2429

client.Rejected("Denied")

1762

2430

return

1763

1764

#wait until timeout or approved

2431

2432

# wait until timeout or approved

1765

2433

time = datetime.datetime.now()

1766

2434

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2435

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

1770

2436

client.changedstate.release()

1771

2437

time2 = datetime.datetime.now()

1772

2438

if (time2 - time) >= delay:

1773

2439

if not client.approved_by_default:

1774

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

1775

" waiting for approval",

1776

client.name)

2440

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

2441

" waiting for approval",

2442

client.name)

1777

2443

if self.server.use_dbus:

1778

2444

# Emit D-Bus signal

1779

2445

client.Rejected("Approval timed out")

1782

2448

break

1783

2449

else:

1784

2450

delay -= time2 - time

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

1799

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

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

1800

2459

# bump the timeout using extended_timeout

1801

2460

client.bump_timeout(client.extended_timeout)

1802

2461

if self.server.use_dbus:

1803

2462

# Emit D-Bus signal

1804

2463

client.GotSecret()

1805

2464

1806

2465

finally:

1807

2466

if approval_required:

1808

2467

client.approvals_pending -= 1

1809

2468

try:

1810

2469

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

1812

logger.warning("GnuTLS bye failed",

1813

exc_info=error)

1814

2470

except gnutls.Error as error:

2471

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

2472

1815

2473

@staticmethod

1816

2474

def peer_certificate(session):

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

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

1824

2491

list_size = ctypes.c_uint(1)

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

1827

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

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1828

2494

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

1829

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

1830

" certificate")

2495

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

1831

2496

if list_size.value == 0:

1832

2497

return None

1833

2498

cert = cert_list[0]

1834

2499

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

1835

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

1836

2536

@staticmethod

1837

2537

def fingerprint(openpgp):

1838

2538

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2539

# New GnuTLS "datum" with the OpenPGP public key

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

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

1845

2544

# New empty GnuTLS certificate

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2547

# Import the OpenPGP public key into the certificate

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1854

2550

# Verify the self signature in the key

1855

2551

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1859

2554

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1863

2558

# New buffer for the fingerprint

1864

2559

buf = ctypes.create_string_buffer(20)

1865

2560

buf_len = ctypes.c_size_t()

1866

2561

# Get the fingerprint from the certificate into the buffer

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2562

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

2563

ctypes.byref(buf_len))

1870

2564

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2565

gnutls.openpgp_crt_deinit(crt)

1872

2566

# Convert the buffer to a Python bytestring

1873

2567

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

1874

2568

# Convert the bytestring to hexadecimal notation

1876

2570

return hex_fpr

1877

2571

1878

2572

1879

class MultiprocessingMixIn(object):

2573

class MultiprocessingMixIn:

1880

2574

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

2575

1881

2576

def sub_process_main(self, request, address):

1882

2577

try:

1883

2578

self.finish_request(request, address)

1884

2579

except Exception:

1885

2580

self.handle_error(request, address)

1886

2581

self.close_request(request)

1887

2582

1888

2583

def process_request(self, request, address):

1889

2584

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

1890

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

1891

args = (request, address))

2585

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

2586

args=(request, address))

1892

2587

proc.start()

1893

2588

return proc

1894

2589

1895

2590

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1897

2592

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

2593

1898

2594

def process_request(self, request, client_address):

1899

2595

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

1900

2596

1901

2597

This function creates a new pipe in self.pipe

1902

2598

"""

1903

2599

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1904

2600

1905

2601

proc = MultiprocessingMixIn.process_request(self, request,

1906

2602

client_address)

1907

2603

self.child_pipe.close()

1908

2604

self.add_pipe(parent_pipe, proc)

1909

2605

1910

2606

def add_pipe(self, parent_pipe, proc):

1911

2607

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

1912

raise NotImplementedError

2608

raise NotImplementedError()

1913

2609

1914

2610

1915

2611

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1916

socketserver.TCPServer, object):

1917

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

1918

2612

socketserver.TCPServer):

2613

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

2614

1919

2615

Attributes:

1920

2616

enabled: Boolean; whether this server is activated yet

1921

2617

interface: None or a network interface name (string)

1922

2618

use_ipv6: Boolean; to use IPv6 or not

1923

2619

"""

2620

1924

2621

def __init__(self, server_address, RequestHandlerClass,

1925

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

2622

interface=None,

2623

use_ipv6=True,

2624

socketfd=None):

1926

2625

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

1927

2626

creating a new one with socket.socket().

1928

2627

"""

1934

2633

self.socketfd = socketfd

1935

2634

# Save the original socket.socket() function

1936

2635

self.socket_socket = socket.socket

2636

1937

2637

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

1938

#

2638

#

1939

2639

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

1940

2640

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

1941

2641

# patching socket.socket.)

1942

#

2642

#

1943

2643

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

1944

2644

@functools.wraps(socket.socket)

1945

2645

def socket_wrapper(*args, **kwargs):

1957

2657

# socket_wrapper(), if socketfd was set.

1958

2658

socketserver.TCPServer.__init__(self, server_address,

1959

2659

RequestHandlerClass)

1960

2660

1961

2661

def server_bind(self):

1962

2662

"""This overrides the normal server_bind() function

1963

2663

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

1964

2664

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

2665

global SO_BINDTODEVICE

1965

2666

if self.interface is not None:

1966

2667

if SO_BINDTODEVICE is None:

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

1988

2688

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

1989

2689

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

1990

2692

if not self.server_address[0]:

1991

2693

if self.address_family == socket.AF_INET6:

1992

any_address = "::" # in6addr_any

2694

any_address = "::" # in6addr_any

1993

2695

else:

1994

any_address = "0.0.0.0" # INADDR_ANY

2696

any_address = "0.0.0.0" # INADDR_ANY

1995

2697

self.server_address = (any_address,

1996

2698

self.server_address[1])

1997

2699

elif not self.server_address[1]:

1998

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

1999

0)

2700

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

2000

2701

# if self.interface:

2001

2702

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

2002

2703

# 0, # port

2008

2709

2009

2710

class MandosServer(IPv6_TCPServer):

2010

2711

"""Mandos server.

2011

2712

2012

2713

Attributes:

2013

2714

clients: set of Client objects

2014

2715

gnutls_priority GnuTLS priority string

2015

2716

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

2016

2017

Assumes a gobject.MainLoop event loop.

2717

2718

Assumes a GLib.MainLoop event loop.

2018

2719

"""

2720

2019

2721

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

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

2722

interface=None,

2723

use_ipv6=True,

2724

clients=None,

2725

gnutls_priority=None,

2726

use_dbus=True,

2727

socketfd=None):

2022

2728

self.enabled = False

2023

2729

self.clients = clients

2024

2730

if self.clients is None:

2027

2733

self.gnutls_priority = gnutls_priority

2028

2734

IPv6_TCPServer.__init__(self, server_address,

2029

2735

RequestHandlerClass,

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2033

2740

def server_activate(self):

2034

2741

if self.enabled:

2035

2742

return socketserver.TCPServer.server_activate(self)

2036

2743

2037

2744

def enable(self):

2038

2745

self.enabled = True

2039

2746

2040

2747

def add_pipe(self, parent_pipe, proc):

2041

2748

# Call "handle_ipc" for both data and EOF events

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

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

2051

2760

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

2052

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

2761

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

2053

2762

# Wait for other process to exit

2054

2763

proc.join()

2055

2764

return False

2056

2765

2057

2766

# Read a request from the child

2058

2767

request = parent_pipe.recv()

2059

2768

command = request[0]

2060

2061

if command == 'init':

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2067

2783

client = c

2068

2784

break

2069

2785

else:

2070

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

2071

"dress: %s", fpr, address)

2786

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

2787

" %s", key_id or fpr, address)

2072

2788

if self.use_dbus:

2073

2789

# Emit D-Bus signal

2074

mandos_dbus_service.ClientNotFound(fpr,

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2075

2791

address[0])

2076

2792

parent_pipe.send(False)

2077

2793

return False

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

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

2087

2802

parent_pipe.send(True)

2088

2803

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

2089

2804

# same fileno

2090

2805

return False

2091

if command == 'funcall':

2806

if command == "funcall":

2092

2807

funcname = request[1]

2093

2808

args = request[2]

2094

2809

kwargs = request[3]

2095

2096

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

2810

2811

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

2097

2812

funcname)(*args,

2098

**kwargs)))

2099

2100

if command == 'getattr':

2813

**kwargs)))

2814

2815

if command == "getattr":

2101

2816

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2817

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2104

2820

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2108

if command == 'setattr':

2821

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2109

2825

attrname = request[1]

2110

2826

value = request[2]

2111

2827

setattr(client_object, attrname, value)

2112

2828

2113

2829

return True

2114

2830

2115

2831

2116

2832

def rfc3339_duration_to_delta(duration):

2117

2833

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

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2133

2851

"""

2134

2852

2135

2853

# Parsing an RFC 3339 duration with regular expressions is not

2136

2854

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

2137

2855

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

2138

2856

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

2139

2857

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

2140

2858

# avoid excessive use of external libraries.

2141

2859

2142

2860

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

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

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

2152

2866

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

2153

2867

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

2154

2868

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

2155

2869

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

2156

2870

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2871

frozenset((token_end, )))

2158

2872

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

2159

2873

datetime.timedelta(minutes=1),

2160

2874

frozenset((token_second, token_end)))

2176

2890

frozenset((token_month, token_end)))

2177

2891

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

2178

2892

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2893

frozenset((token_end, )))

2180

2894

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

2181

2895

frozenset((token_year, token_month,

2182

2896

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2897

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2186

2901

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2189

2906

# Loop until end token is found

2190

2907

while found_token is not token_end:

2191

2908

# Search for any currently valid tokens

2207

2924

break

2208

2925

else:

2209

2926

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2927

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

2928

.format(duration))

2211

2929

# End token found

2212

2930

return value

2213

2931

2214

2932

2215

2933

def string_to_delta(interval):

2216

2934

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

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2230

2948

"""

2231

2949

2232

2950

try:

2233

2951

return rfc3339_duration_to_delta(interval)

2234

2952

except ValueError:

2235

2953

pass

2236

2954

2237

2955

timevalue = datetime.timedelta(0)

2238

2956

for s in interval.split():

2239

2957

try:

2240

suffix = unicode(s[-1])

2958

suffix = s[-1]

2241

2959

value = int(s[:-1])

2242

2960

if suffix == "d":

2243

2961

delta = datetime.timedelta(value)

2250

2968

elif suffix == "w":

2251

2969

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

2252

2970

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2971

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

2972

except IndexError as e:

2256

2973

raise ValueError(*(e.args))

2257

2974

timevalue += delta

2258

2975

return timevalue

2259

2976

2260

2977

2261

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

2978

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

2262

2979

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

2263

2980

2264

2981

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

2265

2982

if os.fork():

2266

2983

sys.exit()

2274

2991

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

2275

2992

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

2276

2993

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2994

"{} not a character device"

2278

2995

.format(os.devnull))

2279

2996

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

2280

2997

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

2284

3001

2285

3002

2286

3003

def main():

2287

3004

2288

3005

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

2289

3006

# Parsing of options, both command line and config file

2290

3007

2291

3008

parser = argparse.ArgumentParser()

2292

3009

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

2293

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

3010

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

2294

3011

help="show version number and exit")

2295

3012

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

2296

3013

help="Bind to interface IF")

2329

3046

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

2330

3047

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

2331

3048

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

2332

3049

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

3050

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

3051

default=None)

3052

2333

3053

options = parser.parse_args()

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

3054

2340

3055

# Default values for config file for server-global settings

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

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

2357

3079

# Parse config file for server-global settings

2358

server_config = configparser.SafeConfigParser(server_defaults)

3080

server_config = configparser.ConfigParser(server_defaults)

2359

3081

del server_defaults

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3082

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

3083

# Convert the ConfigParser object to a dict

2363

3084

server_settings = server_config.defaults()

2364

3085

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

2365

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

3086

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

3087

"foreground", "zeroconf"):

2366

3088

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

2367

3089

option)

2368

3090

if server_settings["port"]:

2378

3100

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

2379

3101

["socket"])

2380

3102

del server_config

2381

3103

2382

3104

# Override the settings from the config file with command line

2383

3105

# options, if set.

2384

3106

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

2385

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

2386

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

2387

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

3107

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

3108

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

3109

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

2388

3110

value = getattr(options, option)

2389

3111

if value is not None:

2390

3112

server_settings[option] = value

2391

3113

del options

2392

3114

# Force all strings to be unicode

2393

3115

for option in server_settings.keys():

2394

if type(server_settings[option]) is str:

2395

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

3116

if isinstance(server_settings[option], bytes):

3117

server_settings[option] = (server_settings[option]

3118

.decode("utf-8"))

2396

3119

# Force all boolean options to be boolean

2397

3120

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

2398

"foreground"):

3121

"foreground", "zeroconf"):

2399

3122

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

2400

3123

# Debug implies foreground

2401

3124

if server_settings["debug"]:

2402

3125

server_settings["foreground"] = True

2403

3126

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

2404

3127

2405

3128

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

2406

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

2407

3135

# For convenience

2408

3136

debug = server_settings["debug"]

2409

3137

debuglevel = server_settings["debuglevel"]

2412

3140

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

2413

3141

stored_state_file)

2414

3142

foreground = server_settings["foreground"]

2415

3143

zeroconf = server_settings["zeroconf"]

3144

2416

3145

if debug:

2417

3146

initlogger(debug, logging.DEBUG)

2418

3147

else:

2421

3150

else:

2422

3151

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

2423

3152

initlogger(debug, level)

2424

3153

2425

3154

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

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3155

syslogger.setFormatter(

3156

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

3157

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

3158

server_settings["servicename"])))

3159

2432

3160

# Parse config file with clients

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2435

3162

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

2436

3163

"clients.conf"))

2437

3164

2438

3165

global mandos_dbus_service

2439

3166

mandos_dbus_service = None

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

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

2452

3179

if not foreground:

2453

3180

pidfilename = "/run/mandos.pid"

3181

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

3182

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

2454

3183

pidfile = None

2455

3184

try:

2456

pidfile = open(pidfilename, "w")

3185

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

2457

3186

except IOError as e:

2458

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

2459

exc_info=e)

2460

2461

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

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2462

3193

try:

2463

3194

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

3195

gid = pwd.getpwnam(group).pw_gid

2465

3196

break

2466

3197

except KeyError:

2467

3198

continue

2471

3202

try:

2472

3203

os.setgid(gid)

2473

3204

os.setuid(uid)

3205

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

2474

3206

except OSError as error:

3207

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

3208

os.strerror(error.errno))

2475

3209

if error.errno != errno.EPERM:

2476

raise error

2477

3210

raise

3211

2478

3212

if debug:

2479

3213

# Enable all possible GnuTLS debugging

2480

3214

2481

3215

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

2482

3216

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2486

3220

def debug_gnutls(level, string):

2487

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2492

3226

# Redirect stdin so all checkers get /dev/null

2493

3227

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

2494

3228

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

2495

3229

if null > 2:

2496

3230

os.close(null)

2497

3231

2498

3232

# Need to fork before connecting to D-Bus

2499

3233

if not foreground:

2500

3234

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

2501

3235

daemon()

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

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

2507

3242

global main_loop

2508

3243

# From the Avahi example code

2509

3244

DBusGMainLoop(set_as_default=True)

2510

main_loop = gobject.MainLoop()

2511

bus = dbus.SystemBus()

3245

main_loop = GLib.MainLoop()

3246

if use_dbus or zeroconf:

3247

bus = dbus.SystemBus()

2512

3248

# End of Avahi example code

2513

3249

if use_dbus:

2514

3250

try:

2515

3251

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

2521

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

3252

bus,

3253

do_not_queue=True)

3254

old_bus_name = dbus.service.BusName(

3255

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

3256

do_not_queue=True)

3257

except dbus.exceptions.DBusException as e:

3258

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

2522

3259

use_dbus = False

2523

3260

server_settings["use_dbus"] = False

2524

3261

tcp_server.use_dbus = False

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3262

if zeroconf:

3263

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3264

service = AvahiServiceToSyslog(

3265

name=server_settings["servicename"],

3266

servicetype="_mandos._tcp",

3267

protocol=protocol,

3268

bus=bus)

3269

if server_settings["interface"]:

3270

service.interface = if_nametoindex(

3271

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

3272

2534

3273

global multiprocessing_manager

2535

3274

multiprocessing_manager = multiprocessing.Manager()

2536

3275

2537

3276

client_class = Client

2538

3277

if use_dbus:

2539

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

2540

3278

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

3279

2541

3280

client_settings = Client.config_parser(client_config)

2542

3281

old_client_settings = {}

2543

3282

clients_data = {}

2544

3283

2545

3284

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

2546

3285

global wnull

2547

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

3286

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

2548

3287

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

2549

3288

# mode

2550

3289

if debug or not foreground:

2551

3290

wnull.close()

2552

3291

2553

3292

# Get client data and settings from last running state.

2554

3293

if server_settings["restore"]:

2555

3294

try:

2556

3295

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

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3296

if sys.version_info.major == 2:

3297

clients_data, old_client_settings = pickle.load(

3298

stored_state)

3299

else:

3300

bytes_clients_data, bytes_old_client_settings = (

3301

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

3302

# Fix bytes to strings

3303

# clients_data

3304

# .keys()

3305

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

3306

if isinstance(key, bytes)

3307

else key): value

3308

for key, value in

3309

bytes_clients_data.items()}

3310

del bytes_clients_data

3311

for key in clients_data:

3312

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

3313

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

3314

for k, v in

3315

clients_data[key].items()}

3316

clients_data[key] = value

3317

# .client_structure

3318

value["client_structure"] = [

3319

(s.decode("utf-8")

3320

if isinstance(s, bytes)

3321

else s) for s in

3322

value["client_structure"]]

3323

# .name, .host, and .checker_command

3324

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

3325

if isinstance(value[k], bytes):

3326

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

3327

if "key_id" not in value:

3328

value["key_id"] = ""

3329

elif "fingerprint" not in value:

3330

value["fingerprint"] = ""

3331

# old_client_settings

3332

# .keys()

3333

old_client_settings = {

3334

(key.decode("utf-8")

3335

if isinstance(key, bytes)

3336

else key): value

3337

for key, value in

3338

bytes_old_client_settings.items()}

3339

del bytes_old_client_settings

3340

# .host and .checker_command

3341

for value in old_client_settings.values():

3342

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

3343

if isinstance(value[attribute], bytes):

3344

value[attribute] = (value[attribute]

3345

.decode("utf-8"))

2559

3346

os.remove(stored_state_path)

2560

3347

except IOError as e:

2561

3348

if e.errno == errno.ENOENT:

2562

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

2563

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

3349

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

3350

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

2564

3351

else:

2565

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

2566

exc_info=e)

3352

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

3353

exc_info=e)

2567

3354

raise

2568

3355

except EOFError as e:

2569

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

2570

"EOFError:", exc_info=e)

2571

3356

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

3357

exc_info=e)

3358

2572

3359

with PGPEngine() as pgp:

2573

for client_name, client in clients_data.iteritems():

3360

for client_name, client in clients_data.items():

2574

3361

# Skip removed clients

2575

3362

if client_name not in client_settings:

2576

3363

continue

2577

3364

2578

3365

# Decide which value to use after restoring saved state.

2579

3366

# We have three different values: Old config file,

2580

3367

# new config file, and saved state.

2585

3372

# For each value in new config, check if it

2586

3373

# differs from the old config value (Except for

2587

3374

# the "secret" attribute)

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3375

if (name != "secret"

3376

and (value !=

3377

old_client_settings[client_name][name])):

2591

3378

client[name] = value

2592

3379

except KeyError:

2593

3380

pass

2594

3381

2595

3382

# Clients who has passed its expire date can still be

2596

# enabled if its last checker was successful. Clients

3383

# enabled if its last checker was successful. A Client

2597

3384

# whose checker succeeded before we stored its state is

2598

3385

# assumed to have successfully run all checkers during

2599

3386

# downtime.

2600

3387

if client["enabled"]:

2601

3388

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

2602

3389

if not client["last_checked_ok"]:

2603

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3390

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

3391

" never performed a successful"

3392

" checker", client_name)

2607

3393

client["enabled"] = False

2608

3394

elif client["last_checker_status"] != 0:

2609

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3395

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

3396

" last checker failed with error"

3397

" code %s", client_name,

3398

client["last_checker_status"])

2614

3399

client["enabled"] = False

2615

3400

else:

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

2619

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3401

client["expires"] = (

3402

datetime.datetime.utcnow()

3403

+ client["timeout"])

3404

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

3405

" enabled", client_name)

2622

3406

try:

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3407

client["secret"] = pgp.decrypt(

3408

client["encrypted_secret"],

3409

client_settings[client_name]["secret"])

2627

3410

except PGPError:

2628

3411

# If decryption fails, we use secret from new settings

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3412

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

3413

client_name)

3414

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

3415

["secret"])

3416

2634

3417

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

2635

3418

for client_name in (set(old_client_settings)

2636

3419

- set(client_settings)):

2638

3421

for client_name in (set(client_settings)

2639

3422

- set(old_client_settings)):

2640

3423

clients_data[client_name] = client_settings[client_name]

2641

3424

2642

3425

# Create all client objects

2643

for client_name, client in clients_data.iteritems():

3426

for client_name, client in clients_data.items():

2644

3427

tcp_server.clients[client_name] = client_class(

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3428

name=client_name,

3429

settings=client,

3430

server_settings=server_settings)

3431

2648

3432

if not tcp_server.clients:

2649

logger.warning("No clients defined")

2650

3433

log.warning("No clients defined")

3434

2651

3435

if not foreground:

2652

3436

if pidfile is not None:

3437

pid = os.getpid()

2653

3438

try:

2654

3439

with pidfile:

2655

pid = os.getpid()

2656

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

3440

print(pid, file=pidfile)

2657

3441

except IOError:

2658

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

2659

pidfilename, pid)

3442

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

3443

pidfilename, pid)

2660

3444

del pidfile

2661

3445

del pidfilename

2662

2663

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

2664

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

2665

3446

3447

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

3448

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3449

lambda: main_loop.quit() and False)

3450

2666

3451

if use_dbus:

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3452

3453

@alternate_dbus_interfaces(

3454

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

3455

class MandosDBusService(DBusObjectWithObjectManager):

2670

3456

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

3457

2671

3458

def __init__(self):

2672

3459

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

3460

2673

3461

_interface = "se.recompile.Mandos"

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3462

2681

3463

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

2682

3464

def ClientAdded(self, objpath):

2683

3465

"D-Bus signal"

2684

3466

pass

2685

3467

2686

3468

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

2687

def ClientNotFound(self, fingerprint, address):

3469

def ClientNotFound(self, key_id, address):

2688

3470

"D-Bus signal"

2689

3471

pass

2690

3472

3473

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

3474

"true"})

2691

3475

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

2692

3476

def ClientRemoved(self, objpath, name):

2693

3477

"D-Bus signal"

2694

3478

pass

2695

3479

3480

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

3481

"true"})

2696

3482

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

2697

3483

def GetAllClients(self):

2698

3484

"D-Bus method"

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3485

return dbus.Array(c.dbus_object_path for c in

3486

tcp_server.clients.values())

3487

3488

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

3489

"true"})

2703

3490

@dbus.service.method(_interface,

2704

3491

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

2705

3492

def GetAllClientsWithProperties(self):

2706

3493

"D-Bus method"

2707

3494

return dbus.Dictionary(

2708

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

2709

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

3495

{c.dbus_object_path: c.GetAll(

3496

"se.recompile.Mandos.Client")

3497

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

2710

3498

signature="oa{sv}")

2711

3499

2712

3500

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

2713

3501

def RemoveClient(self, object_path):

2714

3502

"D-Bus method"

2715

for c in tcp_server.clients.itervalues():

3503

for c in tcp_server.clients.values():

2716

3504

if c.dbus_object_path == object_path:

2717

3505

del tcp_server.clients[c.name]

2718

3506

c.remove_from_connection()

2719

# Don't signal anything except ClientRemoved

3507

# Don't signal the disabling

2720

3508

c.disable(quiet=True)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3509

# Emit D-Bus signal for removal

3510

self.client_removed_signal(c)

2723

3511

return

2724

3512

raise KeyError(object_path)

2725

3513

2726

3514

del _interface

2727

3515

3516

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3517

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

3518

def GetManagedObjects(self):

3519

"""D-Bus method"""

3520

return dbus.Dictionary(

3521

{client.dbus_object_path:

3522

dbus.Dictionary(

3523

{interface: client.GetAll(interface)

3524

for interface in

3525

client._get_all_interface_names()})

3526

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

3527

3528

def client_added_signal(self, client):

3529

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

3530

if use_dbus:

3531

# New standard signal

3532

self.InterfacesAdded(

3533

client.dbus_object_path,

3534

dbus.Dictionary(

3535

{interface: client.GetAll(interface)

3536

for interface in

3537

client._get_all_interface_names()}))

3538

# Old signal

3539

self.ClientAdded(client.dbus_object_path)

3540

3541

def client_removed_signal(self, client):

3542

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

3543

if use_dbus:

3544

# New standard signal

3545

self.InterfacesRemoved(

3546

client.dbus_object_path,

3547

client._get_all_interface_names())

3548

# Old signal

3549

self.ClientRemoved(client.dbus_object_path,

3550

client.name)

3551

2728

3552

mandos_dbus_service = MandosDBusService()

2729

3553

3554

# Save modules to variables to exempt the modules from being

3555

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

3556

mp = multiprocessing

3557

wn = wnull

3558

2730

3559

def cleanup():

2731

3560

"Cleanup function; run on exit"

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3561

if zeroconf:

3562

service.cleanup()

3563

3564

mp.active_children()

3565

wn.close()

2736

3566

if not (tcp_server.clients or client_settings):

2737

3567

return

2738

3568

2739

3569

# Store client before exiting. Secrets are encrypted with key

2740

3570

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

2741

3571

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

2742

3572

clients = {}

2743

3573

with PGPEngine() as pgp:

2744

for client in tcp_server.clients.itervalues():

3574

for client in tcp_server.clients.values():

2745

3575

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

2746

3576

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

2747

3577

key)

2748

3578

client_dict = {}

2749

3579

2750

3580

# A list of attributes that can not be pickled

2751

3581

# + secret.

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3582

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

3583

"checker", "server_settings"}

3584

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

3585

.Object):

2756

3586

exclude.add(name)

2757

3587

2758

3588

client_dict["encrypted_secret"] = (client

2759

3589

.encrypted_secret)

2760

3590

for attr in client.client_structure:

2761

3591

if attr not in exclude:

2762

3592

client_dict[attr] = getattr(client, attr)

2763

3593

2764

3594

clients[client.name] = client_dict

2765

3595

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

2766

3596

2767

3597

try:

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3598

with tempfile.NamedTemporaryFile(

3599

mode="wb",

3600

suffix=".pickle",

3601

prefix="clients-",

3602

dir=os.path.dirname(stored_state_path),

3603

delete=False) as stored_state:

3604

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

3605

protocol=2)

3606

tempname = stored_state.name

2774

3607

os.rename(tempname, stored_state_path)

2775

3608

except (IOError, OSError) as e:

2776

3609

if not debug:

2779

3612

except NameError:

2780

3613

pass

2781

3614

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

2782

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

2783

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

3615

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

3616

os.strerror(e.errno))

2784

3617

else:

2785

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

2786

exc_info=e)

2787

raise e

2788

3618

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

3619

exc_info=e)

3620

raise

3621

2789

3622

# Delete all clients, and settings from config

2790

3623

while tcp_server.clients:

2791

3624

name, client = tcp_server.clients.popitem()

2792

3625

if use_dbus:

2793

3626

client.remove_from_connection()

2794

# Don't signal anything except ClientRemoved

3627

# Don't signal the disabling

2795

3628

client.disable(quiet=True)

3629

# Emit D-Bus signal for removal

2796

3630

if use_dbus:

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3631

mandos_dbus_service.client_removed_signal(client)

2801

3632

client_settings.clear()

2802

3633

2803

3634

atexit.register(cleanup)

2804

2805

for client in tcp_server.clients.itervalues():

3635

3636

for client in tcp_server.clients.values():

2806

3637

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3638

# Emit D-Bus signal for adding

3639

mandos_dbus_service.client_added_signal(client)

2809

3640

# Need to initiate checking of clients

2810

3641

if client.enabled:

2811

client.init_checker()

2812

3642

client.init_checker(randomize_start=True)

3643

2813

3644

tcp_server.enable()

2814

3645

tcp_server.server_activate()

2815

3646

2816

3647

# Find out what port we got

2817

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

3648

if zeroconf:

3649

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

2818

3650

if use_ipv6:

2819

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

2820

" flowinfo %d, scope_id %d",

2821

*tcp_server.socket.getsockname())

3651

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

3652

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

2822

3653

else: # IPv4

2823

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

2824

*tcp_server.socket.getsockname())

2825

2826

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

2827

3654

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

3655

*tcp_server.socket.getsockname())

3656

3657

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

3658

2828

3659

try:

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

2843

logger.debug("Starting main loop")

3660

if zeroconf:

3661

# From the Avahi example code

3662

try:

3663

service.activate()

3664

except dbus.exceptions.DBusException as error:

3665

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

3666

cleanup()

3667

sys.exit(1)

3668

# End of Avahi example code

3669

3670

GLib.io_add_watch(

3671

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

3672

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3673

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

3674

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

3675

3676

log.debug("Starting main loop")

2844

3677

main_loop.run()

2845

3678

except AvahiError as error:

2846

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

3679

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

2847

3680

cleanup()

2848

3681

sys.exit(1)

2849

3682

except KeyboardInterrupt:

2850

3683

if debug:

2851

3684

print("", file=sys.stderr)

2852

logger.debug("Server received KeyboardInterrupt")

2853

logger.debug("Server exiting")

3685

log.debug("Server received KeyboardInterrupt")

3686

log.debug("Server exiting")

2854

3687

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

2855

3688

cleanup()

2856

3689

2857

if __name__ == '__main__':

2858

main()

3690

3691

def parse_test_args():

3692

# type: () -> argparse.Namespace

3693

parser = argparse.ArgumentParser(add_help=False)

3694

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

3695

parser.add_argument("--prefix", )

3696

args, unknown_args = parser.parse_known_args()

3697

if args.check:

3698

# Remove test options from sys.argv

3699

sys.argv[1:] = unknown_args

3700

return args

3701

3702

# Add all tests from doctest strings

3703

def load_tests(loader, tests, none):

3704

import doctest

3705

tests.addTests(doctest.DocTestSuite())

3706

return tests

3707

3708

if __name__ == "__main__":

3709

options = parse_test_args()

3710

try:

3711

if options.check:

3712

extra_test_prefix = options.prefix

3713

if extra_test_prefix is not None:

3714

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

3715

.result.wasSuccessful()):

3716

sys.exit(1)

3717

class ExtraTestLoader(unittest.TestLoader):

3718

testMethodPrefix = extra_test_prefix

3719

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

3720

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

3721

else:

3722

unittest.main(argv=[""])

3723

else:

3724

main()

3725

finally:

3726

logging.shutdown()

3727

3728

# Local Variables:

3729

# run-tests:

3730

# (lambda (&optional extra)

3731

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

3732

# extra))

3733

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

3734

# (funcall remove-test-window)

3735

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

3736

# run-tests-in-test-buffer:

3737

# (lambda (dir &optional extra)

3738

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

3739

# (setq buffer-read-only nil

3740

# default-directory dir)

3741

# (erase-buffer)

3742

# (compilation-mode))

3743

# (let ((process-result

3744

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

3745

# (process-file-shell-command

3746

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

3747

# (and (numberp process-result)

3748

# (= process-result 0))))

3749

# get-command-line:

3750

# (lambda (&optional extra)

3751

# (let ((quoted-script

3752

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

3753

# (format

3754

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

3755

# quoted-script)))

3756

# get-script-name:

3757

# (lambda ()

3758

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

3759

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

3760

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

3761

# (buffer-file-name))))

3762

# remove-test-window:

3763

# (lambda ()

3764

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

3765

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

3766

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

3767

# (lambda ()

3768

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

3769

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

3770

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

3771

# (display-buffer-overriding-action

3772

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

3773

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

3774

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

3775

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

3776

# eval:

3777

# (progn

3778

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

3779

# (funcall run-tests t)))

3780

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

3781

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

3782

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

3783

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

3784

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

3785

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

3786

# End: