/mandos/trunk : revision 1299

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

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

92

147

stored_state_file = "clients.pickle"

93

148

94

logger = logging.getLogger()

149

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

150

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

95

151

syslogger = None

96

152

97

153

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

156

except (OSError, AttributeError):

157

102

158

def if_nametoindex(interface):

103

159

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

104

160

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

105

161

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

106

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

163

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

164

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

111

165

return interface_index

112

166

113

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

114

184

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

115

185

"""init logger and add loglevel"""

116

186

117

187

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

122

191

syslogger.setFormatter(logging.Formatter

123

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

124

' %(message)s'))

125

logger.addHandler(syslogger)

126

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

127

196

if debug:

128

197

console = logging.StreamHandler()

129

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

130

' [%(process)d]:'

131

' %(levelname)s:'

132

' %(message)s'))

133

logger.addHandler(console)

134

logger.setLevel(level)

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)

135

204

136

205

137

206

class PGPError(Exception):

139

208

pass

140

209

141

210

142

class PGPEngine(object):

211

class PGPEngine:

143

212

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

213

144

214

def __init__(self):

145

215

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

146

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

148

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

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

152

235

def __enter__(self):

153

236

return self

154

237

155

238

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

156

239

self._cleanup()

157

240

return False

158

241

159

242

def __del__(self):

160

243

self._cleanup()

161

244

162

245

def _cleanup(self):

163

246

if self.tempdir is not None:

164

247

# Delete contents of tempdir

165

248

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

166

topdown = False):

249

topdown=False):

167

250

for filename in files:

168

251

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

169

252

for dirname in dirs:

171

254

# Remove tempdir

172

255

os.rmdir(self.tempdir)

173

256

self.tempdir = None

174

257

175

258

def password_encode(self, password):

176

259

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

177

260

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

182

265

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

183

266

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

184

267

return encoded

185

268

186

269

def encrypt(self, data, password):

187

270

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

190

273

passfile.write(passphrase)

191

274

passfile.flush()

192

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

193

'--passphrase-file',

275

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

276

"--passphrase-file",

194

277

passfile.name]

195

278

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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)

200

283

if proc.returncode != 0:

201

284

raise PGPError(err)

202

285

return ciphertext

203

286

204

287

def decrypt(self, data, password):

205

288

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

208

291

passfile.write(passphrase)

209

292

passfile.flush()

210

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

211

'--passphrase-file',

293

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

294

"--passphrase-file",

212

295

passfile.name]

213

296

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

219

301

if proc.returncode != 0:

220

302

raise PGPError(err)

221

303

return decrypted_plaintext

222

304

223

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

224

332

class AvahiError(Exception):

225

333

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

226

334

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

335

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

336

**kwargs)

337

230

338

231

339

class AvahiServiceError(AvahiError):

232

340

pass

233

341

342

234

343

class AvahiGroupError(AvahiError):

235

344

pass

236

345

237

346

238

class AvahiService(object):

347

class AvahiService:

239

348

"""An Avahi (Zeroconf) service.

240

349

241

350

Attributes:

242

351

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

243

352

Used to optionally bind to the specified interface.

244

245

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

353

354

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

246

355

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

247

356

port: integer; what port to announce

248

357

TXT: list of strings; TXT record for the service

255

364

server: D-Bus Server

256

365

bus: dbus.SystemBus()

257

366

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

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

263

379

self.interface = interface

264

380

self.name = name

265

381

self.type = servicetype

274

390

self.server = None

275

391

self.bus = bus

276

392

self.entry_group_state_changed_match = None

277

278

def rename(self):

393

394

def rename(self, remove=True):

279

395

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

280

396

if self.rename_count >= self.max_renames:

281

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

282

" after %i retries, exiting.",

283

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

284

400

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

287

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

288

self.name)

289

self.remove()

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

404

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

405

self.name)

406

if remove:

407

self.remove()

290

408

try:

291

409

self.add()

292

410

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

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

298

420

def remove(self):

299

421

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

300

422

if self.entry_group_state_changed_match is not None:

302

424

self.entry_group_state_changed_match = None

303

425

if self.group is not None:

304

426

self.group.Reset()

305

427

306

428

def add(self):

307

429

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

308

430

self.remove()

313

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

314

436

self.entry_group_state_changed_match = (

315

437

self.group.connect_to_signal(

316

'StateChanged', self.entry_group_state_changed))

317

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

318

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)

319

441

self.group.AddService(

320

442

self.interface,

321

443

self.protocol,

325

447

dbus.UInt16(self.port),

326

448

avahi.string_array_to_txt_array(self.TXT))

327

449

self.group.Commit()

328

450

329

451

def entry_group_state_changed(self, state, error):

330

452

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

331

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

332

453

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

454

333

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

335

457

elif state == avahi.ENTRY_GROUP_COLLISION:

336

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

458

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

337

459

self.rename()

338

460

elif state == avahi.ENTRY_GROUP_FAILURE:

339

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

340

unicode(error))

341

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

342

.format(error))

343

461

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

462

str(error))

463

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

464

344

465

def cleanup(self):

345

466

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

346

467

if self.group is not None:

351

472

pass

352

473

self.group = None

353

474

self.remove()

354

475

355

476

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

356

477

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

357

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

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

}

365

485

if state in bad_states:

366

486

if bad_states[state] is not None:

367

487

if error is None:

368

logger.error(bad_states[state])

488

log.error(bad_states[state])

369

489

else:

370

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

490

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

371

491

self.cleanup()

372

492

elif state == avahi.SERVER_RUNNING:

373

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)

374

504

else:

375

505

if error is None:

376

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

506

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

377

507

else:

378

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

379

508

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

509

380

510

def activate(self):

381

511

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

382

512

if self.server is None:

386

516

follow_name_owner_changes=True),

387

517

avahi.DBUS_INTERFACE_SERVER)

388

518

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

519

self.server_state_changed)

390

520

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

391

521

392

522

393

523

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

524

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

395

525

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

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

401

531

return ret

402

532

403

533

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

class Client(object):

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:

412

875

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

413

876

414

877

Attributes:

415

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

878

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

416

879

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

417

880

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

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

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

422

885

checker_command: string; External command which is run to check

423

886

if client lives. %() expansions are done at

424

887

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

425

888

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

426

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

427

890

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

428

891

client_structure: Object describing what attributes a client has

429

892

and is used for storing the client at exit

430

893

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

432

895

enabled: bool()

433

896

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

434

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

435

900

host: string; available for use by the checker command

436

901

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

437

902

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

439

904

last_checker_status: integer between 0 and 255 reflecting exit

440

905

status of last checker. -1 reflects crashed

441

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

442

909

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

443

910

444

911

D-Bus identifiers

451

918

disabled, or None

452

919

server_settings: The server_settings dict from main()

453

920

"""

454

921

455

922

runtime_expansions = ("approval_delay", "approval_duration",

456

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

923

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

457

924

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

458

925

"last_approval_request", "last_checked_ok",

459

926

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

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

486

939

@staticmethod

487

940

def config_parser(config):

488

941

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

495

948

for client_name in config.sections():

496

949

section = dict(config.items(client_name))

497

950

client = settings[client_name] = {}

498

951

499

952

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

500

953

# Reformat values from string types to Python types

501

954

client["approved_by_default"] = config.getboolean(

502

955

client_name, "approved_by_default")

503

956

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

504

957

"enabled")

505

506

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

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

964

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

965

"").upper()

507

966

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

508

972

if "secret" in section:

509

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

973

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

974

.encode("utf-8"),

975

"base64")

510

976

elif "secfile" in section:

511

977

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

512

978

(section["secfile"])),

513

979

"rb") as secfile:

514

980

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

515

981

else:

516

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

982

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

517

983

.format(section))

518

984

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

519

985

client["extended_timeout"] = string_to_delta(

527

993

client["last_approval_request"] = None

528

994

client["last_checked_ok"] = None

529

995

client["last_checker_status"] = -2

530

996

531

997

return settings

532

533

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

998

999

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

534

1000

self.name = name

535

1001

if server_settings is None:

536

1002

server_settings = {}

537

1003

self.server_settings = server_settings

538

1004

# adding all client settings

539

for setting, value in settings.iteritems():

1005

for setting, value in settings.items():

540

1006

setattr(self, setting, value)

541

1007

542

1008

if self.enabled:

543

1009

if not hasattr(self, "last_enabled"):

544

1010

self.last_enabled = datetime.datetime.utcnow()

548

1014

else:

549

1015

self.last_enabled = None

550

1016

self.expires = None

551

552

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

556

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

1017

1018

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

1019

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

1020

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

557

1021

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

558

1022

datetime.datetime.utcnow())

559

1023

560

1024

# attributes specific for this server instance

561

1025

