/mandos/release : revision 237.7.816

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

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

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

497

964

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

498

965

.replace(" ", ""))

499

966

if "secret" in section:

500

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

967

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

968

.encode("utf-8"),

969

"base64")

501

970

elif "secfile" in section:

502

971

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

503

972

(section["secfile"])),

504

973

"rb") as secfile:

505

974

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

506

975

else:

507

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

976

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

508

977

.format(section))

509

978

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

510

979

client["extended_timeout"] = string_to_delta(

518

987

client["last_approval_request"] = None

519

988

client["last_checked_ok"] = None

520

989

client["last_checker_status"] = -2

521

990

522

991

return settings

523

524

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

992

993

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

525

994

self.name = name

526

995

if server_settings is None:

527

996

server_settings = {}

528

997

self.server_settings = server_settings

529

998

# adding all client settings

530

for setting, value in settings.iteritems():

999

for setting, value in settings.items():

531

1000

setattr(self, setting, value)

532

1001

533

1002

if self.enabled:

534

1003

if not hasattr(self, "last_enabled"):

535

1004

self.last_enabled = datetime.datetime.utcnow()

539

1008

else:

540

1009

self.last_enabled = None

541

1010

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)

1011

1012

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

1013

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

1014

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

548

1015

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

549

1016

datetime.datetime.utcnow())

550

1017

551

1018

# attributes specific for this server instance

552

1019

self.checker = None

553

1020

self.checker_initiator_tag = None

556

1023

self.current_checker_command = None

557

1024

self.approved = None

558

1025

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

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

564

1030

if not attr.startswith("_")]

565

1031

self.client_structure.append("client_structure")

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

1032

1033

for name, t in inspect.getmembers(

1034

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

571

1035

if not name.startswith("_"):

572

1036

self.client_structure.append(name)

573

1037

574

1038

# Send notice to process children that client state has changed

575

1039

def send_changedstate(self):

576

1040

with self.changedstate:

577

1041

self.changedstate.notify_all()

578

1042

579

1043

def enable(self):

580

1044

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

581

1045

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

582

1046

# Already enabled

583

1047

return

584

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

585

1048

self.enabled = True

586

1049

self.last_enabled = datetime.datetime.utcnow()

587

1050

self.init_checker()

588

1051

self.send_changedstate()

589

1052

590

1053

def disable(self, quiet=True):

591

1054

"""Disable this client."""

592

1055

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

593

1056

return False

594

1057

if not quiet:

595

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

1058

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

596

1059

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

597

gobject.source_remove(self.disable_initiator_tag)

1060

GLib.source_remove(self.disable_initiator_tag)

598

1061

self.disable_initiator_tag = None

599

1062

self.expires = None

600

1063

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

601

gobject.source_remove(self.checker_initiator_tag)

1064

GLib.source_remove(self.checker_initiator_tag)

602

1065

self.checker_initiator_tag = None

603

1066

self.stop_checker()

604

1067

self.enabled = False

605

1068

if not quiet:

606

1069

self.send_changedstate()

607

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

1070

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

608

1071

return False

609

1072

610

1073

def __del__(self):

611

1074

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.

1075

1076

def init_checker(self, randomize_start=False):

1077

# Schedule a new checker to be started a randomly selected

1078

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

1079

# the startup of checkers over time when the server is

1080

# started.

616

1081

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

1082

GLib.source_remove(self.checker_initiator_tag)

1083

interval_milliseconds = int(self.interval.total_seconds()

1084

* 1000)

1085

if randomize_start:

1086

delay_milliseconds = random.randrange(

1087

interval_milliseconds + 1)

1088

else:

1089

delay_milliseconds = interval_milliseconds

1090

self.checker_initiator_tag = GLib.timeout_add(

1091

delay_milliseconds, self.start_checker, randomize_start)

1092

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

1093

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

1094

# expire at the soonest one interval after a checker was

1095

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

1096

# time might have to be extended.

1097

now = datetime.datetime.utcnow()

1098

self.expires = now + delay + self.interval

1099

# Schedule a disable() at expire time

622

1100

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

1101

GLib.source_remove(self.disable_initiator_tag)

1102

self.disable_initiator_tag = GLib.timeout_add(

1103

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

1104

self.disable)

1105

1106

def checker_callback(self, source, condition, connection,

1107

command):

631

1108

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

1109

# Read return code from connection (see call_pipe)

1110

returncode = connection.recv()

1111

connection.close()

1112

if self.checker is not None:

1113

self.checker.join()

632

1114

self.checker_callback_tag = None

633

1115

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1116

1117

if returncode >= 0:

1118

self.last_checker_status = returncode

1119

self.last_checker_signal = None

636

1120

if self.last_checker_status == 0:

637

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

638

vars(self))

1121

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

639

1122

self.checked_ok()

640

1123

else:

641

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

642

vars(self))

1124

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

643

1125

else:

644

1126

self.last_checker_status = -1

645

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

646

vars(self))

647

1127

self.last_checker_signal = -returncode

1128

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

1129

return False

1130

648

1131

def checked_ok(self):

649

1132

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

650

1133

self.last_checked_ok = datetime.datetime.utcnow()

651

1134

self.last_checker_status = 0

1135

self.last_checker_signal = None

652

1136

self.bump_timeout()

653

1137

654

1138

def bump_timeout(self, timeout=None):

655

1139

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

656

1140

if timeout is None:

657

1141

timeout = self.timeout

658

1142

if self.disable_initiator_tag is not None:

659

gobject.source_remove(self.disable_initiator_tag)

1143

GLib.source_remove(self.disable_initiator_tag)

660

1144

self.disable_initiator_tag = None

661

1145

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1146

self.disable_initiator_tag = GLib.timeout_add(

1147

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

665

1148

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

666

1149

667

1150

def need_approval(self):

668

1151

self.last_approval_request = datetime.datetime.utcnow()

669

670

def start_checker(self):

1152

1153

def start_checker(self, start_was_randomized=False):

671

1154

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

672

1155

673

1156

If a checker already exists, leave it running and do

674

1157

nothing."""

675

1158

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

680

1163

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

681

1164

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

682

1165

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

1166

1167

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

1168

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

1169

self.checker.join()

1170

self.checker = None

697

1171

# Start a new checker if needed

698

1172

if self.checker is None:

699

1173

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

1174

escaped_attrs = {

1175

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

1176

for attr in self.runtime_expansions}

704

1177

try:

705

1178

command = self.checker_command % escaped_attrs

706

1179

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

1180

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

1181

self.checker_command, exc_info=error)

1182

return True # Try again later

710

1183

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

1184

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

1185

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

1186

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

1187

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

1188

# always replaced by /dev/null.)

1189

# The exception is when not debugging but nevertheless

1190

# running in the foreground; use the previously

1191

# created wnull.

1192

popen_args = {"close_fds": True,

1193

"shell": True,

1194

"cwd": "/"}

1195

if (not self.server_settings["debug"]

1196

and self.server_settings["foreground"]):

1197

popen_args.update({"stdout": wnull,

1198

"stderr": wnull})

1199

pipe = multiprocessing.Pipe(duplex=False)

1200

self.checker = multiprocessing.Process(

1201

target=call_pipe,

1202

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

1203

kwargs=popen_args)

1204

self.checker.start()

1205

self.checker_callback_tag = GLib.io_add_watch(

1206

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

1207

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1208

self.checker_callback, pipe[0], command)

1209

if start_was_randomized:

1210

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

1211

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

1212

# interval from then on.

1213

now = datetime.datetime.utcnow()

1214

self.checker_initiator_tag = GLib.timeout_add(

1215

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

1216

self.start_checker)

1217

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

1218

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

1219

return False

1220

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

753

1221

return True

754

1222

755

1223

def stop_checker(self):

756

1224

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

757

1225

if self.checker_callback_tag:

758

gobject.source_remove(self.checker_callback_tag)

1226

GLib.source_remove(self.checker_callback_tag)

759

1227

self.checker_callback_tag = None

760

1228

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

761

1229

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

1230

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

1231

self.checker.terminate()

771

1232

self.checker = None

772

1233

773

1234

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1235

def dbus_service_property(dbus_interface,

1236

signature="v",

1237

access="readwrite",

1238

byte_arrays=False):

776

1239

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1240

become properties on the D-Bus.

778

1241

779

1242

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

780

1243

and with one argument by "Set".

781

1244

782

1245

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

783

1246

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

784

1247

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

787

1250

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

788

1251

if byte_arrays and signature != "ay":

789

1252

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

790

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

1253

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

1254

791

1255

def decorator(func):

792

1256

func._dbus_is_property = True

793

1257

func._dbus_interface = dbus_interface

796

1260

func._dbus_name = func.__name__

797

1261

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

798

1262

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

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1263

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

800

1264

return func

1265

801

1266

return decorator

802

1267

803

1268

804

1269

def dbus_interface_annotations(dbus_interface):

805

1270

"""Decorator for marking functions returning interface annotations

806

1271

807

1272

Usage:

808

1273

809

1274

@dbus_interface_annotations("org.example.Interface")

810

1275

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

811

1276

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

812

1277

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

813

1278

"false"}

814

1279

"""

1280

815

1281

def decorator(func):

816

1282

func._dbus_is_interface = True

817

1283

func._dbus_interface = dbus_interface

818

1284

func._dbus_name = dbus_interface

819

1285

return func

1286

820

1287

return decorator

821

1288

822

1289

823

1290

def dbus_annotations(annotations):

824

1291

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

825

1292

Usage:

826

1293

1294

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

1295

"org.freedesktop.DBus.Property."

1296

"EmitsChangedSignal": "false"})

827

1297

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

828

1298

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1299

def Property_dbus_property(self):

833

1300

return dbus.Boolean(False)

1301

1302

See also the DBusObjectWithAnnotations class.

834

1303

"""

1304

835

1305

def decorator(func):

836

1306

func._dbus_annotations = annotations

837

1307

return func

1308

838

1309

return decorator

839

1310

840

1311

841

1312

class DBusPropertyException(dbus.exceptions.DBusException):

842

1313

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

843

1314

