/mandos/release : revision 237.7.174

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Add os.set_inheritable if it does not exist

114

try:

115

os.set_inheritable

116

except AttributeError:

117

def set_inheritable(fd, inheritable):

118

flags = fcntl.fcntl(fd, fcntl.F_GETFD)

119

if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):

120

fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)

121

elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):

122

fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)

123

os.set_inheritable = set_inheritable

124

del set_inheritable

125

126

# Show warnings by default

127

if not sys.warnoptions:

128

import warnings

129

warnings.simplefilter("default")

130

131

# Try to find the value of SO_BINDTODEVICE:

132

try:

133

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

134

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

83

try:

135

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

136

85

except AttributeError:

137

86

try:

138

# This is where SO_BINDTODEVICE was up to and including Python

139

# 2.6, and also 3.2:

140

87

from IN import SO_BINDTODEVICE

141

88

except ImportError:

142

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

143

# Try running the C preprocessor:

144

try:

145

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

146

"/dev/stdin"],

147

stdin=subprocess.PIPE,

148

stdout=subprocess.PIPE)

149

stdout = cc.communicate(

150

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

151

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

152

except (OSError, ValueError, IndexError):

153

# No value found

154

SO_BINDTODEVICE = None

155

156

if sys.version_info < (3, 2):

157

configparser.Configparser = configparser.SafeConfigParser

158

159

version = "1.8.17"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

160

92

stored_state_file = "clients.pickle"

161

93

162

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

163

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

164

syslogger = None

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

165

98

166

99

try:

167

if_nametoindex = ctypes.cdll.LoadLibrary(

168

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

169

103

except (OSError, AttributeError):

170

171

104

def if_nametoindex(interface):

172

105

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

173

106

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

174

107

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

175

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

176

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

177

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

178

113

return interface_index

179

114

180

115

181

def copy_function(func):

182

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

183

if sys.version_info.major == 2:

184

return types.FunctionType(func.func_code,

185

func.func_globals,

186

func.func_name,

187

func.func_defaults,

188

func.func_closure)

189

else:

190

return types.FunctionType(func.__code__,

191

func.__globals__,

192

func.__name__,

193

func.__defaults__,

194

func.__closure__)

195

196

197

116

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

198

117

"""init logger and add loglevel"""

199

200

global syslogger

201

syslogger = (logging.handlers.SysLogHandler(

202

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

203

address="/dev/log"))

118

204

119

syslogger.setFormatter(logging.Formatter

205

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

206

" %(message)s"))

207

log.addHandler(syslogger)

208

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

209

124

if debug:

210

125

console = logging.StreamHandler()

211

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

212

" [%(process)d]:"

213

" %(levelname)s:"

214

" %(message)s"))

215

log.addHandler(console)

216

log.setLevel(level)

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

217

132

218

133

219

134

class PGPError(Exception):

221

136

pass

222

137

223

138

224

class PGPEngine:

139

class PGPEngine(object):

225

140

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

226

227

141

def __init__(self):

228

142

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

229

self.gpg = "gpg"

230

try:

231

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

232

for line in output.splitlines():

233

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

234

if name == b"gpg":

235

self.gpg = path

236

break

237

except OSError as e:

238

if e.errno != errno.ENOENT:

239

raise

240

self.gnupgargs = ["--batch",

241

"--homedir", self.tempdir,

242

"--force-mdc",

243

"--quiet"]

244

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

245

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

246

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

247

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

248

149

def __enter__(self):

249

150

return self

250

151

251

152

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

252

153

self._cleanup()

253

154

return False

254

155

255

156

def __del__(self):

256

157

self._cleanup()

257

158

258

159

def _cleanup(self):

259

160

if self.tempdir is not None:

260

161

# Delete contents of tempdir

261

162

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

262

topdown=False):

163

topdown = False):

263

164

for filename in files:

264

165

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

265

166

for dirname in dirs:

267

168

# Remove tempdir

268

169

os.rmdir(self.tempdir)

269

170

self.tempdir = None

270

171

271

172

def password_encode(self, password):

272

173

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

273

174

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

274

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

275

if len(encoded) > 2048:

276

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

277

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

278

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

279

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

280

return encoded

281

175

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

176

282

177

def encrypt(self, data, password):

283

178

passphrase = self.password_encode(password)

284

with tempfile.NamedTemporaryFile(

285

dir=self.tempdir) as passfile:

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

286

181

passfile.write(passphrase)

287

182

passfile.flush()

288

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

289

"--passphrase-file",

183

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

184

'--passphrase-file',

290

185

passfile.name]

291

186

+ self.gnupgargs,

292

stdin=subprocess.PIPE,

293

stdout=subprocess.PIPE,

294

stderr=subprocess.PIPE)

295

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

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

296

191

if proc.returncode != 0:

297

192

raise PGPError(err)

298

193

return ciphertext

299

194

300

195

def decrypt(self, data, password):

301

196

passphrase = self.password_encode(password)

302

with tempfile.NamedTemporaryFile(

303

dir=self.tempdir) as passfile:

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

304

199

passfile.write(passphrase)

305

200

passfile.flush()

306

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

307

"--passphrase-file",

201

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

202

'--passphrase-file',

308

203

passfile.name]

309

204

+ self.gnupgargs,

310

stdin=subprocess.PIPE,

311

stdout=subprocess.PIPE,

312

stderr=subprocess.PIPE)

313

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

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

314

210

if proc.returncode != 0:

315

211

raise PGPError(err)

316

212

return decrypted_plaintext

317

213

318

214

319

# Pretend that we have an Avahi module

320

class avahi:

321

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

322

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

323

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

324

PROTO_INET = 0 # avahi-common/address.h

325

PROTO_INET6 = 1 # avahi-common/address.h

326

DBUS_NAME = "org.freedesktop.Avahi"

327

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

328

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

329

DBUS_PATH_SERVER = "/"

330

331

@staticmethod

332

def string_array_to_txt_array(t):

333

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

334

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

335

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

336

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

337

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

338

SERVER_INVALID = 0 # avahi-common/defs.h

339

SERVER_REGISTERING = 1 # avahi-common/defs.h

340

SERVER_RUNNING = 2 # avahi-common/defs.h

341

SERVER_COLLISION = 3 # avahi-common/defs.h

342

SERVER_FAILURE = 4 # avahi-common/defs.h

343

344

345

215

class AvahiError(Exception):

346

216

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

347

217

self.value = value

348

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

349

**kwargs)

350

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

351

221

352

222

class AvahiServiceError(AvahiError):

353

223

pass

354

224

355

356

225

class AvahiGroupError(AvahiError):

357

226

pass

358

227

359

228

360

class AvahiService:

229

class AvahiService(object):

361

230

"""An Avahi (Zeroconf) service.

362

231

363

232

Attributes:

364

233

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

365

234

Used to optionally bind to the specified interface.

366

367

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

235

236

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

368

237

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

369

238

port: integer; what port to announce

370

239

TXT: list of strings; TXT record for the service

377

246

server: D-Bus Server

378

247

bus: dbus.SystemBus()

379

248

"""

380

381

def __init__(self,

382

interface=avahi.IF_UNSPEC,

383

name=None,

384

servicetype=None,

385

port=None,

386

TXT=None,

387

domain="",

388

host="",

389

max_renames=32768,

390

protocol=avahi.PROTO_UNSPEC,

391

bus=None):

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

392

254

self.interface = interface

393

255

self.name = name

394

256

self.type = servicetype

403

265

self.server = None

404

266

self.bus = bus

405

267

self.entry_group_state_changed_match = None

406

407

def rename(self, remove=True):

268

269

def rename(self):

408

270

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

409

271

if self.rename_count >= self.max_renames:

410

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

411

" after %i retries, exiting.",

412

self.rename_count)

272

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

273

" after %i retries, exiting.",

274

self.rename_count)

413

275

raise AvahiServiceError("Too many renames")

414

self.name = str(

415

self.server.GetAlternativeServiceName(self.name))

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

278

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

279

self.name)

280

self.remove()

281

try:

282

self.add()

283

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

416

287

self.rename_count += 1

417

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

418

self.name)

419

if remove:

420

self.remove()

421

try:

422

self.add()

423

except dbus.exceptions.DBusException as error:

424

if (error.get_dbus_name()

425

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

426

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

427

return self.rename(remove=False)

428

else:

429

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

430

self.cleanup()

431

os._exit(1)

432

288

433

289

def remove(self):

434

290

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

435

291

if self.entry_group_state_changed_match is not None:

437

293

self.entry_group_state_changed_match = None

438

294

if self.group is not None:

439

295

self.group.Reset()

440

296

441

297

def add(self):

442

298

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

443

299

self.remove()

448

304

avahi.DBUS_INTERFACE_ENTRY_GROUP)

449

305

self.entry_group_state_changed_match = (

450

306

self.group.connect_to_signal(

451

"StateChanged", self.entry_group_state_changed))

452

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

453

self.name, self.type)

307

'StateChanged', self.entry_group_state_changed))

308

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

309

self.name, self.type)

454

310

self.group.AddService(

455

311

self.interface,

456

312

self.protocol,

460

316

dbus.UInt16(self.port),

461

317

avahi.string_array_to_txt_array(self.TXT))

462

318

self.group.Commit()

463

319

464

320

def entry_group_state_changed(self, state, error):

465

321

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

466

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

467

322

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

323

468

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

469

log.debug("Zeroconf service established.")

325

logger.debug("Zeroconf service established.")

470

326

elif state == avahi.ENTRY_GROUP_COLLISION:

471

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

327

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

472

328

self.rename()

473

329

elif state == avahi.ENTRY_GROUP_FAILURE:

474

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

475

str(error))

476

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

477

330

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

331

unicode(error))

332

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

333

.format(error))

334

478

335

def cleanup(self):

479

336

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

480

337

if self.group is not None:

485

342

pass

486

343

self.group = None

487

344

self.remove()

488

345

489

346

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

490

347

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

491

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

492

bad_states = {

493

avahi.SERVER_INVALID: "Zeroconf server invalid",

494

avahi.SERVER_REGISTERING: None,

495

avahi.SERVER_COLLISION: "Zeroconf server name collision",

496

avahi.SERVER_FAILURE: "Zeroconf server failure",

497

}

348

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

498

356

if state in bad_states:

499

357

if bad_states[state] is not None:

500

358

if error is None:

501

log.error(bad_states[state])

359

logger.error(bad_states[state])

502

360

else:

503

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

361

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

504

362

self.cleanup()

505

363

elif state == avahi.SERVER_RUNNING:

506

try:

507

self.add()

508

except dbus.exceptions.DBusException as error:

509

if (error.get_dbus_name()

510

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

511

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

512

return self.rename(remove=False)

513

else:

514

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

515

self.cleanup()

516

os._exit(1)

364

self.add()

517

365

else:

518

366

if error is None:

519

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

367

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

520

368

else:

521

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

522

369

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

370

523

371

def activate(self):

524

372

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

525

373

if self.server is None:

529

377

follow_name_owner_changes=True),

530

378

avahi.DBUS_INTERFACE_SERVER)

531

379

self.server.connect_to_signal("StateChanged",

532

self.server_state_changed)

380

self.server_state_changed)

533

381

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

534

382

535

383

536

384

class AvahiServiceToSyslog(AvahiService):

537

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

385

def rename(self):

538

386

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

539

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

540

**kwargs)

541

syslogger.setFormatter(logging.Formatter(

542

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

543

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

544

392

return ret

545

393

546

394

547

# Pretend that we have a GnuTLS module

548

class gnutls:

549

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

550

551

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

552

if library is None:

553

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

554

_library = ctypes.cdll.LoadLibrary(library)

555

del library

556

557

# Unless otherwise indicated, the constants and types below are

558

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

559

560

# Constants

561

E_SUCCESS = 0

562

E_INTERRUPTED = -52

563

E_AGAIN = -28

564

CRT_OPENPGP = 2

565

CRT_RAWPK = 3

566

CLIENT = 2

567

SHUT_RDWR = 0

568

CRD_CERTIFICATE = 1

569

E_NO_CERTIFICATE_FOUND = -49

570

X509_FMT_DER = 0

571

NO_TICKETS = 1<<10

572

ENABLE_RAWPK = 1<<18

573

CTYPE_PEERS = 3

574

KEYID_USE_SHA256 = 1 # gnutls/x509.h

575

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

576

577

# Types

578

class _session_int(ctypes.Structure):

579

_fields_ = []

580

session_t = ctypes.POINTER(_session_int)

581

582

class certificate_credentials_st(ctypes.Structure):

583

_fields_ = []

584

certificate_credentials_t = ctypes.POINTER(

585

certificate_credentials_st)

586

certificate_type_t = ctypes.c_int

587

588

class datum_t(ctypes.Structure):

589

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

590

("size", ctypes.c_uint)]

591

592

class _openpgp_crt_int(ctypes.Structure):

593

_fields_ = []

594

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

595

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

596

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

597

credentials_type_t = ctypes.c_int

598

transport_ptr_t = ctypes.c_void_p

599

close_request_t = ctypes.c_int

600

601

# Exceptions

602

class Error(Exception):

603

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

604

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

605

# code is passed, convert it to a string with

606

# gnutls.strerror()

607

self.code = code

608

if message is None and code is not None:

609

message = gnutls.strerror(code).decode(

610

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

611

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

612

message, *args)

613

614

class CertificateSecurityError(Error):

615

pass

616

617

class PointerTo:

618

def __init__(self, cls):

619

self.cls = cls

620

621

def from_param(self, obj):

622

if not isinstance(obj, self.cls):

623

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

624

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

625

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

626

627

class CastToVoidPointer:

628

def __init__(self, cls):

629

self.cls = cls

630

631

def from_param(self, obj):

632

if not isinstance(obj, self.cls):

633

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

634

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

635

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

636

637

class With_from_param:

638

@classmethod

639

def from_param(cls, obj):

640

return obj._as_parameter_

641

642

# Classes

643

class Credentials(With_from_param):

644

def __init__(self):

645

self._as_parameter_ = gnutls.certificate_credentials_t()

646

gnutls.certificate_allocate_credentials(self)

647

self.type = gnutls.CRD_CERTIFICATE

648

649

def __del__(self):

650

gnutls.certificate_free_credentials(self)

651

652

class ClientSession(With_from_param):

653

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

654

self._as_parameter_ = gnutls.session_t()

655

gnutls_flags = gnutls.CLIENT

656

if gnutls.check_version(b"3.5.6"):

657

gnutls_flags |= gnutls.NO_TICKETS

658

if gnutls.has_rawpk:

659

gnutls_flags |= gnutls.ENABLE_RAWPK

660

gnutls.init(self, gnutls_flags)

661

del gnutls_flags

662

gnutls.set_default_priority(self)

663

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

664

gnutls.handshake_set_private_extensions(self, True)

665

self.socket = socket

666

if credentials is None:

667

credentials = gnutls.Credentials()

668

gnutls.credentials_set(self, credentials.type,

669

credentials)

670

self.credentials = credentials

671

672

def __del__(self):

673

gnutls.deinit(self)

674

675

def handshake(self):

676

return gnutls.handshake(self)

677

678

def send(self, data):

679

data = bytes(data)

680

data_len = len(data)

681

while data_len > 0:

682

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

683

data_len)

684

685

def bye(self):

686

return gnutls.bye(self, gnutls.SHUT_RDWR)

687

688

# Error handling functions

689

def _error_code(result):

690

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

691

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

692

if result >= gnutls.E_SUCCESS:

693

return result

694

if result == gnutls.E_NO_CERTIFICATE_FOUND:

695

raise gnutls.CertificateSecurityError(code=result)

696

raise gnutls.Error(code=result)

697

698

def _retry_on_error(result, func, arguments,

699

_error_code=_error_code):

700

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

701

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

702

while result < gnutls.E_SUCCESS:

703

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

704

return _error_code(result)

705

result = func(*arguments)

706

return result

707

708

# Unless otherwise indicated, the function declarations below are

709

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

710

711

# Functions

712

priority_set_direct = _library.gnutls_priority_set_direct

713

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

714

ctypes.POINTER(ctypes.c_char_p)]

715

priority_set_direct.restype = _error_code

716

717

init = _library.gnutls_init

718

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

719

init.restype = _error_code

720

721

set_default_priority = _library.gnutls_set_default_priority

722

set_default_priority.argtypes = [ClientSession]

723

set_default_priority.restype = _error_code

724

725

record_send = _library.gnutls_record_send

726

record_send.argtypes = [ClientSession, ctypes.c_void_p,

727

ctypes.c_size_t]

728

record_send.restype = ctypes.c_ssize_t

729

record_send.errcheck = _retry_on_error

730

731

certificate_allocate_credentials = (

732

_library.gnutls_certificate_allocate_credentials)

733

certificate_allocate_credentials.argtypes = [

734

PointerTo(Credentials)]

735

certificate_allocate_credentials.restype = _error_code

736

737

certificate_free_credentials = (

738

_library.gnutls_certificate_free_credentials)

739

certificate_free_credentials.argtypes = [Credentials]

740

certificate_free_credentials.restype = None

741

742

handshake_set_private_extensions = (

743

_library.gnutls_handshake_set_private_extensions)

744

handshake_set_private_extensions.argtypes = [ClientSession,

745

ctypes.c_int]

746

handshake_set_private_extensions.restype = None

747

748

credentials_set = _library.gnutls_credentials_set

749

credentials_set.argtypes = [ClientSession, credentials_type_t,

750

CastToVoidPointer(Credentials)]

751

credentials_set.restype = _error_code

752

753

strerror = _library.gnutls_strerror

754

strerror.argtypes = [ctypes.c_int]

755

strerror.restype = ctypes.c_char_p

756

757

certificate_type_get = _library.gnutls_certificate_type_get

758

certificate_type_get.argtypes = [ClientSession]

759

certificate_type_get.restype = _error_code

760

761

certificate_get_peers = _library.gnutls_certificate_get_peers

762

certificate_get_peers.argtypes = [ClientSession,

763

ctypes.POINTER(ctypes.c_uint)]

764

certificate_get_peers.restype = ctypes.POINTER(datum_t)

765

766

global_set_log_level = _library.gnutls_global_set_log_level

767

global_set_log_level.argtypes = [ctypes.c_int]

768

global_set_log_level.restype = None

769

770

global_set_log_function = _library.gnutls_global_set_log_function

771

global_set_log_function.argtypes = [log_func]

772

global_set_log_function.restype = None

773

774

deinit = _library.gnutls_deinit

775

deinit.argtypes = [ClientSession]

776

deinit.restype = None

777

778

handshake = _library.gnutls_handshake

779

handshake.argtypes = [ClientSession]

780

handshake.restype = ctypes.c_int

781

handshake.errcheck = _retry_on_error

782

783

transport_set_ptr = _library.gnutls_transport_set_ptr

784

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

785

transport_set_ptr.restype = None

786

787

bye = _library.gnutls_bye

788

bye.argtypes = [ClientSession, close_request_t]

789

bye.restype = ctypes.c_int

790

bye.errcheck = _retry_on_error

791

792

check_version = _library.gnutls_check_version

793

check_version.argtypes = [ctypes.c_char_p]

794

check_version.restype = ctypes.c_char_p

795

796

_need_version = b"3.3.0"

797

if check_version(_need_version) is None:

798

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

799

.format(_need_version))

800

801

_tls_rawpk_version = b"3.6.6"

802

has_rawpk = bool(check_version(_tls_rawpk_version))

803

804

if has_rawpk:

805

# Types

806

class pubkey_st(ctypes.Structure):

807

_fields = []

808

pubkey_t = ctypes.POINTER(pubkey_st)

809

810

x509_crt_fmt_t = ctypes.c_int

811

812

# All the function declarations below are from

813

# gnutls/abstract.h

814

pubkey_init = _library.gnutls_pubkey_init

815

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

816

pubkey_init.restype = _error_code

817

818

pubkey_import = _library.gnutls_pubkey_import

819

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

820

x509_crt_fmt_t]

821

pubkey_import.restype = _error_code

822

823

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

824

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

825

ctypes.POINTER(ctypes.c_ubyte),

826

ctypes.POINTER(ctypes.c_size_t)]

827

pubkey_get_key_id.restype = _error_code

828

829

pubkey_deinit = _library.gnutls_pubkey_deinit

830

pubkey_deinit.argtypes = [pubkey_t]

831

pubkey_deinit.restype = None

832

else:

833

# All the function declarations below are from

834

# gnutls/openpgp.h

835

836

openpgp_crt_init = _library.gnutls_openpgp_crt_init

837

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

838

openpgp_crt_init.restype = _error_code

839

840

openpgp_crt_import = _library.gnutls_openpgp_crt_import

841

openpgp_crt_import.argtypes = [openpgp_crt_t,

842

ctypes.POINTER(datum_t),

843

openpgp_crt_fmt_t]

844

openpgp_crt_import.restype = _error_code

845

846

openpgp_crt_verify_self = \

847

_library.gnutls_openpgp_crt_verify_self

848

openpgp_crt_verify_self.argtypes = [

849

openpgp_crt_t,

850

ctypes.c_uint,

851

ctypes.POINTER(ctypes.c_uint),

852

]

853

openpgp_crt_verify_self.restype = _error_code

854

855

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

856

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

857

openpgp_crt_deinit.restype = None

858

859

openpgp_crt_get_fingerprint = (

860

_library.gnutls_openpgp_crt_get_fingerprint)

861

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

862

ctypes.c_void_p,

863

ctypes.POINTER(

864

ctypes.c_size_t)]

865

openpgp_crt_get_fingerprint.restype = _error_code

866

867

if check_version(b"3.6.4"):

868

certificate_type_get2 = _library.gnutls_certificate_type_get2

869

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

870

certificate_type_get2.restype = _error_code

871

872

# Remove non-public functions

873

del _error_code, _retry_on_error

874

875

876

def call_pipe(connection, # : multiprocessing.Connection

877

func, *args, **kwargs):

878

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

879

880

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

881

return value on the provided multiprocessing.Connection.

882

"""

883

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

884

connection.close()

885

886

887

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

888

403

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

889

404

890

405

Attributes:

891

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

406

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

892

407

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

893

408

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

894

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

895

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

896

running.

897

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

898

413

checker_command: string; External command which is run to check

899

414

if client lives. %() expansions are done at

900

415

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

901

416

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

902

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

903

418

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

904

419

client_structure: Object describing what attributes a client has

905

420

and is used for storing the client at exit

906

421

current_checker_command: string; current running checker_command

907

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

908

423

enabled: bool()

909

424

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

910

uniquely identify an OpenPGP client

911

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

912

a client using raw public keys

425

uniquely identify the client

913

426

host: string; available for use by the checker command

914

427

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

915

428

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

917

430

last_checker_status: integer between 0 and 255 reflecting exit

918

431

status of last checker. -1 reflects crashed

919

432

checker, -2 means no checker completed yet.

920

last_checker_signal: The signal which killed the last checker, if

921

last_checker_status is -1

922

433

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

923

434

924

435

D-Bus identifiers

931

442

disabled, or None

932

443

server_settings: The server_settings dict from main()

933

444

"""

934

445

935

446

runtime_expansions = ("approval_delay", "approval_duration",

936

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

447

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

937

448

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

938

449

"last_approval_request", "last_checked_ok",

939

450

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

940

client_defaults = {

941

"timeout": "PT5M",

942

"extended_timeout": "PT15M",

943

"interval": "PT2M",

944

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

945

"host": "",

946

"approval_delay": "PT0S",

947

"approval_duration": "PT1S",

948

"approved_by_default": "True",

949

"enabled": "True",

950

}

951

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

952

477

@staticmethod

953

478

def config_parser(config):

954

479

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

961

486

for client_name in config.sections():

962

487

section = dict(config.items(client_name))

963

488

client = settings[client_name] = {}

964

489

965

490

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

966

491

# Reformat values from string types to Python types

967

492

client["approved_by_default"] = config.getboolean(

968

493

client_name, "approved_by_default")

969

494

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

970

495

"enabled")

971

972

# Uppercase and remove spaces from key_id and fingerprint

973

# for later comparison purposes with return value from the

974

# key_id() and fingerprint() functions

975

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

976

.replace(" ", ""))

977

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

978

"").upper()

496

497

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

979

498

.replace(" ", ""))

980

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

981

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

982

" fingerprint", client_name)

983

del settings[client_name]

984

continue

985

499

if "secret" in section:

986

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

987

.encode("utf-8"),

988

"base64")

500

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

989

501

elif "secfile" in section:

990

502

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

991

503

(section["secfile"])),

992

504

"rb") as secfile:

993

505

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

994

506

else:

995

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

507

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

996

508

.format(section))

997

509

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

998

510

client["extended_timeout"] = string_to_delta(

1006

518

client["last_approval_request"] = None

1007

519

client["last_checked_ok"] = None

1008

520

client["last_checker_status"] = -2

1009

521

1010

522

return settings

1011

1012

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

523

524

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

1013

525

self.name = name

1014

526

if server_settings is None:

1015

527

server_settings = {}

1016

528

self.server_settings = server_settings

1017

529

# adding all client settings

1018

for setting, value in settings.items():

530

for setting, value in settings.iteritems():

1019

531

setattr(self, setting, value)

1020

532

1021

533

if self.enabled:

1022

534

if not hasattr(self, "last_enabled"):

1023

535

self.last_enabled = datetime.datetime.utcnow()

1027

539

else:

1028

540

self.last_enabled = None

1029

541

self.expires = None

1030

1031

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

1032

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

1033

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

542

543

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

547

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

1034

548

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

1035

549

datetime.datetime.utcnow())

1036

550

1037

551

# attributes specific for this server instance

1038

552

self.checker = None

1039

553

self.checker_initiator_tag = None

1042

556

self.current_checker_command = None

1043

557

self.approved = None

1044

558

self.approvals_pending = 0

1045

self.changedstate = multiprocessing_manager.Condition(

1046

multiprocessing_manager.Lock())

1047

self.client_structure = [attr

1048

for attr in self.__dict__.keys()

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

1049

564

if not attr.startswith("_")]

1050

565

self.client_structure.append("client_structure")

1051

1052

for name, t in inspect.getmembers(

1053

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

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

1054

571

if not name.startswith("_"):

1055

572

self.client_structure.append(name)

1056

573

1057

574

# Send notice to process children that client state has changed

1058

575

def send_changedstate(self):

1059

576

with self.changedstate:

1060

577

self.changedstate.notify_all()

1061

578

1062

579

def enable(self):

1063

580

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

1064

581

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

1065

582

# Already enabled

1066

583

return

584

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

1067

585

self.enabled = True

1068

586

self.last_enabled = datetime.datetime.utcnow()

1069

587

self.init_checker()

1070

588

self.send_changedstate()

1071

589

1072

590

def disable(self, quiet=True):

1073

591

"""Disable this client."""

1074

592

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

1075

593

return False

1076

594

if not quiet:

1077

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

595

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

1078

596

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

1079

GLib.source_remove(self.disable_initiator_tag)

597

gobject.source_remove(self.disable_initiator_tag)

1080

598

self.disable_initiator_tag = None

1081

599

self.expires = None

1082

600

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

1083

GLib.source_remove(self.checker_initiator_tag)

601

gobject.source_remove(self.checker_initiator_tag)

1084

602

self.checker_initiator_tag = None

1085

603

self.stop_checker()

1086

604

self.enabled = False

1087

605

if not quiet:

1088

606

self.send_changedstate()

1089

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

607

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

1090

608

return False

1091

609

1092

610

def __del__(self):

1093

611

self.disable()

1094

1095

def init_checker(self, randomize_start=False):

1096

# Schedule a new checker to be started a randomly selected

1097

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

1098

# the startup of checkers over time when the server is

1099

# started.

612

613

def init_checker(self):

614

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

615

# and every interval from then on.

1100

616

if self.checker_initiator_tag is not None:

1101

GLib.source_remove(self.checker_initiator_tag)

1102

interval_milliseconds = int(self.interval.total_seconds()

1103

* 1000)

1104

if randomize_start:

1105

delay_milliseconds = random.randrange(

1106

interval_milliseconds + 1)

1107

else:

1108

delay_milliseconds = interval_milliseconds

1109

self.checker_initiator_tag = GLib.timeout_add(

1110

delay_milliseconds, self.start_checker, randomize_start)

1111

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

1112

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

1113

# expire at the soonest one interval after a checker was

1114

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

1115

# time might have to be extended.

1116

now = datetime.datetime.utcnow()

1117

self.expires = now + delay + self.interval

1118

# Schedule a disable() at expire time

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

621

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

1119

622

if self.disable_initiator_tag is not None:

1120

GLib.source_remove(self.disable_initiator_tag)

1121

self.disable_initiator_tag = GLib.timeout_add(

1122

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

1123

self.disable)

1124

1125

def checker_callback(self, source, condition, connection,

1126

command):

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

627

# Also start a new checker *right now*.

628

self.start_checker()

629

630

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

1127

631

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

1128

# Read return code from connection (see call_pipe)

1129

returncode = connection.recv()

1130

connection.close()

1131

if self.checker is not None:

1132

self.checker.join()

1133

632

self.checker_callback_tag = None

1134

633

self.checker = None

1135

1136

if returncode >= 0:

1137

self.last_checker_status = returncode

1138

self.last_checker_signal = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1139

636

if self.last_checker_status == 0:

1140

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

637

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

638

vars(self))

1141

639

self.checked_ok()

1142

640

else:

1143

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

641

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

642

vars(self))

1144

643

else:

1145

644

self.last_checker_status = -1

1146

self.last_checker_signal = -returncode

1147

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

1148

return False

1149

645

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

646

vars(self))

647

1150

648

def checked_ok(self):

1151

649

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

1152

650

self.last_checked_ok = datetime.datetime.utcnow()

1153

651

self.last_checker_status = 0

1154

self.last_checker_signal = None

1155

652

self.bump_timeout()

1156

653

1157

654

def bump_timeout(self, timeout=None):

1158

655

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

1159

656

if timeout is None:

1160

657

timeout = self.timeout

1161

658

if self.disable_initiator_tag is not None:

1162

GLib.source_remove(self.disable_initiator_tag)

659

gobject.source_remove(self.disable_initiator_tag)

1163

660

self.disable_initiator_tag = None

1164

661

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

1165

self.disable_initiator_tag = GLib.timeout_add(

1166

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1167

665

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

1168

666

1169

667

def need_approval(self):

1170

668

self.last_approval_request = datetime.datetime.utcnow()

1171

1172

def start_checker(self, start_was_randomized=False):

669

670

def start_checker(self):

1173

671

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

1174

672

1175

673

If a checker already exists, leave it running and do

1176

674

nothing."""

1177

675

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

1182

680

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

1183

681

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

1184

682

# should be.

1185

1186

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

1187

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

1188

self.checker.join()

1189

self.checker = None

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1190

697

# Start a new checker if needed

1191

698

if self.checker is None:

1192

699

# Escape attributes for the shell

1193

escaped_attrs = {

1194

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

1195

for attr in self.runtime_expansions}

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1196

704

try:

1197

705

command = self.checker_command % escaped_attrs

1198

706

except TypeError as error:

1199

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

1200

self.checker_command, exc_info=error)

1201

return True # Try again later

707

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1202

710

self.current_checker_command = command

1203

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

1204

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

1205

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

1206

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

1207

# always replaced by /dev/null.)

1208

# The exception is when not debugging but nevertheless

1209

# running in the foreground; use the previously

1210

# created wnull.

1211

popen_args = {"close_fds": True,

1212

"shell": True,

1213

"cwd": "/"}

1214

if (not self.server_settings["debug"]

1215

and self.server_settings["foreground"]):

1216

popen_args.update({"stdout": wnull,

1217

"stderr": wnull})

1218

pipe = multiprocessing.Pipe(duplex=False)

1219

self.checker = multiprocessing.Process(

1220

target=call_pipe,

1221

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

1222

kwargs=popen_args)

1223

self.checker.start()

1224

self.checker_callback_tag = GLib.io_add_watch(

1225

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

1226

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1227

self.checker_callback, pipe[0], command)

1228

if start_was_randomized:

1229

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

1230

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

1231

# interval from then on.

1232

now = datetime.datetime.utcnow()

1233

self.checker_initiator_tag = GLib.timeout_add(

1234

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

1235

self.start_checker)

1236

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

1237

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

1238

return False

1239

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

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1240

753

return True

1241

754

1242

755

def stop_checker(self):

1243

756

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

1244

757

if self.checker_callback_tag:

1245

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1246

759

self.checker_callback_tag = None

1247

760

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

1248

761

return

1249

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

1250

self.checker.terminate()

762

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1251

771

self.checker = None

1252

772

1253

773

1254

def dbus_service_property(dbus_interface,

1255

signature="v",

1256

access="readwrite",

1257

byte_arrays=False):

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1258

776

"""Decorators for marking methods of a DBusObjectWithProperties to

1259

777

become properties on the D-Bus.

1260

778

1261

779

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

1262

780

and with one argument by "Set".

1263

781

1264

782

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

1265

783

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

1266

784

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

1269

787

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

1270

788

if byte_arrays and signature != "ay":

1271

789

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

1272

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

1273

790

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

1274

791

def decorator(func):

1275

792

func._dbus_is_property = True

1276

793

func._dbus_interface = dbus_interface

1279

796

func._dbus_name = func.__name__

1280

797

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

1281

798

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

1282

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1283

800

return func

1284

1285

801

return decorator

1286

802

1287

803

1288

804

def dbus_interface_annotations(dbus_interface):

1289

805

"""Decorator for marking functions returning interface annotations

1290

806

1291

807

Usage:

1292

808

1293

809

@dbus_interface_annotations("org.example.Interface")

1294

810

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

1295

811

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

1296

812

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

1297

813

"false"}

1298

814

"""

1299

1300

815

def decorator(func):

1301

816

func._dbus_is_interface = True

1302

817

func._dbus_interface = dbus_interface

1303

818

func._dbus_name = dbus_interface

1304

819

return func

1305

1306

820

return decorator

1307

821

1308

822

1309

823

def dbus_annotations(annotations):

1310

824

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

1311

825

Usage:

1312

1313

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

1314

"org.freedesktop.DBus.Property."

1315

"EmitsChangedSignal": "false"})

826

1316

827

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

1317

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

1318

832

def Property_dbus_property(self):

1319

833

return dbus.Boolean(False)

1320

1321

See also the DBusObjectWithAnnotations class.

1322

834

"""

1323

1324

835

def decorator(func):

1325

836

func._dbus_annotations = annotations

1326

837

return func

1327

1328

838

return decorator

1329

839

1330

840

1331

841

class DBusPropertyException(dbus.exceptions.DBusException):

1332

842

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

1333

843

"""

1334

pass

844

def __unicode__(self):

845

return unicode(str(self))

1335

846

1336

847

1337

848

class DBusPropertyAccessException(DBusPropertyException):

1346

857

pass

1347

858

1348

859

1349

class DBusObjectWithAnnotations(dbus.service.Object):

1350

"""A D-Bus object with annotations.

1351

1352

Classes inheriting from this can use the dbus_annotations

1353

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1354

866

"""

1355

867

1356

868

@staticmethod

1357

869

def _is_dbus_thing(thing):

1358

870

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

1359

871

1360

872

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

1361

873

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

1362

874

"""

1363

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

875

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

1364

876

False)

1365

877

1366

878

def _get_all_dbus_things(self, thing):

1367

879

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

1368

880

"""

1369

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

881

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

882

name),

1370

883

athing.__get__(self))

1371

884

for cls in self.__class__.__mro__

1372

885

for name, athing in

1373

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

1374

1375

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1376

out_signature="s",

1377

path_keyword="object_path",

1378

connection_keyword="connection")

1379

def Introspect(self, object_path, connection):

1380

"""Overloading of standard D-Bus method.

1381

1382

Inserts annotation tags on methods and signals.

1383

"""

1384

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

1385

connection)

1386

try:

1387

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

1388

1389

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

1390

# Add annotation tags

1391

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

1392

for tag in if_tag.getElementsByTagName(typ):

1393

annots = dict()

1394

for name, prop in (self.

1395

_get_all_dbus_things(typ)):

1396

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

1397

and prop._dbus_interface

1398

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

1399

annots.update(getattr(

1400

prop, "_dbus_annotations", {}))

1401

for name, value in annots.items():

1402

ann_tag = document.createElement(

1403

"annotation")

1404

ann_tag.setAttribute("name", name)

1405

ann_tag.setAttribute("value", value)

1406

tag.appendChild(ann_tag)

1407

# Add interface annotation tags

1408

for annotation, value in dict(

1409

itertools.chain.from_iterable(

1410

annotations().items()

1411

for name, annotations

1412

in self._get_all_dbus_things("interface")

1413

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

1414

)).items():

1415

ann_tag = document.createElement("annotation")

1416

ann_tag.setAttribute("name", annotation)

1417

ann_tag.setAttribute("value", value)

1418

if_tag.appendChild(ann_tag)

1419

# Fix argument name for the Introspect method itself

1420

if (if_tag.getAttribute("name")

1421

== dbus.INTROSPECTABLE_IFACE):

1422

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

1423

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

1424

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

1425

if (arg.getAttribute("direction")

1426

== "out"):

1427

arg.setAttribute("name",

1428

"xml_data")

1429

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

1430

document.unlink()

1431

except (AttributeError, xml.dom.DOMException,

1432

xml.parsers.expat.ExpatError) as error:

1433

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

1434

exc_info=error)

1435

return xmlstring

1436

1437

1438

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1439

"""A D-Bus object with properties.

1440

1441

Classes inheriting from this can use the dbus_service_property

1442

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

1443

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

1444

"""

1445

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1446

889

def _get_dbus_property(self, interface_name, property_name):

1447

890

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

1448

891

property with the specified name and interface.

1449

892

"""

1450

for cls in self.__class__.__mro__:

1451

for name, value in inspect.getmembers(

1452

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

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1453

897

if (value._dbus_name == property_name

1454

898

and value._dbus_interface == interface_name):

1455

899

return value.__get__(self)

1456

900

1457

901

# No such property

1458

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

1459

self.dbus_object_path, interface_name, property_name))

1460

1461

@classmethod

1462

def _get_all_interface_names(cls):

1463

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

1464

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

1465

"_dbus_interface", None)

1466

for x in (inspect.getmro(cls))

1467

for attr in dir(x))

1468

if name is not None)

1469

1470

@dbus.service.method(dbus.PROPERTIES_IFACE,

1471

in_signature="ss",

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1472

907

out_signature="v")

1473

908

def Get(self, interface_name, property_name):

1474

909

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

1480

915

if not hasattr(value, "variant_level"):

1481

916

return value

1482

917

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

1483

918

1484

919

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

1485

920

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

1486

921

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

1492

927

# The byte_arrays option is not supported yet on

1493

928

# signatures other than "ay".

1494

929

if prop._dbus_signature != "ay":

1495

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

1496

"'ay' signature {!r}"

1497

.format(prop._dbus_signature))

1498

value = dbus.ByteArray(bytes(value))

930

raise ValueError

931

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

932

for byte in value))

1499

933

prop(value)

1500

1501

@dbus.service.method(dbus.PROPERTIES_IFACE,

1502

in_signature="s",

934

935

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

1503

936

out_signature="a{sv}")

1504

937

def GetAll(self, interface_name):

1505

938

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

1506

939

standard.

1507

940

1508

941

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

1509

942

"""

1510

943

properties = {}

1520

953

if not hasattr(value, "variant_level"):

1521

954

properties[name] = value

1522

955

continue

1523

properties[name] = type(value)(

1524

value, variant_level=value.variant_level + 1)

956

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

957

value.variant_level+1)

1525

958

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

1526

1527

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

1528

def PropertiesChanged(self, interface_name, changed_properties,

1529

invalidated_properties):

1530

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

1531

standard.

1532

"""

1533

pass

1534

959

1535

960

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1536

961

out_signature="s",

1537

path_keyword="object_path",

1538

connection_keyword="connection")

962

path_keyword='object_path',

963

connection_keyword='connection')

1539

964

def Introspect(self, object_path, connection):

1540

965

"""Overloading of standard D-Bus method.

1541

966

1542

967

Inserts property tags and interface annotation tags.

1543

968

"""

1544

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1545

object_path,

1546

connection)

969

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

970

connection)

1547

971

try:

1548

972

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

1549

1550

973

def make_tag(document, name, prop):

1551

974

e = document.createElement("property")

1552

975

e.setAttribute("name", name)

1553

976

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

1554

977

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

1555

978

return e

1556

1557

979

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

1558

980

# Add property tags

1559

981

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

1562

984

if prop._dbus_interface

1563

985

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

1564

986

if_tag.appendChild(tag)

1565

# Add annotation tags for properties

1566

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

1567

annots = dict()

1568

for name, prop in self._get_all_dbus_things(

1569

"property"):

1570

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

1571

and prop._dbus_interface

1572

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

1573

annots.update(getattr(

1574

prop, "_dbus_annotations", {}))

1575

for name, value in annots.items():

1576

ann_tag = document.createElement(

1577

"annotation")

1578

ann_tag.setAttribute("name", name)

1579

ann_tag.setAttribute("value", value)

1580

tag.appendChild(ann_tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1581

1018

# Add the names to the return values for the

1582

1019

# "org.freedesktop.DBus.Properties" methods

1583

1020

if (if_tag.getAttribute("name")

1597

1034

document.unlink()

1598

1035

except (AttributeError, xml.dom.DOMException,

1599

1036

xml.parsers.expat.ExpatError) as error:

1600

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

1601

exc_info=error)

1602

return xmlstring

1603

1604

1605

try:

1606

dbus.OBJECT_MANAGER_IFACE

1607

except AttributeError:

1608

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

1609

1610

1611

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1612

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

1613

1614

Classes inheriting from this exposes the standard

1615

GetManagedObjects call and the InterfacesAdded and

1616

InterfacesRemoved signals on the standard

1617

"org.freedesktop.DBus.ObjectManager" interface.

1618

1619

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

1620

manually.

1621

"""

1622

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1623

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

1624

def GetManagedObjects(self):

1625

"""This function must be overridden"""

1626

raise NotImplementedError()

1627

1628

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1629

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

1630

def InterfacesAdded(self, object_path, interfaces_and_properties):

1631

pass

1632

1633

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

1634

def InterfacesRemoved(self, object_path, interfaces):

1635

pass

1636

1637

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1638

out_signature="s",

1639

path_keyword="object_path",

1640

connection_keyword="connection")

1641

def Introspect(self, object_path, connection):

1642

"""Overloading of standard D-Bus method.

1643

1644

Override return argument name of GetManagedObjects to be

1645

"objpath_interfaces_and_properties"

1646

"""

1647

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1648

object_path,

1649

connection)

1650

try:

1651

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

1652

1653

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

1654

# Fix argument name for the GetManagedObjects method

1655

if (if_tag.getAttribute("name")

1656

== dbus.OBJECT_MANAGER_IFACE):

1657

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

1658

if (cn.getAttribute("name")

1659

== "GetManagedObjects"):

1660

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

1661

if (arg.getAttribute("direction")

1662

== "out"):

1663

arg.setAttribute(

1664

"name",

1665

"objpath_interfaces"

1666

"_and_properties")

1667

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

1668

document.unlink()

1669

except (AttributeError, xml.dom.DOMException,

1670

xml.parsers.expat.ExpatError) as error:

1671

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

1672

exc_info=error)

1037

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

1038

exc_info=error)

1673

1039

return xmlstring

1674

1040

1675

1041

1676

1042

def datetime_to_dbus(dt, variant_level=0):

1677

1043

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

1678

1044

if dt is None:

1679

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

1680

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

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1681

1048

1682

1049

1683

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1685

1052

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

1686

1053

interface names according to the "alt_interface_names" mapping.

1687

1054

Usage:

1688

1055

1689

1056

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

1690

1057

"net.example.AlternateInterface"})

1691

1058

class SampleDBusObject(dbus.service.Object):

1692

1059

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

1693

1060

def SampleDBusMethod():

1694

1061

pass

1695

1062

1696

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1697

1064

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

1698

1065

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

1699

1066

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

1700

1067

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

1701

1068

1702

1069

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

1703

1070

(from DBusObjectWithProperties) and interfaces (from the

1704

1071

dbus_interface_annotations decorator).

1705

1072

"""

1706

1707

1073

def wrapper(cls):

1708

1074

for orig_interface_name, alt_interface_name in (

1709

alt_interface_names.items()):

1075

alt_interface_names.iteritems()):

1710

1076

attr = {}

1711

1077

interface_names = set()

1712

1078

# Go though all attributes of the class

1714

1080

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

1715

1081

# with the wrong interface name

1716

1082

if (not hasattr(attribute, "_dbus_interface")

1717

or not attribute._dbus_interface.startswith(

1718

orig_interface_name)):

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1719

1085

continue

1720

1086

# Create an alternate D-Bus interface name based on

1721

1087

# the current name

1722

alt_interface = attribute._dbus_interface.replace(

1723

orig_interface_name, alt_interface_name)

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1724

1091

interface_names.add(alt_interface)

1725

1092

# Is this a D-Bus signal?

1726

1093

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

1727

1094

# Extract the original non-method undecorated

1728

1095

# function by black magic

1729

if sys.version_info.major == 2:

1730

nonmethod_func = (dict(

1096

nonmethod_func = (dict(

1731

1097

zip(attribute.func_code.co_freevars,

1732

attribute.__closure__))

1733

["func"].cell_contents)

1734

else:

1735

nonmethod_func = (dict(

1736

zip(attribute.__code__.co_freevars,

1737

attribute.__closure__))

1738

["func"].cell_contents)

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1739

1100

# Create a new, but exactly alike, function

1740

1101

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

1741

1102

# with the alternate D-Bus interface name

1742

new_function = copy_function(nonmethod_func)

1743

new_function = (dbus.service.signal(

1744

alt_interface,

1745

attribute._dbus_signature)(new_function))

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1746

1112

# Copy annotations, if any

1747

1113

try:

1748

new_function._dbus_annotations = dict(

1749

attribute._dbus_annotations)

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1750

1116

except AttributeError:

1751

1117

pass

1752

1753

1118

# Define a creator of a function to call both the

1754

1119

# original and alternate functions, so both the

1755

1120

# original and alternate signals gets sent when

1758

1123

"""This function is a scope container to pass

1759

1124

func1 and func2 to the "call_both" function

1760

1125

outside of its arguments"""

1761

1762

@functools.wraps(func2)

1763

1126

def call_both(*args, **kwargs):

1764

1127

"""This function will emit two D-Bus

1765

1128

signals by calling func1 and func2"""

1766

1129

func1(*args, **kwargs)

1767

1130

func2(*args, **kwargs)

1768

# Make wrapper function look like a D-Bus

1769

# signal

1770

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

1771

if name.startswith("_dbus_"):

1772

setattr(call_both, name, attr)

1773

1774

1131

return call_both

1775

1132

# Create the "call_both" function and add it to

1776

1133

# the class

1781

1138

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

1782

1139

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

1783

1140

# to the class.

1784

attr[attrname] = (

1785

dbus.service.method(

1786

alt_interface,

1787

attribute._dbus_in_signature,

1788

attribute._dbus_out_signature)

1789

(copy_function(attribute)))

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1790

1151

# Copy annotations, if any

1791

1152

try:

1792

attr[attrname]._dbus_annotations = dict(

1793

attribute._dbus_annotations)

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1794

1155

except AttributeError:

1795

1156

pass

1796

1157

# Is this a D-Bus property?

1799

1160

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

1800

1161

# property with the alternate D-Bus interface

1801

1162

# name. Add it to the class.

1802

attr[attrname] = (dbus_service_property(

1803

alt_interface, attribute._dbus_signature,

1804

attribute._dbus_access,

1805

attribute._dbus_get_args_options

1806

["byte_arrays"])

1807

(copy_function(attribute)))

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1808

1176

# Copy annotations, if any

1809

1177

try:

1810

attr[attrname]._dbus_annotations = dict(

1811

attribute._dbus_annotations)

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1812

1180

except AttributeError:

1813

1181

pass

1814

1182

# Is this a D-Bus interface?

1817

1185

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

1818

1186

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

1819

1187

# to the class.

1820

attr[attrname] = (

1821

dbus_interface_annotations(alt_interface)

1822

(copy_function(attribute)))

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1823

1196

if deprecate:

1824

1197

# Deprecate all alternate interfaces

1825

iname = "_AlternateDBusNames_interface_annotation{}"

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1826

1199

for interface_name in interface_names:

1827

1828

1200

@dbus_interface_annotations(interface_name)

1829

1201

def func(self):

1830

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

1831

"true"}

1202

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

1203

"true" }

1832

1204

# Find an unused name

1833

1205

for aname in (iname.format(i)

1834

1206

for i in itertools.count()):

1838

1210

if interface_names:

1839

1211

# Replace the class with a new subclass of it with

1840

1212

# methods, signals, etc. as created above.

1841

if sys.version_info.major == 2:

1842

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

1843

(cls, ), attr)

1844

else:

1845

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

1846

(cls, ), attr)

1213

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

1214

(cls,), attr)

1847

1215

return cls

1848

1849

1216

return wrapper

1850

1217

1851

1218

1852

1219

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

1853

"se.bsnet.fukt.Mandos"})

1220

"se.bsnet.fukt.Mandos"})

1854

1221

class ClientDBus(Client, DBusObjectWithProperties):

1855

1222

"""A Client class using D-Bus

1856

1223

1857

1224

Attributes:

1858

1225

dbus_object_path: dbus.ObjectPath

1859

1226

bus: dbus.SystemBus()

1860

1227

"""

1861

1228

1862

1229

runtime_expansions = (Client.runtime_expansions

1863

+ ("dbus_object_path", ))

1864

1865

_interface = "se.recompile.Mandos.Client"

1866

1230

+ ("dbus_object_path",))

1231

1867

1232

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

1868

1869

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

1233

1234

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

1870

1235

self.bus = bus

1871

1236

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

1872

1237

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

1873

1238

# the D-Bus

1874

client_object_name = str(self.name).translate(

1239

client_object_name = unicode(self.name).translate(

1875

1240

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

1876

1241

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

1877

self.dbus_object_path = dbus.ObjectPath(

1878

"/clients/" + client_object_name)

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1879

1244

DBusObjectWithProperties.__init__(self, self.bus,

1880

1245

self.dbus_object_path)

1881

1882

def notifychangeproperty(transform_func, dbus_name,

1883

type_func=lambda x: x,

1884

variant_level=1,

1885

invalidate_only=False,

1886

_interface=_interface):

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1887

1250

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

1888

1251

its changes to DBus.

1889

1252

1890

1253

transform_fun: Function that takes a value and a variant_level

1891

1254

and transforms it to a D-Bus type.

1892

1255

dbus_name: D-Bus name of the variable

1894

1257

to the D-Bus. Default: no transform

1895

1258

variant_level: D-Bus variant level. Default: 1

1896

1259

"""

1897

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

1898

1260

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

1899

1261

def setter(self, value):

1900

1262

if hasattr(self, "dbus_object_path"):

1901

1263

if (not hasattr(self, attrname) or

1902

1264

type_func(getattr(self, attrname, None))

1903

1265

!= type_func(value)):

1904

if invalidate_only:

1905

self.PropertiesChanged(

1906

_interface, dbus.Dictionary(),

1907

dbus.Array((dbus_name, )))

1908

else:

1909

dbus_value = transform_func(

1910

type_func(value),

1911

variant_level=variant_level)

1912

self.PropertyChanged(dbus.String(dbus_name),

1913

dbus_value)

1914

self.PropertiesChanged(

1915

_interface,

1916

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

1917

dbus_value}),

1918

dbus.Array())

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1919

1271

setattr(self, attrname, value)

1920

1272

1921

1273

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

1922

1274

1923

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1924

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1925

1277

"ApprovalPending",

1926

type_func=bool)

1278

type_func = bool)

1927

1279

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

1928

1280

last_enabled = notifychangeproperty(datetime_to_dbus,

1929

1281

"LastEnabled")

1930

checker = notifychangeproperty(

1931

dbus.Boolean, "CheckerRunning",

1932

type_func=lambda checker: checker is not None)

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1933

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1934

1286

"LastCheckedOK")

1935

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1938

1290

datetime_to_dbus, "LastApprovalRequest")

1939

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1940

1292

"ApprovedByDefault")

1941

approval_delay = notifychangeproperty(

1942

dbus.UInt64, "ApprovalDelay",

1943

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

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1944

1297

approval_duration = notifychangeproperty(

1945

1298

dbus.UInt64, "ApprovalDuration",

1946

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

1299

type_func = timedelta_to_milliseconds)

1947

1300

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

1948

timeout = notifychangeproperty(

1949

dbus.UInt64, "Timeout",

1950

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1951

1304

extended_timeout = notifychangeproperty(

1952

1305

dbus.UInt64, "ExtendedTimeout",

1953

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

1954

interval = notifychangeproperty(

1955

dbus.UInt64, "Interval",

1956

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

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1957

1311

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

1958

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

1959

invalidate_only=True)

1960

1312

1961

1313

del notifychangeproperty

1962

1314

1963

1315

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

1964

1316

try:

1965

1317

self.remove_from_connection()

1968

1320

if hasattr(DBusObjectWithProperties, "__del__"):

1969

1321

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

1970

1322

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

1971

1972

def checker_callback(self, source, condition,

1973

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

1974

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

1975

connection, command, *args,

1976

**kwargs)

1977

exitstatus = self.last_checker_status

1978

if exitstatus >= 0:

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1979

1330

# Emit D-Bus signal

1980

1331

self.CheckerCompleted(dbus.Int16(exitstatus),

1981

# This is specific to GNU libC

1982

dbus.Int64(exitstatus << 8),

1332

dbus.Int64(condition),

1983

1333

dbus.String(command))

1984

1334

else:

1985

1335

# Emit D-Bus signal

1986

1336

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

1987

dbus.Int64(

1988

# This is specific to GNU libC

1989

(exitstatus << 8)

1990

| self.last_checker_signal),

1337

dbus.Int64(condition),

1991

1338

dbus.String(command))

1992

return ret

1993

1339

1340

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

1341

*args, **kwargs)

1342

1994

1343

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

1995

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1996

1349

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

1997

1350

# Only if new checker process was started

1998

1351

if (self.checker is not None

2000

1353

# Emit D-Bus signal

2001

1354

self.CheckerStarted(self.current_checker_command)

2002

1355

return r

2003

1356

2004

1357

def _reset_approved(self):

2005

1358

self.approved = None

2006

1359

return False

2007

1360

2008

1361

def approve(self, value=True):

2009

1362

self.approved = value

2010

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

2011

* 1000), self._reset_approved)

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

2012

1366

self.send_changedstate()

2013

2014

# D-Bus methods, signals & properties

2015

2016

# Interfaces

2017

2018

# Signals

2019

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

2020

1380

# CheckerCompleted - signal

2021

1381

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

2022

1382

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

2023

1383

"D-Bus signal"

2024

1384

pass

2025

1385

2026

1386

# CheckerStarted - signal

2027

1387

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

2028

1388

def CheckerStarted(self, command):

2029

1389

"D-Bus signal"

2030

1390

pass

2031

1391

2032

1392

# PropertyChanged - signal

2033

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

2034

1393

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

2035

1394

def PropertyChanged(self, property, value):

2036

1395

"D-Bus signal"

2037

1396

pass

2038

1397

2039

1398

# GotSecret - signal

2040

1399

@dbus.service.signal(_interface)

2041

1400

def GotSecret(self):

2044

1403

server to mandos-client

2045

1404

"""

2046

1405

pass

2047

1406

2048

1407

# Rejected - signal

2049

1408

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

2050

1409

def Rejected(self, reason):

2051

1410

"D-Bus signal"

2052

1411

pass

2053

1412

2054

1413

# NeedApproval - signal

2055

1414

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

2056

1415

def NeedApproval(self, timeout, default):

2057

1416

"D-Bus signal"

2058

1417

return self.need_approval()

2059

2060

# Methods

2061

1418

1419

## Methods

1420

2062

1421

# Approve - method

2063

1422

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

2064

1423

def Approve(self, value):

2065

1424

self.approve(value)

2066

1425

2067

1426

# CheckedOK - method

2068

1427

@dbus.service.method(_interface)

2069

1428

def CheckedOK(self):

2070

1429

self.checked_ok()

2071

1430

2072

1431

# Enable - method

2073

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

2074

1432

@dbus.service.method(_interface)

2075

1433

def Enable(self):

2076

1434

"D-Bus method"

2077

1435

self.enable()

2078

1436

2079

1437

# StartChecker - method

2080

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

2081

1438

@dbus.service.method(_interface)

2082

1439

def StartChecker(self):

2083

1440

"D-Bus method"

2084

1441

self.start_checker()

2085

1442

2086

1443

# Disable - method

2087

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

2088

1444

@dbus.service.method(_interface)

2089

1445

def Disable(self):

2090

1446

"D-Bus method"

2091

1447

self.disable()

2092

1448

2093

1449

# StopChecker - method

2094

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

2095

1450

@dbus.service.method(_interface)

2096

1451

def StopChecker(self):

2097

1452

self.stop_checker()

2098

2099

# Properties

2100

1453

1454

## Properties

1455

2101

1456

# ApprovalPending - property

2102

1457

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

2103

1458

def ApprovalPending_dbus_property(self):

2104

1459

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

2105

1460

2106

1461

# ApprovedByDefault - property

2107

@dbus_service_property(_interface,

2108

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2109

1463

access="readwrite")

2110

1464

def ApprovedByDefault_dbus_property(self, value=None):

2111

1465

if value is None: # get

2112

1466

return dbus.Boolean(self.approved_by_default)

2113

1467

self.approved_by_default = bool(value)

2114

1468

2115

1469

# ApprovalDelay - property

2116

@dbus_service_property(_interface,

2117

signature="t",

1470

@dbus_service_property(_interface, signature="t",

2118

1471

access="readwrite")

2119

1472

def ApprovalDelay_dbus_property(self, value=None):

2120

1473

if value is None: # get

2121

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

2122

* 1000)

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2123

1475

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

2124

1476

2125

1477

# ApprovalDuration - property

2126

@dbus_service_property(_interface,

2127

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2128

1479

access="readwrite")

2129

1480

def ApprovalDuration_dbus_property(self, value=None):

2130

1481

if value is None: # get

2131

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

2132

* 1000)

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2133

1484

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

2134

1485

2135

1486

# Name - property

2136

@dbus_annotations(

2137

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

2138

1487

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

2139

1488

def Name_dbus_property(self):

2140

1489

return dbus.String(self.name)

2141

2142

# KeyID - property

2143

@dbus_annotations(

2144

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

2145

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

2146

def KeyID_dbus_property(self):

2147

return dbus.String(self.key_id)

2148

1490

2149

1491

# Fingerprint - property

2150

@dbus_annotations(

2151

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

2152

1492

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

2153

1493

def Fingerprint_dbus_property(self):

2154

1494

return dbus.String(self.fingerprint)

2155

1495

2156

1496

# Host - property

2157

@dbus_service_property(_interface,

2158

signature="s",

1497

@dbus_service_property(_interface, signature="s",

2159

1498

access="readwrite")

2160

1499

def Host_dbus_property(self, value=None):

2161

1500

if value is None: # get

2162

1501

return dbus.String(self.host)

2163

self.host = str(value)

2164

1502

self.host = unicode(value)

1503

2165

1504

# Created - property

2166

@dbus_annotations(

2167

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

2168

1505

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

2169

1506

def Created_dbus_property(self):

2170

1507

return datetime_to_dbus(self.created)

2171

1508

2172

1509

# LastEnabled - property

2173

1510

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

2174

1511

def LastEnabled_dbus_property(self):

2175

1512

return datetime_to_dbus(self.last_enabled)

2176

1513

2177

1514

# Enabled - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1515

@dbus_service_property(_interface, signature="b",

2180

1516

access="readwrite")

2181

1517

def Enabled_dbus_property(self, value=None):

2182

1518

if value is None: # get

2185

1521

self.enable()

2186

1522

else:

2187

1523

self.disable()

2188

1524

2189

1525

# LastCheckedOK - property

2190

@dbus_service_property(_interface,

2191

signature="s",

1526

@dbus_service_property(_interface, signature="s",

2192

1527

access="readwrite")

2193

1528

def LastCheckedOK_dbus_property(self, value=None):

2194

1529

if value is not None:

2195

1530

self.checked_ok()

2196

1531

return

2197

1532

return datetime_to_dbus(self.last_checked_ok)

2198

1533

2199

1534

# LastCheckerStatus - property

2200

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

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2201

1537

def LastCheckerStatus_dbus_property(self):

2202

1538

return dbus.Int16(self.last_checker_status)

2203

1539

2204

1540

# Expires - property

2205

1541

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

2206

1542

def Expires_dbus_property(self):

2207

1543

return datetime_to_dbus(self.expires)

2208

1544

2209

1545

# LastApprovalRequest - property

2210

1546

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

2211

1547

def LastApprovalRequest_dbus_property(self):

2212

1548

return datetime_to_dbus(self.last_approval_request)

2213

1549

2214

1550

# Timeout - property

2215

@dbus_service_property(_interface,

2216

signature="t",

1551

@dbus_service_property(_interface, signature="t",

2217

1552

access="readwrite")

2218

1553

def Timeout_dbus_property(self, value=None):

2219

1554

if value is None: # get

2220

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

1555

return dbus.UInt64(self.timeout_milliseconds())

2221

1556

old_timeout = self.timeout

2222

1557

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

2223

1558

# Reschedule disabling

2231

1566

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

2232

1567

is None):

2233

1568

return

2234

GLib.source_remove(self.disable_initiator_tag)

2235

self.disable_initiator_tag = GLib.timeout_add(

2236

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

2237

self.disable)

2238

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2239

1575

# ExtendedTimeout - property

2240

@dbus_service_property(_interface,

2241

signature="t",

1576

@dbus_service_property(_interface, signature="t",

2242

1577

access="readwrite")

2243

1578

def ExtendedTimeout_dbus_property(self, value=None):

2244

1579

if value is None: # get

2245

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

2246

* 1000)

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2247

1581

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

2248

1582

2249

1583

# Interval - property

2250

@dbus_service_property(_interface,

2251

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2252

1585

access="readwrite")

2253

1586

def Interval_dbus_property(self, value=None):

2254

1587

if value is None: # get

2255

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

1588

return dbus.UInt64(self.interval_milliseconds())

2256

1589

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

2257

1590

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

2258

1591

return

2259

1592

if self.enabled:

2260

1593

# Reschedule checker run

2261

GLib.source_remove(self.checker_initiator_tag)

2262

self.checker_initiator_tag = GLib.timeout_add(

2263

value, self.start_checker)

2264

self.start_checker() # Start one now, too

2265

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2266

1599

# Checker - property

2267

@dbus_service_property(_interface,

2268

signature="s",

1600

@dbus_service_property(_interface, signature="s",

2269

1601

access="readwrite")

2270

1602

def Checker_dbus_property(self, value=None):

2271

1603

if value is None: # get

2272

1604

return dbus.String(self.checker_command)

2273

self.checker_command = str(value)

2274

1605

self.checker_command = unicode(value)

1606

2275

1607

# CheckerRunning - property

2276

@dbus_service_property(_interface,

2277

signature="b",

1608

@dbus_service_property(_interface, signature="b",

2278

1609

access="readwrite")

2279

1610

def CheckerRunning_dbus_property(self, value=None):

2280

1611

if value is None: # get

2283

1614

self.start_checker()

2284

1615

else:

2285

1616

self.stop_checker()

2286

1617

2287

1618

# ObjectPath - property

2288

@dbus_annotations(

2289

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

2290

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

2291

1619

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

2292

1620

def ObjectPath_dbus_property(self):

2293

return self.dbus_object_path # is already a dbus.ObjectPath

2294

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2295

1623

# Secret = property

2296

@dbus_annotations(

2297

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

2298

"invalidates"})

2299

@dbus_service_property(_interface,

2300

signature="ay",

2301

access="write",

2302

byte_arrays=True)

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2303

1626

def Secret_dbus_property(self, value):

2304

self.secret = bytes(value)

2305

1627

self.secret = str(value)

1628

2306

1629

del _interface

2307

1630

2308

1631

2309

class ProxyClient:

2310

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

1632

class ProxyClient(object):

1633

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

2311

1634

self._pipe = child_pipe

2312

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

1635

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

2313

1636

if not self._pipe.recv():

2314

raise KeyError(key_id or fpr)

2315

1637

raise KeyError()

1638

2316

1639

def __getattribute__(self, name):

2317

if name == "_pipe":

1640

if name == '_pipe':

2318

1641

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

2319

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

1642

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

2320

1643

data = self._pipe.recv()

2321

if data[0] == "data":

1644

if data[0] == 'data':

2322

1645

return data[1]

2323

if data[0] == "function":

2324

1646

if data[0] == 'function':

2325

1647

def func(*args, **kwargs):

2326

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

1648

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

2327

1649

return self._pipe.recv()[1]

2328

2329

1650

return func

2330

1651

2331

1652

def __setattr__(self, name, value):

2332

if name == "_pipe":

1653

if name == '_pipe':

2333

1654

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

2334

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

1655

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

2335

1656

2336

1657

2337

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

2338

1659

"""A class to handle client connections.

2339

1660

2340

1661

Instantiated once for each connection to handle it.

2341

1662

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

2342

1663

2343

1664

def handle(self):

2344

1665

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

2345

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

2346

str(self.client_address))

2347

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

2348

2349

session = gnutls.ClientSession(self.request)

2350

2351

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

2352

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

2353

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

2354

# "+DHE-DSS"))

1666

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

1667

unicode(self.client_address))

1668

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

1669

self.server.child_pipe.fileno())

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2355

1685

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

2356

1686

priority = self.server.gnutls_priority

2357

1687

if priority is None:

2358

1688

priority = "NORMAL"

2359

gnutls.priority_set_direct(session,

2360

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

2361

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2362

1693

# Start communication using the Mandos protocol

2363

1694

# Get protocol number

2364

1695

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

2365

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

1696

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

2366

1697

try:

2367

1698

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

2368

raise RuntimeError(line)

1699

raise RuntimeError

2369

1700

except (ValueError, IndexError, RuntimeError) as error:

2370

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

1701

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

2371

1702

return

2372

1703

2373

1704

# Start GnuTLS connection

2374

1705

try:

2375

1706

session.handshake()

2376

except gnutls.Error as error:

2377

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

1707

except gnutls.errors.GNUTLSError as error:

1708

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

2378

1709

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

2379

1710

# established. Just abandon the request.

2380

1711

return

2381

log.debug("Handshake succeeded")

2382

1712

logger.debug("Handshake succeeded")

1713

2383

1714

approval_required = False

2384

1715

try:

2385

if gnutls.has_rawpk:

2386

fpr = b""

2387

try:

2388

key_id = self.key_id(

2389

self.peer_certificate(session))

2390

except (TypeError, gnutls.Error) as error:

2391

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

2392

return

2393

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

2394

key_id.decode("utf-8",

2395

errors="replace"))

2396

2397

else:

2398

key_id = b""

2399

try:

2400

fpr = self.fingerprint(

2401

self.peer_certificate(session))

2402

except (TypeError, gnutls.Error) as error:

2403

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

2404

return

2405

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

2406

2407

try:

2408

client = ProxyClient(child_pipe, key_id, fpr,

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2409

1727

self.client_address)

2410

1728

except KeyError:

2411

1729

return

2412

1730

2413

1731

if client.approval_delay:

2414

1732

delay = client.approval_delay

2415

1733

client.approvals_pending += 1

2416

1734

approval_required = True

2417

1735

2418

1736

while True:

2419

1737

if not client.enabled:

2420

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

1738

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

1739

client.name)

2421

1740

if self.server.use_dbus:

2422

1741

# Emit D-Bus signal

2423

1742

client.Rejected("Disabled")

2424

1743

return

2425

1744

2426

1745

if client.approved or not client.approval_delay:

2427

# We are approved or approval is disabled

1746

#We are approved or approval is disabled

2428

1747

break

2429

1748

elif client.approved is None:

2430

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

2431

client.name)

1749

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

1750

client.name)

2432

1751

if self.server.use_dbus:

2433

1752

# Emit D-Bus signal

2434

1753

client.NeedApproval(

2435

client.approval_delay.total_seconds()

2436

* 1000, client.approved_by_default)

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2437

1756

else:

2438

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

2439

client.name)

1757

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

1758

client.name)

2440

1759

if self.server.use_dbus:

2441

1760

# Emit D-Bus signal

2442

1761

client.Rejected("Denied")

2443

1762

return

2444

2445

# wait until timeout or approved

1763

1764

#wait until timeout or approved

2446

1765

time = datetime.datetime.now()

2447

1766

client.changedstate.acquire()

2448

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

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2449

1770

client.changedstate.release()

2450

1771

time2 = datetime.datetime.now()

2451

1772

if (time2 - time) >= delay:

2452

1773

if not client.approved_by_default:

2453

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

2454

" waiting for approval",

2455

client.name)

1774

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

1775

" waiting for approval",

1776

client.name)

2456

1777

if self.server.use_dbus:

2457

1778

# Emit D-Bus signal

2458

1779

client.Rejected("Approval timed out")

2461

1782

break

2462

1783

else:

2463

1784

delay -= time2 - time

2464

2465

try:

2466

session.send(client.secret)

2467

except gnutls.Error as error:

2468

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

2469

return

2470

2471

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

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

1799

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

2472

1800

# bump the timeout using extended_timeout

2473

1801

client.bump_timeout(client.extended_timeout)

2474

1802

if self.server.use_dbus:

2475

1803

# Emit D-Bus signal

2476

1804

client.GotSecret()

2477

1805

2478

1806

finally:

2479

1807

if approval_required:

2480

1808

client.approvals_pending -= 1

2481

1809

try:

2482

1810

session.bye()

2483

except gnutls.Error as error:

2484

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

2485

1811

except gnutls.errors.GNUTLSError as error:

1812

logger.warning("GnuTLS bye failed",

1813

exc_info=error)

1814

2486

1815

@staticmethod

2487

1816

def peer_certificate(session):

2488

"Return the peer's certificate as a bytestring"

2489

try:

2490

cert_type = gnutls.certificate_type_get2(

2491

session, gnutls.CTYPE_PEERS)

2492

except AttributeError:

2493

cert_type = gnutls.certificate_type_get(session)

2494

if gnutls.has_rawpk:

2495

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2496

else:

2497

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2498

# If not a valid certificate type...

2499

if cert_type not in valid_cert_types:

2500

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

2501

valid_cert_types)

2502

# ...return invalid data

2503

return b""

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2504

1824

list_size = ctypes.c_uint(1)

2505

cert_list = (gnutls.certificate_get_peers

2506

(session, ctypes.byref(list_size)))

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

1827

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

2507

1828

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

2508

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

1829

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

1830

" certificate")

2509

1831

if list_size.value == 0:

2510

1832

return None

2511

1833

cert = cert_list[0]

2512

1834

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

2513

2514

@staticmethod

2515

def key_id(certificate):

2516

"Convert a certificate bytestring to a hexdigit key ID"

2517

# New GnuTLS "datum" with the public key

2518

datum = gnutls.datum_t(

2519

ctypes.cast(ctypes.c_char_p(certificate),

2520

ctypes.POINTER(ctypes.c_ubyte)),

2521

ctypes.c_uint(len(certificate)))

2522

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

2523

# New empty GnuTLS certificate

2524

pubkey = gnutls.pubkey_t()

2525

gnutls.pubkey_init(ctypes.byref(pubkey))

2526

# Import the raw public key into the certificate

2527

gnutls.pubkey_import(pubkey,

2528

ctypes.byref(datum),

2529

gnutls.X509_FMT_DER)

2530

# New buffer for the key ID

2531

buf = ctypes.create_string_buffer(32)

2532

buf_len = ctypes.c_size_t(len(buf))

2533

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

2534

gnutls.pubkey_get_key_id(

2535

pubkey,

2536

gnutls.KEYID_USE_SHA256,

2537

ctypes.cast(ctypes.byref(buf),

2538

ctypes.POINTER(ctypes.c_ubyte)),

2539

ctypes.byref(buf_len))

2540

# Deinit the certificate

2541

gnutls.pubkey_deinit(pubkey)

2542

2543

# Convert the buffer to a Python bytestring

2544

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

2545

# Convert the bytestring to hexadecimal notation

2546

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

2547

return hex_key_id

2548

1835

2549

1836

@staticmethod

2550

1837

def fingerprint(openpgp):

2551

1838

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2552

1839

# New GnuTLS "datum" with the OpenPGP public key

2553

datum = gnutls.datum_t(

2554

ctypes.cast(ctypes.c_char_p(openpgp),

2555

ctypes.POINTER(ctypes.c_ubyte)),

2556

ctypes.c_uint(len(openpgp)))

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2557

1845

# New empty GnuTLS certificate

2558

crt = gnutls.openpgp_crt_t()

2559

gnutls.openpgp_crt_init(ctypes.byref(crt))

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2560

1849

# Import the OpenPGP public key into the certificate

2561

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

2562

gnutls.OPENPGP_FMT_RAW)

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2563

1854

# Verify the self signature in the key

2564

1855

crtverify = ctypes.c_uint()

2565

gnutls.openpgp_crt_verify_self(crt, 0,

2566

ctypes.byref(crtverify))

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2567

1859

if crtverify.value != 0:

2568

gnutls.openpgp_crt_deinit(crt)

2569

raise gnutls.CertificateSecurityError(code

2570

=crtverify.value)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2571

1863

# New buffer for the fingerprint

2572

1864

buf = ctypes.create_string_buffer(20)

2573

1865

buf_len = ctypes.c_size_t()

2574

1866

# Get the fingerprint from the certificate into the buffer

2575

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

2576

ctypes.byref(buf_len))

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2577

1870

# Deinit the certificate

2578

gnutls.openpgp_crt_deinit(crt)

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2579

1872

# Convert the buffer to a Python bytestring

2580

1873

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

2581

1874

# Convert the bytestring to hexadecimal notation

2583

1876

return hex_fpr

2584

1877

2585

1878

2586

class MultiprocessingMixIn:

1879

class MultiprocessingMixIn(object):

2587

1880

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

2588

2589

1881

def sub_process_main(self, request, address):

2590

1882

try:

2591

1883

self.finish_request(request, address)

2592

1884

except Exception:

2593

1885

self.handle_error(request, address)

2594

1886

self.close_request(request)

2595

1887

2596

1888

def process_request(self, request, address):

2597

1889

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

2598

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

2599

args=(request, address))

1890

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

1891

args = (request, address))

2600

1892

proc.start()

2601

1893

return proc

2602

1894

2603

1895

2604

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2605

1897

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

2606

2607

1898

def process_request(self, request, client_address):

2608

1899

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

2609

1900

2610

1901

This function creates a new pipe in self.pipe

2611

1902

"""

2612

1903

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2613

1904

2614

1905

proc = MultiprocessingMixIn.process_request(self, request,

2615

1906

client_address)

2616

1907

self.child_pipe.close()

2617

1908

self.add_pipe(parent_pipe, proc)

2618

1909

2619

1910

def add_pipe(self, parent_pipe, proc):

2620

1911

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

2621

raise NotImplementedError()

1912

raise NotImplementedError

2622

1913

2623

1914

2624

1915

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2625

socketserver.TCPServer):

2626

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

2627

1916

socketserver.TCPServer, object):

1917

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

1918

2628

1919

Attributes:

2629

1920

enabled: Boolean; whether this server is activated yet

2630

1921

interface: None or a network interface name (string)

2631

1922

use_ipv6: Boolean; to use IPv6 or not

2632

1923

"""

2633

2634

1924

def __init__(self, server_address, RequestHandlerClass,

2635

interface=None,

2636

use_ipv6=True,

2637

socketfd=None):

1925

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

2638

1926

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

2639

1927

creating a new one with socket.socket().

2640

1928

"""

2646

1934

self.socketfd = socketfd

2647

1935

# Save the original socket.socket() function

2648

1936

self.socket_socket = socket.socket

2649

2650

1937

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

2651

#

1938

#

2652

1939

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

2653

1940

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

2654

1941

# patching socket.socket.)

2655

#

1942

#

2656

1943

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

2657

1944

@functools.wraps(socket.socket)

2658

1945

def socket_wrapper(*args, **kwargs):

2670

1957

# socket_wrapper(), if socketfd was set.

2671

1958

socketserver.TCPServer.__init__(self, server_address,

2672

1959

RequestHandlerClass)

2673

1960

2674

1961

def server_bind(self):

2675

1962

"""This overrides the normal server_bind() function

2676

1963

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

2677

1964

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

2678

global SO_BINDTODEVICE

2679

1965

if self.interface is not None:

2680

1966

if SO_BINDTODEVICE is None:

2681

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

2682

# common enough.

2683

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

2684

SO_BINDTODEVICE = 25

2685

try:

2686

self.socket.setsockopt(

2687

socket.SOL_SOCKET, SO_BINDTODEVICE,

2688

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

2689

except socket.error as error:

2690

if error.errno == errno.EPERM:

2691

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

2692

self.interface)

2693

elif error.errno == errno.ENOPROTOOPT:

2694

log.error("SO_BINDTODEVICE not available; cannot"

2695

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

2696

elif error.errno == errno.ENODEV:

2697

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

2698

" bind", self.interface)

2699

else:

2700

raise

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2701

1988

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

2702

1989

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

2703

if self.server_address[1]:

2704

self.allow_reuse_address = True

2705

1990

if not self.server_address[0]:

2706

1991

if self.address_family == socket.AF_INET6:

2707

any_address = "::" # in6addr_any

1992

any_address = "::" # in6addr_any

2708

1993

else:

2709

any_address = "0.0.0.0" # INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

2710

1995

self.server_address = (any_address,

2711

1996

self.server_address[1])

2712

1997

elif not self.server_address[1]:

2713

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

1998

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

1999

0)

2714

2000

# if self.interface:

2715

2001

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

2716

2002

# 0, # port

2722

2008

2723

2009

class MandosServer(IPv6_TCPServer):

2724

2010

"""Mandos server.

2725

2011

2726

2012

Attributes:

2727

2013

clients: set of Client objects

2728

2014

gnutls_priority GnuTLS priority string

2729

2015

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

2730

2731

Assumes a GLib.MainLoop event loop.

2016

2017

Assumes a gobject.MainLoop event loop.

2732

2018

"""

2733

2734

2019

def __init__(self, server_address, RequestHandlerClass,

2735

interface=None,

2736

use_ipv6=True,

2737

clients=None,

2738

gnutls_priority=None,

2739

use_dbus=True,

2740

socketfd=None):

2020

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

2021

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

2741

2022

self.enabled = False

2742

2023

self.clients = clients

2743

2024

if self.clients is None:

2746

2027

self.gnutls_priority = gnutls_priority

2747

2028

IPv6_TCPServer.__init__(self, server_address,

2748

2029

RequestHandlerClass,

2749

interface=interface,

2750

use_ipv6=use_ipv6,

2751

socketfd=socketfd)

2752

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2753

2033

def server_activate(self):

2754

2034

if self.enabled:

2755

2035

return socketserver.TCPServer.server_activate(self)

2756

2036

2757

2037

def enable(self):

2758

2038

self.enabled = True

2759

2039

2760

2040

def add_pipe(self, parent_pipe, proc):

2761

2041

# Call "handle_ipc" for both data and EOF events

2762

GLib.io_add_watch(

2763

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

2764

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

2765

functools.partial(self.handle_ipc,

2766

parent_pipe=parent_pipe,

2767

proc=proc))

2768

2769

def handle_ipc(self, source, condition,

2770

parent_pipe=None,

2771

proc=None,

2772

client_object=None):

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2773

2051

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

2774

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

2052

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

2775

2053

# Wait for other process to exit

2776

2054

proc.join()

2777

2055

return False

2778

2056

2779

2057

# Read a request from the child

2780

2058

request = parent_pipe.recv()

2781

2059

command = request[0]

2782

2783

if command == "init":

2784

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

2785

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

2786

address = request[3]

2787

2788

for c in self.clients.values():

2789

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2790

"27AE41E4649B934CA495991B7852B855"):

2791

continue

2792

if key_id and c.key_id == key_id:

2793

client = c

2794

break

2795

if fpr and c.fingerprint == fpr:

2060

2061

if command == 'init':

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2796

2067

client = c

2797

2068

break

2798

2069

else:

2799

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

2800

" %s", key_id or fpr, address)

2070

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

2071

"dress: %s", fpr, address)

2801

2072

if self.use_dbus:

2802

2073

# Emit D-Bus signal

2803

mandos_dbus_service.ClientNotFound(key_id or fpr,

2074

mandos_dbus_service.ClientNotFound(fpr,

2804

2075

address[0])

2805

2076

parent_pipe.send(False)

2806

2077

return False

2807

2808

GLib.io_add_watch(

2809

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

2810

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

2811

functools.partial(self.handle_ipc,

2812

parent_pipe=parent_pipe,

2813

proc=proc,

2814

client_object=client))

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2815

2087

parent_pipe.send(True)

2816

2088

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

2817

2089

# same fileno

2818

2090

return False

2819

if command == "funcall":

2091

if command == 'funcall':

2820

2092

funcname = request[1]

2821

2093

args = request[2]

2822

2094

kwargs = request[3]

2823

2824

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

2095

2096

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

2825

2097

funcname)(*args,

2826

**kwargs)))

2827

2828

if command == "getattr":

2098

**kwargs)))

2099

2100

if command == 'getattr':

2829

2101

attrname = request[1]

2830

if isinstance(client_object.__getattribute__(attrname),

2831

collections.abc.Callable):

2832

parent_pipe.send(("function", ))

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2833

2104

else:

2834

parent_pipe.send((

2835

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

2836

2837

if command == "setattr":

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2108

if command == 'setattr':

2838

2109

attrname = request[1]

2839

2110

value = request[2]

2840

2111

setattr(client_object, attrname, value)

2841

2112

2842

2113

return True

2843

2114

2844

2115

2845

2116

def rfc3339_duration_to_delta(duration):

2846

2117

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

2847

2848

>>> timedelta = datetime.timedelta

2849

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

2850

True

2851

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

2852

True

2853

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

2854

True

2855

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

2856

True

2857

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

2858

True

2859

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

2860

True

2861

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

2862

True

2863

>>> del timedelta

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2864

2133

"""

2865

2134

2866

2135

# Parsing an RFC 3339 duration with regular expressions is not

2867

2136

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

2868

2137

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

2869

2138

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

2870

2139

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

2871

2140

# avoid excessive use of external libraries.

2872

2141

2873

2142

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

2874

Token = collections.namedtuple("Token", (

2875

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

2876

# a "group" containing digits

2877

"value", # datetime.timedelta or None

2878

"followers")) # Tokens valid after this token

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2879

2152

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

2880

2153

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

2881

2154

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

2882

2155

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

2883

2156

datetime.timedelta(seconds=1),

2884

frozenset((token_end, )))

2157

frozenset((token_end,)))

2885

2158

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

2886

2159

datetime.timedelta(minutes=1),

2887

2160

frozenset((token_second, token_end)))

2903

2176

frozenset((token_month, token_end)))

2904

2177

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

2905

2178

datetime.timedelta(weeks=1),

2906

frozenset((token_end, )))

2179

frozenset((token_end,)))

2907

2180

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

2908

2181

frozenset((token_year, token_month,

2909

2182

token_day, token_time,

2910

token_week)))

2911

# Define starting values:

2912

# Value so far

2913

value = datetime.timedelta()

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2914

2186

found_token = None

2915

# Following valid tokens

2916

followers = frozenset((token_duration, ))

2917

# String left to parse

2918

s = duration

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2919

2189

# Loop until end token is found

2920

2190

while found_token is not token_end:

2921

2191

# Search for any currently valid tokens

2937

2207

break

2938

2208

else:

2939

2209

# No currently valid tokens were found

2940

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

2941

.format(duration))

2210

raise ValueError("Invalid RFC 3339 duration")

2942

2211

# End token found

2943

2212

return value

2944

2213

2945

2214

2946

2215

def string_to_delta(interval):

2947

2216

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

2948

2949

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

2950

True

2951

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

2952

True

2953

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

2954

True

2955

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

2956

True

2957

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

2958

True

2959

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

2960

True

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2961

2230

"""

2962

2231

2963

2232

try:

2964

2233

return rfc3339_duration_to_delta(interval)

2965

2234

except ValueError:

2966

2235

pass

2967

2236

2968

2237

timevalue = datetime.timedelta(0)

2969

2238

for s in interval.split():

2970

2239

try:

2971

suffix = s[-1]

2240

suffix = unicode(s[-1])

2972

2241

value = int(s[:-1])

2973

2242

if suffix == "d":

2974

2243

delta = datetime.timedelta(value)

2981

2250

elif suffix == "w":

2982

2251

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

2983

2252

else:

2984

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

2985

except IndexError as e:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2986

2256

raise ValueError(*(e.args))

2987

2257

timevalue += delta

2988

2258

return timevalue

2989

2259

2990

2260

2991

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

2261

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

2992

2262

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

2993

2263

2994

2264

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

2995

2265

if os.fork():

2996

2266

sys.exit()

3004

2274

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

3005

2275

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

3006

2276

raise OSError(errno.ENODEV,

3007

"{} not a character device"

2277

"{0} not a character device"

3008

2278

.format(os.devnull))

3009

2279

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

3010

2280

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

3014

2284

3015

2285

3016

2286

def main():

3017

2287

3018

2288

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

3019

2289

# Parsing of options, both command line and config file

3020

2290

3021

2291

parser = argparse.ArgumentParser()

3022

2292

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

3023

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

2293

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

3024

2294

help="show version number and exit")

3025

2295

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

3026

2296

help="Bind to interface IF")

3059

2329

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

3060

2330

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

3061

2331

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

3062

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

3063

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

3064

default=None)

3065

2332

3066

2333

options = parser.parse_args()

3067

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

3068

2340

# Default values for config file for server-global settings

3069

if gnutls.has_rawpk:

3070

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

3071

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

3072

else:

3073

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

3074

":+SIGN-DSA-SHA256")

3075

server_defaults = {"interface": "",

3076

"address": "",

3077

"port": "",

3078

"debug": "False",

3079

"priority": priority,

3080

"servicename": "Mandos",

3081

"use_dbus": "True",

3082

"use_ipv6": "True",

3083

"debuglevel": "",

3084

"restore": "True",

3085

"socket": "",

3086

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

3087

"foreground": "False",

3088

"zeroconf": "True",

3089

}

3090

del priority

3091

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

3092

2357

# Parse config file for server-global settings

3093

server_config = configparser.ConfigParser(server_defaults)

2358

server_config = configparser.SafeConfigParser(server_defaults)

3094

2359

del server_defaults

3095

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

3096

# Convert the ConfigParser object to a dict

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3097

2363

server_settings = server_config.defaults()

3098

2364

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

3099

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

3100

"foreground", "zeroconf"):

2365

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

3101

2366

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

3102

2367

option)

3103

2368

if server_settings["port"]:

3109

2374

# Later, stdin will, and stdout and stderr might, be dup'ed

3110

2375

# over with an opened os.devnull. But we don't want this to

3111

2376

# happen with a supplied network socket.

3112

while 0 <= server_settings["socket"] <= 2:

2377

if 0 <= server_settings["socket"] <= 2:

3113

2378

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

3114

2379

["socket"])

3115

os.set_inheritable(server_settings["socket"], False)

3116

2380

del server_config

3117

2381

3118

2382

# Override the settings from the config file with command line

3119

2383

# options, if set.

3120

2384

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

3121

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

3122

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

3123

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

2385

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

2386

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

2387

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

3124

2388

value = getattr(options, option)

3125

2389

if value is not None:

3126

2390

server_settings[option] = value

3127

2391

del options

3128

2392

# Force all strings to be unicode

3129

2393

for option in server_settings.keys():

3130

if isinstance(server_settings[option], bytes):

3131

server_settings[option] = (server_settings[option]

3132

.decode("utf-8"))

2394

if type(server_settings[option]) is str:

2395

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

3133

2396

# Force all boolean options to be boolean

3134

2397

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

3135

"foreground", "zeroconf"):

2398

"foreground"):

3136

2399

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

3137

2400

# Debug implies foreground

3138

2401

if server_settings["debug"]:

3139

2402

server_settings["foreground"] = True

3140

2403

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

3141

2404

3142

2405

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

3143

3144

if (not server_settings["zeroconf"]

3145

and not (server_settings["port"]

3146

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

3147

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

3148

2406

3149

2407

# For convenience

3150

2408

debug = server_settings["debug"]

3151

2409

debuglevel = server_settings["debuglevel"]

3154

2412

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

3155

2413

stored_state_file)

3156

2414

foreground = server_settings["foreground"]

3157

zeroconf = server_settings["zeroconf"]

3158

2415

3159

2416

if debug:

3160

2417

initlogger(debug, logging.DEBUG)

3161

2418

else:

3164

2421

else:

3165

2422

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

3166

2423

initlogger(debug, level)

3167

2424

3168

2425

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

3169

syslogger.setFormatter(

3170

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

3171

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

3172

server_settings["servicename"])))

3173

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3174

2432

# Parse config file with clients

3175

client_config = configparser.ConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3176

2435

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

3177

2436

"clients.conf"))

3178

2437

3179

2438

global mandos_dbus_service

3180

2439

mandos_dbus_service = None

3181

3182

socketfd = None

3183

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

3184

socketfd = server_settings["socket"]

3185

tcp_server = MandosServer(

3186

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

3187

ClientHandler,

3188

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

3189

use_ipv6=use_ipv6,

3190

gnutls_priority=server_settings["priority"],

3191

use_dbus=use_dbus,

3192

socketfd=socketfd)

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3193

2452

if not foreground:

3194

2453

pidfilename = "/run/mandos.pid"

3195

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

3196

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

3197

2454

pidfile = None

3198

2455

try:

3199

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

2456

pidfile = open(pidfilename, "w")

3200

2457

except IOError as e:

3201

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

3202

exc_info=e)

3203

3204

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

3205

("mandos", "mandos"),

3206

("nobody", "nogroup")):

2458

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

2459

exc_info=e)

2460

2461

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

3207

2462

try:

3208

2463

uid = pwd.getpwnam(name).pw_uid

3209

gid = pwd.getpwnam(group).pw_gid

2464

gid = pwd.getpwnam(name).pw_gid

3210

2465

break

3211

2466

except KeyError:

3212

2467

continue

3216

2471

try:

3217

2472

os.setgid(gid)

3218

2473

os.setuid(uid)

3219

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

3220

2474

except OSError as error:

3221

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

3222

os.strerror(error.errno))

3223

2475

if error.errno != errno.EPERM:

3224

raise

3225

2476

raise error

2477

3226

2478

if debug:

3227

2479

# Enable all possible GnuTLS debugging

3228

2480

3229

2481

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

3230

2482

# - GnuTLS manual

3231

gnutls.global_set_log_level(11)

3232

3233

@gnutls.log_func

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3234

2486

def debug_gnutls(level, string):

3235

log.debug("GnuTLS: %s",

3236

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

3237

3238

gnutls.global_set_log_function(debug_gnutls)

3239

2487

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3240

2492

# Redirect stdin so all checkers get /dev/null

3241

2493

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

3242

2494

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

3243

2495

if null > 2:

3244

2496

os.close(null)

3245

2497

3246

2498

# Need to fork before connecting to D-Bus

3247

2499

if not foreground:

3248

2500

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

3249

2501

daemon()

3250

3251

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

3252

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

3253

# need to inform GLib that threads will be used.

3254

GLib.threads_init()

3255

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3256

2507

global main_loop

3257

2508

# From the Avahi example code

3258

2509

DBusGMainLoop(set_as_default=True)

3259

main_loop = GLib.MainLoop()

3260

if use_dbus or zeroconf:

3261

bus = dbus.SystemBus()

2510

main_loop = gobject.MainLoop()

2511

bus = dbus.SystemBus()

3262

2512

# End of Avahi example code

3263

2513

if use_dbus:

3264

2514

try:

3265

2515

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

3266

bus,

3267

do_not_queue=True)

3268

old_bus_name = dbus.service.BusName(

3269

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

3270

do_not_queue=True)

3271

except dbus.exceptions.DBusException as e:

3272

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

2521

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

3273

2522

use_dbus = False

3274

2523

server_settings["use_dbus"] = False

3275

2524

tcp_server.use_dbus = False

3276

if zeroconf:

3277

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3278

service = AvahiServiceToSyslog(

3279

name=server_settings["servicename"],

3280

servicetype="_mandos._tcp",

3281

protocol=protocol,

3282

bus=bus)

3283

if server_settings["interface"]:

3284

service.interface = if_nametoindex(

3285

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

3286

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3287

2534

global multiprocessing_manager

3288

2535

multiprocessing_manager = multiprocessing.Manager()

3289

2536

3290

2537

client_class = Client

3291

2538

if use_dbus:

3292

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

3293

2539

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

2540

3294

2541

client_settings = Client.config_parser(client_config)

3295

2542

old_client_settings = {}

3296

2543

clients_data = {}

3297

2544

3298

2545

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

3299

2546

global wnull

3300

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

2547

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

3301

2548

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

3302

2549

# mode

3303

2550

if debug or not foreground:

3304

2551

wnull.close()

3305

2552

3306

2553

# Get client data and settings from last running state.

3307

2554

if server_settings["restore"]:

3308

2555

try:

3309

2556

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

3310

if sys.version_info.major == 2:

3311

clients_data, old_client_settings = pickle.load(

3312

stored_state)

3313

else:

3314

bytes_clients_data, bytes_old_client_settings = (

3315

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

3316

# Fix bytes to strings

3317

# clients_data

3318

# .keys()

3319

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

3320

if isinstance(key, bytes)

3321

else key): value

3322

for key, value in

3323

bytes_clients_data.items()}

3324

del bytes_clients_data

3325

for key in clients_data:

3326

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

3327

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

3328

for k, v in

3329

clients_data[key].items()}

3330

clients_data[key] = value

3331

# .client_structure

3332

value["client_structure"] = [

3333

(s.decode("utf-8")

3334

if isinstance(s, bytes)

3335

else s) for s in

3336

value["client_structure"]]

3337

# .name, .host, and .checker_command

3338

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

3339

if isinstance(value[k], bytes):

3340

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

3341

if "key_id" not in value:

3342

value["key_id"] = ""

3343

elif "fingerprint" not in value:

3344

value["fingerprint"] = ""

3345

# old_client_settings

3346

# .keys()

3347

old_client_settings = {

3348

(key.decode("utf-8")

3349

if isinstance(key, bytes)

3350

else key): value

3351

for key, value in

3352

bytes_old_client_settings.items()}

3353

del bytes_old_client_settings

3354

# .host and .checker_command

3355

for value in old_client_settings.values():

3356

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

3357

if isinstance(value[attribute], bytes):

3358

value[attribute] = (value[attribute]

3359

.decode("utf-8"))

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3360

2559

os.remove(stored_state_path)

3361

2560

except IOError as e:

3362

2561

if e.errno == errno.ENOENT:

3363

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

3364

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

2562

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

2563

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

3365

2564

else:

3366

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

3367

exc_info=e)

2565

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

2566

exc_info=e)

3368

2567

raise

3369

2568

except EOFError as e:

3370

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

3371

exc_info=e)

3372

2569

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

2570

"EOFError:", exc_info=e)

2571

3373

2572

with PGPEngine() as pgp:

3374

for client_name, client in clients_data.items():

2573

for client_name, client in clients_data.iteritems():

3375

2574

# Skip removed clients

3376

2575

if client_name not in client_settings:

3377

2576

continue

3378

2577

3379

2578

# Decide which value to use after restoring saved state.

3380

2579

# We have three different values: Old config file,

3381

2580

# new config file, and saved state.

3386

2585

# For each value in new config, check if it

3387

2586

# differs from the old config value (Except for

3388

2587

# the "secret" attribute)

3389

if (name != "secret"

3390

and (value !=

3391

old_client_settings[client_name][name])):

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3392

2591

client[name] = value

3393

2592

except KeyError:

3394

2593

pass

3395

2594

3396

2595

# Clients who has passed its expire date can still be

3397

# enabled if its last checker was successful. A Client

2596

# enabled if its last checker was successful. Clients

3398

2597

# whose checker succeeded before we stored its state is

3399

2598

# assumed to have successfully run all checkers during

3400

2599

# downtime.

3401

2600

if client["enabled"]:

3402

2601

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

3403

2602

if not client["last_checked_ok"]:

3404

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

3405

" never performed a successful"

3406

" checker", client_name)

2603

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3407

2607

client["enabled"] = False

3408

2608

elif client["last_checker_status"] != 0:

3409

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

3410

" last checker failed with error"

3411

" code %s", client_name,

3412

client["last_checker_status"])

2609

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3413

2614

client["enabled"] = False

3414

2615

else:

3415

client["expires"] = (

3416

datetime.datetime.utcnow()

3417

+ client["timeout"])

3418

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

3419

" enabled", client_name)

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

2619

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3420

2622

try:

3421

client["secret"] = pgp.decrypt(

3422

client["encrypted_secret"],

3423

client_settings[client_name]["secret"])

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3424

2627

except PGPError:

3425

2628

# If decryption fails, we use secret from new settings

3426

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

3427

client_name)

3428

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

3429

["secret"])

3430

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3431

2634

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

3432

2635

for client_name in (set(old_client_settings)

3433

2636

- set(client_settings)):

3435

2638

for client_name in (set(client_settings)

3436

2639

- set(old_client_settings)):

3437

2640

clients_data[client_name] = client_settings[client_name]

3438

2641

3439

2642

# Create all client objects

3440

for client_name, client in clients_data.items():

2643

for client_name, client in clients_data.iteritems():

3441

2644

tcp_server.clients[client_name] = client_class(

3442

name=client_name,

3443

settings=client,

3444

server_settings=server_settings)

3445

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3446

2648

if not tcp_server.clients:

3447

log.warning("No clients defined")

3448

2649

logger.warning("No clients defined")

2650

3449

2651

if not foreground:

3450

2652

if pidfile is not None:

3451

pid = os.getpid()

3452

2653

try:

3453

2654

with pidfile:

3454

print(pid, file=pidfile)

2655

pid = os.getpid()

2656

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

3455

2657

except IOError:

3456

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

3457

pidfilename, pid)

2658

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

2659

pidfilename, pid)

3458

2660

del pidfile

3459

2661

del pidfilename

3460

3461

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

3462

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3463

lambda: main_loop.quit() and False)

3464

2662

2663

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

2664

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

2665

3465

2666

if use_dbus:

3466

3467

@alternate_dbus_interfaces(

3468

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

3469

class MandosDBusService(DBusObjectWithObjectManager):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3470

2670

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

3471

3472

2671

def __init__(self):

3473

2672

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

3474

3475

2673

_interface = "se.recompile.Mandos"

3476

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3477

2681

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

3478

2682

def ClientAdded(self, objpath):

3479

2683

"D-Bus signal"

3480

2684

pass

3481

2685

3482

2686

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

3483

def ClientNotFound(self, key_id, address):

2687

def ClientNotFound(self, fingerprint, address):

3484

2688

"D-Bus signal"

3485

2689

pass

3486

3487

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

3488

"true"})

2690

3489

2691

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

3490

2692

def ClientRemoved(self, objpath, name):

3491

2693

"D-Bus signal"

3492

2694

pass

3493

3494

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

3495

"true"})

2695

3496

2696

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

3497

2697

def GetAllClients(self):

3498

2698

"D-Bus method"

3499

return dbus.Array(c.dbus_object_path for c in

3500

tcp_server.clients.values())

3501

3502

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

3503

"true"})

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3504

2703

@dbus.service.method(_interface,

3505

2704

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

3506

2705

def GetAllClientsWithProperties(self):

3507

2706

"D-Bus method"

3508

2707

return dbus.Dictionary(

3509

{c.dbus_object_path: c.GetAll(

3510

"se.recompile.Mandos.Client")

3511

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

2708

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

2709

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

3512

2710

signature="oa{sv}")

3513

2711

3514

2712

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

3515

2713

def RemoveClient(self, object_path):

3516

2714

"D-Bus method"

3517

for c in tcp_server.clients.values():

2715

for c in tcp_server.clients.itervalues():

3518

2716

if c.dbus_object_path == object_path:

3519

2717

del tcp_server.clients[c.name]

3520

2718

c.remove_from_connection()

3521

# Don't signal the disabling

2719

# Don't signal anything except ClientRemoved

3522

2720

c.disable(quiet=True)

3523

# Emit D-Bus signal for removal

3524

self.client_removed_signal(c)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3525

2723

return

3526

2724

raise KeyError(object_path)

3527

2725

3528

2726

del _interface

3529

3530

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3531

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

3532

def GetManagedObjects(self):

3533

"""D-Bus method"""

3534

return dbus.Dictionary(

3535

{client.dbus_object_path:

3536

dbus.Dictionary(

3537

{interface: client.GetAll(interface)

3538

for interface in

3539

client._get_all_interface_names()})

3540

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

3541

3542

def client_added_signal(self, client):

3543

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

3544

if use_dbus:

3545

# New standard signal

3546

self.InterfacesAdded(

3547

client.dbus_object_path,

3548

dbus.Dictionary(

3549

{interface: client.GetAll(interface)

3550

for interface in

3551

client._get_all_interface_names()}))

3552

# Old signal

3553

self.ClientAdded(client.dbus_object_path)

3554

3555

def client_removed_signal(self, client):

3556

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

3557

if use_dbus:

3558

# New standard signal

3559

self.InterfacesRemoved(

3560

client.dbus_object_path,

3561

client._get_all_interface_names())

3562

# Old signal

3563

self.ClientRemoved(client.dbus_object_path,

3564

client.name)

3565

2727

3566

2728

mandos_dbus_service = MandosDBusService()

3567

3568

# Save modules to variables to exempt the modules from being

3569

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

3570

mp = multiprocessing

3571

wn = wnull

3572

2729

3573

2730

def cleanup():

3574

2731

"Cleanup function; run on exit"

3575

if zeroconf:

3576

service.cleanup()

3577

3578

mp.active_children()

3579

wn.close()

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3580

2736

if not (tcp_server.clients or client_settings):

3581

2737

return

3582

2738

3583

2739

# Store client before exiting. Secrets are encrypted with key

3584

2740

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

3585

2741

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

3586

2742

clients = {}

3587

2743

with PGPEngine() as pgp:

3588

for client in tcp_server.clients.values():

2744

for client in tcp_server.clients.itervalues():

3589

2745

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

3590

2746

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

3591

2747

key)

3592

2748

client_dict = {}

3593

2749

3594

2750

# A list of attributes that can not be pickled

3595

2751

# + secret.

3596

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

3597

"checker", "server_settings"}

3598

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

3599

.Object):

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3600

2756

exclude.add(name)

3601

2757

3602

2758

client_dict["encrypted_secret"] = (client

3603

2759

.encrypted_secret)

3604

2760

for attr in client.client_structure:

3605

2761

if attr not in exclude:

3606

2762

client_dict[attr] = getattr(client, attr)

3607

2763

3608

2764

clients[client.name] = client_dict

3609

2765

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

3610

2766

3611

2767

try:

3612

with tempfile.NamedTemporaryFile(

3613

mode="wb",

3614

suffix=".pickle",

3615

prefix="clients-",

3616

dir=os.path.dirname(stored_state_path),

3617

delete=False) as stored_state:

3618

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

3619

protocol=2)

3620

tempname = stored_state.name

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3621

2774

os.rename(tempname, stored_state_path)

3622

2775

except (IOError, OSError) as e:

3623

2776

if not debug:

3626

2779

except NameError:

3627

2780

pass

3628

2781

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

3629

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

3630

os.strerror(e.errno))

2782

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

2783

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

3631

2784

else:

3632

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

3633

exc_info=e)

3634

raise

3635

2785

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

2786

exc_info=e)

2787

raise e

2788

3636

2789

# Delete all clients, and settings from config

3637

2790

while tcp_server.clients:

3638

2791

name, client = tcp_server.clients.popitem()

3639

2792

if use_dbus:

3640

2793

client.remove_from_connection()

3641

# Don't signal the disabling

2794

# Don't signal anything except ClientRemoved

3642

2795

client.disable(quiet=True)

3643

# Emit D-Bus signal for removal

3644

2796

if use_dbus:

3645

mandos_dbus_service.client_removed_signal(client)

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3646

2801

client_settings.clear()

3647

2802

3648

2803

atexit.register(cleanup)

3649

3650

for client in tcp_server.clients.values():

2804

2805

for client in tcp_server.clients.itervalues():

3651

2806

if use_dbus:

3652

# Emit D-Bus signal for adding

3653

mandos_dbus_service.client_added_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3654

2809

# Need to initiate checking of clients

3655

2810

if client.enabled:

3656

client.init_checker(randomize_start=True)

3657

2811

client.init_checker()

2812

3658

2813

tcp_server.enable()

3659

2814

tcp_server.server_activate()

3660

2815

3661

2816

# Find out what port we got

3662

if zeroconf:

3663

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

2817

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

3664

2818

if use_ipv6:

3665

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

3666

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

2819

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

2820

" flowinfo %d, scope_id %d",

2821

*tcp_server.socket.getsockname())

3667

2822

else: # IPv4

3668

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

3669

*tcp_server.socket.getsockname())

3670

3671

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

3672

2823

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

2824

*tcp_server.socket.getsockname())

2825

2826

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

2827

3673

2828

try:

3674

if zeroconf:

3675

# From the Avahi example code

3676

try:

3677

service.activate()

3678

except dbus.exceptions.DBusException as error:

3679

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

3680

cleanup()

3681

sys.exit(1)

3682

# End of Avahi example code

3683

3684

GLib.io_add_watch(

3685

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

3686

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3687

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

3688

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

3689

3690

log.debug("Starting main loop")

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

2843

logger.debug("Starting main loop")

3691

2844

main_loop.run()

3692

2845

except AvahiError as error:

3693

log.critical("Avahi Error", exc_info=error)

2846

logger.critical("Avahi Error", exc_info=error)

3694

2847

cleanup()

3695

2848

sys.exit(1)

3696

2849

except KeyboardInterrupt:

3697

2850

if debug:

3698

2851

print("", file=sys.stderr)

3699

log.debug("Server received KeyboardInterrupt")

3700

log.debug("Server exiting")

2852

logger.debug("Server received KeyboardInterrupt")

2853

logger.debug("Server exiting")

3701

2854

# Must run before the D-Bus bus name gets deregistered

3702

2855

cleanup()

3703

2856

3704

3705

def parse_test_args():

3706

# type: () -> argparse.Namespace

3707

parser = argparse.ArgumentParser(add_help=False)

3708

parser.add_argument("--check", action="store_true")

3709

parser.add_argument("--prefix", )

3710

args, unknown_args = parser.parse_known_args()

3711

if args.check:

3712

# Remove test options from sys.argv

3713

sys.argv[1:] = unknown_args

3714

return args

3715

3716

# Add all tests from doctest strings

3717

def load_tests(loader, tests, none):

3718

import doctest

3719

tests.addTests(doctest.DocTestSuite())

3720

return tests

3721

3722

if __name__ == "__main__":

3723

options = parse_test_args()

3724

try:

3725

if options.check:

3726

extra_test_prefix = options.prefix

3727

if extra_test_prefix is not None:

3728

if not (unittest.main(argv=[""], exit=False)

3729

.result.wasSuccessful()):

3730

sys.exit(1)

3731

class ExtraTestLoader(unittest.TestLoader):

3732

testMethodPrefix = extra_test_prefix

3733

# Call using ./scriptname --test [--verbose]

3734

unittest.main(argv=[""], testLoader=ExtraTestLoader())

3735

else:

3736

unittest.main(argv=[""])

3737

else:

3738

main()

3739

finally:

3740

logging.shutdown()

3741

3742

# Local Variables:

3743

# run-tests:

3744

# (lambda (&optional extra)

3745

# (if (not (funcall run-tests-in-test-buffer default-directory

3746

# extra))

3747

# (funcall show-test-buffer-in-test-window)

3748

# (funcall remove-test-window)

3749

# (if extra (message "Extra tests run successfully!"))))

3750

# run-tests-in-test-buffer:

3751

# (lambda (dir &optional extra)

3752

# (with-current-buffer (get-buffer-create "*Test*")

3753

# (setq buffer-read-only nil

3754

# default-directory dir)

3755

# (erase-buffer)

3756

# (compilation-mode))

3757

# (let ((process-result

3758

# (let ((inhibit-read-only t))

3759

# (process-file-shell-command

3760

# (funcall get-command-line extra) nil "*Test*"))))

3761

# (and (numberp process-result)

3762

# (= process-result 0))))

3763

# get-command-line:

3764

# (lambda (&optional extra)

3765

# (let ((quoted-script

3766

# (shell-quote-argument (funcall get-script-name))))

3767

# (format

3768

# (concat "%s --check" (if extra " --prefix=atest" ""))

3769

# quoted-script)))

3770

# get-script-name:

3771

# (lambda ()

3772

# (if (fboundp 'file-local-name)

3773

# (file-local-name (buffer-file-name))

3774

# (or (file-remote-p (buffer-file-name) 'localname)

3775

# (buffer-file-name))))

3776

# remove-test-window:

3777

# (lambda ()

3778

# (let ((test-window (get-buffer-window "*Test*")))

3779

# (if test-window (delete-window test-window))))

3780

# show-test-buffer-in-test-window:

3781

# (lambda ()

3782

# (when (not (get-buffer-window-list "*Test*"))

3783

# (setq next-error-last-buffer (get-buffer "*Test*"))

3784

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3785

# (display-buffer-overriding-action

3786

# `((display-buffer-in-side-window) (side . ,side)

3787

# (window-height . fit-window-to-buffer)

3788

# (window-width . fit-window-to-buffer))))

3789

# (display-buffer "*Test*"))))

3790

# eval:

3791

# (progn

3792

# (let* ((run-extra-tests (lambda () (interactive)

3793

# (funcall run-tests t)))

3794

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3795

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3796

# (setq minor-mode-overriding-map-alist

3797

# (cons `(run-tests . ,outer-keymap)

3798

# minor-mode-overriding-map-alist)))

3799

# (add-hook 'after-save-hook run-tests 90 t))

3800

# End:

2857

if __name__ == '__main__':

2858

main()