self.checker = None

562

1026

self.checker_initiator_tag = None

565

1029

self.current_checker_command = None

566

1030

self.approved = None

567

1031

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

1032

self.changedstate = multiprocessing_manager.Condition(

1033

multiprocessing_manager.Lock())

1034

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

573

1036

if not attr.startswith("_")]

574

1037

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

1038

1039

for name, t in inspect.getmembers(

1040

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

580

1041

if not name.startswith("_"):

581

1042

self.client_structure.append(name)

582

1043

583

1044

# Send notice to process children that client state has changed

584

1045

def send_changedstate(self):

585

1046

with self.changedstate:

586

1047

self.changedstate.notify_all()

587

1048

588

1049

def enable(self):

589

1050

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

590

1051

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

591

1052

# Already enabled

592

1053

return

593

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

594

1054

self.enabled = True

595

1055

self.last_enabled = datetime.datetime.utcnow()

596

1056

self.init_checker()

597

1057

self.send_changedstate()

598

1058

599

1059

def disable(self, quiet=True):

600

1060

"""Disable this client."""

601

1061

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

602

1062

return False

603

1063

if not quiet:

604

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

1064

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

605

1065

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

606

gobject.source_remove(self.disable_initiator_tag)

1066

GLib.source_remove(self.disable_initiator_tag)

607

1067

self.disable_initiator_tag = None

608

1068

self.expires = None

609

1069

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

610

gobject.source_remove(self.checker_initiator_tag)

1070

GLib.source_remove(self.checker_initiator_tag)

611

1071

self.checker_initiator_tag = None

612

1072

self.stop_checker()

613

1073

self.enabled = False

614

1074

if not quiet:

615

1075

self.send_changedstate()

616

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

1076

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

617

1077

return False

618

1078

619

1079

def __del__(self):

620

1080

self.disable()

621

622

def init_checker(self):

623

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

624

# and every interval from then on.

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

625

1087

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

630

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

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

631

1106

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

636

# Also start a new checker *right now*.

637

self.start_checker()

638

639

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

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

1112

def checker_callback(self, source, condition, connection,

1113

command):

640

1114

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

1115

# Read return code from connection (see call_pipe)

1116

returncode = connection.recv()

1117

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

641

1120

self.checker_callback_tag = None

642

1121

self.checker = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1122

1123

if returncode >= 0:

1124

self.last_checker_status = returncode

1125

self.last_checker_signal = None

645

1126

if self.last_checker_status == 0:

646

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

647

vars(self))

1127

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

648

1128

self.checked_ok()

649

1129

else:

650

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

651

vars(self))

1130

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

652

1131

else:

653

1132

self.last_checker_status = -1

654

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

655

vars(self))

656

1133

self.last_checker_signal = -returncode

1134

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

1135

return False

1136

657

1137

def checked_ok(self):

658

1138

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

659

1139

self.last_checked_ok = datetime.datetime.utcnow()

660

1140

self.last_checker_status = 0

1141

self.last_checker_signal = None

661

1142

self.bump_timeout()

662

1143

663

1144

def bump_timeout(self, timeout=None):

664

1145

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

665

1146

if timeout is None:

666

1147

timeout = self.timeout

667

1148

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1149

GLib.source_remove(self.disable_initiator_tag)

669

1150

self.disable_initiator_tag = None

670

1151

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1152

self.disable_initiator_tag = GLib.timeout_add(

1153

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

674

1154

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

675

1155

676

1156

def need_approval(self):

677

1157

self.last_approval_request = datetime.datetime.utcnow()

678

679

def start_checker(self):

1158

1159

def start_checker(self, start_was_randomized=False):

680

1160

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

681

1161

682

1162

If a checker already exists, leave it running and do

683

1163

nothing."""

684

1164

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

689

1169

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

690

1170

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

691

1171

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1172

1173

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

1174

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

1175

self.checker.join()

1176

self.checker = None

707

1177

# Start a new checker if needed

708

1178

if self.checker is None:

709

1179

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1180

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

714

1183

try:

715

1184

command = self.checker_command % escaped_attrs

716

1185

except TypeError as error:

717

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1186

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

1187

self.checker_command, exc_info=error)

1188

return True # Try again later

720

1189

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1190

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

1191

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

1192

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

1193

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

1194

# always replaced by /dev/null.)

1195

# The exception is when not debugging but nevertheless

1196

# running in the foreground; use the previously

1197

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

1201

if (not self.server_settings["debug"]

1202

and self.server_settings["foreground"]):

1203

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

1206

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

1210

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1214

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1226

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

763

1227

return True

764

1228

765

1229

def stop_checker(self):

766

1230

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

767

1231

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1232

GLib.source_remove(self.checker_callback_tag)

769

1233

self.checker_callback_tag = None

770

1234

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

771

1235

return

772

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1236

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

1237

self.checker.terminate()

781

1238

self.checker = None

782

1239

783

1240

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1241

def dbus_service_property(dbus_interface,

1242

signature="v",

1243

access="readwrite",

1244

byte_arrays=False):

786

1245

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1246

become properties on the D-Bus.

788

1247

789

1248

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

790

1249

and with one argument by "Set".

791

1250

792

1251

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

793

1252

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

794

1253

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

797

1256

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

798

1257

if byte_arrays and signature != "ay":

799

1258

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

800

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

1259

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

1260

801

1261

def decorator(func):

802

1262

func._dbus_is_property = True

803

1263

func._dbus_interface = dbus_interface

806

1266

func._dbus_name = func.__name__

807

1267

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

808

1268

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

810

1270

return func

1271

811

1272

return decorator

812

1273

813

1274

814

1275

def dbus_interface_annotations(dbus_interface):

815

1276

"""Decorator for marking functions returning interface annotations

816

1277

817

1278

Usage:

818

1279

819

1280

@dbus_interface_annotations("org.example.Interface")

820

1281

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

821

1282

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

822

1283

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

823

1284

"false"}

824

1285

"""

1286

825

1287

def decorator(func):

826

1288

func._dbus_is_interface = True

827

1289

func._dbus_interface = dbus_interface

828

1290

func._dbus_name = dbus_interface

829

1291

return func

1292

830

1293

return decorator

831

1294

832

1295

833

1296

def dbus_annotations(annotations):

834

1297

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

835

1298

Usage:

836

1299

1300

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

1301

"org.freedesktop.DBus.Property."

1302

"EmitsChangedSignal": "false"})

837

1303

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

838

1304

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1305

def Property_dbus_property(self):

843

1306

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

844

1309

"""

1310

845

1311

def decorator(func):

846

1312

func._dbus_annotations = annotations

847

1313

return func

1314

848

1315

return decorator

849

1316

850

1317

851

1318

class DBusPropertyException(dbus.exceptions.DBusException):

852

1319

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

853

1320

"""

854

def __unicode__(self):

855

return unicode(str(self))

1321

pass

856

1322

857

1323

858

1324

class DBusPropertyAccessException(DBusPropertyException):

867

1333

pass

868

1334

869

1335

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1337

"""A D-Bus object with annotations.

1338

1339

Classes inheriting from this can use the dbus_annotations

1340

decorator to add annotations to methods or signals.

876

1341

"""

877

1342

878

1343

@staticmethod

879

1344

def _is_dbus_thing(thing):

880

1345

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

881

1346

882

1347

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

883

1348

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

884

1349

"""

885

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

1350

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

886

1351

False)

887

1352

888

1353

def _get_all_dbus_things(self, thing):

889

1354

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

890

1355

"""

891

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

892

name),

1356

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

893

1357

athing.__get__(self))

894

1358

for cls in self.__class__.__mro__

895

1359

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1360

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

1361

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1366

def Introspect(self, object_path, connection):

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts annotation tags on methods and signals.

1370

"""

1371

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

1372

connection)

1373

try:

1374

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

1375

1376

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

1377

# Add annotation tags

1378

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

1379

for tag in if_tag.getElementsByTagName(typ):

1380

annots = dict()

1381

for name, prop in (self.

1382

_get_all_dbus_things(typ)):

1383

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

1384

and prop._dbus_interface

1385

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

1386

annots.update(getattr(

1387

prop, "_dbus_annotations", {}))

1388

for name, value in annots.items():

1389

ann_tag = document.createElement(

1390

"annotation")

1391

ann_tag.setAttribute("name", name)

1392

ann_tag.setAttribute("value", value)

1393

tag.appendChild(ann_tag)

1394

# Add interface annotation tags

1395

for annotation, value in dict(

1396

itertools.chain.from_iterable(

1397

annotations().items()

1398

for name, annotations

1399

in self._get_all_dbus_things("interface")

1400

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

1401

)).items():

1402

ann_tag = document.createElement("annotation")

1403

ann_tag.setAttribute("name", annotation)