"""

844

def __unicode__(self):

845

return unicode(str(self))

1315

pass

846

1316

847

1317

848

1318

class DBusPropertyAccessException(DBusPropertyException):

857

1327

pass

858

1328

859

1329

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.

1330

class DBusObjectWithAnnotations(dbus.service.Object):

1331

"""A D-Bus object with annotations.

1332

1333

Classes inheriting from this can use the dbus_annotations

1334

decorator to add annotations to methods or signals.

866

1335

"""

867

1336

868

1337

@staticmethod

869

1338

def _is_dbus_thing(thing):

870

1339

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

871

1340

872

1341

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

873

1342

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

874

1343

"""

875

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

1344

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

876

1345

False)

877

1346

878

1347

def _get_all_dbus_things(self, thing):

879

1348

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

880

1349

"""

881

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

882

name),

1350

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

883

1351

athing.__get__(self))

884

1352

for cls in self.__class__.__mro__

885

1353

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1354

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

1355

1356

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1357

out_signature="s",

1358

path_keyword="object_path",

1359

connection_keyword="connection")

1360

def Introspect(self, object_path, connection):

1361

"""Overloading of standard D-Bus method.

1362

1363

Inserts annotation tags on methods and signals.

1364

"""

1365

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

1366

connection)

1367

try:

1368

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

1369

1370

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

1371

# Add annotation tags

1372

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

1373

for tag in if_tag.getElementsByTagName(typ):

1374

annots = dict()

1375

for name, prop in (self.

1376

_get_all_dbus_things(typ)):

1377

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

1378

and prop._dbus_interface

1379

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

1380

annots.update(getattr(

1381

prop, "_dbus_annotations", {}))

1382

for name, value in annots.items():

1383

ann_tag = document.createElement(

1384

"annotation")

1385

ann_tag.setAttribute("name", name)

1386

ann_tag.setAttribute("value", value)

1387

tag.appendChild(ann_tag)

1388

# Add interface annotation tags

1389

for annotation, value in dict(

1390

itertools.chain.from_iterable(

1391

annotations().items()

1392

for name, annotations

1393

in self._get_all_dbus_things("interface")

1394

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

1395

)).items():

1396

ann_tag = document.createElement("annotation")

1397

ann_tag.setAttribute("name", annotation)

1398

ann_tag.setAttribute("value", value)

1399

if_tag.appendChild(ann_tag)

1400

# Fix argument name for the Introspect method itself

1401

if (if_tag.getAttribute("name")

1402

== dbus.INTROSPECTABLE_IFACE):

1403

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

1404

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

1405

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

1406

if (arg.getAttribute("direction")

1407

== "out"):

1408

arg.setAttribute("name",

1409

"xml_data")

1410

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

1411

document.unlink()

1412

except (AttributeError, xml.dom.DOMException,

1413

xml.parsers.expat.ExpatError) as error:

1414

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

1415

exc_info=error)

1416

return xmlstring

1417

1418

1419

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1420

"""A D-Bus object with properties.

1421

1422

Classes inheriting from this can use the dbus_service_property

1423

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

1424

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

1425

"""

1426

889

1427

def _get_dbus_property(self, interface_name, property_name):

890

1428

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

891

1429

property with the specified name and interface.

892

1430

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1431

for cls in self.__class__.__mro__:

1432

for name, value in inspect.getmembers(

1433

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

897

1434

if (value._dbus_name == property_name

898

1435

and value._dbus_interface == interface_name):

899

1436

return value.__get__(self)

900

1437

901

1438

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

1439

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

1440

self.dbus_object_path, interface_name, property_name))

1441

1442

@classmethod

1443

def _get_all_interface_names(cls):

1444

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

1445

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

1446

"_dbus_interface", None)

1447

for x in (inspect.getmro(cls))

1448

for attr in dir(x))

1449

if name is not None)

1450

1451

@dbus.service.method(dbus.PROPERTIES_IFACE,

1452

in_signature="ss",

907

1453

out_signature="v")

908

1454

def Get(self, interface_name, property_name):

909

1455

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

915

1461

if not hasattr(value, "variant_level"):

916

1462

return value

917

1463

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

918

1464

919

1465

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

920

1466

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

921

1467

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

927

1473

# The byte_arrays option is not supported yet on

928

1474

# signatures other than "ay".

929

1475

if prop._dbus_signature != "ay":

930

raise ValueError

931

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

932

for byte in value))

1476

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

1477

"'ay' signature {!r}"

1478

.format(prop._dbus_signature))

1479

value = dbus.ByteArray(bytes(value))

933

1480

prop(value)

934

935

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

1481

1482

@dbus.service.method(dbus.PROPERTIES_IFACE,

1483

in_signature="s",

936

1484

out_signature="a{sv}")

937

1485

def GetAll(self, interface_name):

938

1486

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

939

1487

standard.

940

1488

941

1489

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

942

1490

"""

943

1491

properties = {}

953

1501

if not hasattr(value, "variant_level"):

954

1502

properties[name] = value

955

1503

continue

956

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

957

value.variant_level+1)

1504

properties[name] = type(value)(

1505

value, variant_level=value.variant_level + 1)

958

1506

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

959

1507

1508

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

1509

def PropertiesChanged(self, interface_name, changed_properties,

1510

invalidated_properties):

1511

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

1512

standard.

1513

"""

1514

pass

1515

960

1516

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1517

out_signature="s",

962

path_keyword='object_path',

963

connection_keyword='connection')

1518

path_keyword="object_path",

1519

connection_keyword="connection")

964

1520

def Introspect(self, object_path, connection):

965

1521

"""Overloading of standard D-Bus method.

966

1522

967

1523

Inserts property tags and interface annotation tags.

968

1524

"""

969

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

970

connection)

1525

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1526

object_path,

1527

connection)

971

1528

try:

972

1529

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

1530

973

1531

def make_tag(document, name, prop):

974

1532

e = document.createElement("property")

975

1533

e.setAttribute("name", name)

976

1534

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

977

1535

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

978

1536

return e

1537

979

1538

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

980

1539

# Add property tags

981

1540

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

984

1543

if prop._dbus_interface

985

1544

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

986

1545

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)

1546

# Add annotation tags for properties

1547

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

1548

annots = dict()

1549

for name, prop in self._get_all_dbus_things(

1550

"property"):

1551

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

1552

and prop._dbus_interface

1553

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

1554

annots.update(getattr(

1555

prop, "_dbus_annotations", {}))

1556

for name, value in annots.items():

1557

ann_tag = document.createElement(

1558

"annotation")

1559

ann_tag.setAttribute("name", name)

1560

ann_tag.setAttribute("value", value)

1561

tag.appendChild(ann_tag)

1018

1562

# Add the names to the return values for the

1019

1563

# "org.freedesktop.DBus.Properties" methods

1020

1564

if (if_tag.getAttribute("name")

1034

1578

document.unlink()

1035

1579

except (AttributeError, xml.dom.DOMException,

1036

1580

xml.parsers.expat.ExpatError) as error:

1037

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

1038

exc_info=error)

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

try:

1587

dbus.OBJECT_MANAGER_IFACE

1588

except AttributeError:

1589

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

1590

1591

1592

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1593

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

1594

1595

Classes inheriting from this exposes the standard

1596

GetManagedObjects call and the InterfacesAdded and

1597

InterfacesRemoved signals on the standard

1598

"org.freedesktop.DBus.ObjectManager" interface.

1599

1600

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

1601

manually.

1602

"""

1603

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1604

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

1605

def GetManagedObjects(self):

1606

"""This function must be overridden"""

1607

raise NotImplementedError()

1608

1609

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def InterfacesAdded(self, object_path, interfaces_and_properties):

1612

pass

1613

1614

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

1615

def InterfacesRemoved(self, object_path, interfaces):

1616

pass

1617

1618

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1619

out_signature="s",

1620

path_keyword="object_path",

1621

connection_keyword="connection")

1622

def Introspect(self, object_path, connection):

1623

"""Overloading of standard D-Bus method.

1624

1625

Override return argument name of GetManagedObjects to be

1626

"objpath_interfaces_and_properties"

1627

"""

1628

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1629

object_path,

1630

connection)

1631

try:

1632

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

1633

1634

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

1635

# Fix argument name for the GetManagedObjects method

1636

if (if_tag.getAttribute("name")

1637

== dbus.OBJECT_MANAGER_IFACE):

1638

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

1639

if (cn.getAttribute("name")

1640

== "GetManagedObjects"):

1641

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

1642

if (arg.getAttribute("direction")

1643

== "out"):

1644

arg.setAttribute(

1645

"name",

1646

"objpath_interfaces"

1647

"_and_properties")

1648

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

1649

document.unlink()

1650

except (AttributeError, xml.dom.DOMException,

1651

xml.parsers.expat.ExpatError) as error:

1652

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

1653

exc_info=error)

1039

1654

return xmlstring

1040

1655

1041

1656

1042

1657

def datetime_to_dbus(dt, variant_level=0):

1043

1658

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

1044

1659

if dt is None:

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1660

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

1661

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

1048

1662

1049

1663

1050

1664

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1052

1666

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

1053

1667

interface names according to the "alt_interface_names" mapping.

1054

1668

Usage:

1055

1669

1056

1670

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

1057

1671

"net.example.AlternateInterface"})

1058

1672

class SampleDBusObject(dbus.service.Object):

1059

1673

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

1060

1674

def SampleDBusMethod():

1061

1675

pass

1062

1676

1063

1677

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

1678

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

1065

1679

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

1066

1680

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

1067

1681

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

1068

1682

1069

1683

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

1070

1684

(from DBusObjectWithProperties) and interfaces (from the

1071

1685

dbus_interface_annotations decorator).

1072

1686

"""

1687

1073

1688

def wrapper(cls):

1074

1689

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1690

alt_interface_names.items()):

1076

1691

attr = {}

1077

1692

interface_names = set()

1078

1693

# Go though all attributes of the class

1080

1695

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

1081

1696

# with the wrong interface name

1082

1697

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1698

or not attribute._dbus_interface.startswith(

1699

orig_interface_name)):

1085

1700

continue

1086

1701

# Create an alternate D-Bus interface name based on

1087

1702

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1703

alt_interface = attribute._dbus_interface.replace(

1704

orig_interface_name, alt_interface_name)

1091

1705

interface_names.add(alt_interface)

1092

1706

# Is this a D-Bus signal?

1093

1707

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

1094

1708

# Extract the original non-method undecorated

1095

1709

# function by black magic

1096

nonmethod_func = (dict(

1710

if sys.version_info.major == 2:

1711

nonmethod_func = (dict(

1097

1712

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1713

attribute.__closure__))

1714

["func"].cell_contents)

1715

else:

1716

nonmethod_func = (dict(

1717

zip(attribute.__code__.co_freevars,

1718

attribute.__closure__))

1719

["func"].cell_contents)

1100

1720

# Create a new, but exactly alike, function

1101

1721

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

1102

1722

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

1723

new_function = copy_function(nonmethod_func)

1724

new_function = (dbus.service.signal(

1725

alt_interface,

1726

attribute._dbus_signature)(new_function))

1112

1727

# Copy annotations, if any

1113

1728

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1729

new_function._dbus_annotations = dict(

1730

attribute._dbus_annotations)

1116

1731

except AttributeError:

1117

1732

pass

1733

1118

1734

# Define a creator of a function to call both the

1119

1735

# original and alternate functions, so both the

1120

1736

# original and alternate signals gets sent when

1123

1739

"""This function is a scope container to pass

1124

1740

func1 and func2 to the "call_both" function

1125

1741

outside of its arguments"""

1742

1743

@functools.wraps(func2)

1126

1744

def call_both(*args, **kwargs):

1127

1745

"""This function will emit two D-Bus

1128

1746

signals by calling func1 and func2"""

1129

1747

func1(*args, **kwargs)

1130

1748

func2(*args, **kwargs)

1749

# Make wrapper function look like a D-Bus

1750

# signal

1751

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

1752

if name.startswith("_dbus_"):

1753

setattr(call_both, name, attr)

1754

1131

1755

return call_both

1132

1756

# Create the "call_both" function and add it to

1133

1757

# the class

1138

1762

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

1139

1763

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

1140

1764

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

1765

attr[attrname] = (

1766

dbus.service.method(

1767

alt_interface,

1768

attribute._dbus_in_signature,

1769

attribute._dbus_out_signature)

1770

(copy_function(attribute)))

1151

1771

# Copy annotations, if any

1152

1772

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1155

1775

except AttributeError:

1156

1776

pass

1157

1777

# Is this a D-Bus property?

1160

1780

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

1161

1781

# property with the alternate D-Bus interface

1162

1782

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

1783

attr[attrname] = (dbus_service_property(

1784

alt_interface, attribute._dbus_signature,

1785

attribute._dbus_access,

1786

attribute._dbus_get_args_options

1787

["byte_arrays"])

1788

(copy_function(attribute)))

1176

1789

# Copy annotations, if any

1177

1790

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1791

attr[attrname]._dbus_annotations = dict(

1792

attribute._dbus_annotations)

1180

1793

except AttributeError:

1181

1794

pass

1182

1795

# Is this a D-Bus interface?

1185

1798

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

1186

1799

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

1187

1800

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

1801

attr[attrname] = (

1802

dbus_interface_annotations(alt_interface)

1803

(copy_function(attribute)))

1196

1804

if deprecate:

1197

1805

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1806

iname = "_AlternateDBusNames_interface_annotation{}"

1199

1807

for interface_name in interface_names:

1808

1200

1809

@dbus_interface_annotations(interface_name)

1201

1810

def func(self):

1202

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

1203

"true" }

1811

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

1812

"true"}

1204

1813

# Find an unused name

1205

1814

for aname in (iname.format(i)

1206

1815

for i in itertools.count()):

1210

1819

if interface_names:

1211

1820

# Replace the class with a new subclass of it with

1212

1821

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1822

if sys.version_info.major == 2:

1823

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

1824

(cls, ), attr)

1825

else:

1826

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

1827

(cls, ), attr)

1215

1828

return cls

1829

1216

1830

return wrapper

1217

1831

1218

1832

1219

1833

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

1220

"se.bsnet.fukt.Mandos"})

1834

"se.bsnet.fukt.Mandos"})

1221

1835

class ClientDBus(Client, DBusObjectWithProperties):

1222

1836

"""A Client class using D-Bus

1223

1837

1224

1838

Attributes:

1225

1839

dbus_object_path: dbus.ObjectPath

1226

1840

bus: dbus.SystemBus()

1227

1841

"""

1228

1842

1229

1843

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1231

1844

+ ("dbus_object_path", ))

1845

1846

_interface = "se.recompile.Mandos.Client"

1847

1232

1848

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

1233

1234

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

1849

1850

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

1235

1851

self.bus = bus

1236

1852

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

1237

1853

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

1238

1854

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1855

client_object_name = str(self.name).translate(

1240

1856

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

1241

1857

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1858

self.dbus_object_path = dbus.ObjectPath(

1859

"/clients/" + client_object_name)

1244

1860

DBusObjectWithProperties.__init__(self, self.bus,

1245

1861

self.dbus_object_path)

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1862

1863

def notifychangeproperty(transform_func, dbus_name,

1864

type_func=lambda x: x,

1865

variant_level=1,

1866

invalidate_only=False,

1867

_interface=_interface):

1250

1868

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

1251

1869

its changes to DBus.

1252

1870

1253

1871

transform_fun: Function that takes a value and a variant_level

1254

1872

and transforms it to a D-Bus type.

1255

1873

dbus_name: D-Bus name of the variable

1257

1875

to the D-Bus. Default: no transform

1258

1876

variant_level: D-Bus variant level. Default: 1

1259

1877

"""

1260

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

1878

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

1879

1261

1880

def setter(self, value):

1262

1881

if hasattr(self, "dbus_object_path"):

1263

1882

if (not hasattr(self, attrname) or

1264

1883

type_func(getattr(self, attrname, None))

1265

1884

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

1885

if invalidate_only:

1886

self.PropertiesChanged(

1887

_interface, dbus.Dictionary(),

1888

dbus.Array((dbus_name, )))

1889

else:

1890

dbus_value = transform_func(

1891

type_func(value),

1892

variant_level=variant_level)

1893

self.PropertyChanged(dbus.String(dbus_name),

1894

dbus_value)

1895

self.PropertiesChanged(

1896

_interface,

1897

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

1898

dbus_value}),

1899

dbus.Array())

1271

1900

setattr(self, attrname, value)

1272

1901

1273

1902

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

1274

1903

1275

1904

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1276

1905

approvals_pending = notifychangeproperty(dbus.Boolean,

1277

1906

"ApprovalPending",

1278

type_func = bool)

1907

type_func=bool)

1279

1908

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

1280

1909

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1910

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1911

checker = notifychangeproperty(

1912

dbus.Boolean, "CheckerRunning",

1913

type_func=lambda checker: checker is not None)

1285

1914

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1915

"LastCheckedOK")

1287

1916

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1919

datetime_to_dbus, "LastApprovalRequest")

1291

1920

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1921

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1922

approval_delay = notifychangeproperty(

1923

dbus.UInt64, "ApprovalDelay",

1924

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

1297

1925

approval_duration = notifychangeproperty(

1298

1926

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1927

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

1300

1928

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1929

timeout = notifychangeproperty(

1930

dbus.UInt64, "Timeout",

1931

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

1304

1932

extended_timeout = notifychangeproperty(

1305

1933

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1934

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

1935

interval = notifychangeproperty(

1936

dbus.UInt64, "Interval",

1937

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

1311

1938

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

1312

1939

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

1940

invalidate_only=True)

1941

1313

1942

del notifychangeproperty

1314

1943

1315

1944

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

1316

1945

try:

1317

1946

self.remove_from_connection()

1320

1949

if hasattr(DBusObjectWithProperties, "__del__"):

1321

1950

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

1322

1951

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)

1952

1953

def checker_callback(self, source, condition,

1954

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

1955

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

1956

connection, command, *args,

1957

**kwargs)

1958

exitstatus = self.last_checker_status

1959

if exitstatus >= 0:

1330

1960

# Emit D-Bus signal

1331

1961

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1962

# This is specific to GNU libC

1963

dbus.Int64(exitstatus << 8),

1333

1964

dbus.String(command))

1334

1965

else:

1335

1966

# Emit D-Bus signal

1336

1967

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

1337

dbus.Int64(condition),

1968

dbus.Int64(

1969

# This is specific to GNU libC

1970

(exitstatus << 8)

1971

| self.last_checker_signal),

1338

1972

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1342

1973

return ret

1974

1343

1975

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

1976

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

1349

1977

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

1350

1978

# Only if new checker process was started

1351

1979

if (self.checker is not None

1353

1981

# Emit D-Bus signal

1354

1982

self.CheckerStarted(self.current_checker_command)

1355

1983

return r

1356

1984

1357

1985

def _reset_approved(self):

1358

1986

self.approved = None

1359

1987

return False

1360

1988

1361

1989

def approve(self, value=True):

1362

1990

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1991

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

1992

* 1000), self._reset_approved)

1366

1993

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

1994

1995

# D-Bus methods, signals & properties

1996

1997

# Interfaces

1998

1999

# Signals

2000

1380

2001

# CheckerCompleted - signal

1381

2002

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

1382

2003

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

1383

2004

"D-Bus signal"

1384

2005

pass

1385

2006

1386

2007

# CheckerStarted - signal

1387

2008

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

1388

2009

def CheckerStarted(self, command):

1389

2010

"D-Bus signal"

1390

2011

pass

1391

2012

1392

2013

# PropertyChanged - signal

2014

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

1393

2015

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

1394

2016

def PropertyChanged(self, property, value):

1395

2017

"D-Bus signal"

1396

2018

pass

1397

2019

1398

2020

# GotSecret - signal

1399

2021

@dbus.service.signal(_interface)

1400

2022

def GotSecret(self):

1403

2025

server to mandos-client

1404

2026

"""

1405

2027

pass

1406

2028

1407

2029

# Rejected - signal

1408

2030

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

1409

2031

def Rejected(self, reason):

1410

2032

"D-Bus signal"

1411

2033

pass

1412

2034

1413

2035

# NeedApproval - signal

1414

2036

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

1415

2037

def NeedApproval(self, timeout, default):

1416

2038

"D-Bus signal"

1417

2039

return self.need_approval()

1418

1419

## Methods

1420

2040

2041

# Methods

2042

1421

2043

# Approve - method

1422

2044

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

1423

2045

def Approve(self, value):

1424

2046

self.approve(value)

1425

2047

1426

2048

# CheckedOK - method

1427

2049

@dbus.service.method(_interface)

1428

2050

def CheckedOK(self):

1429

2051

self.checked_ok()

1430

2052

1431

2053

# Enable - method

2054

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

1432

2055

@dbus.service.method(_interface)

1433

2056

def Enable(self):

1434

2057

"D-Bus method"

1435

2058

self.enable()

1436

2059

1437

2060

# StartChecker - method

2061

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

1438

2062

@dbus.service.method(_interface)

1439

2063

def StartChecker(self):

1440

2064

"D-Bus method"

1441

2065

self.start_checker()

1442

2066

1443

2067

# Disable - method

2068

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

1444

2069

@dbus.service.method(_interface)

1445

2070

def Disable(self):

1446

2071

"D-Bus method"

1447

2072

self.disable()

1448

2073

1449

2074

# StopChecker - method

2075

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

1450

2076

@dbus.service.method(_interface)

1451

2077

def StopChecker(self):

1452

2078

self.stop_checker()

1453

1454

## Properties

1455

2079

2080

# Properties

2081

1456

2082

# ApprovalPending - property

1457

2083

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

1458

2084

def ApprovalPending_dbus_property(self):

1459

2085

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

1460

2086

1461

2087

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

2088

@dbus_service_property(_interface,

2089

signature="b",

1463

2090

access="readwrite")

1464

2091

def ApprovedByDefault_dbus_property(self, value=None):

1465

2092

if value is None: # get

1466

2093

return dbus.Boolean(self.approved_by_default)

1467

2094

self.approved_by_default = bool(value)

1468

2095

1469

2096

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

2097

@dbus_service_property(_interface,

2098

signature="t",

1471

2099

access="readwrite")

1472

2100

def ApprovalDelay_dbus_property(self, value=None):

1473

2101

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2102

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

2103

* 1000)

1475

2104

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

1476

2105

1477

2106

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

2107

@dbus_service_property(_interface,

2108

signature="t",

1479

2109

access="readwrite")

1480

2110

def ApprovalDuration_dbus_property(self, value=None):

1481

2111

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2112

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

2113

* 1000)

1484

2114

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

1485

2115

1486

2116

# Name - property

2117

@dbus_annotations(

2118

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

1487

2119

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

1488

2120

def Name_dbus_property(self):

1489

2121

return dbus.String(self.name)

1490

2122

2123

# KeyID - property

2124

@dbus_annotations(

2125

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

2126

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

2127

def KeyID_dbus_property(self):

2128

return dbus.String(self.key_id)

2129

1491

2130

# Fingerprint - property

2131

@dbus_annotations(

2132

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

1492

2133

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

1493

2134

def Fingerprint_dbus_property(self):

1494

2135

return dbus.String(self.fingerprint)

1495

2136

1496

2137

# Host - property

1497

@dbus_service_property(_interface, signature="s",

2138

@dbus_service_property(_interface,

2139

signature="s",

1498

2140

access="readwrite")

1499

2141

def Host_dbus_property(self, value=None):

1500

2142

if value is None: # get

1501

2143

return dbus.String(self.host)

1502

self.host = unicode(value)

1503

2144

self.host = str(value)

2145

1504

2146

# Created - property

2147

@dbus_annotations(

2148

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

1505

2149

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

1506

2150

def Created_dbus_property(self):

1507

2151

return datetime_to_dbus(self.created)

1508

2152

1509

2153

# LastEnabled - property

1510

2154

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

1511

2155

def LastEnabled_dbus_property(self):

1512

2156

return datetime_to_dbus(self.last_enabled)

1513

2157

1514

2158

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

2159

@dbus_service_property(_interface,

2160

signature="b",

1516

2161

access="readwrite")

1517

2162

def Enabled_dbus_property(self, value=None):

1518

2163

if value is None: # get

1521

2166

self.enable()

1522

2167

else:

1523

2168

self.disable()

1524

2169

1525

2170

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

2171

@dbus_service_property(_interface,

2172

signature="s",

1527

2173

access="readwrite")

1528

2174

def LastCheckedOK_dbus_property(self, value=None):

1529

2175

if value is not None:

1530

2176

self.checked_ok()

1531

2177

return

1532

2178

return datetime_to_dbus(self.last_checked_ok)

1533

2179

1534

2180

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2181

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

1537

2182

def LastCheckerStatus_dbus_property(self):

1538

2183

return dbus.Int16(self.last_checker_status)

1539

2184

1540

2185

# Expires - property

1541

2186

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

1542

2187

def Expires_dbus_property(self):

1543

2188

return datetime_to_dbus(self.expires)

1544

2189

1545

2190

# LastApprovalRequest - property

1546

2191

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

1547

2192

def LastApprovalRequest_dbus_property(self):

1548

2193

return datetime_to_dbus(self.last_approval_request)

1549

2194

1550

2195

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

2196

@dbus_service_property(_interface,

2197

signature="t",

1552

2198

access="readwrite")

1553

2199

def Timeout_dbus_property(self, value=None):

1554

2200

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

2201

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

1556

2202

old_timeout = self.timeout

1557

2203

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

1558

2204

# Reschedule disabling

1566

2212

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

1567

2213

is None):

1568

2214

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

2215

GLib.source_remove(self.disable_initiator_tag)

2216

self.disable_initiator_tag = GLib.timeout_add(

2217

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

2218

self.disable)

2219

1575

2220

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2221

@dbus_service_property(_interface,

2222

signature="t",

1577

2223

access="readwrite")

1578

2224

def ExtendedTimeout_dbus_property(self, value=None):

1579

2225

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2226

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

2227

* 1000)

1581

2228

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

1582

2229

1583

2230

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2231

@dbus_service_property(_interface,

2232

signature="t",

1585

2233

access="readwrite")

1586

2234

def Interval_dbus_property(self, value=None):

1587

2235

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2236

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

1589

2237

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

1590

2238

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

1591

2239

return

1592

2240

if self.enabled:

1593

2241

# 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

2242

GLib.source_remove(self.checker_initiator_tag)

2243

self.checker_initiator_tag = GLib.timeout_add(

2244

value, self.start_checker)

2245

self.start_checker() # Start one now, too

2246

1599

2247

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2248

@dbus_service_property(_interface,

2249

signature="s",

1601

2250

access="readwrite")

1602

2251

def Checker_dbus_property(self, value=None):

1603

2252

if value is None: # get

1604

2253

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

1606

2254

self.checker_command = str(value)

2255

1607

2256

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2257

@dbus_service_property(_interface,

2258

signature="b",

1609

2259

access="readwrite")

1610

2260

def CheckerRunning_dbus_property(self, value=None):

1611

2261

if value is None: # get

1614

2264

self.start_checker()

1615

2265

else:

1616

2266

self.stop_checker()

1617

2267

1618

2268

# ObjectPath - property

2269

@dbus_annotations(

2270

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

2271

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

1619

2272

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

1620

2273

def ObjectPath_dbus_property(self):

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2274

return self.dbus_object_path # is already a dbus.ObjectPath

2275

1623

2276

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2277

@dbus_annotations(

2278

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

2279

"invalidates"})

2280

@dbus_service_property(_interface,

2281

signature="ay",

2282

access="write",

2283

byte_arrays=True)

1626

2284

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

1628

2285

self.secret = bytes(value)

2286

1629

2287

del _interface

1630

2288

1631

2289

1632

class ProxyClient(object):

1633

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

2290

class ProxyClient:

2291

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

1634

2292

self._pipe = child_pipe

1635

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

2293

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

1636

2294

if not self._pipe.recv():

1637

raise KeyError()

1638

2295

raise KeyError(key_id or fpr)

2296

1639

2297

def __getattribute__(self, name):

1640

if name == '_pipe':

2298

if name == "_pipe":

1641

2299

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

1642

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

2300

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

1643

2301

data = self._pipe.recv()

1644

if data[0] == 'data':

2302

if data[0] == "data":

1645

2303

return data[1]

1646

if data[0] == 'function':

2304

if data[0] == "function":

2305

1647

2306

def func(*args, **kwargs):

1648

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

2307

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

1649

2308

return self._pipe.recv()[1]

2309

1650

2310

return func

1651

2311

1652

2312

def __setattr__(self, name, value):

1653

if name == '_pipe':

2313

if name == "_pipe":

1654

2314

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

1655

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

2315

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

1656

2316

1657

2317

1658

2318

class ClientHandler(socketserver.BaseRequestHandler, object):

1659

2319

"""A class to handle client connections.

1660

2320

1661

2321

Instantiated once for each connection to handle it.

1662

2322

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

1663

2323

1664

2324

def handle(self):

1665

2325

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

2326

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

2327

str(self.client_address))

2328

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

2329

2330

session = gnutls.ClientSession(self.request)

2331

2332

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

2333

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

2334

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

2335

# "+DHE-DSS"))

1685

2336

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

1686

2337

priority = self.server.gnutls_priority

1687

2338

if priority is None:

1688

2339

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2340

gnutls.priority_set_direct(session,

2341

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

2342

1693

2343

# Start communication using the Mandos protocol

1694

2344

# Get protocol number

1695

2345

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

1696

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

2346

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

1697

2347

try:

1698

2348

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

1699

raise RuntimeError

2349

raise RuntimeError(line)

1700

2350

except (ValueError, IndexError, RuntimeError) as error:

1701

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

2351

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

1702

2352

return

1703

2353

1704

2354

# Start GnuTLS connection

1705

2355

try:

1706

2356

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

1708

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

2357

except gnutls.Error as error:

2358

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

1709

2359

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

1710

2360

# established. Just abandon the request.

1711

2361

return

1712

logger.debug("Handshake succeeded")

1713

2362

log.debug("Handshake succeeded")

2363

1714

2364

approval_required = False

1715

2365

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,

2366

if gnutls.has_rawpk:

2367

fpr = b""

2368

try:

2369

key_id = self.key_id(

2370

self.peer_certificate(session))

2371

except (TypeError, gnutls.Error) as error:

2372

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

2373

return

2374

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

2375

key_id.decode("utf-8",

2376

errors="replace"))

2377

2378

else:

2379

key_id = b""

2380

try:

2381

fpr = self.fingerprint(

2382

self.peer_certificate(session))

2383

except (TypeError, gnutls.Error) as error:

2384

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

2385

return

2386

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

2387

2388

try:

2389

client = ProxyClient(child_pipe, key_id, fpr,

1727

2390

self.client_address)

1728

2391

except KeyError:

1729

2392

return

1730

2393

1731

2394

if client.approval_delay:

1732

2395

delay = client.approval_delay

1733

2396

client.approvals_pending += 1

1734

2397

approval_required = True

1735

2398

1736

2399

while True:

1737

2400

if not client.enabled:

1738

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

1739

client.name)

2401

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

1740

2402

if self.server.use_dbus:

1741

2403

# Emit D-Bus signal

1742

2404

client.Rejected("Disabled")

1743

2405

return

1744

2406

1745

2407

if client.approved or not client.approval_delay:

1746

#We are approved or approval is disabled

2408

# We are approved or approval is disabled

1747

2409

break

1748

2410

elif client.approved is None:

1749

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

2411

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

2412

client.name)

2413

if self.server.use_dbus:

2414

# Emit D-Bus signal

2415

client.NeedApproval(

2416

client.approval_delay.total_seconds()

2417

* 1000, client.approved_by_default)

2418

else:

2419

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

1750

2420

client.name)

1751

2421

if self.server.use_dbus:

1752

2422

# 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

2423

client.Rejected("Denied")

1762

2424

return

1763

1764

#wait until timeout or approved

2425

2426

# wait until timeout or approved

1765

2427

time = datetime.datetime.now()

1766

2428

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2429

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

1770

2430

client.changedstate.release()

1771

2431

time2 = datetime.datetime.now()

1772

2432

if (time2 - time) >= delay:

1773

2433

if not client.approved_by_default:

1774

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

1775

" waiting for approval",

1776

client.name)

2434

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

2435

" waiting for approval",

2436

client.name)

1777

2437

if self.server.use_dbus:

1778

2438

# Emit D-Bus signal

1779

2439

client.Rejected("Approval timed out")

1782

2442

break

1783

2443

else:

1784

2444

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)

2445

2446

try:

2447

session.send(client.secret)

2448

except gnutls.Error as error:

2449

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

2450

return

2451

2452

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

1800

2453

# bump the timeout using extended_timeout

1801

2454

client.bump_timeout(client.extended_timeout)

1802

2455

if self.server.use_dbus:

1803

2456

# Emit D-Bus signal

1804

2457

client.GotSecret()

1805

2458

1806

2459

finally:

1807

2460

if approval_required:

1808

2461

client.approvals_pending -= 1

1809

2462

try:

1810

2463

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

1812

logger.warning("GnuTLS bye failed",

1813

exc_info=error)

1814

2464

except gnutls.Error as error:

2465

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

2466

1815

2467

@staticmethod

1816

2468

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

2469

"Return the peer's certificate as a bytestring"

2470

try:

2471

cert_type = gnutls.certificate_type_get2(

2472

session, gnutls.CTYPE_PEERS)

2473

except AttributeError:

2474

cert_type = gnutls.certificate_type_get(session)

2475

if gnutls.has_rawpk:

2476

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2477

else:

2478

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2479

# If not a valid certificate type...

2480

if cert_type not in valid_cert_types:

2481

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

2482

valid_cert_types)

2483

# ...return invalid data

2484

return b""

1824

2485

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

2486

cert_list = (gnutls.certificate_get_peers

2487

(session, ctypes.byref(list_size)))

1828

2488

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

1829

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

1830

" certificate")

2489

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

1831

2490

if list_size.value == 0:

1832

2491

return None

1833

2492

cert = cert_list[0]

1834

2493

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

1835

2494

2495

@staticmethod

2496

def key_id(certificate):

2497

"Convert a certificate bytestring to a hexdigit key ID"

2498

# New GnuTLS "datum" with the public key

2499

datum = gnutls.datum_t(

2500

ctypes.cast(ctypes.c_char_p(certificate),

2501

ctypes.POINTER(ctypes.c_ubyte)),

2502

ctypes.c_uint(len(certificate)))

2503

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

2504

# New empty GnuTLS certificate

2505

pubkey = gnutls.pubkey_t()

2506

gnutls.pubkey_init(ctypes.byref(pubkey))

2507

# Import the raw public key into the certificate

2508

gnutls.pubkey_import(pubkey,

2509

ctypes.byref(datum),

2510

gnutls.X509_FMT_DER)

2511

# New buffer for the key ID

2512

buf = ctypes.create_string_buffer(32)

2513

buf_len = ctypes.c_size_t(len(buf))

2514

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

2515

gnutls.pubkey_get_key_id(

2516

pubkey,

2517

gnutls.KEYID_USE_SHA256,

2518

ctypes.cast(ctypes.byref(buf),

2519

ctypes.POINTER(ctypes.c_ubyte)),

2520

ctypes.byref(buf_len))

2521

# Deinit the certificate

2522

gnutls.pubkey_deinit(pubkey)

2523

2524

# Convert the buffer to a Python bytestring

2525

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

2526

# Convert the bytestring to hexadecimal notation

2527

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

2528

return hex_key_id

2529

1836

2530

@staticmethod

1837

2531

def fingerprint(openpgp):

1838

2532

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2533

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

2534

datum = gnutls.datum_t(

2535

ctypes.cast(ctypes.c_char_p(openpgp),

2536

ctypes.POINTER(ctypes.c_ubyte)),

2537

ctypes.c_uint(len(openpgp)))

1845

2538

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

2539

crt = gnutls.openpgp_crt_t()

2540

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2541

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

2542

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

2543

gnutls.OPENPGP_FMT_RAW)

1854

2544

# Verify the self signature in the key

1855

2545

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2546

gnutls.openpgp_crt_verify_self(crt, 0,

2547

ctypes.byref(crtverify))

1859

2548

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2549

gnutls.openpgp_crt_deinit(crt)

2550

raise gnutls.CertificateSecurityError(code

2551

=crtverify.value)

1863

2552

# New buffer for the fingerprint

1864

2553

buf = ctypes.create_string_buffer(20)

1865

2554

buf_len = ctypes.c_size_t()

1866

2555

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

2556

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

2557

ctypes.byref(buf_len))

1870

2558

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2559

gnutls.openpgp_crt_deinit(crt)

1872

2560

# Convert the buffer to a Python bytestring

1873

2561

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

1874

2562

# Convert the bytestring to hexadecimal notation

1876

2564

return hex_fpr

1877

2565

1878

2566

1879

class MultiprocessingMixIn(object):

2567

class MultiprocessingMixIn:

1880

2568

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

2569

1881

2570

def sub_process_main(self, request, address):

1882

2571

try:

1883

2572

self.finish_request(request, address)

1884

2573

except Exception:

1885

2574

self.handle_error(request, address)

1886

2575

self.close_request(request)

1887

2576

1888

2577

def process_request(self, request, address):

1889

2578

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

1890

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

1891

args = (request, address))

2579

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

2580

args=(request, address))

1892

2581

proc.start()

1893

2582

return proc

1894

2583

1895

2584

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2585

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1897

2586

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

2587

1898

2588

def process_request(self, request, client_address):

1899

2589

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

1900

2590

1901

2591

This function creates a new pipe in self.pipe

1902

2592

"""

1903

2593

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1904

2594

1905

2595

proc = MultiprocessingMixIn.process_request(self, request,

1906

2596

client_address)

1907

2597

self.child_pipe.close()

1908

2598

self.add_pipe(parent_pipe, proc)

1909

2599

1910

2600

def add_pipe(self, parent_pipe, proc):

1911

2601

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

1912

raise NotImplementedError

2602

raise NotImplementedError()

1913

2603

1914

2604

1915

2605

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1916

socketserver.TCPServer, object):

1917

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

1918

2606

socketserver.TCPServer):

2607

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

2608

1919

2609

Attributes:

1920

2610

enabled: Boolean; whether this server is activated yet

1921

2611

interface: None or a network interface name (string)

1922

2612

use_ipv6: Boolean; to use IPv6 or not

1923

2613

"""

2614

1924

2615

def __init__(self, server_address, RequestHandlerClass,

1925

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

2616

interface=None,

2617

use_ipv6=True,

2618

socketfd=None):

1926

2619

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

1927

2620

creating a new one with socket.socket().

1928

2621

"""

1934

2627

self.socketfd = socketfd

1935

2628

# Save the original socket.socket() function

1936

2629

self.socket_socket = socket.socket

2630

1937

2631

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

1938

#

2632

#

1939

2633

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

1940

2634

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

1941

2635

# patching socket.socket.)

1942

#

2636

#

1943

2637

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

1944

2638

@functools.wraps(socket.socket)

1945

2639

def socket_wrapper(*args, **kwargs):

1957

2651

# socket_wrapper(), if socketfd was set.

1958

2652

socketserver.TCPServer.__init__(self, server_address,

1959

2653

RequestHandlerClass)

1960

2654

1961

2655

def server_bind(self):

1962

2656

"""This overrides the normal server_bind() function

1963

2657

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

1964

2658

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

2659

global SO_BINDTODEVICE

1965

2660

if self.interface is not None:

1966

2661

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

2662

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

2663

# common enough.

2664

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

2665

SO_BINDTODEVICE = 25

2666

try:

2667

self.socket.setsockopt(

2668

socket.SOL_SOCKET, SO_BINDTODEVICE,

2669

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

2670

except socket.error as error:

2671

if error.errno == errno.EPERM:

2672

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

2673

self.interface)

2674

elif error.errno == errno.ENOPROTOOPT:

2675

log.error("SO_BINDTODEVICE not available; cannot"

2676

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

2677

elif error.errno == errno.ENODEV:

2678

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

2679

" bind", self.interface)

2680

else:

2681

raise

1988

2682

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

1989

2683

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

2684

if self.server_address[1]:

2685

self.allow_reuse_address = True

1990

2686

if not self.server_address[0]:

1991

2687

if self.address_family == socket.AF_INET6:

1992

any_address = "::" # in6addr_any

2688

any_address = "::" # in6addr_any

1993

2689

else:

1994

any_address = "0.0.0.0" # INADDR_ANY

2690

any_address = "0.0.0.0" # INADDR_ANY

1995

2691

self.server_address = (any_address,

1996

2692

self.server_address[1])

1997

2693

elif not self.server_address[1]:

1998

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

1999

0)

2694

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

2000

2695

# if self.interface:

2001

2696

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

2002

2697

# 0, # port

2008

2703

2009

2704

class MandosServer(IPv6_TCPServer):

2010

2705

"""Mandos server.

2011

2706

2012

2707

Attributes:

2013

2708

clients: set of Client objects

2014

2709

gnutls_priority GnuTLS priority string

2015

2710

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

2016

2017

Assumes a gobject.MainLoop event loop.

2711

2712

Assumes a GLib.MainLoop event loop.

2018

2713

"""

2714

2019

2715

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

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

2716

interface=None,

2717

use_ipv6=True,

2718

clients=None,

2719

gnutls_priority=None,

2720

use_dbus=True,

2721

socketfd=None):

2022

2722

self.enabled = False

2023

2723

self.clients = clients

2024

2724

if self.clients is None:

2027

2727

self.gnutls_priority = gnutls_priority

2028

2728

IPv6_TCPServer.__init__(self, server_address,

2029

2729

RequestHandlerClass,

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2730

interface=interface,

2731

use_ipv6=use_ipv6,

2732

socketfd=socketfd)

2733

2033

2734

def server_activate(self):

2034

2735

if self.enabled:

2035

2736

return socketserver.TCPServer.server_activate(self)

2036

2737

2037

2738

def enable(self):

2038

2739

self.enabled = True

2039

2740

2040

2741

def add_pipe(self, parent_pipe, proc):

2041

2742

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

2743

GLib.io_add_watch(

2744

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

2745

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

2746

functools.partial(self.handle_ipc,

2747

parent_pipe=parent_pipe,

2748

proc=proc))

2749

2750

def handle_ipc(self, source, condition,

2751

parent_pipe=None,

2752

proc=None,

2753

client_object=None):

2051

2754

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

2052

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

2755

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

2053

2756

# Wait for other process to exit

2054

2757

proc.join()

2055

2758

return False

2056

2759

2057

2760

# Read a request from the child

2058

2761

request = parent_pipe.recv()

2059

2762

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:

2763

2764

if command == "init":

2765

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

2766

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

2767

address = request[3]

2768

2769

for c in self.clients.values():

2770

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2771

"27AE41E4649B934CA495991B7852B855"):

2772

continue

2773

if key_id and c.key_id == key_id:

2774

client = c

2775

break

2776

if fpr and c.fingerprint == fpr:

2067

2777

client = c

2068

2778

break

2069

2779

else:

2070

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

2071

"dress: %s", fpr, address)

2780

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

2781

" %s", key_id or fpr, address)

2072

2782

if self.use_dbus:

2073

2783

# Emit D-Bus signal

2074

mandos_dbus_service.ClientNotFound(fpr,

2784

mandos_dbus_service.ClientNotFound(key_id or fpr,

2075

2785

address[0])

2076

2786

parent_pipe.send(False)

2077

2787

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

2788

2789

GLib.io_add_watch(

2790

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

2791

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

2792

functools.partial(self.handle_ipc,

2793

parent_pipe=parent_pipe,

2794

proc=proc,

2795

client_object=client))

2087

2796

parent_pipe.send(True)

2088

2797

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

2089

2798

# same fileno

2090

2799

return False

2091

if command == 'funcall':

2800

if command == "funcall":

2092

2801

funcname = request[1]

2093

2802

args = request[2]

2094

2803

kwargs = request[3]

2095

2096

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

2804

2805

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

2097

2806

funcname)(*args,

2098

**kwargs)))

2099

2100

if command == 'getattr':

2807

**kwargs)))

2808

2809

if command == "getattr":

2101

2810

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2811

if isinstance(client_object.__getattribute__(attrname),

2812

collections.abc.Callable):

2813

parent_pipe.send(("function", ))

2104

2814

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2108

if command == 'setattr':

2815

parent_pipe.send((

2816

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

2817

2818

if command == "setattr":

2109

2819

attrname = request[1]

2110

2820

value = request[2]

2111

2821

setattr(client_object, attrname, value)

2112

2822

2113

2823

return True

2114

2824

2115

2825

2116

2826

def rfc3339_duration_to_delta(duration):

2117

2827

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

2828

2829

>>> timedelta = datetime.timedelta

2830

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

2831

True

2832

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

2833

True

2834

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

2835

True

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

>>> del timedelta

2133

2845

"""

2134

2846

2135

2847

# Parsing an RFC 3339 duration with regular expressions is not

2136

2848

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

2137

2849

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

2138

2850

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

2139

2851

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

2140

2852

# avoid excessive use of external libraries.

2141

2853

2142

2854

# 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

2855

Token = collections.namedtuple("Token", (

2856

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

2857

# a "group" containing digits

2858

"value", # datetime.timedelta or None

2859

"followers")) # Tokens valid after this token

2152

2860

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

2153

2861

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

2154

2862

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

2155

2863

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

2156

2864

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2865

frozenset((token_end, )))

2158

2866

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

2159

2867

datetime.timedelta(minutes=1),

2160

2868

frozenset((token_second, token_end)))

2176

2884

frozenset((token_month, token_end)))

2177

2885

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

2178

2886

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2887

frozenset((token_end, )))

2180

2888

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

2181

2889

frozenset((token_year, token_month,

2182

2890

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2891

token_week)))

2892

# Define starting values:

2893

# Value so far

2894

value = datetime.timedelta()

2186

2895

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2896

# Following valid tokens

2897

followers = frozenset((token_duration, ))

2898

# String left to parse

2899

s = duration

2189

2900

# Loop until end token is found

2190

2901

while found_token is not token_end:

2191

2902

# Search for any currently valid tokens

2207

2918

break

2208

2919

else:

2209

2920

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2921

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

2922

.format(duration))

2211

2923

# End token found

2212

2924

return value

2213

2925

2214

2926

2215

2927

def string_to_delta(interval):

2216

2928

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

2929

2930

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

2931

True

2932

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

2933

True

2934

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

2935

True

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2230

2942

"""

2231

2943

2232

2944

try:

2233

2945

return rfc3339_duration_to_delta(interval)

2234

2946

except ValueError:

2235

2947

pass

2236

2948

2237

2949

timevalue = datetime.timedelta(0)

2238

2950

for s in interval.split():

2239

2951

try:

2240

suffix = unicode(s[-1])

2952

suffix = s[-1]

2241

2953

value = int(s[:-1])

2242

2954

if suffix == "d":

2243

2955

delta = datetime.timedelta(value)

2250

2962

elif suffix == "w":

2251

2963

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

2252

2964

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2965

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

2966

except IndexError as e:

2256

2967

raise ValueError(*(e.args))

2257

2968

timevalue += delta

2258

2969

return timevalue

2259

2970

2260

2971

2261

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

2972

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

2262

2973

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

2263

2974

2264

2975

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

2265

2976

if os.fork():

2266

2977

sys.exit()

2274

2985

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

2275

2986

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

2276

2987

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2988

"{} not a character device"

2278

2989

.format(os.devnull))

2279

2990

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

2280

2991

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

2284

2995

2285

2996

2286

2997

def main():

2287

2998

2288

2999

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

2289

3000

# Parsing of options, both command line and config file

2290

3001

2291

3002

parser = argparse.ArgumentParser()

2292

3003

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

2293

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

3004

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

2294

3005

help="show version number and exit")

2295

3006

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

2296

3007

help="Bind to interface IF")

2329

3040

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

2330

3041

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

2331

3042

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

2332

3043

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

3044

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

3045

default=None)

3046

2333

3047

options = parser.parse_args()

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

3048

2340

3049

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

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

3050

if gnutls.has_rawpk:

3051

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

3052

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

3053

else:

3054

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

3055

":+SIGN-DSA-SHA256")

3056

server_defaults = {"interface": "",

3057

"address": "",

3058

"port": "",

3059

"debug": "False",

3060

"priority": priority,

3061

"servicename": "Mandos",

3062

"use_dbus": "True",

3063

"use_ipv6": "True",

3064

"debuglevel": "",

3065

"restore": "True",

3066

"socket": "",

3067

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

3068

"foreground": "False",

3069

"zeroconf": "True",

3070

}

3071

del priority

3072

2357

3073

# Parse config file for server-global settings

2358

server_config = configparser.SafeConfigParser(server_defaults)

3074

server_config = configparser.ConfigParser(server_defaults)

2359

3075

del server_defaults

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3076

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

3077

# Convert the ConfigParser object to a dict

2363

3078

server_settings = server_config.defaults()

2364

3079

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

2365

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

3080

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

3081

"foreground", "zeroconf"):

2366

3082

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

2367

3083

option)

2368

3084

if server_settings["port"]:

2378

3094

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

2379

3095

["socket"])

2380

3096

del server_config

2381

3097

2382

3098

# Override the settings from the config file with command line

2383

3099

# options, if set.

2384

3100

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

2385

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

2386

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

2387

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

3101

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

3102

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

3103

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

2388

3104

value = getattr(options, option)

2389

3105

if value is not None:

2390

3106

server_settings[option] = value

2391

3107

del options

2392

3108

# Force all strings to be unicode

2393

3109

for option in server_settings.keys():

2394

if type(server_settings[option]) is str:

2395

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

3110

if isinstance(server_settings[option], bytes):

3111

server_settings[option] = (server_settings[option]

3112

.decode("utf-8"))

2396

3113

# Force all boolean options to be boolean

2397

3114

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

2398

"foreground"):

3115

"foreground", "zeroconf"):

2399

3116

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

2400

3117

# Debug implies foreground

2401

3118

if server_settings["debug"]:

2402

3119

server_settings["foreground"] = True

2403

3120

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

2404

3121

2405

3122

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

2406

3123

3124

if (not server_settings["zeroconf"]

3125

and not (server_settings["port"]

3126

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

3127

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

3128

2407

3129

# For convenience

2408

3130

debug = server_settings["debug"]

2409

3131

debuglevel = server_settings["debuglevel"]

2412

3134

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

2413

3135

stored_state_file)

2414

3136

foreground = server_settings["foreground"]

2415

3137

zeroconf = server_settings["zeroconf"]

3138

2416

3139

if debug:

2417

3140

initlogger(debug, logging.DEBUG)

2418

3141

else:

2421

3144

else:

2422

3145

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

2423

3146

initlogger(debug, level)

2424

3147

2425

3148

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

3149

syslogger.setFormatter(

3150

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

3151

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

3152

server_settings["servicename"])))

3153

2432

3154

# Parse config file with clients

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3155

client_config = configparser.ConfigParser(Client.client_defaults)

2435

3156

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

2436

3157

"clients.conf"))

2437

3158

2438

3159

global mandos_dbus_service

2439

3160

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

3161

3162

socketfd = None

3163

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

3164

socketfd = server_settings["socket"]

3165

tcp_server = MandosServer(

3166

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

3167

ClientHandler,

3168

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

3169

use_ipv6=use_ipv6,

3170

gnutls_priority=server_settings["priority"],

3171

use_dbus=use_dbus,

3172

socketfd=socketfd)

2452

3173

if not foreground:

2453

3174

pidfilename = "/run/mandos.pid"

3175

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

3176

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

2454

3177

pidfile = None

2455

3178

try:

2456

pidfile = open(pidfilename, "w")

3179

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

2457

3180

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

3181

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

3182

exc_info=e)

3183

3184

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

3185

("mandos", "mandos"),

3186

("nobody", "nogroup")):

2462

3187

try:

2463

3188

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

3189

gid = pwd.getpwnam(group).pw_gid

2465

3190

break

2466

3191

except KeyError:

2467

3192

continue

2471

3196

try:

2472

3197

os.setgid(gid)

2473

3198

os.setuid(uid)

3199

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

2474

3200

except OSError as error:

3201

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

3202

os.strerror(error.errno))

2475

3203

if error.errno != errno.EPERM:

2476

raise error

2477

3204

raise

3205

2478

3206

if debug:

2479

3207

# Enable all possible GnuTLS debugging

2480

3208

2481

3209

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

2482

3210

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3211

gnutls.global_set_log_level(11)

3212

3213

@gnutls.log_func

2486

3214

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

3215

log.debug("GnuTLS: %s",

3216

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

3217

3218

gnutls.global_set_log_function(debug_gnutls)

3219

2492

3220

# Redirect stdin so all checkers get /dev/null

2493

3221

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

2494

3222

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

2495

3223

if null > 2:

2496

3224

os.close(null)

2497

3225

2498

3226

# Need to fork before connecting to D-Bus

2499

3227

if not foreground:

2500

3228

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

2501

3229

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

3230

3231

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

3232

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

3233

# need to inform GLib that threads will be used.

3234

GLib.threads_init()

3235

2507

3236

global main_loop

2508

3237

# From the Avahi example code

2509

3238

DBusGMainLoop(set_as_default=True)

2510

main_loop = gobject.MainLoop()

3239

main_loop = GLib.MainLoop()

2511

3240

bus = dbus.SystemBus()

2512

3241

# End of Avahi example code

2513

3242

if use_dbus:

2514

3243

try:

2515

3244

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)

3245

bus,

3246

do_not_queue=True)

3247

old_bus_name = dbus.service.BusName(

3248

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

3249

do_not_queue=True)

3250

except dbus.exceptions.DBusException as e:

3251

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

2522

3252

use_dbus = False

2523

3253

server_settings["use_dbus"] = False

2524

3254

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

3255

if zeroconf:

3256

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3257

service = AvahiServiceToSyslog(

3258

name=server_settings["servicename"],

3259

servicetype="_mandos._tcp",

3260

protocol=protocol,

3261

bus=bus)

3262

if server_settings["interface"]:

3263

service.interface = if_nametoindex(

3264

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

3265

2534

3266

global multiprocessing_manager

2535

3267

multiprocessing_manager = multiprocessing.Manager()

2536

3268

2537

3269

client_class = Client

2538

3270

if use_dbus:

2539

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

2540

3271

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

3272

2541

3273

client_settings = Client.config_parser(client_config)

2542

3274

old_client_settings = {}

2543

3275

clients_data = {}

2544

3276

2545

3277

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

2546

3278

global wnull

2547

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

3279

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

2548

3280

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

2549

3281

# mode

2550

3282

if debug or not foreground:

2551

3283

wnull.close()

2552

3284

2553

3285

# Get client data and settings from last running state.

2554

3286

if server_settings["restore"]:

2555

3287

try:

2556

3288

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

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3289

if sys.version_info.major == 2:

3290

clients_data, old_client_settings = pickle.load(

3291

stored_state)

3292

else:

3293

bytes_clients_data, bytes_old_client_settings = (

3294

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

3295

# Fix bytes to strings

3296

# clients_data

3297

# .keys()

3298

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

3299

if isinstance(key, bytes)

3300

else key): value

3301

for key, value in

3302

bytes_clients_data.items()}

3303

del bytes_clients_data

3304

for key in clients_data:

3305

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

3306

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

3307

for k, v in

3308

clients_data[key].items()}

3309

clients_data[key] = value

3310

# .client_structure

3311

value["client_structure"] = [

3312

(s.decode("utf-8")

3313

if isinstance(s, bytes)

3314

else s) for s in

3315

value["client_structure"]]

3316

# .name, .host, and .checker_command

3317

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

3318

if isinstance(value[k], bytes):

3319

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

3320

if "key_id" not in value:

3321

value["key_id"] = ""

3322

elif "fingerprint" not in value:

3323

value["fingerprint"] = ""

3324

# old_client_settings

3325

# .keys()

3326

old_client_settings = {

3327

(key.decode("utf-8")

3328

if isinstance(key, bytes)

3329

else key): value

3330

for key, value in

3331

bytes_old_client_settings.items()}

3332

del bytes_old_client_settings

3333

# .host and .checker_command

3334

for value in old_client_settings.values():

3335

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

3336

if isinstance(value[attribute], bytes):

3337

value[attribute] = (value[attribute]

3338

.decode("utf-8"))

2559

3339

os.remove(stored_state_path)

2560

3340

except IOError as e:

2561

3341

if e.errno == errno.ENOENT:

2562

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

2563

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

3342

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

3343

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

2564

3344

else:

2565

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

2566

exc_info=e)

3345

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

3346

exc_info=e)

2567

3347

raise

2568

3348

except EOFError as e:

2569

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

2570

"EOFError:", exc_info=e)

2571

3349

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

3350

exc_info=e)

3351

2572

3352

with PGPEngine() as pgp:

2573

for client_name, client in clients_data.iteritems():

3353

for client_name, client in clients_data.items():

2574

3354

# Skip removed clients

2575

3355

if client_name not in client_settings:

2576

3356

continue

2577

3357

2578

3358

# Decide which value to use after restoring saved state.

2579

3359

# We have three different values: Old config file,

2580

3360

# new config file, and saved state.

2585

3365

# For each value in new config, check if it

2586

3366

# differs from the old config value (Except for

2587

3367

# the "secret" attribute)

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3368

if (name != "secret"

3369

and (value !=

3370

old_client_settings[client_name][name])):

2591

3371

client[name] = value

2592

3372

except KeyError:

2593

3373

pass

2594

3374

2595

3375

# Clients who has passed its expire date can still be

2596

# enabled if its last checker was successful. Clients

3376

# enabled if its last checker was successful. A Client

2597

3377

# whose checker succeeded before we stored its state is

2598

3378

# assumed to have successfully run all checkers during

2599

3379

# downtime.

2600

3380

if client["enabled"]:

2601

3381

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

2602

3382

if not client["last_checked_ok"]:

2603

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3383

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

3384

" never performed a successful"

3385

" checker", client_name)

2607

3386

client["enabled"] = False

2608

3387

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

3388

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

3389

" last checker failed with error"

3390

" code %s", client_name,

3391

client["last_checker_status"])

2614

3392

client["enabled"] = False

2615

3393

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

3394

client["expires"] = (

3395

datetime.datetime.utcnow()

3396

+ client["timeout"])

3397

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

3398

" enabled", client_name)

2622

3399

try:

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3400

client["secret"] = pgp.decrypt(

3401

client["encrypted_secret"],

3402

client_settings[client_name]["secret"])

2627

3403

except PGPError:

2628

3404

# 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

3405

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

3406

client_name)

3407

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

3408

["secret"])

3409

2634

3410

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

2635

3411

for client_name in (set(old_client_settings)

2636

3412

- set(client_settings)):

2638

3414

for client_name in (set(client_settings)

2639

3415

- set(old_client_settings)):

2640

3416

clients_data[client_name] = client_settings[client_name]

2641

3417

2642

3418

# Create all client objects

2643

for client_name, client in clients_data.iteritems():

3419

for client_name, client in clients_data.items():

2644

3420

tcp_server.clients[client_name] = client_class(

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3421

name=client_name,

3422

settings=client,

3423

server_settings=server_settings)

3424

2648

3425

if not tcp_server.clients:

2649

logger.warning("No clients defined")

2650

3426

log.warning("No clients defined")

3427

2651

3428

if not foreground:

2652

3429

if pidfile is not None:

3430

pid = os.getpid()

2653

3431

try:

2654

3432

with pidfile:

2655

pid = os.getpid()

2656

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

3433

print(pid, file=pidfile)

2657

3434

except IOError:

2658

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

2659

pidfilename, pid)

3435

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

3436

pidfilename, pid)

2660

3437

del pidfile

2661

3438

del pidfilename

2662

2663

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

2664

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

2665

3439

3440

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

3441

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3442

lambda: main_loop.quit() and False)

3443

2666

3444

if use_dbus:

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3445

3446

@alternate_dbus_interfaces(

3447

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

3448

class MandosDBusService(DBusObjectWithObjectManager):

2670

3449

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

3450

2671

3451

def __init__(self):

2672

3452

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

3453

2673

3454

_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

3455

2681

3456

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

2682

3457

def ClientAdded(self, objpath):

2683

3458

"D-Bus signal"

2684

3459

pass

2685

3460

2686

3461

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

2687

def ClientNotFound(self, fingerprint, address):

3462

def ClientNotFound(self, key_id, address):

2688

3463

"D-Bus signal"

2689

3464

pass

2690

3465

3466

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

3467

"true"})

2691

3468

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

2692

3469

def ClientRemoved(self, objpath, name):

2693

3470

"D-Bus signal"

2694

3471

pass

2695

3472

3473

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

3474

"true"})

2696

3475

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

2697

3476

def GetAllClients(self):

2698

3477

"D-Bus method"

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3478

return dbus.Array(c.dbus_object_path for c in

3479

tcp_server.clients.values())

3480

3481

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

3482

"true"})

2703

3483

@dbus.service.method(_interface,

2704

3484

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

2705

3485

def GetAllClientsWithProperties(self):

2706

3486

"D-Bus method"

2707

3487

return dbus.Dictionary(

2708

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

2709

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

3488

{c.dbus_object_path: c.GetAll(

3489

"se.recompile.Mandos.Client")

3490

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

2710

3491

signature="oa{sv}")

2711

3492

2712

3493

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

2713

3494

def RemoveClient(self, object_path):

2714

3495

"D-Bus method"

2715

for c in tcp_server.clients.itervalues():

3496

for c in tcp_server.clients.values():

2716

3497

if c.dbus_object_path == object_path:

2717

3498

del tcp_server.clients[c.name]

2718

3499

c.remove_from_connection()

2719

# Don't signal anything except ClientRemoved

3500

# Don't signal the disabling

2720

3501

c.disable(quiet=True)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3502

# Emit D-Bus signal for removal

3503

self.client_removed_signal(c)

2723

3504

return

2724

3505

raise KeyError(object_path)

2725

3506

2726

3507

del _interface

2727

3508

3509

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3510

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

3511

def GetManagedObjects(self):

3512

"""D-Bus method"""

3513

return dbus.Dictionary(

3514

{client.dbus_object_path:

3515

dbus.Dictionary(

3516

{interface: client.GetAll(interface)

3517

for interface in

3518

client._get_all_interface_names()})

3519

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

3520

3521

def client_added_signal(self, client):

3522

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

3523

if use_dbus:

3524

# New standard signal

3525

self.InterfacesAdded(

3526

client.dbus_object_path,

3527

dbus.Dictionary(

3528

{interface: client.GetAll(interface)

3529

for interface in

3530

client._get_all_interface_names()}))

3531

# Old signal

3532

self.ClientAdded(client.dbus_object_path)

3533

3534

def client_removed_signal(self, client):

3535

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

3536

if use_dbus:

3537

# New standard signal

3538

self.InterfacesRemoved(

3539

client.dbus_object_path,

3540

client._get_all_interface_names())

3541

# Old signal

3542

self.ClientRemoved(client.dbus_object_path,

3543

client.name)

3544

2728

3545

mandos_dbus_service = MandosDBusService()

2729

3546

3547

# Save modules to variables to exempt the modules from being

3548

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

3549

mp = multiprocessing

3550

wn = wnull

3551

2730

3552

def cleanup():

2731

3553

"Cleanup function; run on exit"

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3554

if zeroconf:

3555

service.cleanup()

3556

3557

mp.active_children()

3558

wn.close()

2736

3559

if not (tcp_server.clients or client_settings):

2737

3560

return

2738

3561

2739

3562

# Store client before exiting. Secrets are encrypted with key

2740

3563

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

2741

3564

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

2742

3565

clients = {}

2743

3566

with PGPEngine() as pgp:

2744

for client in tcp_server.clients.itervalues():

3567

for client in tcp_server.clients.values():

2745

3568

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

2746

3569

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

2747

3570

key)

2748

3571

client_dict = {}

2749

3572

2750

3573

# A list of attributes that can not be pickled

2751

3574

# + secret.

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3575

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

3576

"checker", "server_settings"}

3577

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

3578

.Object):

2756

3579

exclude.add(name)

2757

3580

2758

3581

client_dict["encrypted_secret"] = (client

2759

3582

.encrypted_secret)

2760

3583

for attr in client.client_structure:

2761

3584

if attr not in exclude:

2762

3585

client_dict[attr] = getattr(client, attr)

2763

3586

2764

3587

clients[client.name] = client_dict

2765

3588

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

2766

3589

2767

3590

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

3591

with tempfile.NamedTemporaryFile(

3592

mode="wb",

3593

suffix=".pickle",

3594

prefix="clients-",

3595

dir=os.path.dirname(stored_state_path),

3596

delete=False) as stored_state:

3597

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

3598

protocol=2)

3599

tempname = stored_state.name

2774

3600

os.rename(tempname, stored_state_path)

2775

3601

except (IOError, OSError) as e:

2776

3602

if not debug:

2779

3605

except NameError:

2780

3606

pass

2781

3607

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

3608

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

3609

os.strerror(e.errno))

2784

3610

else:

2785

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

2786

exc_info=e)

2787

raise e

2788

3611

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

3612

exc_info=e)

3613

raise

3614

2789

3615

# Delete all clients, and settings from config

2790

3616

while tcp_server.clients:

2791

3617

name, client = tcp_server.clients.popitem()

2792

3618

if use_dbus:

2793

3619

client.remove_from_connection()

2794

# Don't signal anything except ClientRemoved

3620

# Don't signal the disabling

2795

3621

client.disable(quiet=True)

3622

# Emit D-Bus signal for removal

2796

3623

if use_dbus:

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3624

mandos_dbus_service.client_removed_signal(client)

2801

3625

client_settings.clear()

2802

3626

2803

3627

atexit.register(cleanup)

2804

2805

for client in tcp_server.clients.itervalues():

3628

3629

for client in tcp_server.clients.values():

2806

3630

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3631

# Emit D-Bus signal for adding

3632

mandos_dbus_service.client_added_signal(client)

2809

3633

# Need to initiate checking of clients

2810

3634

if client.enabled:

2811

client.init_checker()

2812

3635

client.init_checker(randomize_start=True)

3636

2813

3637

tcp_server.enable()

2814

3638

tcp_server.server_activate()

2815

3639

2816

3640

# Find out what port we got

2817

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

3641

if zeroconf:

3642

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

2818

3643

if use_ipv6:

2819

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

2820

" flowinfo %d, scope_id %d",

2821

*tcp_server.socket.getsockname())

3644

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

3645

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

2822

3646

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

3647

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

3648

*tcp_server.socket.getsockname())

3649

3650

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

3651

2828

3652

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

3653

if zeroconf:

3654

# From the Avahi example code

3655

try:

3656

service.activate()

3657

except dbus.exceptions.DBusException as error:

3658

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

3659

cleanup()

3660

sys.exit(1)

3661

# End of Avahi example code

3662

3663

GLib.io_add_watch(

3664

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

3665

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3666

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

3667

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

3668

3669

log.debug("Starting main loop")

2844

3670

main_loop.run()

2845

3671

except AvahiError as error:

2846

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

3672

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

2847

3673

cleanup()

2848

3674

sys.exit(1)

2849

3675

except KeyboardInterrupt:

2850

3676

if debug:

2851

3677

print("", file=sys.stderr)

2852

logger.debug("Server received KeyboardInterrupt")

2853

logger.debug("Server exiting")

3678

log.debug("Server received KeyboardInterrupt")

3679

log.debug("Server exiting")

2854

3680

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

2855

3681

cleanup()

2856

3682

2857

if __name__ == '__main__':

2858

main()

3683

3684

def parse_test_args():

3685

# type: () -> argparse.Namespace

3686

parser = argparse.ArgumentParser(add_help=False)

3687

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

3688

parser.add_argument("--prefix", )

3689

args, unknown_args = parser.parse_known_args()

3690

if args.check:

3691

# Remove test options from sys.argv

3692

sys.argv[1:] = unknown_args

3693

return args

3694

3695

# Add all tests from doctest strings

3696

def load_tests(loader, tests, none):

3697

import doctest

3698

tests.addTests(doctest.DocTestSuite())

3699

return tests

3700

3701

if __name__ == "__main__":

3702

options = parse_test_args()

3703

try:

3704

if options.check:

3705

extra_test_prefix = options.prefix

3706

if extra_test_prefix is not None:

3707

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

3708

.result.wasSuccessful()):

3709

sys.exit(1)

3710

class ExtraTestLoader(unittest.TestLoader):

3711

testMethodPrefix = extra_test_prefix

3712

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

3713

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

3714

else:

3715

unittest.main(argv=[""])

3716

else:

3717

main()

3718

finally:

3719

logging.shutdown()

3720

3721

# Local Variables:

3722

# run-tests:

3723

# (lambda (&optional extra)

3724

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

3725

# extra))

3726

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

3727

# (funcall remove-test-window)

3728

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

3729

# run-tests-in-test-buffer:

3730

# (lambda (dir &optional extra)

3731

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

3732

# (setq buffer-read-only nil

3733

# default-directory dir)

3734

# (erase-buffer)

3735

# (compilation-mode))

3736

# (let ((process-result

3737

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

3738

# (process-file-shell-command

3739

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

3740

# (and (numberp process-result)

3741

# (= process-result 0))))

3742

# get-command-line:

3743

# (lambda (&optional extra)

3744

# (let ((quoted-script

3745

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

3746

# (format

3747

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

3748

# quoted-script)))

3749

# get-script-name:

3750

# (lambda ()

3751

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

3752

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

3753

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

3754

# (buffer-file-name))))

3755

# remove-test-window:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (lambda ()

3761

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

3762

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

3763

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

3764

# (display-buffer-overriding-action

3765

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

3766

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

3767

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

3768

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

3769

# eval:

3770

# (progn

3771

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

3772

# (funcall run-tests t)))

3773

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

3774

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

3775

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

3776

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

3777

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

3778

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

3779

# End: