/mandos/release : revision 237.7.159

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

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:

82

import GnuPGInterface

83

84

try:

135

85

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

136

86

except AttributeError:

137

87

try:

138

# This is where SO_BINDTODEVICE was up to and including Python

139

# 2.6, and also 3.2:

140

88

from IN import SO_BINDTODEVICE

141

89

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"

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

160

93

stored_state_file = "clients.pickle"

161

94

162

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

163

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

164

syslogger = None

95

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

165

99

166

100

try:

167

if_nametoindex = ctypes.cdll.LoadLibrary(

168

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

169

104

except (OSError, AttributeError):

170

171

105

def if_nametoindex(interface):

172

106

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

173

107

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

174

108

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

175

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

176

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

177

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

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

178

114

return interface_index

179

115

180

116

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

117

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

198

118

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

119

204

120

syslogger.setFormatter(logging.Formatter

205

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

206

" %(message)s"))

207

log.addHandler(syslogger)

208

121

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

122

' %(message)s'))

123

logger.addHandler(syslogger)

124

209

125

if debug:

210

126

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)

127

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

128

' [%(process)d]:'

129

' %(levelname)s:'

130

' %(message)s'))

131

logger.addHandler(console)

132

logger.setLevel(level)

217

133

218

134

219

135

class PGPError(Exception):

221

137

pass

222

138

223

139

224

class PGPEngine:

140

class PGPEngine(object):

225

141

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

226

227

142

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

228

144

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

self.gnupg.options.extra_args.extend(['--force-mdc',

149

'--quiet',

150

'--no-use-agent'])

151

248

152

def __enter__(self):

249

153

return self

250

154

251

155

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

252

156

self._cleanup()

253

157

return False

254

158

255

159

def __del__(self):

256

160

self._cleanup()

257

161

258

162

def _cleanup(self):

259

163

if self.tempdir is not None:

260

164

# Delete contents of tempdir

261

165

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

262

topdown=False):

166

topdown = False):

263

167

for filename in files:

264

168

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

265

169

for dirname in dirs:

267

171

# Remove tempdir

268

172

os.rmdir(self.tempdir)

269

173

self.tempdir = None

270

174

271

175

def password_encode(self, password):

272

176

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

273

177

# 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

178

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

179

282

180

def encrypt(self, data, password):

283

passphrase = self.password_encode(password)

284

with tempfile.NamedTemporaryFile(

285

dir=self.tempdir) as passfile:

286

passfile.write(passphrase)

287

passfile.flush()

288

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

289

"--passphrase-file",

290

passfile.name]

291

+ self.gnupgargs,

292

stdin=subprocess.PIPE,

293

stdout=subprocess.PIPE,

294

stderr=subprocess.PIPE)

295

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

296

if proc.returncode != 0:

297

raise PGPError(err)

181

self.gnupg.passphrase = self.password_encode(password)

182

with open(os.devnull, "w") as devnull:

183

try:

184

proc = self.gnupg.run(['--symmetric'],

185

create_fhs=['stdin', 'stdout'],

186

attach_fhs={'stderr': devnull})

187

with contextlib.closing(proc.handles['stdin']) as f:

188

f.write(data)

189

with contextlib.closing(proc.handles['stdout']) as f:

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

298

195

return ciphertext

299

196

300

197

def decrypt(self, data, password):

301

passphrase = self.password_encode(password)

302

with tempfile.NamedTemporaryFile(

303

dir=self.tempdir) as passfile:

304

passfile.write(passphrase)

305

passfile.flush()

306

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

307

"--passphrase-file",

308

passfile.name]

309

+ self.gnupgargs,

310

stdin=subprocess.PIPE,

311

stdout=subprocess.PIPE,

312

stderr=subprocess.PIPE)

313

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

314

if proc.returncode != 0:

315

raise PGPError(err)

198

self.gnupg.passphrase = self.password_encode(password)

199

with open(os.devnull, "w") as devnull:

200

try:

201

proc = self.gnupg.run(['--decrypt'],

202

create_fhs=['stdin', 'stdout'],

203

attach_fhs={'stderr': devnull})

204

with contextlib.closing(proc.handles['stdin']) as f:

205

f.write(data)

206

with contextlib.closing(proc.handles['stdout']) as f:

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

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

368

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

235

236

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

237

See <http://www.dns-sd.org/ServiceTypes.html>

369

238

port: integer; what port to announce

370

239

TXT: list of strings; TXT record for the service

371

240

domain: string; Domain to publish on, default to .local if empty.

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

929

440

runtime_expansions: Allowed attributes for runtime expansion.

930

441

expires: datetime.datetime(); time (UTC) when a client will be

931

442

disabled, or None

932

server_settings: The server_settings dict from main()

933

443

"""

934

444

935

445

runtime_expansions = ("approval_delay", "approval_duration",

936

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

446

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

937

447

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

938

448

"last_approval_request", "last_checked_ok",

939

449

"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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

952

476

@staticmethod

953

477

def config_parser(config):

954

478

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

961

485

for client_name in config.sections():

962

486

section = dict(config.items(client_name))

963

487

client = settings[client_name] = {}

964

488

965

489

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

966

490

# Reformat values from string types to Python types

967

491

client["approved_by_default"] = config.getboolean(

968

492

client_name, "approved_by_default")

969

493

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

970

494

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

495

496

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

979

497

.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

498

if "secret" in section:

986

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

987

.encode("utf-8"),

988

"base64")

499

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

989

500

elif "secfile" in section:

990

501

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

991

502

(section["secfile"])),

992

503

"rb") as secfile:

993

504

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

994

505

else:

995

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

506

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

996

507

.format(section))

997

508

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

998

509

client["extended_timeout"] = string_to_delta(

1006

517

client["last_approval_request"] = None

1007

518

client["last_checked_ok"] = None

1008

519

client["last_checker_status"] = -2

1009

520

1010

521

return settings

1011

1012

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

522

523

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

1013

524

self.name = name

1014

if server_settings is None:

1015

server_settings = {}

1016

self.server_settings = server_settings

1017

525

# adding all client settings

1018

for setting, value in settings.items():

526

for setting, value in settings.iteritems():

1019

527

setattr(self, setting, value)

1020

528

1021

529

if self.enabled:

1022

530

if not hasattr(self, "last_enabled"):

1023

531

self.last_enabled = datetime.datetime.utcnow()

1027

535

else:

1028

536

self.last_enabled = None

1029

537

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)

538

539

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

543

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

1034

544

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

1035

545

datetime.datetime.utcnow())

1036

546

1037

547

# attributes specific for this server instance

1038

548

self.checker = None

1039

549

self.checker_initiator_tag = None

1042

552

self.current_checker_command = None

1043

553

self.approved = None

1044

554

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

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

1049

560

if not attr.startswith("_")]

1050

561

self.client_structure.append("client_structure")

1051

1052

for name, t in inspect.getmembers(

1053

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

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

1054

567

if not name.startswith("_"):

1055

568

self.client_structure.append(name)

1056

569

1057

570

# Send notice to process children that client state has changed

1058

571

def send_changedstate(self):

1059

572

with self.changedstate:

1060

573

self.changedstate.notify_all()

1061

574

1062

575

def enable(self):

1063

576

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

1064

577

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

1065

578

# Already enabled

1066

579

return

580

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

1067

581

self.enabled = True

1068

582

self.last_enabled = datetime.datetime.utcnow()

1069

583

self.init_checker()

1070

584

self.send_changedstate()

1071

585

1072

586

def disable(self, quiet=True):

1073

587

"""Disable this client."""

1074

588

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

1075

589

return False

1076

590

if not quiet:

1077

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

591

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

1078

592

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

1079

GLib.source_remove(self.disable_initiator_tag)

593

gobject.source_remove(self.disable_initiator_tag)

1080

594

self.disable_initiator_tag = None

1081

595

self.expires = None

1082

596

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

1083

GLib.source_remove(self.checker_initiator_tag)

597

gobject.source_remove(self.checker_initiator_tag)

1084

598

self.checker_initiator_tag = None

1085

599

self.stop_checker()

1086

600

self.enabled = False

1087

601

if not quiet:

1088

602

self.send_changedstate()

1089

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

603

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

1090

604

return False

1091

605

1092

606

def __del__(self):

1093

607

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.

608

609

def init_checker(self):

610

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

611

# and every interval from then on.

1100

612

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

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

617

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

1119

618

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

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

623

# Also start a new checker *right now*.

624

self.start_checker()

625

626

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

1127

627

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

628

self.checker_callback_tag = None

1134

629

self.checker = None

1135

1136

if returncode >= 0:

1137

self.last_checker_status = returncode

1138

self.last_checker_signal = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1139

632

if self.last_checker_status == 0:

1140

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

633

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

634

vars(self))

1141

635

self.checked_ok()

1142

636

else:

1143

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

637

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

638

vars(self))

1144

639

else:

1145

640

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

641

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

642

vars(self))

643

1150

644

def checked_ok(self):

1151

645

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

1152

646

self.last_checked_ok = datetime.datetime.utcnow()

1153

647

self.last_checker_status = 0

1154

self.last_checker_signal = None

1155

648

self.bump_timeout()

1156

649

1157

650

def bump_timeout(self, timeout=None):

1158

651

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

1159

652

if timeout is None:

1160

653

timeout = self.timeout

1161

654

if self.disable_initiator_tag is not None:

1162

GLib.source_remove(self.disable_initiator_tag)

655

gobject.source_remove(self.disable_initiator_tag)

1163

656

self.disable_initiator_tag = None

1164

657

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

1165

self.disable_initiator_tag = GLib.timeout_add(

1166

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1167

661

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

1168

662

1169

663

def need_approval(self):

1170

664

self.last_approval_request = datetime.datetime.utcnow()

1171

1172

def start_checker(self, start_was_randomized=False):

665

666

def start_checker(self):

1173

667

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

1174

668

1175

669

If a checker already exists, leave it running and do

1176

670

nothing."""

1177

671

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

1182

676

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

1183

677

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

1184

678

# 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

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1190

693

# Start a new checker if needed

1191

694

if self.checker is None:

1192

695

# Escape attributes for the shell

1193

escaped_attrs = {

1194

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

1195

for attr in self.runtime_expansions}

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1196

700

try:

1197

701

command = self.checker_command % escaped_attrs

1198

702

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

703

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1202

706

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

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

# This should never happen

732

logger.error("Child process vanished",

733

exc_info=error)

734

return True

735

raise

736

if pid:

737

gobject.source_remove(self.checker_callback_tag)

738

self.checker_callback(pid, status, command)

739

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

1240

740

return True

1241

741

1242

742

def stop_checker(self):

1243

743

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

1244

744

if self.checker_callback_tag:

1245

GLib.source_remove(self.checker_callback_tag)

745

gobject.source_remove(self.checker_callback_tag)

1246

746

self.checker_callback_tag = None

1247

747

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

1248

748

return

1249

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

1250

self.checker.terminate()

749

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

750

try:

751

self.checker.terminate()

752

#time.sleep(0.5)

753

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

754

# self.checker.kill()

755

except OSError as error:

756

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

757

raise

1251

758

self.checker = None

1252

759

1253

760

1254

def dbus_service_property(dbus_interface,

1255

signature="v",

1256

access="readwrite",

1257

byte_arrays=False):

761

def dbus_service_property(dbus_interface, signature="v",

762

access="readwrite", byte_arrays=False):

1258

763

"""Decorators for marking methods of a DBusObjectWithProperties to

1259

764

become properties on the D-Bus.

1260

765

1261

766

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

1262

767

and with one argument by "Set".

1263

768

1264

769

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

1265

770

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

1266

771

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

1269

774

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

1270

775

if byte_arrays and signature != "ay":

1271

776

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

1272

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

1273

777

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

1274

778

def decorator(func):

1275

779

func._dbus_is_property = True

1276

780

func._dbus_interface = dbus_interface

1279

783

func._dbus_name = func.__name__

1280

784

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

1281

785

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

1282

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

786

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1283

787

return func

1284

1285

788

return decorator

1286

789

1287

790

1288

791

def dbus_interface_annotations(dbus_interface):

1289

792

"""Decorator for marking functions returning interface annotations

1290

793

1291

794

Usage:

1292

795

1293

796

@dbus_interface_annotations("org.example.Interface")

1294

797

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

1295

798

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

1296

799

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

1297

800

"false"}

1298

801

"""

1299

1300

802

def decorator(func):

1301

803

func._dbus_is_interface = True

1302

804

func._dbus_interface = dbus_interface

1303

805

func._dbus_name = dbus_interface

1304

806

return func

1305

1306

807

return decorator

1307

808

1308

809

1309

810

def dbus_annotations(annotations):

1310

811

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

1311

812

Usage:

1312

1313

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

1314

"org.freedesktop.DBus.Property."

1315

"EmitsChangedSignal": "false"})

813

1316

814

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

1317

815

access="r")

816

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

817

"org.freedesktop.DBus.Property."

818

"EmitsChangedSignal": "false"})

1318

819

def Property_dbus_property(self):

1319

820

return dbus.Boolean(False)

1320

1321

See also the DBusObjectWithAnnotations class.

1322

821

"""

1323

1324

822

def decorator(func):

1325

823

func._dbus_annotations = annotations

1326

824

return func

1327

1328

825

return decorator

1329

826

1330

827

1331

828

class DBusPropertyException(dbus.exceptions.DBusException):

1332

829

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

1333

830

"""

1334

pass

831

def __unicode__(self):

832

return unicode(str(self))

1335

833

1336

834

1337

835

class DBusPropertyAccessException(DBusPropertyException):

1346

844

pass

1347

845

1348

846

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.

847

class DBusObjectWithProperties(dbus.service.Object):

848

"""A D-Bus object with properties.

849

850

Classes inheriting from this can use the dbus_service_property

851

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

852

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

1354

853

"""

1355

854

1356

855

@staticmethod

1357

856

def _is_dbus_thing(thing):

1358

857

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

1359

858

1360

859

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

1361

860

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

1362

861

"""

1363

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

862

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

1364

863

False)

1365

864

1366

865

def _get_all_dbus_things(self, thing):

1367

866

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

1368

867

"""

1369

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

868

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

869

name),

1370

870

athing.__get__(self))

1371

871

for cls in self.__class__.__mro__

1372

872

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

873

inspect.getmembers(cls,

874

self._is_dbus_thing(thing)))

875

1446

876

def _get_dbus_property(self, interface_name, property_name):

1447

877

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

1448

878

property with the specified name and interface.

1449

879

"""

1450

for cls in self.__class__.__mro__:

1451

for name, value in inspect.getmembers(

1452

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

880

for cls in self.__class__.__mro__:

881

for name, value in (inspect.getmembers

882

(cls,

883

self._is_dbus_thing("property"))):

1453

884

if (value._dbus_name == property_name

1454

885

and value._dbus_interface == interface_name):

1455

886

return value.__get__(self)

1456

887

1457

888

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

889

raise DBusPropertyNotFound(self.dbus_object_path + ":"

890

+ interface_name + "."

891

+ property_name)

892

893

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

1472

894

out_signature="v")

1473

895

def Get(self, interface_name, property_name):

1474

896

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

1480

902

if not hasattr(value, "variant_level"):

1481

903

return value

1482

904

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

1483

905

1484

906

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

1485

907

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

1486

908

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

1492

914

# The byte_arrays option is not supported yet on

1493

915

# signatures other than "ay".

1494

916

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

917

raise ValueError

918

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

919

for byte in value))

1499

920

prop(value)

1500

1501

@dbus.service.method(dbus.PROPERTIES_IFACE,

1502

in_signature="s",

921

922

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

1503

923

out_signature="a{sv}")

1504

924

def GetAll(self, interface_name):

1505

925

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

1506

926

standard.

1507

927

1508

928

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

1509

929

"""

1510

930

properties = {}

1520

940

if not hasattr(value, "variant_level"):

1521

941

properties[name] = value

1522

942

continue

1523

properties[name] = type(value)(

1524

value, variant_level=value.variant_level + 1)

943

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

944

value.variant_level+1)

1525

945

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

946

1535

947

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1536

948

out_signature="s",

1537

path_keyword="object_path",

1538

connection_keyword="connection")

949

path_keyword='object_path',

950

connection_keyword='connection')

1539

951

def Introspect(self, object_path, connection):

1540

952

"""Overloading of standard D-Bus method.

1541

953

1542

954

Inserts property tags and interface annotation tags.

1543

955

"""

1544

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1545

object_path,

1546

connection)

956

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

957

connection)

1547

958

try:

1548

959

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

1549

1550

960

def make_tag(document, name, prop):

1551

961

e = document.createElement("property")

1552

962

e.setAttribute("name", name)

1553

963

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

1554

964

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

1555

965

return e

1556

1557

966

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

1558

967

# Add property tags

1559

968

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

1562

971

if prop._dbus_interface

1563

972

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

1564

973

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)

974

# Add annotation tags

975

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

976

for tag in if_tag.getElementsByTagName(typ):

977

annots = dict()

978

for name, prop in (self.

979

_get_all_dbus_things(typ)):

980

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

981

and prop._dbus_interface

982

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

983

annots.update(getattr

984

(prop,

985

"_dbus_annotations",

986

{}))

987

for name, value in annots.iteritems():

988

ann_tag = document.createElement(

989

"annotation")

990

ann_tag.setAttribute("name", name)

991

ann_tag.setAttribute("value", value)

992

tag.appendChild(ann_tag)

993

# Add interface annotation tags

994

for annotation, value in dict(

995

itertools.chain.from_iterable(

996

annotations().iteritems()

997

for name, annotations in

998

self._get_all_dbus_things("interface")

999

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

1000

)).iteritems():

1001

ann_tag = document.createElement("annotation")

1002

ann_tag.setAttribute("name", annotation)

1003

ann_tag.setAttribute("value", value)

1004

if_tag.appendChild(ann_tag)

1581

1005

# Add the names to the return values for the

1582

1006

# "org.freedesktop.DBus.Properties" methods

1583

1007

if (if_tag.getAttribute("name")

1597

1021

document.unlink()

1598

1022

except (AttributeError, xml.dom.DOMException,

1599

1023

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)

1024

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

1025

exc_info=error)

1673

1026

return xmlstring

1674

1027

1675

1028

1676

1029

def datetime_to_dbus(dt, variant_level=0):

1677

1030

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

1678

1031

if dt is None:

1679

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

1680

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

1032

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

1033

return dbus.String(dt.isoformat(),

1034

variant_level=variant_level)

1681

1035

1682

1036

1683

1037

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1685

1039

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

1686

1040

interface names according to the "alt_interface_names" mapping.

1687

1041

Usage:

1688

1042

1689

1043

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

1690

1044

"net.example.AlternateInterface"})

1691

1045

class SampleDBusObject(dbus.service.Object):

1692

1046

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

1693

1047

def SampleDBusMethod():

1694

1048

pass

1695

1049

1696

1050

The above "SampleDBusMethod" on "SampleDBusObject" will be

1697

1051

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

1698

1052

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

1699

1053

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

1700

1054

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

1701

1055

1702

1056

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

1703

1057

(from DBusObjectWithProperties) and interfaces (from the

1704

1058

dbus_interface_annotations decorator).

1705

1059

"""

1706

1707

1060

def wrapper(cls):

1708

1061

for orig_interface_name, alt_interface_name in (

1709

alt_interface_names.items()):

1062

alt_interface_names.iteritems()):

1710

1063

attr = {}

1711

1064

interface_names = set()

1712

1065

# Go though all attributes of the class

1714

1067

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

1715

1068

# with the wrong interface name

1716

1069

if (not hasattr(attribute, "_dbus_interface")

1717

or not attribute._dbus_interface.startswith(

1718

orig_interface_name)):

1070

or not attribute._dbus_interface

1071

.startswith(orig_interface_name)):

1719

1072

continue

1720

1073

# Create an alternate D-Bus interface name based on

1721

1074

# the current name

1722

alt_interface = attribute._dbus_interface.replace(

1723

orig_interface_name, alt_interface_name)

1075

alt_interface = (attribute._dbus_interface

1076

.replace(orig_interface_name,

1077

alt_interface_name))

1724

1078

interface_names.add(alt_interface)

1725

1079

# Is this a D-Bus signal?

1726

1080

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

1727

# Extract the original non-method undecorated

1728

# function by black magic

1729

if sys.version_info.major == 2:

1730

nonmethod_func = (dict(

1081

# Extract the original non-method function by

1082

# black magic

1083

nonmethod_func = (dict(

1731

1084

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)

1085

attribute.__closure__))["func"]

1086

.cell_contents)

1739

1087

# Create a new, but exactly alike, function

1740

1088

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

1741

1089

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

1090

new_function = (dbus.service.signal

1091

(alt_interface,

1092

attribute._dbus_signature)

1093

(types.FunctionType(

1094

nonmethod_func.func_code,

1095

nonmethod_func.func_globals,

1096

nonmethod_func.func_name,

1097

nonmethod_func.func_defaults,

1098

nonmethod_func.func_closure)))

1746

1099

# Copy annotations, if any

1747

1100

try:

1748

new_function._dbus_annotations = dict(

1749

attribute._dbus_annotations)

1101

new_function._dbus_annotations = (

1102

dict(attribute._dbus_annotations))

1750

1103

except AttributeError:

1751

1104

pass

1752

1753

1105

# Define a creator of a function to call both the

1754

1106

# original and alternate functions, so both the

1755

1107

# original and alternate signals gets sent when

1758

1110

"""This function is a scope container to pass

1759

1111

func1 and func2 to the "call_both" function

1760

1112

outside of its arguments"""

1761

1762

@functools.wraps(func2)

1763

1113

def call_both(*args, **kwargs):

1764

1114

"""This function will emit two D-Bus

1765

1115

signals by calling func1 and func2"""

1766

1116

func1(*args, **kwargs)

1767

1117

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

1118

return call_both

1775

1119

# Create the "call_both" function and add it to

1776

1120

# the class

1781

1125

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

1782

1126

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

1783

1127

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

1128

attr[attrname] = (dbus.service.method

1129

(alt_interface,

1130

attribute._dbus_in_signature,

1131

attribute._dbus_out_signature)

1132

(types.FunctionType

1133

(attribute.func_code,

1134

attribute.func_globals,

1135

attribute.func_name,

1136

attribute.func_defaults,

1137

attribute.func_closure)))

1790

1138

# Copy annotations, if any

1791

1139

try:

1792

attr[attrname]._dbus_annotations = dict(

1793

attribute._dbus_annotations)

1140

attr[attrname]._dbus_annotations = (

1141

dict(attribute._dbus_annotations))

1794

1142

except AttributeError:

1795

1143

pass

1796

1144

# Is this a D-Bus property?

1799

1147

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

1800

1148

# property with the alternate D-Bus interface

1801

1149

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

1150

attr[attrname] = (dbus_service_property

1151

(alt_interface,

1152

attribute._dbus_signature,

1153

attribute._dbus_access,

1154

attribute

1155

._dbus_get_args_options

1156

["byte_arrays"])

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1808

1163

# Copy annotations, if any

1809

1164

try:

1810

attr[attrname]._dbus_annotations = dict(

1811

attribute._dbus_annotations)

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1812

1167

except AttributeError:

1813

1168

pass

1814

1169

# Is this a D-Bus interface?

1817

1172

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

1818

1173

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

1819

1174

# to the class.

1820

attr[attrname] = (

1821

dbus_interface_annotations(alt_interface)

1822

(copy_function(attribute)))

1175

attr[attrname] = (dbus_interface_annotations

1176

(alt_interface)

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1823

1183

if deprecate:

1824

1184

# Deprecate all alternate interfaces

1825

iname = "_AlternateDBusNames_interface_annotation{}"

1185

iname="_AlternateDBusNames_interface_annotation{0}"

1826

1186

for interface_name in interface_names:

1827

1828

1187

@dbus_interface_annotations(interface_name)

1829

1188

def func(self):

1830

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

1831

"true"}

1189

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

1190

"true" }

1832

1191

# Find an unused name

1833

1192

for aname in (iname.format(i)

1834

1193

for i in itertools.count()):

1838

1197

if interface_names:

1839

1198

# Replace the class with a new subclass of it with

1840

1199

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

1200

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

1201

(cls,), attr)

1847

1202

return cls

1848

1849

1203

return wrapper

1850

1204

1851

1205

1852

1206

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

1853

"se.bsnet.fukt.Mandos"})

1207

"se.bsnet.fukt.Mandos"})

1854

1208

class ClientDBus(Client, DBusObjectWithProperties):

1855

1209

"""A Client class using D-Bus

1856

1210

1857

1211

Attributes:

1858

1212

dbus_object_path: dbus.ObjectPath

1859

1213

bus: dbus.SystemBus()

1860

1214

"""

1861

1215

1862

1216

runtime_expansions = (Client.runtime_expansions

1863

+ ("dbus_object_path", ))

1864

1865

_interface = "se.recompile.Mandos.Client"

1866

1217

+ ("dbus_object_path",))

1218

1867

1219

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

1868

1869

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

1220

1221

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

1870

1222

self.bus = bus

1871

1223

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

1872

1224

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

1873

1225

# the D-Bus

1874

client_object_name = str(self.name).translate(

1226

client_object_name = unicode(self.name).translate(

1875

1227

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

1876

1228

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

1877

self.dbus_object_path = dbus.ObjectPath(

1878

"/clients/" + client_object_name)

1229

self.dbus_object_path = (dbus.ObjectPath

1230

("/clients/" + client_object_name))

1879

1231

DBusObjectWithProperties.__init__(self, self.bus,

1880

1232

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

1233

1234

def notifychangeproperty(transform_func,

1235

dbus_name, type_func=lambda x: x,

1236

variant_level=1):

1887

1237

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

1888

1238

its changes to DBus.

1889

1239

1890

1240

transform_fun: Function that takes a value and a variant_level

1891

1241

and transforms it to a D-Bus type.

1892

1242

dbus_name: D-Bus name of the variable

1894

1244

to the D-Bus. Default: no transform

1895

1245

variant_level: D-Bus variant level. Default: 1

1896

1246

"""

1897

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

1898

1247

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

1899

1248

def setter(self, value):

1900

1249

if hasattr(self, "dbus_object_path"):

1901

1250

if (not hasattr(self, attrname) or

1902

1251

type_func(getattr(self, attrname, None))

1903

1252

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

1253

dbus_value = transform_func(type_func(value),

1254

variant_level

1255

=variant_level)

1256

self.PropertyChanged(dbus.String(dbus_name),

1257

dbus_value)

1919

1258

setattr(self, attrname, value)

1920

1259

1921

1260

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

1922

1261

1923

1262

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1924

1263

approvals_pending = notifychangeproperty(dbus.Boolean,

1925

1264

"ApprovalPending",

1926

type_func=bool)

1265

type_func = bool)

1927

1266

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

1928

1267

last_enabled = notifychangeproperty(datetime_to_dbus,

1929

1268

"LastEnabled")

1930

checker = notifychangeproperty(

1931

dbus.Boolean, "CheckerRunning",

1932

type_func=lambda checker: checker is not None)

1269

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

1270

type_func = lambda checker:

1271

checker is not None)

1933

1272

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1934

1273

"LastCheckedOK")

1935

1274

last_checker_status = notifychangeproperty(dbus.Int16,

1938

1277

datetime_to_dbus, "LastApprovalRequest")

1939

1278

approved_by_default = notifychangeproperty(dbus.Boolean,

1940

1279

"ApprovedByDefault")

1941

approval_delay = notifychangeproperty(

1942

dbus.UInt64, "ApprovalDelay",

1943

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

1280

approval_delay = notifychangeproperty(dbus.UInt64,

1281

"ApprovalDelay",

1282

type_func =

1283

timedelta_to_milliseconds)

1944

1284

approval_duration = notifychangeproperty(

1945

1285

dbus.UInt64, "ApprovalDuration",

1946

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

1286

type_func = timedelta_to_milliseconds)

1947

1287

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

1948

timeout = notifychangeproperty(

1949

dbus.UInt64, "Timeout",

1950

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

1288

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

1289

type_func =

1290

timedelta_to_milliseconds)

1951

1291

extended_timeout = notifychangeproperty(

1952

1292

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)

1293

type_func = timedelta_to_milliseconds)

1294

interval = notifychangeproperty(dbus.UInt64,

1295

"Interval",

1296

type_func =

1297

timedelta_to_milliseconds)

1957

1298

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

1958

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

1959

invalidate_only=True)

1960

1299

1961

1300

del notifychangeproperty

1962

1301

1963

1302

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

1964

1303

try:

1965

1304

self.remove_from_connection()

1968

1307

if hasattr(DBusObjectWithProperties, "__del__"):

1969

1308

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

1970

1309

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:

1310

1311

def checker_callback(self, pid, condition, command,

1312

*args, **kwargs):

1313

self.checker_callback_tag = None

1314

self.checker = None

1315

if os.WIFEXITED(condition):

1316

exitstatus = os.WEXITSTATUS(condition)

1979

1317

# Emit D-Bus signal

1980

1318

self.CheckerCompleted(dbus.Int16(exitstatus),

1981

# This is specific to GNU libC

1982

dbus.Int64(exitstatus << 8),

1319

dbus.Int64(condition),

1983

1320

dbus.String(command))

1984

1321

else:

1985

1322

# Emit D-Bus signal

1986

1323

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

1987

dbus.Int64(

1988

# This is specific to GNU libC

1989

(exitstatus << 8)

1990

| self.last_checker_signal),

1324

dbus.Int64(condition),

1991

1325

dbus.String(command))

1992

return ret

1993

1326

1327

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

1328

*args, **kwargs)

1329

1994

1330

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

1995

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

1331

old_checker = self.checker

1332

if self.checker is not None:

1333

old_checker_pid = self.checker.pid

1334

else:

1335

old_checker_pid = None

1996

1336

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

1997

1337

# Only if new checker process was started

1998

1338

if (self.checker is not None

2000

1340

# Emit D-Bus signal

2001

1341

self.CheckerStarted(self.current_checker_command)

2002

1342

return r

2003

1343

2004

1344

def _reset_approved(self):

2005

1345

self.approved = None

2006

1346

return False

2007

1347

2008

1348

def approve(self, value=True):

2009

1349

self.approved = value

2010

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

2011

* 1000), self._reset_approved)

1350

gobject.timeout_add(timedelta_to_milliseconds

1351

(self.approval_duration),

1352

self._reset_approved)

2012

1353

self.send_changedstate()

2013

2014

# D-Bus methods, signals & properties

2015

2016

# Interfaces

2017

2018

# Signals

2019

1354

1355

## D-Bus methods, signals & properties

1356

_interface = "se.recompile.Mandos.Client"

1357

1358

## Interfaces

1359

1360

@dbus_interface_annotations(_interface)

1361

def _foo(self):

1362

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

1363

"false"}

1364

1365

## Signals

1366

2020

1367

# CheckerCompleted - signal

2021

1368

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

2022

1369

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

2023

1370

"D-Bus signal"

2024

1371

pass

2025

1372

2026

1373

# CheckerStarted - signal

2027

1374

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

2028

1375

def CheckerStarted(self, command):

2029

1376

"D-Bus signal"

2030

1377

pass

2031

1378

2032

1379

# PropertyChanged - signal

2033

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

2034

1380

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

2035

1381

def PropertyChanged(self, property, value):

2036

1382

"D-Bus signal"

2037

1383

pass

2038

1384

2039

1385

# GotSecret - signal

2040

1386

@dbus.service.signal(_interface)

2041

1387

def GotSecret(self):

2044

1390

server to mandos-client

2045

1391

"""

2046

1392

pass

2047

1393

2048

1394

# Rejected - signal

2049

1395

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

2050

1396

def Rejected(self, reason):

2051

1397

"D-Bus signal"

2052

1398

pass

2053

1399

2054

1400

# NeedApproval - signal

2055

1401

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

2056

1402

def NeedApproval(self, timeout, default):

2057

1403

"D-Bus signal"

2058

1404

return self.need_approval()

2059

2060

# Methods

2061

1405

1406

## Methods

1407

2062

1408

# Approve - method

2063

1409

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

2064

1410

def Approve(self, value):

2065

1411

self.approve(value)

2066

1412

2067

1413

# CheckedOK - method

2068

1414

@dbus.service.method(_interface)

2069

1415

def CheckedOK(self):

2070

1416

self.checked_ok()

2071

1417

2072

1418

# Enable - method

2073

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

2074

1419

@dbus.service.method(_interface)

2075

1420

def Enable(self):

2076

1421

"D-Bus method"

2077

1422

self.enable()

2078

1423

2079

1424

# StartChecker - method

2080

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

2081

1425

@dbus.service.method(_interface)

2082

1426

def StartChecker(self):

2083

1427

"D-Bus method"

2084

1428

self.start_checker()

2085

1429

2086

1430

# Disable - method

2087

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

2088

1431

@dbus.service.method(_interface)

2089

1432

def Disable(self):

2090

1433

"D-Bus method"

2091

1434

self.disable()

2092

1435

2093

1436

# StopChecker - method

2094

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

2095

1437

@dbus.service.method(_interface)

2096

1438

def StopChecker(self):

2097

1439

self.stop_checker()

2098

2099

# Properties

2100

1440

1441

## Properties

1442

2101

1443

# ApprovalPending - property

2102

1444

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

2103

1445

def ApprovalPending_dbus_property(self):

2104

1446

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

2105

1447

2106

1448

# ApprovedByDefault - property

2107

@dbus_service_property(_interface,

2108

signature="b",

1449

@dbus_service_property(_interface, signature="b",

2109

1450

access="readwrite")

2110

1451

def ApprovedByDefault_dbus_property(self, value=None):

2111

1452

if value is None: # get

2112

1453

return dbus.Boolean(self.approved_by_default)

2113

1454

self.approved_by_default = bool(value)

2114

1455

2115

1456

# ApprovalDelay - property

2116

@dbus_service_property(_interface,

2117

signature="t",

1457

@dbus_service_property(_interface, signature="t",

2118

1458

access="readwrite")

2119

1459

def ApprovalDelay_dbus_property(self, value=None):

2120

1460

if value is None: # get

2121

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

2122

* 1000)

1461

return dbus.UInt64(self.approval_delay_milliseconds())

2123

1462

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

2124

1463

2125

1464

# ApprovalDuration - property

2126

@dbus_service_property(_interface,

2127

signature="t",

1465

@dbus_service_property(_interface, signature="t",

2128

1466

access="readwrite")

2129

1467

def ApprovalDuration_dbus_property(self, value=None):

2130

1468

if value is None: # get

2131

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

2132

* 1000)

1469

return dbus.UInt64(timedelta_to_milliseconds(

1470

self.approval_duration))

2133

1471

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

2134

1472

2135

1473

# Name - property

2136

@dbus_annotations(

2137

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

2138

1474

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

2139

1475

def Name_dbus_property(self):

2140

1476

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

1477

2149

1478

# Fingerprint - property

2150

@dbus_annotations(

2151

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

2152

1479

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

2153

1480

def Fingerprint_dbus_property(self):

2154

1481

return dbus.String(self.fingerprint)

2155

1482

2156

1483

# Host - property

2157

@dbus_service_property(_interface,

2158

signature="s",

1484

@dbus_service_property(_interface, signature="s",

2159

1485

access="readwrite")

2160

1486

def Host_dbus_property(self, value=None):

2161

1487

if value is None: # get

2162

1488

return dbus.String(self.host)

2163

self.host = str(value)

2164

1489

self.host = unicode(value)

1490

2165

1491

# Created - property

2166

@dbus_annotations(

2167

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

2168

1492

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

2169

1493

def Created_dbus_property(self):

2170

1494

return datetime_to_dbus(self.created)

2171

1495

2172

1496

# LastEnabled - property

2173

1497

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

2174

1498

def LastEnabled_dbus_property(self):

2175

1499

return datetime_to_dbus(self.last_enabled)

2176

1500

2177

1501

# Enabled - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1502

@dbus_service_property(_interface, signature="b",

2180

1503

access="readwrite")

2181

1504

def Enabled_dbus_property(self, value=None):

2182

1505

if value is None: # get

2185

1508

self.enable()

2186

1509

else:

2187

1510

self.disable()

2188

1511

2189

1512

# LastCheckedOK - property

2190

@dbus_service_property(_interface,

2191

signature="s",

1513

@dbus_service_property(_interface, signature="s",

2192

1514

access="readwrite")

2193

1515

def LastCheckedOK_dbus_property(self, value=None):

2194

1516

if value is not None:

2195

1517

self.checked_ok()

2196

1518

return

2197

1519

return datetime_to_dbus(self.last_checked_ok)

2198

1520

2199

1521

# LastCheckerStatus - property

2200

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

1522

@dbus_service_property(_interface, signature="n",

1523

access="read")

2201

1524

def LastCheckerStatus_dbus_property(self):

2202

1525

return dbus.Int16(self.last_checker_status)

2203

1526

2204

1527

# Expires - property

2205

1528

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

2206

1529

def Expires_dbus_property(self):

2207

1530

return datetime_to_dbus(self.expires)

2208

1531

2209

1532

# LastApprovalRequest - property

2210

1533

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

2211

1534

def LastApprovalRequest_dbus_property(self):

2212

1535

return datetime_to_dbus(self.last_approval_request)

2213

1536

2214

1537

# Timeout - property

2215

@dbus_service_property(_interface,

2216

signature="t",

1538

@dbus_service_property(_interface, signature="t",

2217

1539

access="readwrite")

2218

1540

def Timeout_dbus_property(self, value=None):

2219

1541

if value is None: # get

2220

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

1542

return dbus.UInt64(self.timeout_milliseconds())

2221

1543

old_timeout = self.timeout

2222

1544

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

2223

1545

# Reschedule disabling

2231

1553

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

2232

1554

is None):

2233

1555

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

1556

gobject.source_remove(self.disable_initiator_tag)

1557

self.disable_initiator_tag = (

1558

gobject.timeout_add(

1559

timedelta_to_milliseconds(self.expires - now),

1560

self.disable))

1561

2239

1562

# ExtendedTimeout - property

2240

@dbus_service_property(_interface,

2241

signature="t",

1563

@dbus_service_property(_interface, signature="t",

2242

1564

access="readwrite")

2243

1565

def ExtendedTimeout_dbus_property(self, value=None):

2244

1566

if value is None: # get

2245

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

2246

* 1000)

1567

return dbus.UInt64(self.extended_timeout_milliseconds())

2247

1568

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

2248

1569

2249

1570

# Interval - property

2250

@dbus_service_property(_interface,

2251

signature="t",

1571

@dbus_service_property(_interface, signature="t",

2252

1572

access="readwrite")

2253

1573

def Interval_dbus_property(self, value=None):

2254

1574

if value is None: # get

2255

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

1575

return dbus.UInt64(self.interval_milliseconds())

2256

1576

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

2257

1577

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

2258

1578

return

2259

1579

if self.enabled:

2260

1580

# 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

1581

gobject.source_remove(self.checker_initiator_tag)

1582

self.checker_initiator_tag = (gobject.timeout_add

1583

(value, self.start_checker))

1584

self.start_checker() # Start one now, too

1585

2266

1586

# Checker - property

2267

@dbus_service_property(_interface,

2268

signature="s",

1587

@dbus_service_property(_interface, signature="s",

2269

1588

access="readwrite")

2270

1589

def Checker_dbus_property(self, value=None):

2271

1590

if value is None: # get

2272

1591

return dbus.String(self.checker_command)

2273

self.checker_command = str(value)

2274

1592

self.checker_command = unicode(value)

1593

2275

1594

# CheckerRunning - property

2276

@dbus_service_property(_interface,

2277

signature="b",

1595

@dbus_service_property(_interface, signature="b",

2278

1596

access="readwrite")

2279

1597

def CheckerRunning_dbus_property(self, value=None):

2280

1598

if value is None: # get

2283

1601

self.start_checker()

2284

1602

else:

2285

1603

self.stop_checker()

2286

1604

2287

1605

# ObjectPath - property

2288

@dbus_annotations(

2289

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

2290

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

2291

1606

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

2292

1607

def ObjectPath_dbus_property(self):

2293

return self.dbus_object_path # is already a dbus.ObjectPath

2294

1608

return self.dbus_object_path # is already a dbus.ObjectPath

1609

2295

1610

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

1611

@dbus_service_property(_interface, signature="ay",

1612

access="write", byte_arrays=True)

2303

1613

def Secret_dbus_property(self, value):

2304

self.secret = bytes(value)

2305

1614

self.secret = str(value)

1615

2306

1616

del _interface

2307

1617

2308

1618

2309

class ProxyClient:

2310

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

1619

class ProxyClient(object):

1620

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

2311

1621

self._pipe = child_pipe

2312

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

1622

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

2313

1623

if not self._pipe.recv():

2314

raise KeyError(key_id or fpr)

2315

1624

raise KeyError()

1625

2316

1626

def __getattribute__(self, name):

2317

if name == "_pipe":

1627

if name == '_pipe':

2318

1628

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

2319

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

1629

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

2320

1630

data = self._pipe.recv()

2321

if data[0] == "data":

1631

if data[0] == 'data':

2322

1632

return data[1]

2323

if data[0] == "function":

2324

1633

if data[0] == 'function':

2325

1634

def func(*args, **kwargs):

2326

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

1635

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

2327

1636

return self._pipe.recv()[1]

2328

2329

1637

return func

2330

1638

2331

1639

def __setattr__(self, name, value):

2332

if name == "_pipe":

1640

if name == '_pipe':

2333

1641

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

2334

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

1642

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

2335

1643

2336

1644

2337

1645

class ClientHandler(socketserver.BaseRequestHandler, object):

2338

1646

"""A class to handle client connections.

2339

1647

2340

1648

Instantiated once for each connection to handle it.

2341

1649

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

2342

1650

2343

1651

def handle(self):

2344

1652

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

1653

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

1654

unicode(self.client_address))

1655

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

1656

self.server.child_pipe.fileno())

1657

1658

session = (gnutls.connection

1659

.ClientSession(self.request,

1660

gnutls.connection

1661

.X509Credentials()))

1662

1663

# Note: gnutls.connection.X509Credentials is really a

1664

# generic GnuTLS certificate credentials object so long as

1665

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

1666

# here despite using OpenPGP certificates.

1667

1668

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

1669

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

1670

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

1671

# "+DHE-DSS"))

2355

1672

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

2356

1673

priority = self.server.gnutls_priority

2357

1674

if priority is None:

2358

1675

priority = "NORMAL"

2359

gnutls.priority_set_direct(session,

2360

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

2361

1676

(gnutls.library.functions

1677

.gnutls_priority_set_direct(session._c_object,

1678

priority, None))

1679

2362

1680

# Start communication using the Mandos protocol

2363

1681

# Get protocol number

2364

1682

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

2365

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

1683

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

2366

1684

try:

2367

1685

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

2368

raise RuntimeError(line)

1686

raise RuntimeError

2369

1687

except (ValueError, IndexError, RuntimeError) as error:

2370

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

1688

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

2371

1689

return

2372

1690

2373

1691

# Start GnuTLS connection

2374

1692

try:

2375

1693

session.handshake()

2376

except gnutls.Error as error:

2377

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

1694

except gnutls.errors.GNUTLSError as error:

1695

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

2378

1696

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

2379

1697

# established. Just abandon the request.

2380

1698

return

2381

log.debug("Handshake succeeded")

2382

1699

logger.debug("Handshake succeeded")

1700

2383

1701

approval_required = False

2384

1702

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,

1703

try:

1704

fpr = self.fingerprint(self.peer_certificate

1705

(session))

1706

except (TypeError,

1707

gnutls.errors.GNUTLSError) as error:

1708

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

1709

return

1710

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

1711

1712

try:

1713

client = ProxyClient(child_pipe, fpr,

2409

1714

self.client_address)

2410

1715

except KeyError:

2411

1716

return

2412

1717

2413

1718

if client.approval_delay:

2414

1719

delay = client.approval_delay

2415

1720

client.approvals_pending += 1

2416

1721

approval_required = True

2417

1722

2418

1723

while True:

2419

1724

if not client.enabled:

2420

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

1725

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

1726

client.name)

2421

1727

if self.server.use_dbus:

2422

1728

# Emit D-Bus signal

2423

1729

client.Rejected("Disabled")

2424

1730

return

2425

1731

2426

1732

if client.approved or not client.approval_delay:

2427

# We are approved or approval is disabled

1733

#We are approved or approval is disabled

2428

1734

break

2429

1735

elif client.approved is None:

2430

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

2431

client.name)

1736

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

1737

client.name)

2432

1738

if self.server.use_dbus:

2433

1739

# Emit D-Bus signal

2434

1740

client.NeedApproval(

2435

client.approval_delay.total_seconds()

2436

* 1000, client.approved_by_default)

1741

client.approval_delay_milliseconds(),

1742

client.approved_by_default)

2437

1743

else:

2438

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

2439

client.name)

1744

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

1745

client.name)

2440

1746

if self.server.use_dbus:

2441

1747

# Emit D-Bus signal

2442

1748

client.Rejected("Denied")

2443

1749

return

2444

2445

# wait until timeout or approved

1750

1751

#wait until timeout or approved

2446

1752

time = datetime.datetime.now()

2447

1753

client.changedstate.acquire()

2448

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

1754

client.changedstate.wait(

1755

float(timedelta_to_milliseconds(delay)

1756

/ 1000))

2449

1757

client.changedstate.release()

2450

1758

time2 = datetime.datetime.now()

2451

1759

if (time2 - time) >= delay:

2452

1760

if not client.approved_by_default:

2453

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

2454

" waiting for approval",

2455

client.name)

1761

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

1762

" waiting for approval",

1763

client.name)

2456

1764

if self.server.use_dbus:

2457

1765

# Emit D-Bus signal

2458

1766

client.Rejected("Approval timed out")

2461

1769

break

2462

1770

else:

2463

1771

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)

1772

1773

sent_size = 0

1774

while sent_size < len(client.secret):

1775

try:

1776

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

1777

except gnutls.errors.GNUTLSError as error:

1778

logger.warning("gnutls send failed",

1779

exc_info=error)

1780

return

1781

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

1782

sent, len(client.secret)

1783

- (sent_size + sent))

1784

sent_size += sent

1785

1786

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

2472

1787

# bump the timeout using extended_timeout

2473

1788

client.bump_timeout(client.extended_timeout)

2474

1789

if self.server.use_dbus:

2475

1790

# Emit D-Bus signal

2476

1791

client.GotSecret()

2477

1792

2478

1793

finally:

2479

1794

if approval_required:

2480

1795

client.approvals_pending -= 1

2481

1796

try:

2482

1797

session.bye()

2483

except gnutls.Error as error:

2484

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

2485

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("GnuTLS bye failed",

1800

exc_info=error)

1801

2486

1802

@staticmethod

2487

1803

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

1804

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

1805

# If not an OpenPGP certificate...

1806

if (gnutls.library.functions

1807

.gnutls_certificate_type_get(session._c_object)

1808

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1809

# ...do the normal thing

1810

return session.peer_certificate

2504

1811

list_size = ctypes.c_uint(1)

2505

cert_list = (gnutls.certificate_get_peers

2506

(session, ctypes.byref(list_size)))

1812

cert_list = (gnutls.library.functions

1813

.gnutls_certificate_get_peers

1814

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

2507

1815

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

2508

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

1816

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

1817

" certificate")

2509

1818

if list_size.value == 0:

2510

1819

return None

2511

1820

cert = cert_list[0]

2512

1821

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

1822

2549

1823

@staticmethod

2550

1824

def fingerprint(openpgp):

2551

1825

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2552

1826

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

1827

datum = (gnutls.library.types

1828

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

1829

ctypes.POINTER

1830

(ctypes.c_ubyte)),

1831

ctypes.c_uint(len(openpgp))))

2557

1832

# New empty GnuTLS certificate

2558

crt = gnutls.openpgp_crt_t()

2559

gnutls.openpgp_crt_init(ctypes.byref(crt))

1833

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2560

1836

# Import the OpenPGP public key into the certificate

2561

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

2562

gnutls.OPENPGP_FMT_RAW)

1837

(gnutls.library.functions

1838

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

1839

gnutls.library.constants

1840

.GNUTLS_OPENPGP_FMT_RAW))

2563

1841

# Verify the self signature in the key

2564

1842

crtverify = ctypes.c_uint()

2565

gnutls.openpgp_crt_verify_self(crt, 0,

2566

ctypes.byref(crtverify))

1843

(gnutls.library.functions

1844

.gnutls_openpgp_crt_verify_self(crt, 0,

1845

ctypes.byref(crtverify)))

2567

1846

if crtverify.value != 0:

2568

gnutls.openpgp_crt_deinit(crt)

2569

raise gnutls.CertificateSecurityError(code

2570

=crtverify.value)

1847

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1848

raise (gnutls.errors.CertificateSecurityError

1849

("Verify failed"))

2571

1850

# New buffer for the fingerprint

2572

1851

buf = ctypes.create_string_buffer(20)

2573

1852

buf_len = ctypes.c_size_t()

2574

1853

# Get the fingerprint from the certificate into the buffer

2575

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

2576

ctypes.byref(buf_len))

1854

(gnutls.library.functions

1855

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

1856

ctypes.byref(buf_len)))

2577

1857

# Deinit the certificate

2578

gnutls.openpgp_crt_deinit(crt)

1858

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2579

1859

# Convert the buffer to a Python bytestring

2580

1860

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

2581

1861

# Convert the bytestring to hexadecimal notation

2583

1863

return hex_fpr

2584

1864

2585

1865

2586

class MultiprocessingMixIn:

1866

class MultiprocessingMixIn(object):

2587

1867

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

2588

2589

1868

def sub_process_main(self, request, address):

2590

1869

try:

2591

1870

self.finish_request(request, address)

2592

1871

except Exception:

2593

1872

self.handle_error(request, address)

2594

1873

self.close_request(request)

2595

1874

2596

1875

def process_request(self, request, address):

2597

1876

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

2598

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

2599

args=(request, address))

1877

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

1878

args = (request, address))

2600

1879

proc.start()

2601

1880

return proc

2602

1881

2603

1882

2604

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1883

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2605

1884

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

2606

2607

1885

def process_request(self, request, client_address):

2608

1886

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

2609

1887

2610

1888

This function creates a new pipe in self.pipe

2611

1889

"""

2612

1890

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2613

1891

2614

1892

proc = MultiprocessingMixIn.process_request(self, request,

2615

1893

client_address)

2616

1894

self.child_pipe.close()

2617

1895

self.add_pipe(parent_pipe, proc)

2618

1896

2619

1897

def add_pipe(self, parent_pipe, proc):

2620

1898

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

2621

raise NotImplementedError()

1899

raise NotImplementedError

2622

1900

2623

1901

2624

1902

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2625

socketserver.TCPServer):

2626

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

2627

1903

socketserver.TCPServer, object):

1904

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

1905

2628

1906

Attributes:

2629

1907

enabled: Boolean; whether this server is activated yet

2630

1908

interface: None or a network interface name (string)

2631

1909

use_ipv6: Boolean; to use IPv6 or not

2632

1910

"""

2633

2634

1911

def __init__(self, server_address, RequestHandlerClass,

2635

interface=None,

2636

use_ipv6=True,

2637

socketfd=None):

1912

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

2638

1913

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

2639

1914

creating a new one with socket.socket().

2640

1915

"""

2646

1921

self.socketfd = socketfd

2647

1922

# Save the original socket.socket() function

2648

1923

self.socket_socket = socket.socket

2649

2650

1924

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

2651

#

1925

#

2652

1926

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

2653

1927

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

2654

1928

# patching socket.socket.)

2655

#

1929

#

2656

1930

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

2657

1931

@functools.wraps(socket.socket)

2658

1932

def socket_wrapper(*args, **kwargs):

2670

1944

# socket_wrapper(), if socketfd was set.

2671

1945

socketserver.TCPServer.__init__(self, server_address,

2672

1946

RequestHandlerClass)

2673

1947

2674

1948

def server_bind(self):

2675

1949

"""This overrides the normal server_bind() function

2676

1950

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

2677

1951

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

2678

global SO_BINDTODEVICE

2679

1952

if self.interface is not None:

2680

1953

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

1954

logger.error("SO_BINDTODEVICE does not exist;"

1955

" cannot bind to interface %s",

1956

self.interface)

1957

else:

1958

try:

1959

self.socket.setsockopt(socket.SOL_SOCKET,

1960

SO_BINDTODEVICE,

1961

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

1962

except socket.error as error:

1963

if error.errno == errno.EPERM:

1964

logger.error("No permission to bind to"

1965

" interface %s", self.interface)

1966

elif error.errno == errno.ENOPROTOOPT:

1967

logger.error("SO_BINDTODEVICE not available;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

elif error.errno == errno.ENODEV:

1971

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

1972

" cannot bind", self.interface)

1973

else:

1974

raise

2701

1975

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

2702

1976

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

2703

if self.server_address[1]:

2704

self.allow_reuse_address = True

2705

1977

if not self.server_address[0]:

2706

1978

if self.address_family == socket.AF_INET6:

2707

any_address = "::" # in6addr_any

1979

any_address = "::" # in6addr_any

2708

1980

else:

2709

any_address = "0.0.0.0" # INADDR_ANY

1981

any_address = socket.INADDR_ANY

2710

1982

self.server_address = (any_address,

2711

1983

self.server_address[1])

2712

1984

elif not self.server_address[1]:

2713

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

1985

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

1986

0)

2714

1987

# if self.interface:

2715

1988

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

2716

1989

# 0, # port

2722

1995

2723

1996

class MandosServer(IPv6_TCPServer):

2724

1997

"""Mandos server.

2725

1998

2726

1999

Attributes:

2727

2000

clients: set of Client objects

2728

2001

gnutls_priority GnuTLS priority string

2729

2002

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

2730

2731

Assumes a GLib.MainLoop event loop.

2003

2004

Assumes a gobject.MainLoop event loop.

2732

2005

"""

2733

2734

2006

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

2007

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

2008

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

2741

2009

self.enabled = False

2742

2010

self.clients = clients

2743

2011

if self.clients is None:

2746

2014

self.gnutls_priority = gnutls_priority

2747

2015

IPv6_TCPServer.__init__(self, server_address,

2748

2016

RequestHandlerClass,

2749

interface=interface,

2750

use_ipv6=use_ipv6,

2751

socketfd=socketfd)

2752

2017

interface = interface,

2018

use_ipv6 = use_ipv6,

2019

socketfd = socketfd)

2753

2020

def server_activate(self):

2754

2021

if self.enabled:

2755

2022

return socketserver.TCPServer.server_activate(self)

2756

2023

2757

2024

def enable(self):

2758

2025

self.enabled = True

2759

2026

2760

2027

def add_pipe(self, parent_pipe, proc):

2761

2028

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

2029

gobject.io_add_watch(parent_pipe.fileno(),

2030

gobject.IO_IN | gobject.IO_HUP,

2031

functools.partial(self.handle_ipc,

2032

parent_pipe =

2033

parent_pipe,

2034

proc = proc))

2035

2036

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

2037

proc = None, client_object=None):

2773

2038

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

2774

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

2039

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

2775

2040

# Wait for other process to exit

2776

2041

proc.join()

2777

2042

return False

2778

2043

2779

2044

# Read a request from the child

2780

2045

request = parent_pipe.recv()

2781

2046

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:

2047

2048

if command == 'init':

2049

fpr = request[1]

2050

address = request[2]

2051

2052

for c in self.clients.itervalues():

2053

if c.fingerprint == fpr:

2796

2054

client = c

2797

2055

break

2798

2056

else:

2799

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

2800

" %s", key_id or fpr, address)

2057

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

2058

"dress: %s", fpr, address)

2801

2059

if self.use_dbus:

2802

2060

# Emit D-Bus signal

2803

mandos_dbus_service.ClientNotFound(key_id or fpr,

2061

mandos_dbus_service.ClientNotFound(fpr,

2804

2062

address[0])

2805

2063

parent_pipe.send(False)

2806

2064

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

2065

2066

gobject.io_add_watch(parent_pipe.fileno(),

2067

gobject.IO_IN | gobject.IO_HUP,

2068

functools.partial(self.handle_ipc,

2069

parent_pipe =

2070

parent_pipe,

2071

proc = proc,

2072

client_object =

2073

client))

2815

2074

parent_pipe.send(True)

2816

2075

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

2817

2076

# same fileno

2818

2077

return False

2819

if command == "funcall":

2078

if command == 'funcall':

2820

2079

funcname = request[1]

2821

2080

args = request[2]

2822

2081

kwargs = request[3]

2823

2824

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

2082

2083

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

2825

2084

funcname)(*args,

2826

**kwargs)))

2827

2828

if command == "getattr":

2085

**kwargs)))

2086

2087

if command == 'getattr':

2829

2088

attrname = request[1]

2830

if isinstance(client_object.__getattribute__(attrname),

2831

collections.abc.Callable):

2832

parent_pipe.send(("function", ))

2089

if callable(client_object.__getattribute__(attrname)):

2090

parent_pipe.send(('function',))

2833

2091

else:

2834

parent_pipe.send((

2835

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

2836

2837

if command == "setattr":

2092

parent_pipe.send(('data', client_object

2093

.__getattribute__(attrname)))

2094

2095

if command == 'setattr':

2838

2096

attrname = request[1]

2839

2097

value = request[2]

2840

2098

setattr(client_object, attrname, value)

2841

2099

2842

2100

return True

2843

2101

2844

2102

2845

2103

def rfc3339_duration_to_delta(duration):

2846

2104

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

2105

2106

>>> rfc3339_duration_to_delta("P7D")

2107

datetime.timedelta(7)

2108

>>> rfc3339_duration_to_delta("PT60S")

2109

datetime.timedelta(0, 60)

2110

>>> rfc3339_duration_to_delta("PT60M")

2111

datetime.timedelta(0, 3600)

2112

>>> rfc3339_duration_to_delta("PT24H")

2113

datetime.timedelta(1)

2114

>>> rfc3339_duration_to_delta("P1W")

2115

datetime.timedelta(7)

2116

>>> rfc3339_duration_to_delta("PT5M30S")

2117

datetime.timedelta(0, 330)

2118

>>> rfc3339_duration_to_delta("P1DT3M20S")

2119

datetime.timedelta(1, 200)

2864

2120

"""

2865

2121

2866

2122

# Parsing an RFC 3339 duration with regular expressions is not

2867

2123

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

2868

2124

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

2869

2125

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

2870

2126

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

2871

2127

# avoid excessive use of external libraries.

2872

2128

2873

2129

# 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

2130

Token = collections.namedtuple("Token",

2131

("regexp", # To match token; if

2132

# "value" is not None,

2133

# must have a "group"

2134

# containing digits

2135

"value", # datetime.timedelta or

2136

# None

2137

"followers")) # Tokens valid after

2138

# this token

2879

2139

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

2880

2140

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

2881

2141

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

2882

2142

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

2883

2143

datetime.timedelta(seconds=1),

2884

frozenset((token_end, )))

2144

frozenset((token_end,)))

2885

2145

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

2886

2146

datetime.timedelta(minutes=1),

2887

2147

frozenset((token_second, token_end)))

2903

2163

frozenset((token_month, token_end)))

2904

2164

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

2905

2165

datetime.timedelta(weeks=1),

2906

frozenset((token_end, )))

2166

frozenset((token_end,)))

2907

2167

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

2908

2168

frozenset((token_year, token_month,

2909

2169

token_day, token_time,

2910

token_week)))

2911

# Define starting values:

2912

# Value so far

2913

value = datetime.timedelta()

2170

token_week))),

2171

# Define starting values

2172

value = datetime.timedelta() # Value so far

2914

2173

found_token = None

2915

# Following valid tokens

2916

followers = frozenset((token_duration, ))

2917

# String left to parse

2918

s = duration

2174

followers = frozenset(token_duration,) # Following valid tokens

2175

s = duration # String left to parse

2919

2176

# Loop until end token is found

2920

2177

while found_token is not token_end:

2921

2178

# Search for any currently valid tokens

2937

2194

break

2938

2195

else:

2939

2196

# No currently valid tokens were found

2940

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

2941

.format(duration))

2197

raise ValueError("Invalid RFC 3339 duration")

2942

2198

# End token found

2943

2199

return value

2944

2200

2945

2201

2946

2202

def string_to_delta(interval):

2947

2203

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

2204

2205

>>> string_to_delta('7d')

2206

datetime.timedelta(7)

2207

>>> string_to_delta('60s')

2208

datetime.timedelta(0, 60)

2209

>>> string_to_delta('60m')

2210

datetime.timedelta(0, 3600)

2211

>>> string_to_delta('24h')

2212

datetime.timedelta(1)

2213

>>> string_to_delta('1w')

2214

datetime.timedelta(7)

2215

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

2216

datetime.timedelta(0, 330)

2961

2217

"""

2962

2218

2963

2219

try:

2964

2220

return rfc3339_duration_to_delta(interval)

2965

2221

except ValueError:

2966

2222

pass

2967

2223

2968

2224

timevalue = datetime.timedelta(0)

2969

2225

for s in interval.split():

2970

2226

try:

2971

suffix = s[-1]

2227

suffix = unicode(s[-1])

2972

2228

value = int(s[:-1])

2973

2229

if suffix == "d":

2974

2230

delta = datetime.timedelta(value)

2981

2237

elif suffix == "w":

2982

2238

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

2983

2239

else:

2984

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

2985

except IndexError as e:

2240

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

2241

.format(suffix))

2242

except (ValueError, IndexError) as e:

2986

2243

raise ValueError(*(e.args))

2987

2244

timevalue += delta

2988

2245

return timevalue

2989

2246

2990

2247

2991

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

2248

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

2992

2249

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

2993

2250

2994

2251

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

2995

2252

if os.fork():

2996

2253

sys.exit()

3004

2261

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

3005

2262

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

3006

2263

raise OSError(errno.ENODEV,

3007

"{} not a character device"

2264

"{0} not a character device"

3008

2265

.format(os.devnull))

3009

2266

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

3010

2267

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

3014

2271

3015

2272

3016

2273

def main():

3017

2274

3018

2275

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

3019

2276

# Parsing of options, both command line and config file

3020

2277

3021

2278

parser = argparse.ArgumentParser()

3022

2279

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

3023

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

2280

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

3024

2281

help="show version number and exit")

3025

2282

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

3026

2283

help="Bind to interface IF")

3032

2289

help="Run self-test")

3033

2290

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

3034

2291

help="Debug mode; run in foreground and log"

3035

" to terminal", default=None)

2292

" to terminal")

3036

2293

parser.add_argument("--debuglevel", metavar="LEVEL",

3037

2294

help="Debug level for stdout output")

3038

2295

parser.add_argument("--priority", help="GnuTLS"

3045

2302

" files")

3046

2303

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

3047

2304

dest="use_dbus", help="Do not provide D-Bus"

3048

" system bus interface", default=None)

2305

" system bus interface")

3049

2306

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

3050

dest="use_ipv6", help="Do not use IPv6",

3051

default=None)

2307

dest="use_ipv6", help="Do not use IPv6")

3052

2308

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

3053

2309

dest="restore", help="Do not restore stored"

3054

" state", default=None)

2310

" state")

3055

2311

parser.add_argument("--socket", type=int,

3056

2312

help="Specify a file descriptor to a network"

3057

2313

" socket to use instead of creating one")

3058

2314

parser.add_argument("--statedir", metavar="DIR",

3059

2315

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

3060

2316

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

3061

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

2317

help="Run in foreground")

2318

3066

2319

options = parser.parse_args()

3067

2320

2321

if options.check:

2322

import doctest

2323

doctest.testmod()

2324

sys.exit()

2325

3068

2326

# 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

2327

server_defaults = { "interface": "",

2328

"address": "",

2329

"port": "",

2330

"debug": "False",

2331

"priority":

2332

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

2333

"servicename": "Mandos",

2334

"use_dbus": "True",

2335

"use_ipv6": "True",

2336

"debuglevel": "",

2337

"restore": "True",

2338

"socket": "",

2339

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

2340

"foreground": "False",

2341

}

2342

3092

2343

# Parse config file for server-global settings

3093

server_config = configparser.ConfigParser(server_defaults)

2344

server_config = configparser.SafeConfigParser(server_defaults)

3094

2345

del server_defaults

3095

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

3096

# Convert the ConfigParser object to a dict

2346

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

2347

"mandos.conf"))

2348

# Convert the SafeConfigParser object to a dict

3097

2349

server_settings = server_config.defaults()

3098

2350

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

3099

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

3100

"foreground", "zeroconf"):

2351

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

3101

2352

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

3102

2353

option)

3103

2354

if server_settings["port"]:

3109

2360

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

3110

2361

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

3111

2362

# happen with a supplied network socket.

3112

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

2363

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

3113

2364

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

3114

2365

["socket"])

3115

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

3116

2366

del server_config

3117

2367

3118

2368

# Override the settings from the config file with command line

3119

2369

# options, if set.

3120

2370

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

3121

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

3122

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

3123

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

2371

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

2372

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

2373

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

3124

2374

value = getattr(options, option)

3125

2375

if value is not None:

3126

2376

server_settings[option] = value

3127

2377

del options

3128

2378

# Force all strings to be unicode

3129

2379

for option in server_settings.keys():

3130

if isinstance(server_settings[option], bytes):

3131

server_settings[option] = (server_settings[option]

3132

.decode("utf-8"))

3133

# Force all boolean options to be boolean

3134

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

3135

"foreground", "zeroconf"):

3136

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

2380

if type(server_settings[option]) is str:

2381

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

3137

2382

# Debug implies foreground

3138

2383

if server_settings["debug"]:

3139

2384

server_settings["foreground"] = True

3140

2385

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

3141

2386

3142

2387

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

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

2388

3149

2389

# For convenience

3150

2390

debug = server_settings["debug"]

3151

2391

debuglevel = server_settings["debuglevel"]

3154

2394

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

3155

2395

stored_state_file)

3156

2396

foreground = server_settings["foreground"]

3157

zeroconf = server_settings["zeroconf"]

3158

2397

3159

2398

if debug:

3160

2399

initlogger(debug, logging.DEBUG)

3161

2400

else:

3164

2403

else:

3165

2404

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

3166

2405

initlogger(debug, level)

3167

2406

3168

2407

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

2408

syslogger.setFormatter(logging.Formatter

2409

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

2410

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

2411

.format(server_settings

2412

["servicename"])))

2413

3174

2414

# Parse config file with clients

3175

client_config = configparser.ConfigParser(Client.client_defaults)

2415

client_config = configparser.SafeConfigParser(Client

2416

.client_defaults)

3176

2417

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

3177

2418

"clients.conf"))

3178

2419

3179

2420

global mandos_dbus_service

3180

2421

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)

2422

2423

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

2424

server_settings["port"]),

2425

ClientHandler,

2426

interface=(server_settings["interface"]

2427

or None),

2428

use_ipv6=use_ipv6,

2429

gnutls_priority=

2430

server_settings["priority"],

2431

use_dbus=use_dbus,

2432

socketfd=(server_settings["socket"]

2433

or None))

3193

2434

if not foreground:

3194

pidfilename = "/run/mandos.pid"

3195

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

3196

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

2435

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

3197

2436

pidfile = None

3198

2437

try:

3199

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

2438

pidfile = open(pidfilename, "w")

3200

2439

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

2440

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

2441

exc_info=e)

2442

2443

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

3207

2444

try:

3208

2445

uid = pwd.getpwnam(name).pw_uid

3209

gid = pwd.getpwnam(group).pw_gid

2446

gid = pwd.getpwnam(name).pw_gid

3210

2447

break

3211

2448

except KeyError:

3212

2449

continue

3216

2453

try:

3217

2454

os.setgid(gid)

3218

2455

os.setuid(uid)

3219

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

3220

2456

except OSError as error:

3221

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

3222

os.strerror(error.errno))

3223

2457

if error.errno != errno.EPERM:

3224

raise

3225

2458

raise error

2459

3226

2460

if debug:

3227

2461

# Enable all possible GnuTLS debugging

3228

2462

3229

2463

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

3230

2464

# - GnuTLS manual

3231

gnutls.global_set_log_level(11)

3232

3233

@gnutls.log_func

2465

gnutls.library.functions.gnutls_global_set_log_level(11)

2466

2467

@gnutls.library.types.gnutls_log_func

3234

2468

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

2469

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

2470

2471

(gnutls.library.functions

2472

.gnutls_global_set_log_function(debug_gnutls))

2473

3240

2474

# Redirect stdin so all checkers get /dev/null

3241

2475

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

3242

2476

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

3243

2477

if null > 2:

3244

2478

os.close(null)

3245

2479

3246

2480

# Need to fork before connecting to D-Bus

3247

2481

if not foreground:

3248

2482

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

3249

2483

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

2484

2485

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

2486

# need to inform gobject that threads will be used.

2487

gobject.threads_init()

2488

3256

2489

global main_loop

3257

2490

# From the Avahi example code

3258

2491

DBusGMainLoop(set_as_default=True)

3259

main_loop = GLib.MainLoop()

3260

if use_dbus or zeroconf:

3261

bus = dbus.SystemBus()

2492

main_loop = gobject.MainLoop()

2493

bus = dbus.SystemBus()

3262

2494

# End of Avahi example code

3263

2495

if use_dbus:

3264

2496

try:

3265

2497

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)

2498

bus, do_not_queue=True)

2499

old_bus_name = (dbus.service.BusName

2500

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

2501

do_not_queue=True))

2502

except dbus.exceptions.NameExistsException as e:

2503

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

3273

2504

use_dbus = False

3274

2505

server_settings["use_dbus"] = False

3275

2506

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

2507

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2508

service = AvahiServiceToSyslog(name =

2509

server_settings["servicename"],

2510

servicetype = "_mandos._tcp",

2511

protocol = protocol, bus = bus)

2512

if server_settings["interface"]:

2513

service.interface = (if_nametoindex

2514

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

2515

3287

2516

global multiprocessing_manager

3288

2517

multiprocessing_manager = multiprocessing.Manager()

3289

2518

3290

2519

client_class = Client

3291

2520

if use_dbus:

3292

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

3293

2521

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

2522

3294

2523

client_settings = Client.config_parser(client_config)

3295

2524

old_client_settings = {}

3296

2525

clients_data = {}

3297

3298

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

3299

global wnull

3300

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

3301

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

3302

# mode

3303

if debug or not foreground:

3304

wnull.close()

3305

2526

3306

2527

# Get client data and settings from last running state.

3307

2528

if server_settings["restore"]:

3308

2529

try:

3309

2530

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

2531

clients_data, old_client_settings = (pickle.load

2532

(stored_state))

3360

2533

os.remove(stored_state_path)

3361

2534

except IOError as e:

3362

2535

if e.errno == errno.ENOENT:

3363

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

3364

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

2536

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

2537

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

3365

2538

else:

3366

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

3367

exc_info=e)

2539

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

2540

exc_info=e)

3368

2541

raise

3369

2542

except EOFError as e:

3370

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

3371

exc_info=e)

3372

2543

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

2544

"EOFError:", exc_info=e)

2545

3373

2546

with PGPEngine() as pgp:

3374

for client_name, client in clients_data.items():

3375

# Skip removed clients

3376

if client_name not in client_settings:

3377

continue

3378

2547

for client_name, client in clients_data.iteritems():

3379

2548

# Decide which value to use after restoring saved state.

3380

2549

# We have three different values: Old config file,

3381

2550

# new config file, and saved state.

3386

2555

# For each value in new config, check if it

3387

2556

# differs from the old config value (Except for

3388

2557

# the "secret" attribute)

3389

if (name != "secret"

3390

and (value !=

3391

old_client_settings[client_name][name])):

2558

if (name != "secret" and

2559

value != old_client_settings[client_name]

2560

[name]):

3392

2561

client[name] = value

3393

2562

except KeyError:

3394

2563

pass

3395

2564

3396

2565

# Clients who has passed its expire date can still be

3397

# enabled if its last checker was successful. A Client

2566

# enabled if its last checker was successful. Clients

3398

2567

# whose checker succeeded before we stored its state is

3399

2568

# assumed to have successfully run all checkers during

3400

2569

# downtime.

3401

2570

if client["enabled"]:

3402

2571

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

3403

2572

if not client["last_checked_ok"]:

3404

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

3405

" never performed a successful"

3406

" checker", client_name)

2573

logger.warning(

2574

"disabling client {0} - Client never "

2575

"performed a successful checker"

2576

.format(client_name))

3407

2577

client["enabled"] = False

3408

2578

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

2579

logger.warning(

2580

"disabling client {0} - Client "

2581

"last checker failed with error code {1}"

2582

.format(client_name,

2583

client["last_checker_status"]))

3413

2584

client["enabled"] = False

3414

2585

else:

3415

client["expires"] = (

3416

datetime.datetime.utcnow()

3417

+ client["timeout"])

3418

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

3419

" enabled", client_name)

2586

client["expires"] = (datetime.datetime

2587

.utcnow()

2588

+ client["timeout"])

2589

logger.debug("Last checker succeeded,"

2590

" keeping {0} enabled"

2591

.format(client_name))

3420

2592

try:

3421

client["secret"] = pgp.decrypt(

3422

client["encrypted_secret"],

3423

client_settings[client_name]["secret"])

2593

client["secret"] = (

2594

pgp.decrypt(client["encrypted_secret"],

2595

client_settings[client_name]

2596

["secret"]))

3424

2597

except PGPError:

3425

2598

# 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

2599

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

2600

.format(client_name))

2601

client["secret"] = (

2602

client_settings[client_name]["secret"])

2603

3431

2604

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

3432

2605

for client_name in (set(old_client_settings)

3433

2606

- set(client_settings)):

3435

2608

for client_name in (set(client_settings)

3436

2609

- set(old_client_settings)):

3437

2610

clients_data[client_name] = client_settings[client_name]

3438

2611

3439

2612

# Create all client objects

3440

for client_name, client in clients_data.items():

2613

for client_name, client in clients_data.iteritems():

3441

2614

tcp_server.clients[client_name] = client_class(

3442

name=client_name,

3443

settings=client,

3444

server_settings=server_settings)

3445

2615

name = client_name, settings = client)

2616

3446

2617

if not tcp_server.clients:

3447

log.warning("No clients defined")

3448

2618

logger.warning("No clients defined")

2619

3449

2620

if not foreground:

3450

2621

if pidfile is not None:

3451

pid = os.getpid()

3452

2622

try:

3453

2623

with pidfile:

3454

print(pid, file=pidfile)

2624

pid = os.getpid()

2625

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

3455

2626

except IOError:

3456

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

3457

pidfilename, pid)

2627

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

2628

pidfilename, pid)

3458

2629

del pidfile

3459

2630

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

2631

2632

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

2633

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

2634

3465

2635

if use_dbus:

3466

3467

@alternate_dbus_interfaces(

3468

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

3469

class MandosDBusService(DBusObjectWithObjectManager):

2636

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

2637

"se.bsnet.fukt.Mandos"})

2638

class MandosDBusService(DBusObjectWithProperties):

3470

2639

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

3471

3472

2640

def __init__(self):

3473

2641

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

3474

3475

2642

_interface = "se.recompile.Mandos"

3476

2643

2644

@dbus_interface_annotations(_interface)

2645

def _foo(self):

2646

return { "org.freedesktop.DBus.Property"

2647

".EmitsChangedSignal":

2648

"false"}

2649

3477

2650

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

3478

2651

def ClientAdded(self, objpath):

3479

2652

"D-Bus signal"

3480

2653

pass

3481

2654

3482

2655

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

3483

def ClientNotFound(self, key_id, address):

2656

def ClientNotFound(self, fingerprint, address):

3484

2657

"D-Bus signal"

3485

2658

pass

3486

3487

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

3488

"true"})

2659

3489

2660

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

3490

2661

def ClientRemoved(self, objpath, name):

3491

2662

"D-Bus signal"

3492

2663

pass

3493

3494

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

3495

"true"})

2664

3496

2665

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

3497

2666

def GetAllClients(self):

3498

2667

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

2668

return dbus.Array(c.dbus_object_path

2669

for c in

2670

tcp_server.clients.itervalues())

2671

3504

2672

@dbus.service.method(_interface,

3505

2673

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

3506

2674

def GetAllClientsWithProperties(self):

3507

2675

"D-Bus method"

3508

2676

return dbus.Dictionary(

3509

{c.dbus_object_path: c.GetAll(

3510

"se.recompile.Mandos.Client")

3511

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

2677

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

2678

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

3512

2679

signature="oa{sv}")

3513

2680

3514

2681

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

3515

2682

def RemoveClient(self, object_path):

3516

2683

"D-Bus method"

3517

for c in tcp_server.clients.values():

2684

for c in tcp_server.clients.itervalues():

3518

2685

if c.dbus_object_path == object_path:

3519

2686

del tcp_server.clients[c.name]

3520

2687

c.remove_from_connection()

3521

# Don't signal the disabling

2688

# Don't signal anything except ClientRemoved

3522

2689

c.disable(quiet=True)

3523

# Emit D-Bus signal for removal

3524

self.client_removed_signal(c)

2690

# Emit D-Bus signal

2691

self.ClientRemoved(object_path, c.name)

3525

2692

return

3526

2693

raise KeyError(object_path)

3527

2694

3528

2695

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

2696

3566

2697

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

2698

3573

2699

def cleanup():

3574

2700

"Cleanup function; run on exit"

3575

if zeroconf:

3576

service.cleanup()

3577

3578

mp.active_children()

3579

wn.close()

2701

service.cleanup()

2702

2703

multiprocessing.active_children()

3580

2704

if not (tcp_server.clients or client_settings):

3581

2705

return

3582

2706

3583

2707

# Store client before exiting. Secrets are encrypted with key

3584

2708

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

3585

2709

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

3586

2710

clients = {}

3587

2711

with PGPEngine() as pgp:

3588

for client in tcp_server.clients.values():

2712

for client in tcp_server.clients.itervalues():

3589

2713

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

3590

2714

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

3591

2715

key)

3592

2716

client_dict = {}

3593

2717

3594

2718

# A list of attributes that can not be pickled

3595

2719

# + secret.

3596

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

3597

"checker", "server_settings"}

3598

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

3599

.Object):

2720

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

2721

"checker"))

2722

for name, typ in (inspect.getmembers

2723

(dbus.service.Object)):

3600

2724

exclude.add(name)

3601

2725

3602

2726

client_dict["encrypted_secret"] = (client

3603

2727

.encrypted_secret)

3604

2728

for attr in client.client_structure:

3605

2729

if attr not in exclude:

3606

2730

client_dict[attr] = getattr(client, attr)

3607

2731

3608

2732

clients[client.name] = client_dict

3609

2733

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

3610

2734

3611

2735

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

2736

with (tempfile.NamedTemporaryFile

2737

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

2738

dir=os.path.dirname(stored_state_path),

2739

delete=False)) as stored_state:

2740

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

2741

tempname=stored_state.name

3621

2742

os.rename(tempname, stored_state_path)

3622

2743

except (IOError, OSError) as e:

3623

2744

if not debug:

3626

2747

except NameError:

3627

2748

pass

3628

2749

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

3629

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

3630

os.strerror(e.errno))

2750

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

2751

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

3631

2752

else:

3632

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

3633

exc_info=e)

3634

raise

3635

2753

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

2754

exc_info=e)

2755

raise e

2756

3636

2757

# Delete all clients, and settings from config

3637

2758

while tcp_server.clients:

3638

2759

name, client = tcp_server.clients.popitem()

3639

2760

if use_dbus:

3640

2761

client.remove_from_connection()

3641

# Don't signal the disabling

2762

# Don't signal anything except ClientRemoved

3642

2763

client.disable(quiet=True)

3643

# Emit D-Bus signal for removal

3644

2764

if use_dbus:

3645

mandos_dbus_service.client_removed_signal(client)

2765

# Emit D-Bus signal

2766

mandos_dbus_service.ClientRemoved(client

2767

.dbus_object_path,

2768

client.name)

3646

2769

client_settings.clear()

3647

2770

3648

2771

atexit.register(cleanup)

3649

3650

for client in tcp_server.clients.values():

2772

2773

for client in tcp_server.clients.itervalues():

3651

2774

if use_dbus:

3652

# Emit D-Bus signal for adding

3653

mandos_dbus_service.client_added_signal(client)

2775

# Emit D-Bus signal

2776

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3654

2777

# Need to initiate checking of clients

3655

2778

if client.enabled:

3656

client.init_checker(randomize_start=True)

3657

2779

client.init_checker()

2780

3658

2781

tcp_server.enable()

3659

2782

tcp_server.server_activate()

3660

2783

3661

2784

# Find out what port we got

3662

if zeroconf:

3663

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

2785

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

3664

2786

if use_ipv6:

3665

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

3666

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

2787

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

2788

" flowinfo %d, scope_id %d",

2789

*tcp_server.socket.getsockname())

3667

2790

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

2791

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

2792

*tcp_server.socket.getsockname())

2793

2794

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

2795

3673

2796

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

2797

# From the Avahi example code

2798

try:

2799

service.activate()

2800

except dbus.exceptions.DBusException as error:

2801

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

2802

cleanup()

2803

sys.exit(1)

2804

# End of Avahi example code

2805

2806

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

2807

lambda *args, **kwargs:

2808

(tcp_server.handle_request

2809

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

2810

2811

logger.debug("Starting main loop")

3691

2812

main_loop.run()

3692

2813

except AvahiError as error:

3693

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

2814

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

3694

2815

cleanup()

3695

2816

sys.exit(1)

3696

2817

except KeyboardInterrupt:

3697

2818

if debug:

3698

2819

print("", file=sys.stderr)

3699

log.debug("Server received KeyboardInterrupt")

3700

log.debug("Server exiting")

2820

logger.debug("Server received KeyboardInterrupt")

2821

logger.debug("Server exiting")

3701

2822

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

3702

2823

cleanup()

3703

2824

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:

2825

if __name__ == '__main__':

2826

main()