1404

ann_tag.setAttribute("value", value)

1405

if_tag.appendChild(ann_tag)

1406

# Fix argument name for the Introspect method itself

1407

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1409

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

1410

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

1411

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

1412

if (arg.getAttribute("direction")

1413

== "out"):

1414

arg.setAttribute("name",

1415

"xml_data")

1416

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

1417

document.unlink()

1418

except (AttributeError, xml.dom.DOMException,

1419

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1422

return xmlstring

1423

1424

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

"""A D-Bus object with properties.

1427

1428

Classes inheriting from this can use the dbus_service_property

1429

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

1430

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

1431

"""

1432

899

1433

def _get_dbus_property(self, interface_name, property_name):

900

1434

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

901

1435

property with the specified name and interface.

902

1436

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1437

for cls in self.__class__.__mro__:

1438

for name, value in inspect.getmembers(

1439

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

907

1440

if (value._dbus_name == property_name

908

1441

and value._dbus_interface == interface_name):

909

1442

return value.__get__(self)

910

1443

911

1444

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1445

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

1446

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

1457

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

in_signature="ss",

917

1459

out_signature="v")

918

1460

def Get(self, interface_name, property_name):

919

1461

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

925

1467

if not hasattr(value, "variant_level"):

926

1468

return value

927

1469

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

928

1470

929

1471

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

930

1472

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

931

1473

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

938

1480

# signatures other than "ay".

939

1481

if prop._dbus_signature != "ay":

940

1482

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

941

"'ay' signature {0!r}"

1483

"'ay' signature {!r}"

942

1484

.format(prop._dbus_signature))

943

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

944

for byte in value))

1485

value = dbus.ByteArray(bytes(value))

945

1486

prop(value)

946

947

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

1487

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

in_signature="s",

948

1490

out_signature="a{sv}")

949

1491

def GetAll(self, interface_name):

950

1492

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

951

1493

standard.

952

1494

953

1495

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

954

1496

"""

955

1497

properties = {}

965

1507

if not hasattr(value, "variant_level"):

966

1508

properties[name] = value

967

1509

continue

968

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

969

value.variant_level+1)

1510

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

970

1512

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

971

1513

1514

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

1515

def PropertiesChanged(self, interface_name, changed_properties,

1516

invalidated_properties):

1517

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

1518

standard.

1519

"""

1520

pass

1521

972

1522

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1523

out_signature="s",

974

path_keyword='object_path',

975

connection_keyword='connection')

1524

path_keyword="object_path",

1525

connection_keyword="connection")

976

1526

def Introspect(self, object_path, connection):

977

1527

"""Overloading of standard D-Bus method.

978

1528

979

1529

Inserts property tags and interface annotation tags.

980

1530

"""

981

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

982

connection)

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

983

1534

try:

984

1535

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

1536

985

1537

def make_tag(document, name, prop):

986

1538

e = document.createElement("property")

987

1539

e.setAttribute("name", name)

988

1540

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

989

1541

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

990

1542

return e

1543

991

1544

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

992

1545

# Add property tags

993

1546

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

996

1549

if prop._dbus_interface

997

1550

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

998

1551

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1552

# Add annotation tags for properties

1553

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

1554

annots = dict()

1555

for name, prop in self._get_all_dbus_things(

1556

"property"):

1557

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

1558

and prop._dbus_interface

1559

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

1560

annots.update(getattr(

1561

prop, "_dbus_annotations", {}))

1562

for name, value in annots.items():

1563

ann_tag = document.createElement(

1564

"annotation")

1565

ann_tag.setAttribute("name", name)

1566

ann_tag.setAttribute("value", value)

1567

tag.appendChild(ann_tag)

1030

1568

# Add the names to the return values for the

1031

1569

# "org.freedesktop.DBus.Properties" methods

1032

1570

if (if_tag.getAttribute("name")

1046

1584

document.unlink()

1047

1585

except (AttributeError, xml.dom.DOMException,

1048

1586

xml.parsers.expat.ExpatError) as error:

1049

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

1050

exc_info=error)

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1051

1660

return xmlstring

1052

1661

1053

1662

1054

1663

def datetime_to_dbus(dt, variant_level=0):

1055

1664

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

1056

1665

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1666

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

1667

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

1060

1668

1061

1669

1062

1670

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1672

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

1065

1673

interface names according to the "alt_interface_names" mapping.

1066

1674

Usage:

1067

1675

1068

1676

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

1069

1677

"net.example.AlternateInterface"})

1070

1678

class SampleDBusObject(dbus.service.Object):

1071

1679

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

1072

1680

def SampleDBusMethod():

1073

1681

pass

1074

1682

1075

1683

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1684

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

1077

1685

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

1078

1686

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

1079

1687

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

1080

1688

1081

1689

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

1082

1690

(from DBusObjectWithProperties) and interfaces (from the

1083

1691

dbus_interface_annotations decorator).

1084

1692

"""

1693

1085

1694

def wrapper(cls):

1086

1695

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1696

alt_interface_names.items()):

1088

1697

attr = {}

1089

1698

interface_names = set()

1090

1699

# Go though all attributes of the class

1092

1701

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

1093

1702

# with the wrong interface name

1094

1703

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1704

or not attribute._dbus_interface.startswith(

1705

orig_interface_name)):

1097

1706

continue

1098

1707

# Create an alternate D-Bus interface name based on

1099

1708

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1709

alt_interface = attribute._dbus_interface.replace(

1710

orig_interface_name, alt_interface_name)

1103

1711

interface_names.add(alt_interface)

1104

1712

# Is this a D-Bus signal?

1105

1713

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

1106

1714

# Extract the original non-method undecorated

1107

1715

# function by black magic

1108

nonmethod_func = (dict(

1716

if sys.version_info.major == 2:

1717

nonmethod_func = (dict(

1109

1718

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1719

attribute.__closure__))

1720

["func"].cell_contents)

1721

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1112

1726

# Create a new, but exactly alike, function

1113

1727

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

1114

1728

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1729

new_function = copy_function(nonmethod_func)

1730

new_function = (dbus.service.signal(

1731

alt_interface,

1732

attribute._dbus_signature)(new_function))

1124

1733

# Copy annotations, if any

1125

1734

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1735

new_function._dbus_annotations = dict(

1736

attribute._dbus_annotations)

1128

1737

except AttributeError:

1129

1738

pass

1739

1130

1740

# Define a creator of a function to call both the

1131

1741

# original and alternate functions, so both the

1132

1742

# original and alternate signals gets sent when

1135

1745

"""This function is a scope container to pass

1136

1746

func1 and func2 to the "call_both" function

1137

1747

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1138

1750

def call_both(*args, **kwargs):

1139

1751

"""This function will emit two D-Bus

1140

1752

signals by calling func1 and func2"""

1141

1753

func1(*args, **kwargs)

1142

1754

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1143

1761

return call_both

1144

1762

# Create the "call_both" function and add it to

1145

1763

# the class

1150

1768

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

1151

1769

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

1152

1770

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1771

attr[attrname] = (

1772

dbus.service.method(

1773

alt_interface,

1774

attribute._dbus_in_signature,

1775

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1163

1777

# Copy annotations, if any

1164

1778

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1779

attr[attrname]._dbus_annotations = dict(

1780

attribute._dbus_annotations)

1167

1781

except AttributeError:

1168

1782

pass

1169

1783

# Is this a D-Bus property?

1172

1786

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

1173

1787

# property with the alternate D-Bus interface

1174

1788

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1789

attr[attrname] = (dbus_service_property(

1790

alt_interface, attribute._dbus_signature,

1791

attribute._dbus_access,

1792

attribute._dbus_get_args_options

1793

["byte_arrays"])

1794

(copy_function(attribute)))

1188

1795

# Copy annotations, if any

1189

1796

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1797

attr[attrname]._dbus_annotations = dict(

1798

attribute._dbus_annotations)

1192

1799

except AttributeError:

1193

1800

pass

1194

1801

# Is this a D-Bus interface?

1197

1804

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

1198

1805

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

1199

1806

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1807

attr[attrname] = (

1808

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1208

1810

if deprecate:

1209

1811

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1813

for interface_name in interface_names:

1814

1212

1815

@dbus_interface_annotations(interface_name)

1213

1816

def func(self):

1214

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

1215

"true" }

1817

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

1818

"true"}

1216

1819

# Find an unused name

1217

1820

for aname in (iname.format(i)

1218

1821

for i in itertools.count()):

1222

1825

if interface_names:

1223

1826

# Replace the class with a new subclass of it with

1224

1827

# methods, signals, etc. as created above.

1225

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

1226

(cls,), attr)

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1227

1834

return cls

1835

1228

1836

return wrapper

1229

1837

1230

1838

1231

1839

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

1232

"se.bsnet.fukt.Mandos"})

1840

"se.bsnet.fukt.Mandos"})

1233

1841

class ClientDBus(Client, DBusObjectWithProperties):

1234

1842

"""A Client class using D-Bus

1235

1843

1236

1844

Attributes:

1237

1845

dbus_object_path: dbus.ObjectPath

1238

1846

bus: dbus.SystemBus()

1239

1847

"""

1240

1848

1241

1849

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1850

+ ("dbus_object_path", ))

1851

1852

_interface = "se.recompile.Mandos.Client"

1853

1244

1854

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

1245

1246

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

1855

1856

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

1247

1857

self.bus = bus

1248

1858

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

1249

1859

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

1250

1860

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1861

client_object_name = str(self.name).translate(

1252

1862

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

1253

1863

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1864

self.dbus_object_path = dbus.ObjectPath(

1865

"/clients/" + client_object_name)

1256

1866

DBusObjectWithProperties.__init__(self, self.bus,

1257

1867

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1868

1869

def notifychangeproperty(transform_func, dbus_name,

1870

type_func=lambda x: x,

1871

variant_level=1,

1872

invalidate_only=False,

1873

_interface=_interface):

1262

1874

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

1263

1875

its changes to DBus.

1264

1876

1265

1877

transform_fun: Function that takes a value and a variant_level

1266

1878

and transforms it to a D-Bus type.

1267

1879

dbus_name: D-Bus name of the variable

1269

1881

to the D-Bus. Default: no transform

1270

1882

variant_level: D-Bus variant level. Default: 1

1271

1883

"""

1272

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

1884

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

1885

1273

1886

def setter(self, value):

1274

1887

if hasattr(self, "dbus_object_path"):

1275

1888

if (not hasattr(self, attrname) or

1276

1889

type_func(getattr(self, attrname, None))

1277

1890

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1891

if invalidate_only:

1892

self.PropertiesChanged(

1893

_interface, dbus.Dictionary(),

1894

dbus.Array((dbus_name, )))

1895

else:

1896

dbus_value = transform_func(

1897

type_func(value),

1898

variant_level=variant_level)

1899

self.PropertyChanged(dbus.String(dbus_name),

1900

dbus_value)

1901

self.PropertiesChanged(

1902

_interface,

1903

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

1904

dbus_value}),

1905

dbus.Array())

1283

1906

setattr(self, attrname, value)

1284

1907

1285

1908

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

1286

1909

1287

1910

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1911

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1912

"ApprovalPending",

1290

type_func = bool)

1913

type_func=bool)

1291

1914

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

1292

1915

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1916

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1917

checker = notifychangeproperty(

1918

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1297

1920

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1921

"LastCheckedOK")

1299

1922

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1925

datetime_to_dbus, "LastApprovalRequest")

1303

1926

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1927

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1928

approval_delay = notifychangeproperty(

1929

dbus.UInt64, "ApprovalDelay",

1930

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

1309

1931

approval_duration = notifychangeproperty(

1310

1932

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1933

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

1312

1934

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1935

timeout = notifychangeproperty(

1936

dbus.UInt64, "Timeout",

1937

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

1316

1938

extended_timeout = notifychangeproperty(

1317

1939

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1940

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

1941

interval = notifychangeproperty(

1942

dbus.UInt64, "Interval",

1943

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

1323

1944

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

1324

1945

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

1946

invalidate_only=True)

1947

1325

1948

del notifychangeproperty

1326

1949

1327

1950

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

1328

1951

try:

1329

1952

self.remove_from_connection()

1332

1955

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1956

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

1334

1957

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1958

1959

def checker_callback(self, source, condition,

1960

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

1961

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

1962

connection, command, *args,

1963

**kwargs)

1964

exitstatus = self.last_checker_status

1965

if exitstatus >= 0:

1342

1966

# Emit D-Bus signal

1343

1967

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1345

1970

dbus.String(command))

1346

1971

else:

1347

1972

# Emit D-Bus signal

1348

1973

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

1349

dbus.Int64(condition),

1974

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1350

1978

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1979

return ret

1980

1355

1981

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

1356

1982

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

1357

1983

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

1361

1987

# Emit D-Bus signal

1362

1988

self.CheckerStarted(self.current_checker_command)

1363

1989

return r

1364

1990

1365

1991

def _reset_approved(self):

1366

1992

self.approved = None

1367

1993

return False

1368

1994

1369

1995

def approve(self, value=True):

1370

1996

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1997

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

1998

* 1000), self._reset_approved)

1374

1999

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1388

2007

# CheckerCompleted - signal

1389

2008

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

1390

2009

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

1391

2010

"D-Bus signal"

1392

2011

pass

1393

2012

1394

2013

# CheckerStarted - signal

1395

2014

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

1396

2015

def CheckerStarted(self, command):

1397

2016

"D-Bus signal"

1398

2017

pass

1399

2018

1400

2019

# PropertyChanged - signal

2020

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

1401

2021

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

1402

2022

def PropertyChanged(self, property, value):

1403

2023

"D-Bus signal"

1404

2024

pass

1405

2025

1406

2026

# GotSecret - signal

1407

2027

@dbus.service.signal(_interface)

1408

2028

def GotSecret(self):

1411

2031

server to mandos-client

1412

2032

"""

1413

2033

pass

1414

2034

1415

2035

# Rejected - signal

1416

2036

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

1417

2037

def Rejected(self, reason):

1418

2038

"D-Bus signal"

1419

2039

pass

1420

2040

1421

2041

# NeedApproval - signal

1422

2042

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

1423

2043

def NeedApproval(self, timeout, default):

1424

2044

"D-Bus signal"

1425

2045

return self.need_approval()

1426

1427

## Methods

1428

2046

2047

# Methods

2048

1429

2049

# Approve - method

1430

2050

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

1431

2051

def Approve(self, value):

1432

2052

self.approve(value)

1433

2053

1434

2054

# CheckedOK - method

1435

2055

@dbus.service.method(_interface)

1436

2056

def CheckedOK(self):

1437

2057

self.checked_ok()

1438

2058

1439

2059

# Enable - method

2060

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

1440

2061

@dbus.service.method(_interface)

1441

2062

def Enable(self):

1442

2063

"D-Bus method"

1443

2064

self.enable()

1444

2065

1445

2066

# StartChecker - method

2067

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

1446

2068

@dbus.service.method(_interface)

1447

2069

def StartChecker(self):

1448

2070

"D-Bus method"

1449

2071

self.start_checker()

1450

2072

1451

2073

# Disable - method

2074

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

1452

2075

@dbus.service.method(_interface)

1453

2076

def Disable(self):

1454

2077

"D-Bus method"

1455

2078

self.disable()

1456

2079

1457

2080

# StopChecker - method

2081

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

1458

2082

@dbus.service.method(_interface)

1459

2083

def StopChecker(self):

1460

2084

self.stop_checker()

1461

1462

## Properties

1463

2085

2086

# Properties

2087

1464

2088

# ApprovalPending - property

1465

2089

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

1466

2090

def ApprovalPending_dbus_property(self):

1467

2091

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

1468

2092

1469

2093

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

2094

@dbus_service_property(_interface,

2095

signature="b",

1471

2096

access="readwrite")

1472

2097

def ApprovedByDefault_dbus_property(self, value=None):

1473

2098

if value is None: # get

1474

2099

return dbus.Boolean(self.approved_by_default)

1475

2100

self.approved_by_default = bool(value)

1476

2101

1477

2102

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1479

2105

access="readwrite")

1480

2106

def ApprovalDelay_dbus_property(self, value=None):

1481

2107

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2108

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

2109

* 1000)

1483

2110

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

1484

2111

1485

2112

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

2113

@dbus_service_property(_interface,

2114

signature="t",

1487

2115

access="readwrite")

1488

2116

def ApprovalDuration_dbus_property(self, value=None):

1489

2117

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2118

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

2119

* 1000)

1492

2120

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

1493

2121

1494

2122

# Name - property

2123

@dbus_annotations(

2124

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

1495

2125

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

1496

2126

def Name_dbus_property(self):

1497

2127

return dbus.String(self.name)

1498

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1499

2136

# Fingerprint - property

2137

@dbus_annotations(

2138

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

1500

2139

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

1501

2140

def Fingerprint_dbus_property(self):

1502

2141

return dbus.String(self.fingerprint)

1503

2142

1504

2143

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2144

@dbus_service_property(_interface,

2145

signature="s",

1506

2146

access="readwrite")

1507

2147

def Host_dbus_property(self, value=None):

1508

2148

if value is None: # get

1509

2149

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2150

self.host = str(value)

2151

1512

2152

# Created - property

2153

@dbus_annotations(

2154

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

1513

2155

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

1514

2156

def Created_dbus_property(self):

1515

2157

return datetime_to_dbus(self.created)

1516

2158

1517

2159

# LastEnabled - property

1518

2160

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

1519

2161

def LastEnabled_dbus_property(self):

1520

2162

return datetime_to_dbus(self.last_enabled)

1521

2163

1522

2164

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2165

@dbus_service_property(_interface,

2166

signature="b",

1524

2167

access="readwrite")

1525

2168

def Enabled_dbus_property(self, value=None):

1526

2169

if value is None: # get

1529

2172

self.enable()

1530

2173

else:

1531

2174

self.disable()

1532

2175

1533

2176

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2177

@dbus_service_property(_interface,

2178

signature="s",

1535

2179

access="readwrite")

1536

2180

def LastCheckedOK_dbus_property(self, value=None):

1537

2181

if value is not None:

1538

2182

self.checked_ok()

1539

2183

return

1540

2184

return datetime_to_dbus(self.last_checked_ok)

1541

2185

1542

2186

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2187

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

1545

2188

def LastCheckerStatus_dbus_property(self):

1546

2189

return dbus.Int16(self.last_checker_status)

1547

2190

1548

2191

# Expires - property

1549

2192

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

1550

2193

def Expires_dbus_property(self):

1551

2194

return datetime_to_dbus(self.expires)

1552

2195

1553

2196

# LastApprovalRequest - property

1554

2197

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

1555

2198

def LastApprovalRequest_dbus_property(self):

1556

2199

return datetime_to_dbus(self.last_approval_request)

1557

2200

1558

2201

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2202

@dbus_service_property(_interface,

2203

signature="t",

1560

2204

access="readwrite")

1561

2205

def Timeout_dbus_property(self, value=None):

1562

2206

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2207

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

1564

2208

old_timeout = self.timeout

1565

2209

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

1566

2210

# Reschedule disabling

1574

2218

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

1575

2219

is None):

1576

2220

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2223

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

2224

self.disable)

2225

1583

2226

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2227

@dbus_service_property(_interface,

2228

signature="t",

1585

2229

access="readwrite")

1586

2230

def ExtendedTimeout_dbus_property(self, value=None):

1587

2231

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2232

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

2233

* 1000)

1589

2234

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

1590

2235

1591

2236

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2237

@dbus_service_property(_interface,

2238

signature="t",

1593

2239

access="readwrite")

1594

2240

def Interval_dbus_property(self, value=None):

1595

2241

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2242

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

1597

2243

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

1598

2244

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

1599

2245

return

1600

2246

if self.enabled:

1601

2247

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2250

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1607

2253

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2254

@dbus_service_property(_interface,

2255

signature="s",

1609

2256

access="readwrite")

1610

2257

def Checker_dbus_property(self, value=None):

1611

2258

if value is None: # get

1612

2259

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2260

self.checker_command = str(value)

2261

1615

2262

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2263

@dbus_service_property(_interface,

2264

signature="b",

1617

2265

access="readwrite")

1618

2266

def CheckerRunning_dbus_property(self, value=None):

1619

2267

if value is None: # get

1622

2270

self.start_checker()

1623

2271

else:

1624

2272

self.stop_checker()

1625

2273

1626

2274

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

1627

2278

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

1628

2279

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1631

2282

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2283

@dbus_annotations(

2284

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

2285

"invalidates"})

2286

@dbus_service_property(_interface,

2287

signature="ay",

2288

access="write",

2289

byte_arrays=True)

1634

2290

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2291

self.secret = bytes(value)

2292

1637

2293

del _interface

1638

2294

1639

2295

1640

class ProxyClient(object):

1641

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

2296

class ProxyClient:

2297

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

1642

2298

self._pipe = child_pipe

1643

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

2299

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

1644

2300

if not self._pipe.recv():

1645

raise KeyError()

1646

2301

raise KeyError(key_id or fpr)

2302

1647

2303

def __getattribute__(self, name):

1648

if name == '_pipe':

2304

if name == "_pipe":

1649

2305

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

1650

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

2306

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

1651

2307

data = self._pipe.recv()

1652

if data[0] == 'data':

2308

if data[0] == "data":

1653

2309

return data[1]

1654

if data[0] == 'function':

2310

if data[0] == "function":

2311

1655

2312

def func(*args, **kwargs):

1656

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

2313

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

1657

2314

return self._pipe.recv()[1]

2315

1658

2316

return func

1659

2317

1660

2318

def __setattr__(self, name, value):

1661

if name == '_pipe':

2319

if name == "_pipe":

1662

2320

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

1663

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

2321

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

1664

2322

1665

2323

1666

2324

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2325

"""A class to handle client connections.

1668

2326

1669

2327

Instantiated once for each connection to handle it.

1670

2328

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

1671

2329

1672

2330

def handle(self):

1673

2331

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

1674

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

1675

unicode(self.client_address))

1676

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

1677

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2332

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

2333

str(self.client_address))

2334

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

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1693

2342

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

1694

2343

priority = self.server.gnutls_priority

1695

2344

if priority is None:

1696

2345

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2346

gnutls.priority_set_direct(session,

2347

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

2348

1701

2349

# Start communication using the Mandos protocol

1702

2350

# Get protocol number

1703

2351

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

1704

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

2352

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

1705

2353

try:

1706

2354

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

1707

2355

raise RuntimeError(line)

1708

2356

except (ValueError, IndexError, RuntimeError) as error:

1709

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

2357

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

1710

2358

return

1711

2359

1712

2360

# Start GnuTLS connection

1713

2361

try:

1714

2362

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

1716

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

2363

except gnutls.Error as error:

2364

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

1717

2365

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

1718

2366

# established. Just abandon the request.

1719

2367

return

1720

logger.debug("Handshake succeeded")

1721

2368

log.debug("Handshake succeeded")

2369

1722

2370

approval_required = False

1723

2371

try:

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1735

2396

self.client_address)

1736

2397

except KeyError:

1737

2398

return

1738

2399

1739

2400

if client.approval_delay:

1740

2401

delay = client.approval_delay

1741

2402

client.approvals_pending += 1

1742

2403

approval_required = True

1743

2404

1744

2405

while True:

1745

2406

if not client.enabled:

1746

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

1747

client.name)

2407

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

1748

2408

if self.server.use_dbus:

1749

2409

# Emit D-Bus signal

1750

2410

client.Rejected("Disabled")

1751

2411

return

1752

2412

1753

2413

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2414

# We are approved or approval is disabled

1755

2415

break

1756

2416

elif client.approved is None:

1757

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

2417

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

2418

client.name)

2419

if self.server.use_dbus:

2420

# Emit D-Bus signal

2421

client.NeedApproval(

2422

client.approval_delay.total_seconds()

2423

* 1000, client.approved_by_default)

2424

else:

2425

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

1758

2426

client.name)

1759

2427

if self.server.use_dbus:

1760

2428

# Emit D-Bus signal

1761

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

1764

else:

1765

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

1766

client.name)

1767

if self.server.use_dbus:

1768

# Emit D-Bus signal

1769

2429

client.Rejected("Denied")

1770

2430

return

1771

1772

#wait until timeout or approved

2431

2432

# wait until timeout or approved

1773

2433

time = datetime.datetime.now()

1774

2434

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2435

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

1778

2436

client.changedstate.release()

1779

2437

time2 = datetime.datetime.now()

1780

2438

if (time2 - time) >= delay:

1781

2439

if not client.approved_by_default:

1782

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

1783

" waiting for approval",

1784

client.name)

2440

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

2441

" waiting for approval",

2442

client.name)

1785

2443

if self.server.use_dbus:

1786

2444

# Emit D-Bus signal

1787

2445

client.Rejected("Approval timed out")

1790

2448

break

1791

2449

else:

1792

2450

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

1807

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

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

1808

2459

# bump the timeout using extended_timeout

1809

2460

client.bump_timeout(client.extended_timeout)

1810

2461

if self.server.use_dbus:

1811

2462

# Emit D-Bus signal

1812

2463

client.GotSecret()

1813

2464

1814

2465

finally:

1815

2466

if approval_required:

1816

2467

client.approvals_pending -= 1

1817

2468

try:

1818

2469

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

1820

logger.warning("GnuTLS bye failed",

1821

exc_info=error)

1822

2470

except gnutls.Error as error:

2471

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

2472

1823

2473

@staticmethod

1824

2474

def peer_certificate(session):

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1832

2491

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

1835

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

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1836

2494

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

1837

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

1838

" certificate")

2495

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

1839

2496

if list_size.value == 0:

1840

2497

return None

1841

2498

cert = cert_list[0]

1842

2499

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

1843

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

1844

2536

@staticmethod

1845

2537

def fingerprint(openpgp):

1846

2538

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2539

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2540

datum = gnutls.datum_t(

2541

ctypes.cast(ctypes.c_char_p(openpgp),

2542

ctypes.POINTER(ctypes.c_ubyte)),

2543

ctypes.c_uint(len(openpgp)))

1853

2544

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2547

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1862

2550

# Verify the self signature in the key

1863

2551

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1867

2554

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1871

2558

# New buffer for the fingerprint

1872

2559

buf = ctypes.create_string_buffer(20)

1873

2560

buf_len = ctypes.c_size_t()

1874

2561

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2562

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

2563

ctypes.byref(buf_len))

1878

2564

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2565

gnutls.openpgp_crt_deinit(crt)

1880

2566

# Convert the buffer to a Python bytestring

1881

2567

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

1882

2568

# Convert the bytestring to hexadecimal notation

1884

2570

return hex_fpr

1885

2571

1886

2572

1887

class MultiprocessingMixIn(object):

2573

class MultiprocessingMixIn:

1888

2574

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

2575

1889

2576

def sub_process_main(self, request, address):

1890

2577

try:

1891

2578

self.finish_request(request, address)

1892

2579

except Exception:

1893

2580

self.handle_error(request, address)

1894

2581

self.close_request(request)

1895

2582

1896

2583

def process_request(self, request, address):

1897

2584

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

1898

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

1899

args = (request, address))

2585

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

2586

args=(request, address))

1900

2587

proc.start()

1901

2588

return proc

1902

2589

1903

2590

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1905

2592

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

2593

1906

2594

def process_request(self, request, client_address):

1907

2595

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

1908

2596

1909

2597

This function creates a new pipe in self.pipe

1910

2598

"""

1911

2599

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2600

1913

2601

proc = MultiprocessingMixIn.process_request(self, request,

1914

2602

client_address)

1915

2603

self.child_pipe.close()

1916

2604

self.add_pipe(parent_pipe, proc)

1917

2605

1918

2606

def add_pipe(self, parent_pipe, proc):

1919

2607

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

1920

2608

raise NotImplementedError()

1921

2609

1922

2610

1923

2611

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

socketserver.TCPServer, object):

1925

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

1926

2612

socketserver.TCPServer):

2613

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

2614

1927

2615

Attributes:

1928

2616

enabled: Boolean; whether this server is activated yet

1929

2617

interface: None or a network interface name (string)

1930

2618

use_ipv6: Boolean; to use IPv6 or not

1931

2619

"""

2620

1932

2621

def __init__(self, server_address, RequestHandlerClass,

1933

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

2622

interface=None,

2623

use_ipv6=True,

2624

socketfd=None):

1934

2625

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

1935

2626

creating a new one with socket.socket().

1936

2627

"""

1942

2633

self.socketfd = socketfd

1943

2634

# Save the original socket.socket() function

1944

2635

self.socket_socket = socket.socket

2636

1945

2637

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

1946

#

2638

#

1947

2639

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

1948

2640

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

1949

2641

# patching socket.socket.)

1950

#

2642

#

1951

2643

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

1952

2644

@functools.wraps(socket.socket)

1953

2645

def socket_wrapper(*args, **kwargs):

1965

2657

# socket_wrapper(), if socketfd was set.

1966

2658

socketserver.TCPServer.__init__(self, server_address,

1967

2659

RequestHandlerClass)

1968

2660

1969

2661

def server_bind(self):

1970

2662

"""This overrides the normal server_bind() function

1971

2663

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

1972

2664

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

2665

global SO_BINDTODEVICE

1973

2666

if self.interface is not None:

1974

2667

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

1996

2688

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

1997

2689

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

1998

2692

if not self.server_address[0]:

1999

2693

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2694

any_address = "::" # in6addr_any

2001

2695

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2696

any_address = "0.0.0.0" # INADDR_ANY

2003

2697

self.server_address = (any_address,

2004

2698

self.server_address[1])

2005

2699

elif not self.server_address[1]:

2006

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

2007

0)

2700

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

2008

2701

# if self.interface:

2009

2702

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

2010

2703

# 0, # port

2016

2709

2017

2710

class MandosServer(IPv6_TCPServer):

2018

2711

"""Mandos server.

2019

2712

2020

2713

Attributes:

2021

2714

clients: set of Client objects

2022

2715

gnutls_priority GnuTLS priority string

2023

2716

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

2024

2025

Assumes a gobject.MainLoop event loop.

2717

2718

Assumes a GLib.MainLoop event loop.

2026

2719

"""

2720

2027

2721

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2722

interface=None,

2723

use_ipv6=True,

2724

clients=None,

2725

gnutls_priority=None,

2726

use_dbus=True,

2727

socketfd=None):

2030

2728

self.enabled = False

2031

2729

self.clients = clients

2032

2730

if self.clients is None:

2035

2733

self.gnutls_priority = gnutls_priority

2036

2734

IPv6_TCPServer.__init__(self, server_address,

2037

2735

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2041

2740

def server_activate(self):

2042

2741

if self.enabled:

2043

2742

return socketserver.TCPServer.server_activate(self)

2044

2743

2045

2744

def enable(self):

2046

2745

self.enabled = True

2047

2746

2048

2747

def add_pipe(self, parent_pipe, proc):

2049

2748

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2749

GLib.io_add_watch(

2750

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

2751

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

2752

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2756

def handle_ipc(self, source, condition,

2757

parent_pipe=None,

2758

proc=None,

2759

client_object=None):

2059

2760

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

2060

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

2761

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

2061

2762

# Wait for other process to exit

2062

2763

proc.join()

2063

2764

return False

2064

2765

2065

2766

# Read a request from the child

2066

2767

request = parent_pipe.recv()

2067

2768

command = request[0]

2068

2069

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2075

2783

client = c

2076

2784

break

2077

2785

else:

2078

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

2079

"dress: %s", fpr, address)

2786

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

2787

" %s", key_id or fpr, address)

2080

2788

if self.use_dbus:

2081

2789

# Emit D-Bus signal

2082

mandos_dbus_service.ClientNotFound(fpr,

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

2791

address[0])

2084

2792

parent_pipe.send(False)

2085

2793

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2798

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2095

2802

parent_pipe.send(True)

2096

2803

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

2097

2804

# same fileno

2098

2805

return False

2099

if command == 'funcall':

2806

if command == "funcall":

2100

2807

funcname = request[1]

2101

2808

args = request[2]

2102

2809

kwargs = request[3]

2103

2104

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

2810

2811

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

2105

2812

funcname)(*args,

2106

**kwargs)))

2107

2108

if command == 'getattr':

2813

**kwargs)))

2814

2815

if command == "getattr":

2109

2816

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2817

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2112

2820

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2116

if command == 'setattr':

2821

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2117

2825

attrname = request[1]

2118

2826

value = request[2]

2119

2827

setattr(client_object, attrname, value)

2120

2828

2121

2829

return True

2122

2830

2123

2831

2124

2832

def rfc3339_duration_to_delta(duration):

2125

2833

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

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2141

2851

"""

2142

2852

2143

2853

# Parsing an RFC 3339 duration with regular expressions is not

2144

2854

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

2145

2855

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

2146

2856

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

2147

2857

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

2148

2858

# avoid excessive use of external libraries.

2149

2859

2150

2860

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2861

Token = collections.namedtuple("Token", (

2862

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

2863

# a "group" containing digits

2864

"value", # datetime.timedelta or None

2865

"followers")) # Tokens valid after this token

2160

2866

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

2161

2867

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

2162

2868

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

2163

2869

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

2164

2870

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2871

frozenset((token_end, )))

2166

2872

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

2167

2873

datetime.timedelta(minutes=1),

2168

2874

frozenset((token_second, token_end)))

2184

2890

frozenset((token_month, token_end)))

2185

2891

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

2186

2892

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2893

frozenset((token_end, )))

2188

2894

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

2189

2895

frozenset((token_year, token_month,

2190

2896

token_day, token_time,

2191

2897

token_week)))

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2194

2901

found_token = None

2195

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

2196

s = duration # String left to parse

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2197

2906

# Loop until end token is found

2198

2907

while found_token is not token_end:

2199

2908

# Search for any currently valid tokens

2215

2924

break

2216

2925

else:

2217

2926

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2927

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

2928

.format(duration))

2219

2929

# End token found

2220

2930

return value

2221

2931

2222

2932

2223

2933

def string_to_delta(interval):

2224

2934

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

2225

2226

>>> string_to_delta('7d')

2227

datetime.timedelta(7)

2228

>>> string_to_delta('60s')

2229

datetime.timedelta(0, 60)

2230

>>> string_to_delta('60m')

2231

datetime.timedelta(0, 3600)

2232

>>> string_to_delta('24h')

2233

datetime.timedelta(1)

2234

>>> string_to_delta('1w')

2235

datetime.timedelta(7)

2236

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

2237

datetime.timedelta(0, 330)

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2238

2948

"""

2239

2949

2240

2950

try:

2241

2951

return rfc3339_duration_to_delta(interval)

2242

2952

except ValueError:

2243

2953

pass

2244

2954

2245

2955

timevalue = datetime.timedelta(0)

2246

2956

for s in interval.split():

2247

2957

try:

2248

suffix = unicode(s[-1])

2958

suffix = s[-1]

2249

2959

value = int(s[:-1])

2250

2960

if suffix == "d":

2251

2961

delta = datetime.timedelta(value)

2258

2968

elif suffix == "w":

2259

2969

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

2260

2970

else:

2261

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

2262

.format(suffix))

2971

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

2263

2972

except IndexError as e:

2264

2973

raise ValueError(*(e.args))

2265

2974

timevalue += delta

2266

2975

return timevalue

2267

2976

2268

2977

2269

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

2978

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

2270

2979

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

2271

2980

2272

2981

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

2273

2982

if os.fork():

2274

2983

sys.exit()

2282

2991

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

2283

2992

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

2284

2993

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2994

"{} not a character device"

2286

2995

.format(os.devnull))

2287

2996

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

2288

2997

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

2292

3001

2293

3002

2294

3003

def main():

2295

3004

2296

3005

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

2297

3006

# Parsing of options, both command line and config file

2298

3007

2299

3008

parser = argparse.ArgumentParser()

2300

3009

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

2301

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

3010

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

2302

3011

help="show version number and exit")

2303

3012

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

2304

3013

help="Bind to interface IF")

2340

3049

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

2341

3050

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

2342

3051

default=None)

2343

3052

2344

3053

options = parser.parse_args()

2345

2346

if options.check:

2347

import doctest

2348

fail_count, test_count = doctest.testmod()

2349

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

2350

3054

2351

3055

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2369

3079

# Parse config file for server-global settings

2370

server_config = configparser.SafeConfigParser(server_defaults)

3080

server_config = configparser.ConfigParser(server_defaults)

2371

3081

del server_defaults

2372

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

2373

"mandos.conf"))

2374

# Convert the SafeConfigParser object to a dict

3082

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

3083

# Convert the ConfigParser object to a dict

2375

3084

server_settings = server_config.defaults()

2376

3085

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

2377

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

3086

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

3087

"foreground", "zeroconf"):

2378

3088

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

2379

3089

option)

2380

3090

if server_settings["port"]:

2390

3100

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

2391

3101

["socket"])

2392

3102

del server_config

2393

3103

2394

3104

# Override the settings from the config file with command line

2395

3105

# options, if set.

2396

3106

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

2397

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

2398

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

2399

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

3107

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

3108

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

3109

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

2400

3110

value = getattr(options, option)

2401

3111

if value is not None:

2402

3112

server_settings[option] = value

2403

3113

del options

2404

3114

# Force all strings to be unicode

2405

3115

for option in server_settings.keys():

2406

if type(server_settings[option]) is str:

2407

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

3116

if isinstance(server_settings[option], bytes):

3117

server_settings[option] = (server_settings[option]

3118

.decode("utf-8"))

2408

3119

# Force all boolean options to be boolean

2409

3120

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

2410

3121

"foreground", "zeroconf"):

2413

3124

if server_settings["debug"]:

2414

3125

server_settings["foreground"] = True

2415

3126

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

2416

3127

2417

3128

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

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

3129

3130

if (not server_settings["zeroconf"]

3131

and not (server_settings["port"]

3132

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

3133

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

3134

2425

3135

# For convenience

2426

3136

debug = server_settings["debug"]

2427

3137

debuglevel = server_settings["debuglevel"]

2431

3141

stored_state_file)

2432

3142

foreground = server_settings["foreground"]

2433

3143

zeroconf = server_settings["zeroconf"]

2434

3144

2435

3145

if debug:

2436

3146

initlogger(debug, logging.DEBUG)

2437

3147

else:

2440

3150

else:

2441

3151

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

2442

3152

initlogger(debug, level)

2443

3153

2444

3154

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

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

3155

syslogger.setFormatter(

3156

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

3157

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

3158

server_settings["servicename"])))

3159

2451

3160

# Parse config file with clients

2452

client_config = configparser.SafeConfigParser(Client

2453

.client_defaults)

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2454

3162

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

2455

3163

"clients.conf"))

2456

3164

2457

3165

global mandos_dbus_service

2458

3166

mandos_dbus_service = None

2459

3167

2460

3168

socketfd = None

2461

3169

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

2462

3170

socketfd = server_settings["socket"]

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

3171

tcp_server = MandosServer(

3172

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

3173

ClientHandler,

3174

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

3175

use_ipv6=use_ipv6,

3176

gnutls_priority=server_settings["priority"],

3177

use_dbus=use_dbus,

3178

socketfd=socketfd)

2473

3179

if not foreground:

2474

3180

pidfilename = "/run/mandos.pid"

2475

3181

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

2476

3182

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

2477

3183

pidfile = None

2478

3184

try:

2479

pidfile = open(pidfilename, "w")

3185

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

2480

3186

except IOError as e:

2481

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

2482

exc_info=e)

2483

2484

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

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2485

3193

try:

2486

3194

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

3195

gid = pwd.getpwnam(group).pw_gid

2488

3196

break

2489

3197

except KeyError:

2490

3198

continue

2494

3202

try:

2495

3203

os.setgid(gid)

2496

3204

os.setuid(uid)

3205

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

2497

3206

except OSError as error:

3207

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

3208

os.strerror(error.errno))

2498

3209

if error.errno != errno.EPERM:

2499

3210

raise

2500

3211

2501

3212

if debug:

2502

3213

# Enable all possible GnuTLS debugging

2503

3214

2504

3215

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

2505

3216

# - GnuTLS manual

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2509

3220

def debug_gnutls(level, string):

2510

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2515

3226

# Redirect stdin so all checkers get /dev/null

2516

3227

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

2517

3228

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

2518

3229

if null > 2:

2519

3230

os.close(null)

2520

3231

2521

3232

# Need to fork before connecting to D-Bus

2522

3233

if not foreground:

2523

3234

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

2524

3235

daemon()

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2530

3242

global main_loop

2531

3243

# From the Avahi example code

2532

3244

DBusGMainLoop(set_as_default=True)

2533

main_loop = gobject.MainLoop()

3245

main_loop = GLib.MainLoop()

2534

3246

bus = dbus.SystemBus()

2535

3247

# End of Avahi example code

2536

3248

if use_dbus:

2537

3249

try:

2538

3250

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

2544

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

3251

bus,

3252

do_not_queue=True)

3253

old_bus_name = dbus.service.BusName(

3254

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

3255

do_not_queue=True)

3256

except dbus.exceptions.DBusException as e:

3257

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

2545

3258

use_dbus = False

2546

3259

server_settings["use_dbus"] = False

2547

3260

tcp_server.use_dbus = False

2548

3261

if zeroconf:

2549

3262

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3263

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

2554

3268

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2557

3269

service.interface = if_nametoindex(

3270

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

3271

2558

3272

global multiprocessing_manager

2559

3273

multiprocessing_manager = multiprocessing.Manager()

2560

3274

2561

3275

client_class = Client

2562

3276

if use_dbus:

2563

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

2564

3277

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

3278

2565

3279

client_settings = Client.config_parser(client_config)

2566

3280

old_client_settings = {}

2567

3281

clients_data = {}

2568

3282

2569

3283

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

2570

3284

global wnull

2571

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

3285

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

2572

3286

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

2573

3287

# mode

2574

3288

if debug or not foreground:

2575

3289

wnull.close()

2576

3290

2577

3291

# Get client data and settings from last running state.

2578

3292

if server_settings["restore"]:

2579

3293

try:

2580

3294

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

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2583

3345

os.remove(stored_state_path)

2584

3346

except IOError as e:

2585

3347

if e.errno == errno.ENOENT:

2586

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

2587

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

3348

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

3349

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

2588

3350

else:

2589

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

2590

exc_info=e)

3351

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

3352

exc_info=e)

2591

3353

raise

2592

3354

except EOFError as e:

2593

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

2594

"EOFError:", exc_info=e)

2595

3355

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

3356

exc_info=e)

3357

2596

3358

with PGPEngine() as pgp:

2597

for client_name, client in clients_data.iteritems():

3359

for client_name, client in clients_data.items():

2598

3360

# Skip removed clients

2599

3361

if client_name not in client_settings:

2600

3362

continue

2601

3363

2602

3364

# Decide which value to use after restoring saved state.

2603

3365

# We have three different values: Old config file,

2604

3366

# new config file, and saved state.

2609

3371

# For each value in new config, check if it

2610

3372

# differs from the old config value (Except for

2611

3373

# the "secret" attribute)

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3374

if (name != "secret"

3375

and (value !=

3376

old_client_settings[client_name][name])):

2615

3377

client[name] = value

2616

3378

except KeyError:

2617

3379

pass

2618

3380

2619

3381

# Clients who has passed its expire date can still be

2620

# enabled if its last checker was successful. Clients

3382

# enabled if its last checker was successful. A Client

2621

3383

# whose checker succeeded before we stored its state is

2622

3384

# assumed to have successfully run all checkers during

2623

3385

# downtime.

2624

3386

if client["enabled"]:

2625

3387

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

2626

3388

if not client["last_checked_ok"]:

2627

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

2631

3392

client["enabled"] = False

2632

3393

elif client["last_checker_status"] != 0:

2633

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2638

3398

client["enabled"] = False

2639

3399

else:

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

2643

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3400

client["expires"] = (

3401

datetime.datetime.utcnow()

3402

+ client["timeout"])

3403

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

3404

" enabled", client_name)

2646

3405

try:

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3406

client["secret"] = pgp.decrypt(

3407

client["encrypted_secret"],

3408

client_settings[client_name]["secret"])

2651

3409

except PGPError:

2652

3410

# If decryption fails, we use secret from new settings

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3411

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

3412

client_name)

3413

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

3414

["secret"])

3415

2658

3416

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

2659

3417

for client_name in (set(old_client_settings)

2660

3418

- set(client_settings)):

2662

3420

for client_name in (set(client_settings)

2663

3421

- set(old_client_settings)):

2664

3422

clients_data[client_name] = client_settings[client_name]

2665

3423

2666

3424

# Create all client objects

2667

for client_name, client in clients_data.iteritems():

3425

for client_name, client in clients_data.items():

2668

3426

tcp_server.clients[client_name] = client_class(

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2672

3431

if not tcp_server.clients:

2673

logger.warning("No clients defined")

2674

3432

log.warning("No clients defined")

3433

2675

3434

if not foreground:

2676

3435

if pidfile is not None:

3436

pid = os.getpid()

2677

3437

try:

2678

3438

with pidfile:

2679

pid = os.getpid()

2680

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

3439

print(pid, file=pidfile)

2681

3440

except IOError:

2682

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

2683

pidfilename, pid)

3441

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

3442

pidfilename, pid)

2684

3443

del pidfile

2685

3444

del pidfilename

2686

2687

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

2688

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

2689

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2690

3450

if use_dbus:

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3451

3452

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2694

3455

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

3456

2695

3457

def __init__(self):

2696

3458

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

3459

2697

3460

_interface = "se.recompile.Mandos"

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3461

2705

3462

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

2706

3463

def ClientAdded(self, objpath):

2707

3464

"D-Bus signal"

2708

3465

pass

2709

3466

2710

3467

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

2711

def ClientNotFound(self, fingerprint, address):

3468

def ClientNotFound(self, key_id, address):

2712

3469

"D-Bus signal"

2713

3470

pass

2714

3471

3472

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

3473

"true"})

2715

3474

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

2716

3475

def ClientRemoved(self, objpath, name):

2717

3476

"D-Bus signal"

2718

3477

pass

2719

3478

3479

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

3480

"true"})

2720

3481

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

2721

3482

def GetAllClients(self):

2722

3483

"D-Bus method"

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3484

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2727

3489

@dbus.service.method(_interface,

2728

3490

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

2729

3491

def GetAllClientsWithProperties(self):

2730

3492

"D-Bus method"

2731

3493

return dbus.Dictionary(

2732

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

2733

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

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2734

3497

signature="oa{sv}")

2735

3498

2736

3499

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

2737

3500

def RemoveClient(self, object_path):

2738

3501

"D-Bus method"

2739

for c in tcp_server.clients.itervalues():

3502

for c in tcp_server.clients.values():

2740

3503

if c.dbus_object_path == object_path:

2741

3504

del tcp_server.clients[c.name]

2742

3505

c.remove_from_connection()

2743

# Don't signal anything except ClientRemoved

3506

# Don't signal the disabling

2744

3507

c.disable(quiet=True)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2747

3510

return

2748

3511

raise KeyError(object_path)

2749

3512

2750

3513

del _interface

2751

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2752

3551

mandos_dbus_service = MandosDBusService()

2753

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2754

3558

def cleanup():

2755

3559

"Cleanup function; run on exit"

2756

3560

if zeroconf:

2757

3561

service.cleanup()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3562

3563

mp.active_children()

3564

wn.close()

2761

3565

if not (tcp_server.clients or client_settings):

2762

3566

return

2763

3567

2764

3568

# Store client before exiting. Secrets are encrypted with key

2765

3569

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

2766

3570

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

2767

3571

clients = {}

2768

3572

with PGPEngine() as pgp:

2769

for client in tcp_server.clients.itervalues():

3573

for client in tcp_server.clients.values():

2770

3574

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

2771

3575

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

2772

3576

key)

2773

3577

client_dict = {}

2774

3578

2775

3579

# A list of attributes that can not be pickled

2776

3580

# + secret.

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3581

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

3582

"checker", "server_settings"}

3583

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

3584

.Object):

2781

3585

exclude.add(name)

2782

3586

2783

3587

client_dict["encrypted_secret"] = (client

2784

3588

.encrypted_secret)

2785

3589

for attr in client.client_structure:

2786

3590

if attr not in exclude:

2787

3591

client_dict[attr] = getattr(client, attr)

2788

3592

2789

3593

clients[client.name] = client_dict

2790

3594

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

2791

3595

2792

3596

try:

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3597

with tempfile.NamedTemporaryFile(

3598

mode="wb",

3599

suffix=".pickle",

3600

prefix="clients-",

3601

dir=os.path.dirname(stored_state_path),

3602

delete=False) as stored_state:

3603

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

3604

protocol=2)

3605

tempname = stored_state.name

2799

3606

os.rename(tempname, stored_state_path)

2800

3607

except (IOError, OSError) as e:

2801

3608

if not debug:

2804

3611

except NameError:

2805

3612

pass

2806

3613

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

2807

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

2808

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

3614

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

3615

os.strerror(e.errno))

2809

3616

else:

2810

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

2811

exc_info=e)

3617

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

3618

exc_info=e)

2812

3619

raise

2813

3620

2814

3621

# Delete all clients, and settings from config

2815

3622

while tcp_server.clients:

2816

3623

name, client = tcp_server.clients.popitem()

2817

3624

if use_dbus:

2818

3625

client.remove_from_connection()

2819

# Don't signal anything except ClientRemoved

3626

# Don't signal the disabling

2820

3627

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

2821

3629

if use_dbus:

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3630

mandos_dbus_service.client_removed_signal(client)

2826

3631

client_settings.clear()

2827

3632

2828

3633

atexit.register(cleanup)

2829

2830

for client in tcp_server.clients.itervalues():

3634

3635

for client in tcp_server.clients.values():

2831

3636

if use_dbus:

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2834

3639

# Need to initiate checking of clients

2835

3640

if client.enabled:

2836

client.init_checker()

2837

3641

client.init_checker(randomize_start=True)

3642

2838

3643

tcp_server.enable()

2839

3644

tcp_server.server_activate()

2840

3645

2841

3646

# Find out what port we got

2842

3647

if zeroconf:

2843

3648

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

2844

3649

if use_ipv6:

2845

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

2846

" flowinfo %d, scope_id %d",

2847

*tcp_server.socket.getsockname())

3650

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

3651

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

2848

3652

else: # IPv4

2849

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

2850

*tcp_server.socket.getsockname())

2851

2852

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

2853

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

2854

3658

try:

2855

3659

if zeroconf:

2856

3660

# From the Avahi example code

2857

3661

try:

2858

3662

service.activate()

2859

3663

except dbus.exceptions.DBusException as error:

2860

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

3664

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

2861

3665

cleanup()

2862

3666

sys.exit(1)

2863

3667

# End of Avahi example code

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

2870

logger.debug("Starting main loop")

3668

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3674

3675

log.debug("Starting main loop")

2871

3676

main_loop.run()

2872

3677

except AvahiError as error:

2873

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

3678

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

2874

3679

cleanup()

2875

3680

sys.exit(1)

2876

3681

except KeyboardInterrupt:

2877

3682

if debug:

2878

3683

print("", file=sys.stderr)

2879

logger.debug("Server received KeyboardInterrupt")

2880

logger.debug("Server exiting")

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2881

3686

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

2882

3687

cleanup()

2883

3688

2884

if __name__ == '__main__':

2885

main()

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

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

3782

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

3783

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

3784

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

3785

# End: