/mandos/trunk : revision 1299

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

39

import SocketServer as socketserver

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

40

51

import socket

41

import argparse

42

52

import datetime

43

53

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

52

58

import re

53

import os

54

59

import signal

55

60

import subprocess

56

61

import atexit

57

62

import stat

58

import logging

59

63

import logging.handlers

60

64

import pwd

61

65

import contextlib

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

78

import collections

79

import codecs

80

import random

81

import shlex

71

82

72

83

import dbus

73

84

import dbus.service

74

import gobject

75

import avahi

85

import gi

86

from gi.repository import GLib

76

87

from dbus.mainloop.glib import DBusGMainLoop

77

88

import ctypes

78

89

import ctypes.util

79

90

import xml.dom.minidom

80

91

import inspect

81

import GnuPGInterface

82

83

try:

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

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.16"

92

147

stored_state_file = "clients.pickle"

93

148

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

149

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

150

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

151

syslogger = None

98

152

99

153

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

103

156

except (OSError, AttributeError):

157

104

158

def if_nametoindex(interface):

105

159

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

106

160

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

107

161

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

108

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

163

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

164

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

113

165

return interface_index

114

166

115

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

116

184

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

117

185

"""init logger and add loglevel"""

118

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

syslogger.setFormatter(logging.Formatter

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

124

196

if debug:

125

197

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

132

204

133

205

134

206

class PGPError(Exception):

136

208

pass

137

209

138

210

139

class PGPEngine(object):

211

class PGPEngine:

140

212

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

213

141

214

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

215

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

151

235

def __enter__(self):

152

236

return self

153

154

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

237

238

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

155

239

self._cleanup()

156

240

return False

157

241

158

242

def __del__(self):

159

243

self._cleanup()

160

244

161

245

def _cleanup(self):

162

246

if self.tempdir is not None:

163

247

# Delete contents of tempdir

164

248

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

165

topdown = False):

249

topdown=False):

166

250

for filename in files:

167

251

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

168

252

for dirname in dirs:

170

254

# Remove tempdir

171

255

os.rmdir(self.tempdir)

172

256

self.tempdir = None

173

257

174

258

def password_encode(self, password):

175

259

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

176

260

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

177

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

178

261

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

262

if len(encoded) > 2048:

263

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

264

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

265

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

266

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

267

return encoded

268

179

269

def encrypt(self, data, password):

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

"--passphrase-file",

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

194

285

return ciphertext

195

286

196

287

def decrypt(self, data, password):

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

"--passphrase-file",

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

211

303

return decrypted_plaintext

212

304

213

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

214

332

class AvahiError(Exception):

215

333

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

216

334

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

335

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

336

**kwargs)

337

220

338

221

339

class AvahiServiceError(AvahiError):

222

340

pass

223

341

342

224

343

class AvahiGroupError(AvahiError):

225

344

pass

226

345

227

346

228

class AvahiService(object):

347

class AvahiService:

229

348

"""An Avahi (Zeroconf) service.

230

349

231

350

Attributes:

232

351

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

233

352

Used to optionally bind to the specified interface.

234

235

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

236

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

353

354

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

355

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

237

356

port: integer; what port to announce

238

357

TXT: list of strings; TXT record for the service

239

358

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

245

364

server: D-Bus Server

246

365

bus: dbus.SystemBus()

247

366

"""

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

253

379

self.interface = interface

254

380

self.name = name

255

381

self.type = servicetype

264

390

self.server = None

265

391

self.bus = bus

266

392

self.entry_group_state_changed_match = None

267

268

def rename(self):

393

394

def rename(self, remove=True):

269

395

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

270

396

if self.rename_count >= self.max_renames:

271

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

272

" after %i retries, exiting.",

273

self.rename_count)

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

274

400

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

277

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

278

self.name)

279

self.remove()

280

try:

281

self.add()

282

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

286

403

self.rename_count += 1

287

404

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

405

self.name)

406

if remove:

407

self.remove()

408

try:

409

self.add()

410

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

288

420

def remove(self):

289

421

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

290

422

if self.entry_group_state_changed_match is not None:

292

424

self.entry_group_state_changed_match = None

293

425

if self.group is not None:

294

426

self.group.Reset()

295

427

296

428

def add(self):

297

429

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

298

430

self.remove()

303

435

avahi.DBUS_INTERFACE_ENTRY_GROUP)

304

436

self.entry_group_state_changed_match = (

305

437

self.group.connect_to_signal(

306

'StateChanged', self.entry_group_state_changed))

307

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

308

self.name, self.type)

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

309

441

self.group.AddService(

310

442

self.interface,

311

443

self.protocol,

315

447

dbus.UInt16(self.port),

316

448

avahi.string_array_to_txt_array(self.TXT))

317

449

self.group.Commit()

318

450

319

451

def entry_group_state_changed(self, state, error):

320

452

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

321

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

322

453

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

454

323

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

324

logger.debug("Zeroconf service established.")

456

log.debug("Zeroconf service established.")

325

457

elif state == avahi.ENTRY_GROUP_COLLISION:

326

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

458

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

327

459

self.rename()

328

460

elif state == avahi.ENTRY_GROUP_FAILURE:

329

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

330

unicode(error))

331

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

332

.format(error))

333

461

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

462

str(error))

463

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

464

334

465

def cleanup(self):

335

466

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

336

467

if self.group is not None:

341

472

pass

342

473

self.group = None

343

474

self.remove()

344

475

345

476

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

346

477

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

347

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

478

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

355

485

if state in bad_states:

356

486

if bad_states[state] is not None:

357

487

if error is None:

358

logger.error(bad_states[state])

488

log.error(bad_states[state])

359

489

else:

360

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

490

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

361

491

self.cleanup()

362

492

elif state == avahi.SERVER_RUNNING:

363

self.add()

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

364

504

else:

365

505

if error is None:

366

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

506

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

367

507

else:

368

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

369

508

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

509

370

510

def activate(self):

371

511

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

372

512

if self.server is None:

376

516

follow_name_owner_changes=True),

377

517

avahi.DBUS_INTERFACE_SERVER)

378

518

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

519

self.server_state_changed)

380

520

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

381

521

522

382

523

class AvahiServiceToSyslog(AvahiService):

383

def rename(self):

524

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

384

525

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

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

526

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

527

**kwargs)

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

390

531

return ret

391

532

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

397

398

class Client(object):

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

399

875

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

400

876

401

877

Attributes:

402

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

878

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

403

879

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

404

880

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

405

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

406

to see if the client lives.

407

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

409

885

checker_command: string; External command which is run to check

410

886

if client lives. %() expansions are done at

411

887

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

412

888

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

413

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

414

890

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

415

891

client_structure: Object describing what attributes a client has

416

892

and is used for storing the client at exit

417

893

current_checker_command: string; current running checker_command

418

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

419

895

enabled: bool()

420

896

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

421

uniquely identify the client

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

422

900

host: string; available for use by the checker command

423

901

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

424

902

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

426

904

last_checker_status: integer between 0 and 255 reflecting exit

427

905

status of last checker. -1 reflects crashed

428

906

checker, -2 means no checker completed yet.

907

last_checker_signal: The signal which killed the last checker, if

908

last_checker_status is -1

429

909

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

430

910

431

911

D-Bus identifiers

436

916

runtime_expansions: Allowed attributes for runtime expansion.

437

917

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

438

918

disabled, or None

919

server_settings: The server_settings dict from main()

439

920

"""

440

921

441

922

runtime_expansions = ("approval_delay", "approval_duration",

442

"created", "enabled", "fingerprint",

443

"host", "interval", "last_checked_ok",

923

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

924

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

925

"last_approval_request", "last_checked_ok",

444

926

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

445

client_defaults = { "timeout": "5m",

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

927

client_defaults = {

928

"timeout": "PT5M",

929

"extended_timeout": "PT15M",

930

"interval": "PT2M",

931

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

932

"host": "",

933

"approval_delay": "PT0S",

934

"approval_duration": "PT1S",

935

"approved_by_default": "True",

936

"enabled": "True",

937

}

938

471

939

@staticmethod

472

940

def config_parser(config):

473

941

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

480

948

for client_name in config.sections():

481

949

section = dict(config.items(client_name))

482

950

client = settings[client_name] = {}

483

951

484

952

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

485

953

# Reformat values from string types to Python types

486

954

client["approved_by_default"] = config.getboolean(

487

955

client_name, "approved_by_default")

488

956

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

489

957

"enabled")

490

491

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

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

964

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

965

"").upper()

492

966

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

493

972

if "secret" in section:

494

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

973

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

974

.encode("utf-8"),

975

"base64")

495

976

elif "secfile" in section:

496

977

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

497

978

(section["secfile"])),

498

979

"rb") as secfile:

499

980

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

500

981

else:

501

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

982

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

502

983

.format(section))

503

984

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

504

985

client["extended_timeout"] = string_to_delta(

512

993

client["last_approval_request"] = None

513

994

client["last_checked_ok"] = None

514

995

client["last_checker_status"] = -2

515

996

516

997

return settings

517

518

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

998

999

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

519

1000

self.name = name

1001

if server_settings is None:

1002

server_settings = {}

1003

self.server_settings = server_settings

520

1004

# adding all client settings

521

for setting, value in settings.iteritems():

1005

for setting, value in settings.items():

522

1006

setattr(self, setting, value)

523

1007

524

1008

if self.enabled:

525

1009

if not hasattr(self, "last_enabled"):

526

1010

self.last_enabled = datetime.datetime.utcnow()

530

1014

else:

531

1015

self.last_enabled = None

532

1016

self.expires = None

533

534

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

538

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

1017

1018

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

1019

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

1020

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

539

1021

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

540

1022

datetime.datetime.utcnow())

541

1023

542

1024

# attributes specific for this server instance

543

1025

self.checker = None

544

1026

self.checker_initiator_tag = None

547

1029

self.current_checker_command = None

548

1030

self.approved = None

549

1031

self.approvals_pending = 0

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

1032

self.changedstate = multiprocessing_manager.Condition(

1033

multiprocessing_manager.Lock())

1034

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

555

1036

if not attr.startswith("_")]

556

1037

self.client_structure.append("client_structure")

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

1038

1039

for name, t in inspect.getmembers(

1040

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

562

1041

if not name.startswith("_"):

563

1042

self.client_structure.append(name)

564

1043

565

1044

# Send notice to process children that client state has changed

566

1045

def send_changedstate(self):

567

1046

with self.changedstate:

568

1047

self.changedstate.notify_all()

569

1048

570

1049

def enable(self):

571

1050

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

572

1051

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

573

1052

# Already enabled

574

1053

return

575

self.send_changedstate()

576

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

577

1054

self.enabled = True

578

1055

self.last_enabled = datetime.datetime.utcnow()

579

1056

self.init_checker()

580

1057

self.send_changedstate()

1058

581

1059

def disable(self, quiet=True):

582

1060

"""Disable this client."""

583

1061

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

584

1062

return False

585

1063

if not quiet:

586

self.send_changedstate()

587

if not quiet:

588

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

589

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

590

gobject.source_remove(self.disable_initiator_tag)

1064

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

1065

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

1066

GLib.source_remove(self.disable_initiator_tag)

591

1067

self.disable_initiator_tag = None

592

1068

self.expires = None

593

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

594

gobject.source_remove(self.checker_initiator_tag)

1069

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

1070

GLib.source_remove(self.checker_initiator_tag)

595

1071

self.checker_initiator_tag = None

596

1072

self.stop_checker()

597

1073

self.enabled = False

598

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

1074

if not quiet:

1075

self.send_changedstate()

1076

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

599

1077

return False

600

1078

601

1079

def __del__(self):

602

1080

self.disable()

603

604

def init_checker(self):

605

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

606

# and every interval from then on.

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

610

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

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

614

# Also start a new checker *right now*.

615

self.start_checker()

616

617

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

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

1087

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

1106

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

1112

def checker_callback(self, source, condition, connection,

1113

command):

618

1114

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

1115

# Read return code from connection (see call_pipe)

1116

returncode = connection.recv()

1117

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

619

1120

self.checker_callback_tag = None

620

1121

self.checker = None

621

if os.WIFEXITED(condition):

622

self.last_checker_status = os.WEXITSTATUS(condition)

1122

1123

if returncode >= 0:

1124

self.last_checker_status = returncode

1125

self.last_checker_signal = None

623

1126

if self.last_checker_status == 0:

624

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

625

vars(self))

1127

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

626

1128

self.checked_ok()

627

1129

else:

628

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

629

vars(self))

1130

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

630

1131

else:

631

1132

self.last_checker_status = -1

632

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

633

vars(self))

634

1133

self.last_checker_signal = -returncode

1134

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

1135

return False

1136

635

1137

def checked_ok(self):

636

1138

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

637

1139

self.last_checked_ok = datetime.datetime.utcnow()

638

1140

self.last_checker_status = 0

1141

self.last_checker_signal = None

639

1142

self.bump_timeout()

640

1143

641

1144

def bump_timeout(self, timeout=None):

642

1145

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

643

1146

if timeout is None:

644

1147

timeout = self.timeout

645

1148

if self.disable_initiator_tag is not None:

646

gobject.source_remove(self.disable_initiator_tag)

1149

GLib.source_remove(self.disable_initiator_tag)

1150

self.disable_initiator_tag = None

647

1151

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

1152

self.disable_initiator_tag = GLib.timeout_add(

1153

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

651

1154

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

652

1155

653

1156

def need_approval(self):

654

1157

self.last_approval_request = datetime.datetime.utcnow()

655

656

def start_checker(self):

1158

1159

def start_checker(self, start_was_randomized=False):

657

1160

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

658

1161

659

1162

If a checker already exists, leave it running and do

660

1163

nothing."""

661

1164

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

666

1169

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

667

1170

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

668

1171

# should be.

669

670

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

671

try:

672

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

673

except (AttributeError, OSError) as error:

674

if (isinstance(error, OSError)

675

and error.errno != errno.ECHILD):

676

raise error

677

else:

678

if pid:

679

logger.warning("Checker was a zombie")

680

gobject.source_remove(self.checker_callback_tag)

681

self.checker_callback(pid, status,

682

self.current_checker_command)

1172

1173

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

1174

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

1175

self.checker.join()

1176

self.checker = None

683

1177

# Start a new checker if needed

684

1178

if self.checker is None:

1179

# Escape attributes for the shell

1180

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

685

1183

try:

686

# In case checker_command has exactly one % operator

687

command = self.checker_command % self.host

688

except TypeError:

689

# Escape attributes for the shell

690

escaped_attrs = dict(

691

(attr,

692

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

693

errors=

694

'replace')))

695

for attr in

696

self.runtime_expansions)

697

698

try:

699

command = self.checker_command % escaped_attrs

700

except TypeError as error:

701

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

1184

command = self.checker_command % escaped_attrs

1185

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

1188

return True # Try again later

704

1189

self.current_checker_command = command

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

self.checker_callback_tag = (gobject.child_watch_add

716

(self.checker.pid,

717

self.checker_callback,

718

data=command))

719

# The checker may have completed before the gobject

720

# watch was added. Check for this.

721

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

722

if pid:

723

gobject.source_remove(self.checker_callback_tag)

724

self.checker_callback(pid, status, command)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

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

1190

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

1191

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

1192

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

1193

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

1194

# always replaced by /dev/null.)

1195

# The exception is when not debugging but nevertheless

1196

# running in the foreground; use the previously

1197

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

1201

if (not self.server_settings["debug"]

1202

and self.server_settings["foreground"]):

1203

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

1206

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

1210

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1214

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1226

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

729

1227

return True

730

1228

731

1229

def stop_checker(self):

732

1230

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

733

1231

if self.checker_callback_tag:

734

gobject.source_remove(self.checker_callback_tag)

1232

GLib.source_remove(self.checker_callback_tag)

735

1233

self.checker_callback_tag = None

736

1234

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

737

1235

return

738

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

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

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

743

# self.checker.kill()

744

except OSError as error:

745

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

746

raise

1236

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

1237

self.checker.terminate()

747

1238

self.checker = None

748

1239

749

1240

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

1241

def dbus_service_property(dbus_interface,

1242

signature="v",

1243

access="readwrite",

1244

byte_arrays=False):

752

1245

"""Decorators for marking methods of a DBusObjectWithProperties to

753

1246

become properties on the D-Bus.

754

1247

755

1248

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

756

1249

and with one argument by "Set".

757

1250

758

1251

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

759

1252

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

760

1253

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

763

1256

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

764

1257

if byte_arrays and signature != "ay":

765

1258

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

766

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

1259

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

1260

767

1261

def decorator(func):

768

1262

func._dbus_is_property = True

769

1263

func._dbus_interface = dbus_interface

772

1266

func._dbus_name = func.__name__

773

1267

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

774

1268

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

775

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

776

1270

return func

1271

777

1272

return decorator

778

1273

779

1274

780

1275

def dbus_interface_annotations(dbus_interface):

781

1276

"""Decorator for marking functions returning interface annotations

782

1277

783

1278

Usage:

784

1279

785

1280

@dbus_interface_annotations("org.example.Interface")

786

1281

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

787

1282

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

788

1283

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

789

1284

"false"}

790

1285

"""

1286

791

1287

def decorator(func):

792

1288

func._dbus_is_interface = True

793

1289

func._dbus_interface = dbus_interface

794

1290

func._dbus_name = dbus_interface

795

1291

return func

1292

796

1293

return decorator

797

1294

798

1295

799

1296

def dbus_annotations(annotations):

800

1297

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

801

1298

Usage:

802

1299

1300

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

1301

"org.freedesktop.DBus.Property."

1302

"EmitsChangedSignal": "false"})

803

1303

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

804

1304

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

808

1305

def Property_dbus_property(self):

809

1306

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

810

1309

"""

1310

811

1311

def decorator(func):

812

1312

func._dbus_annotations = annotations

813

1313

return func

1314

814

1315

return decorator

815

1316

816

1317

817

1318

class DBusPropertyException(dbus.exceptions.DBusException):

818

1319

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

819

1320

"""

820

def __unicode__(self):

821

return unicode(str(self))

1321

pass

822

1322

823

1323

824

1324

class DBusPropertyAccessException(DBusPropertyException):

833

1333

pass

834

1334

835

1335

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

838

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1337

"""A D-Bus object with annotations.

1338

1339

Classes inheriting from this can use the dbus_annotations

1340

decorator to add annotations to methods or signals.

842

1341

"""

843

1342

844

1343

@staticmethod

845

1344

def _is_dbus_thing(thing):

846

1345

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

847

1346

848

1347

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

849

1348

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

850

1349

"""

851

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

1350

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

852

1351

False)

853

1352

854

1353

def _get_all_dbus_things(self, thing):

855

1354

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

856

1355

"""

857

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

858

name),

1356

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

859

1357

athing.__get__(self))

860

1358

for cls in self.__class__.__mro__

861

1359

for name, athing in

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

864

1360

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

1361

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1366

def Introspect(self, object_path, connection):

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts annotation tags on methods and signals.

1370

"""

1371

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

1372

connection)

1373

try:

1374

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

1375

1376

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

1377

# Add annotation tags

1378

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

1379

for tag in if_tag.getElementsByTagName(typ):

1380

annots = dict()

1381

for name, prop in (self.

1382

_get_all_dbus_things(typ)):

1383

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

1384

and prop._dbus_interface

1385

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

1386

annots.update(getattr(

1387

prop, "_dbus_annotations", {}))

1388

for name, value in annots.items():

1389

ann_tag = document.createElement(

1390

"annotation")

1391

ann_tag.setAttribute("name", name)

1392

ann_tag.setAttribute("value", value)

1393

tag.appendChild(ann_tag)

1394

# Add interface annotation tags

1395

for annotation, value in dict(

1396

itertools.chain.from_iterable(

1397

annotations().items()

1398

for name, annotations

1399

in self._get_all_dbus_things("interface")

1400

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

1401

)).items():

1402

ann_tag = document.createElement("annotation")

1403

ann_tag.setAttribute("name", annotation)

1404

ann_tag.setAttribute("value", value)

1405

if_tag.appendChild(ann_tag)

1406

# Fix argument name for the Introspect method itself

1407

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1409

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

1410

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

1411

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

1412

if (arg.getAttribute("direction")

1413

== "out"):

1414

arg.setAttribute("name",

1415

"xml_data")

1416

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

1417

document.unlink()

1418

except (AttributeError, xml.dom.DOMException,

1419

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1422

return xmlstring

1423

1424

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

"""A D-Bus object with properties.

1427

1428

Classes inheriting from this can use the dbus_service_property

1429

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

1430

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

1431

"""

1432

865

1433

def _get_dbus_property(self, interface_name, property_name):

866

1434

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

867

1435

property with the specified name and interface.

868

1436

"""

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

1437

for cls in self.__class__.__mro__:

1438

for name, value in inspect.getmembers(

1439

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

873

1440

if (value._dbus_name == property_name

874

1441

and value._dbus_interface == interface_name):

875

1442

return value.__get__(self)

876

1443

877

1444

# No such property

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

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

1445

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

1446

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

1457

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

in_signature="ss",

883

1459

out_signature="v")

884

1460

def Get(self, interface_name, property_name):

885

1461

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

891

1467

if not hasattr(value, "variant_level"):

892

1468

return value

893

1469

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

894

1470

895

1471

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

896

1472

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

897

1473

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

903

1479

# The byte_arrays option is not supported yet on

904

1480

# signatures other than "ay".

905

1481

if prop._dbus_signature != "ay":

906

raise ValueError

907

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

908

for byte in value))

1482

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

1483

"'ay' signature {!r}"

1484

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

909

1486

prop(value)

910

911

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

1487

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

in_signature="s",

912

1490

out_signature="a{sv}")

913

1491

def GetAll(self, interface_name):

914

1492

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

915

1493

standard.

916

1494

917

1495

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

918

1496

"""

919

1497

properties = {}

929

1507

if not hasattr(value, "variant_level"):

930

1508

properties[name] = value

931

1509

continue

932

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

933

value.variant_level+1)

1510

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

934

1512

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

935

1513

1514

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

1515

def PropertiesChanged(self, interface_name, changed_properties,

1516

invalidated_properties):

1517

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

1518

standard.

1519

"""

1520

pass

1521

936

1522

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

937

1523

out_signature="s",

938

path_keyword='object_path',

939

connection_keyword='connection')

1524

path_keyword="object_path",

1525

connection_keyword="connection")

940

1526

def Introspect(self, object_path, connection):

941

1527

"""Overloading of standard D-Bus method.

942

1528

943

1529

Inserts property tags and interface annotation tags.

944

1530

"""

945

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

946

connection)

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

947

1534

try:

948

1535

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

1536

949

1537

def make_tag(document, name, prop):

950

1538

e = document.createElement("property")

951

1539

e.setAttribute("name", name)

952

1540

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

953

1541

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

954

1542

return e

1543

955

1544

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

956

1545

# Add property tags

957

1546

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

960

1549

if prop._dbus_interface

961

1550

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

962

1551

if_tag.appendChild(tag)

963

# Add annotation tags

964

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

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

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

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_tag)

1552

# Add annotation tags for properties

1553

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

1554

annots = dict()

1555

for name, prop in self._get_all_dbus_things(

1556

"property"):

1557

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

1558

and prop._dbus_interface

1559

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

1560

annots.update(getattr(

1561

prop, "_dbus_annotations", {}))

1562

for name, value in annots.items():

1563

ann_tag = document.createElement(

1564

"annotation")

1565

ann_tag.setAttribute("name", name)

1566

ann_tag.setAttribute("value", value)

1567

tag.appendChild(ann_tag)

994

1568

# Add the names to the return values for the

995

1569

# "org.freedesktop.DBus.Properties" methods

996

1570

if (if_tag.getAttribute("name")

1010

1584

document.unlink()

1011

1585

except (AttributeError, xml.dom.DOMException,

1012

1586

xml.parsers.expat.ExpatError) as error:

1013

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

1014

exc_info=error)

1015

return xmlstring

1016

1017

1018

def datetime_to_dbus (dt, variant_level=0):

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1660

return xmlstring

1661

1662

1663

def datetime_to_dbus(dt, variant_level=0):

1019

1664

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

1020

1665

if dt is None:

1021

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1666

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

1667

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

1024

1668

1025

1669

1026

1670

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1028

1672

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

1029

1673

interface names according to the "alt_interface_names" mapping.

1030

1674

Usage:

1031

1032

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

1033

"net.example.AlternateInterface"})

1675

1676

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

1677

"net.example.AlternateInterface"})

1034

1678

class SampleDBusObject(dbus.service.Object):

1035

1679

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

1036

1680

def SampleDBusMethod():

1037

1681

pass

1038

1682

1039

1683

The above "SampleDBusMethod" on "SampleDBusObject" will be

1040

1684

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

1041

1685

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

1042

1686

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

1043

1687

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

1044

1688

1045

1689

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

1046

1690

(from DBusObjectWithProperties) and interfaces (from the

1047

1691

dbus_interface_annotations decorator).

1048

1692

"""

1693

1049

1694

def wrapper(cls):

1050

1695

for orig_interface_name, alt_interface_name in (

1051

alt_interface_names.iteritems()):

1696

alt_interface_names.items()):

1052

1697

attr = {}

1053

1698

interface_names = set()

1054

1699

# Go though all attributes of the class

1056

1701

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

1057

1702

# with the wrong interface name

1058

1703

if (not hasattr(attribute, "_dbus_interface")

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1704

or not attribute._dbus_interface.startswith(

1705

orig_interface_name)):

1061

1706

continue

1062

1707

# Create an alternate D-Bus interface name based on

1063

1708

# the current name

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1709

alt_interface = attribute._dbus_interface.replace(

1710

orig_interface_name, alt_interface_name)

1067

1711

interface_names.add(alt_interface)

1068

1712

# Is this a D-Bus signal?

1069

1713

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

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1714

# Extract the original non-method undecorated

1715

# function by black magic

1716

if sys.version_info.major == 2:

1717

nonmethod_func = (dict(

1073

1718

zip(attribute.func_code.co_freevars,

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1719

attribute.__closure__))

1720

["func"].cell_contents)

1721

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1076

1726

# Create a new, but exactly alike, function

1077

1727

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

1078

1728

# with the alternate D-Bus interface name

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

1729

new_function = copy_function(nonmethod_func)

1730

new_function = (dbus.service.signal(

1731

alt_interface,

1732

attribute._dbus_signature)(new_function))

1088

1733

# Copy annotations, if any

1089

1734

try:

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1735

new_function._dbus_annotations = dict(

1736

attribute._dbus_annotations)

1092

1737

except AttributeError:

1093

1738

pass

1739

1094

1740

# Define a creator of a function to call both the

1095

1741

# original and alternate functions, so both the

1096

1742

# original and alternate signals gets sent when

1099

1745

"""This function is a scope container to pass

1100

1746

func1 and func2 to the "call_both" function

1101

1747

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1102

1750

def call_both(*args, **kwargs):

1103

1751

"""This function will emit two D-Bus

1104

1752

signals by calling func1 and func2"""

1105

1753

func1(*args, **kwargs)

1106

1754

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1107

1761

return call_both

1108

1762

# Create the "call_both" function and add it to

1109

1763

# the class

1114

1768

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

1115

1769

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

1116

1770

# to the class.

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1771

attr[attrname] = (

1772

dbus.service.method(

1773

alt_interface,

1774

attribute._dbus_in_signature,

1775

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1127

1777

# Copy annotations, if any

1128

1778

try:

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1779

attr[attrname]._dbus_annotations = dict(

1780

attribute._dbus_annotations)

1131

1781

except AttributeError:

1132

1782

pass

1133

1783

# Is this a D-Bus property?

1136

1786

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

1137

1787

# property with the alternate D-Bus interface

1138

1788

# name. Add it to the class.

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1789

attr[attrname] = (dbus_service_property(

1790

alt_interface, attribute._dbus_signature,

1791

attribute._dbus_access,

1792

attribute._dbus_get_args_options

1793

["byte_arrays"])

1794

(copy_function(attribute)))

1152

1795

# Copy annotations, if any

1153

1796

try:

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1797

attr[attrname]._dbus_annotations = dict(

1798

attribute._dbus_annotations)

1156

1799

except AttributeError:

1157

1800

pass

1158

1801

# Is this a D-Bus interface?

1161

1804

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

1162

1805

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

1163

1806

# to the class.

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1807

attr[attrname] = (

1808

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1172

1810

if deprecate:

1173

1811

# Deprecate all alternate interfaces

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1175

1813

for interface_name in interface_names:

1814

1176

1815

@dbus_interface_annotations(interface_name)

1177

1816

def func(self):

1178

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

1179

"true" }

1817

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

1818

"true"}

1180

1819

# Find an unused name

1181

1820

for aname in (iname.format(i)

1182

1821

for i in itertools.count()):

1186

1825

if interface_names:

1187

1826

# Replace the class with a new subclass of it with

1188

1827

# methods, signals, etc. as created above.

1189

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

1190

(cls,), attr)

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1191

1834

return cls

1835

1192

1836

return wrapper

1193

1837

1194

1838

1195

1839

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

1196

"se.bsnet.fukt.Mandos"})

1840

"se.bsnet.fukt.Mandos"})

1197

1841

class ClientDBus(Client, DBusObjectWithProperties):

1198

1842

"""A Client class using D-Bus

1199

1843

1200

1844

Attributes:

1201

1845

dbus_object_path: dbus.ObjectPath

1202

1846

bus: dbus.SystemBus()

1203

1847

"""

1204

1848

1205

1849

runtime_expansions = (Client.runtime_expansions

1206

+ ("dbus_object_path",))

1207

1850

+ ("dbus_object_path", ))

1851

1852

_interface = "se.recompile.Mandos.Client"

1853

1208

1854

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

1209

1210

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

1855

1856

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

1211

1857

self.bus = bus

1212

1858

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

1213

1859

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

1214

1860

# the D-Bus

1215

client_object_name = unicode(self.name).translate(

1861

client_object_name = str(self.name).translate(

1216

1862

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

1217

1863

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

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1864

self.dbus_object_path = dbus.ObjectPath(

1865

"/clients/" + client_object_name)

1220

1866

DBusObjectWithProperties.__init__(self, self.bus,

1221

1867

self.dbus_object_path)

1222

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1868

1869

def notifychangeproperty(transform_func, dbus_name,

1870

type_func=lambda x: x,

1871

variant_level=1,

1872

invalidate_only=False,

1873

_interface=_interface):

1226

1874

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

1227

1875

its changes to DBus.

1228

1876

1229

1877

transform_fun: Function that takes a value and a variant_level

1230

1878

and transforms it to a D-Bus type.

1231

1879

dbus_name: D-Bus name of the variable

1233

1881

to the D-Bus. Default: no transform

1234

1882

variant_level: D-Bus variant level. Default: 1

1235

1883

"""

1236

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

1884

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

1885

1237

1886

def setter(self, value):

1238

1887

if hasattr(self, "dbus_object_path"):

1239

1888

if (not hasattr(self, attrname) or

1240

1889

type_func(getattr(self, attrname, None))

1241

1890

!= type_func(value)):

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1891

if invalidate_only:

1892

self.PropertiesChanged(

1893

_interface, dbus.Dictionary(),

1894

dbus.Array((dbus_name, )))

1895

else:

1896

dbus_value = transform_func(

1897

type_func(value),

1898

variant_level=variant_level)

1899

self.PropertyChanged(dbus.String(dbus_name),

1900

dbus_value)

1901

self.PropertiesChanged(

1902

_interface,

1903

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

1904

dbus_value}),

1905

dbus.Array())

1247

1906

setattr(self, attrname, value)

1248

1907

1249

1908

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

1250

1909

1251

1910

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1252

1911

approvals_pending = notifychangeproperty(dbus.Boolean,

1253

1912

"ApprovalPending",

1254

type_func = bool)

1913

type_func=bool)

1255

1914

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

1256

1915

last_enabled = notifychangeproperty(datetime_to_dbus,

1257

1916

"LastEnabled")

1258

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

1259

type_func = lambda checker:

1260

checker is not None)

1917

checker = notifychangeproperty(

1918

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1261

1920

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1262

1921

"LastCheckedOK")

1263

1922

last_checker_status = notifychangeproperty(dbus.Int16,

1266

1925

datetime_to_dbus, "LastApprovalRequest")

1267

1926

approved_by_default = notifychangeproperty(dbus.Boolean,

1268

1927

"ApprovedByDefault")

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1928

approval_delay = notifychangeproperty(

1929

dbus.UInt64, "ApprovalDelay",

1930

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

1273

1931

approval_duration = notifychangeproperty(

1274

1932

dbus.UInt64, "ApprovalDuration",

1275

type_func = timedelta_to_milliseconds)

1933

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

1276

1934

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

1277

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

1278

type_func =

1279

timedelta_to_milliseconds)

1935

timeout = notifychangeproperty(

1936

dbus.UInt64, "Timeout",

1937

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

1280

1938

extended_timeout = notifychangeproperty(

1281

1939

dbus.UInt64, "ExtendedTimeout",

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1940

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

1941

interval = notifychangeproperty(

1942

dbus.UInt64, "Interval",

1943

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

1287

1944

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

1288

1945

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

1946

invalidate_only=True)

1947

1289

1948

del notifychangeproperty

1290

1949

1291

1950

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

1292

1951

try:

1293

1952

self.remove_from_connection()

1296

1955

if hasattr(DBusObjectWithProperties, "__del__"):

1297

1956

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

1298

1957

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

1299

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1958

1959

def checker_callback(self, source, condition,

1960

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

1961

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

1962

connection, command, *args,

1963

**kwargs)

1964

exitstatus = self.last_checker_status

1965

if exitstatus >= 0:

1306

1966

# Emit D-Bus signal

1307

1967

self.CheckerCompleted(dbus.Int16(exitstatus),

1308

dbus.Int64(condition),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1309

1970

dbus.String(command))

1310

1971

else:

1311

1972

# Emit D-Bus signal

1312

1973

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

1313

dbus.Int64(condition),

1974

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1314

1978

dbus.String(command))

1315

1316

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

1317

*args, **kwargs)

1318

1979

return ret

1980

1319

1981

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1982

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

1325

1983

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

1326

1984

# Only if new checker process was started

1327

1985

if (self.checker is not None

1329

1987

# Emit D-Bus signal

1330

1988

self.CheckerStarted(self.current_checker_command)

1331

1989

return r

1332

1990

1333

1991

def _reset_approved(self):

1334

1992

self.approved = None

1335

1993

return False

1336

1994

1337

1995

def approve(self, value=True):

1338

self.send_changedstate()

1339

1996

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1343

1344

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

## Signals

1355

1997

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

1998

* 1000), self._reset_approved)

1999

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1356

2007

# CheckerCompleted - signal

1357

2008

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

1358

2009

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

1359

2010

"D-Bus signal"

1360

2011

pass

1361

2012

1362

2013

# CheckerStarted - signal

1363

2014

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

1364

2015

def CheckerStarted(self, command):

1365

2016

"D-Bus signal"

1366

2017

pass

1367

2018

1368

2019

# PropertyChanged - signal

2020

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

1369

2021

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

1370

2022

def PropertyChanged(self, property, value):

1371

2023

"D-Bus signal"

1372

2024

pass

1373

2025

1374

2026

# GotSecret - signal

1375

2027

@dbus.service.signal(_interface)

1376

2028

def GotSecret(self):

1379

2031

server to mandos-client

1380

2032

"""

1381

2033

pass

1382

2034

1383

2035

# Rejected - signal

1384

2036

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

1385

2037

def Rejected(self, reason):

1386

2038

"D-Bus signal"

1387

2039

pass

1388

2040

1389

2041

# NeedApproval - signal

1390

2042

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

1391

2043

def NeedApproval(self, timeout, default):

1392

2044

"D-Bus signal"

1393

2045

return self.need_approval()

1394

1395

## Methods

1396

2046

2047

# Methods

2048

1397

2049

# Approve - method

1398

2050

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

1399

2051

def Approve(self, value):

1400

2052

self.approve(value)

1401

2053

1402

2054

# CheckedOK - method

1403

2055

@dbus.service.method(_interface)

1404

2056

def CheckedOK(self):

1405

2057

self.checked_ok()

1406

2058

1407

2059

# Enable - method

2060

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

1408

2061

@dbus.service.method(_interface)

1409

2062

def Enable(self):

1410

2063

"D-Bus method"

1411

2064

self.enable()

1412

2065

1413

2066

# StartChecker - method

2067

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

1414

2068

@dbus.service.method(_interface)

1415

2069

def StartChecker(self):

1416

2070

"D-Bus method"

1417

2071

self.start_checker()

1418

2072

1419

2073

# Disable - method

2074

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

1420

2075

@dbus.service.method(_interface)

1421

2076

def Disable(self):

1422

2077

"D-Bus method"

1423

2078

self.disable()

1424

2079

1425

2080

# StopChecker - method

2081

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

1426

2082

@dbus.service.method(_interface)

1427

2083

def StopChecker(self):

1428

2084

self.stop_checker()

1429

1430

## Properties

1431

2085

2086

# Properties

2087

1432

2088

# ApprovalPending - property

1433

2089

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

1434

2090

def ApprovalPending_dbus_property(self):

1435

2091

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

1436

2092

1437

2093

# ApprovedByDefault - property

1438

@dbus_service_property(_interface, signature="b",

2094

@dbus_service_property(_interface,

2095

signature="b",

1439

2096

access="readwrite")

1440

2097

def ApprovedByDefault_dbus_property(self, value=None):

1441

2098

if value is None: # get

1442

2099

return dbus.Boolean(self.approved_by_default)

1443

2100

self.approved_by_default = bool(value)

1444

2101

1445

2102

# ApprovalDelay - property

1446

@dbus_service_property(_interface, signature="t",

2103

@dbus_service_property(_interface,

2104

signature="t",

1447

2105

access="readwrite")

1448

2106

def ApprovalDelay_dbus_property(self, value=None):

1449

2107

if value is None: # get

1450

return dbus.UInt64(self.approval_delay_milliseconds())

2108

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

2109

* 1000)

1451

2110

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

1452

2111

1453

2112

# ApprovalDuration - property

1454

@dbus_service_property(_interface, signature="t",

2113

@dbus_service_property(_interface,

2114

signature="t",

1455

2115

access="readwrite")

1456

2116

def ApprovalDuration_dbus_property(self, value=None):

1457

2117

if value is None: # get

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

2118

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

2119

* 1000)

1460

2120

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

1461

2121

1462

2122

# Name - property

2123

@dbus_annotations(

2124

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

1463

2125

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

1464

2126

def Name_dbus_property(self):

1465

2127

return dbus.String(self.name)

1466

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1467

2136

# Fingerprint - property

2137

@dbus_annotations(

2138

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

1468

2139

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

1469

2140

def Fingerprint_dbus_property(self):

1470

2141

return dbus.String(self.fingerprint)

1471

2142

1472

2143

# Host - property

1473

@dbus_service_property(_interface, signature="s",

2144

@dbus_service_property(_interface,

2145

signature="s",

1474

2146

access="readwrite")

1475

2147

def Host_dbus_property(self, value=None):

1476

2148

if value is None: # get

1477

2149

return dbus.String(self.host)

1478

self.host = unicode(value)

1479

2150

self.host = str(value)

2151

1480

2152

# Created - property

2153

@dbus_annotations(

2154

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

1481

2155

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

1482

2156

def Created_dbus_property(self):

1483

2157

return datetime_to_dbus(self.created)

1484

2158

1485

2159

# LastEnabled - property

1486

2160

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

1487

2161

def LastEnabled_dbus_property(self):

1488

2162

return datetime_to_dbus(self.last_enabled)

1489

2163

1490

2164

# Enabled - property

1491

@dbus_service_property(_interface, signature="b",

2165

@dbus_service_property(_interface,

2166

signature="b",

1492

2167

access="readwrite")

1493

2168

def Enabled_dbus_property(self, value=None):

1494

2169

if value is None: # get

1497

2172

self.enable()

1498

2173

else:

1499

2174

self.disable()

1500

2175

1501

2176

# LastCheckedOK - property

1502

@dbus_service_property(_interface, signature="s",

2177

@dbus_service_property(_interface,

2178

signature="s",

1503

2179

access="readwrite")

1504

2180

def LastCheckedOK_dbus_property(self, value=None):

1505

2181

if value is not None:

1506

2182

self.checked_ok()

1507

2183

return

1508

2184

return datetime_to_dbus(self.last_checked_ok)

1509

2185

1510

2186

# LastCheckerStatus - property

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

2187

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

1513

2188

def LastCheckerStatus_dbus_property(self):

1514

2189

return dbus.Int16(self.last_checker_status)

1515

2190

1516

2191

# Expires - property

1517

2192

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

1518

2193

def Expires_dbus_property(self):

1519

2194

return datetime_to_dbus(self.expires)

1520

2195

1521

2196

# LastApprovalRequest - property

1522

2197

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

1523

2198

def LastApprovalRequest_dbus_property(self):

1524

2199

return datetime_to_dbus(self.last_approval_request)

1525

2200

1526

2201

# Timeout - property

1527

@dbus_service_property(_interface, signature="t",

2202

@dbus_service_property(_interface,

2203

signature="t",

1528

2204

access="readwrite")

1529

2205

def Timeout_dbus_property(self, value=None):

1530

2206

if value is None: # get

1531

return dbus.UInt64(self.timeout_milliseconds())

2207

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

2208

old_timeout = self.timeout

1532

2209

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

1533

# Reschedule timeout

2210

# Reschedule disabling

1534

2211

if self.enabled:

1535

2212

now = datetime.datetime.utcnow()

1536

time_to_die = timedelta_to_milliseconds(

1537

(self.last_checked_ok + self.timeout) - now)

1538

if time_to_die <= 0:

2213

self.expires += self.timeout - old_timeout

2214

if self.expires <= now:

1539

2215

# The timeout has passed

1540

2216

self.disable()

1541

2217

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

1545

2218

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

1546

2219

is None):

1547

2220

return

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1552

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2223

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

2224

self.disable)

2225

1553

2226

# ExtendedTimeout - property

1554

@dbus_service_property(_interface, signature="t",

2227

@dbus_service_property(_interface,

2228

signature="t",

1555

2229

access="readwrite")

1556

2230

def ExtendedTimeout_dbus_property(self, value=None):

1557

2231

if value is None: # get

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2232

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

2233

* 1000)

1559

2234

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

1560

2235

1561

2236

# Interval - property

1562

@dbus_service_property(_interface, signature="t",

2237

@dbus_service_property(_interface,

2238

signature="t",

1563

2239

access="readwrite")

1564

2240

def Interval_dbus_property(self, value=None):

1565

2241

if value is None: # get

1566

return dbus.UInt64(self.interval_milliseconds())

2242

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

1567

2243

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

1568

2244

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

1569

2245

return

1570

2246

if self.enabled:

1571

2247

# Reschedule checker run

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2250

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1577

2253

# Checker - property

1578

@dbus_service_property(_interface, signature="s",

2254

@dbus_service_property(_interface,

2255

signature="s",

1579

2256

access="readwrite")

1580

2257

def Checker_dbus_property(self, value=None):

1581

2258

if value is None: # get

1582

2259

return dbus.String(self.checker_command)

1583

self.checker_command = unicode(value)

1584

2260

self.checker_command = str(value)

2261

1585

2262

# CheckerRunning - property

1586

@dbus_service_property(_interface, signature="b",

2263

@dbus_service_property(_interface,

2264

signature="b",

1587

2265

access="readwrite")

1588

2266

def CheckerRunning_dbus_property(self, value=None):

1589

2267

if value is None: # get

1592

2270

self.start_checker()

1593

2271

else:

1594

2272

self.stop_checker()

1595

2273

1596

2274

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

1597

2278

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

1598

2279

def ObjectPath_dbus_property(self):

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1601

2282

# Secret = property

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2283

@dbus_annotations(

2284

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

2285

"invalidates"})

2286

@dbus_service_property(_interface,

2287

signature="ay",

2288

access="write",

2289

byte_arrays=True)

1604

2290

def Secret_dbus_property(self, value):

1605

self.secret = str(value)

1606

2291

self.secret = bytes(value)

2292

1607

2293

del _interface

1608

2294

1609

2295

1610

class ProxyClient(object):

1611

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

2296

class ProxyClient:

2297

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

1612

2298

self._pipe = child_pipe

1613

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

2299

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

1614

2300

if not self._pipe.recv():

1615

raise KeyError()

1616

2301

raise KeyError(key_id or fpr)

2302

1617

2303

def __getattribute__(self, name):

1618

if name == '_pipe':

2304

if name == "_pipe":

1619

2305

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

1620

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

2306

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

1621

2307

data = self._pipe.recv()

1622

if data[0] == 'data':

2308

if data[0] == "data":

1623

2309

return data[1]

1624

if data[0] == 'function':

2310

if data[0] == "function":

2311

1625

2312

def func(*args, **kwargs):

1626

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

2313

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

1627

2314

return self._pipe.recv()[1]

2315

1628

2316

return func

1629

2317

1630

2318

def __setattr__(self, name, value):

1631

if name == '_pipe':

2319

if name == "_pipe":

1632

2320

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

1633

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

2321

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

1634

2322

1635

2323

1636

2324

class ClientHandler(socketserver.BaseRequestHandler, object):

1637

2325

"""A class to handle client connections.

1638

2326

1639

2327

Instantiated once for each connection to handle it.

1640

2328

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

1641

2329

1642

2330

def handle(self):

1643

2331

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

1644

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

1645

unicode(self.client_address))

1646

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

1647

self.server.child_pipe.fileno())

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2332

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

2333

str(self.client_address))

2334

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

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1663

2342

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

1664

2343

priority = self.server.gnutls_priority

1665

2344

if priority is None:

1666

2345

priority = "NORMAL"

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2346

gnutls.priority_set_direct(session,

2347

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

2348

1671

2349

# Start communication using the Mandos protocol

1672

2350

# Get protocol number

1673

2351

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

1674

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

2352

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

1675

2353

try:

1676

2354

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

1677

raise RuntimeError

2355

raise RuntimeError(line)

1678

2356

except (ValueError, IndexError, RuntimeError) as error:

1679

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

2357

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

1680

2358

return

1681

2359

1682

2360

# Start GnuTLS connection

1683

2361

try:

1684

2362

session.handshake()

1685

except gnutls.errors.GNUTLSError as error:

1686

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

2363

except gnutls.Error as error:

2364

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

1687

2365

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

1688

2366

# established. Just abandon the request.

1689

2367

return

1690

logger.debug("Handshake succeeded")

1691

2368

log.debug("Handshake succeeded")

2369

1692

2370

approval_required = False

1693

2371

try:

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1705

2396

self.client_address)

1706

2397

except KeyError:

1707

2398

return

1708

2399

1709

2400

if client.approval_delay:

1710

2401

delay = client.approval_delay

1711

2402

client.approvals_pending += 1

1712

2403

approval_required = True

1713

2404

1714

2405

while True:

1715

2406

if not client.enabled:

1716

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

1717

client.name)

2407

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

1718

2408

if self.server.use_dbus:

1719

2409

# Emit D-Bus signal

1720

2410

client.Rejected("Disabled")

1721

2411

return

1722

2412

1723

2413

if client.approved or not client.approval_delay:

1724

#We are approved or approval is disabled

2414

# We are approved or approval is disabled

1725

2415

break

1726

2416

elif client.approved is None:

1727

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

2417

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

2418

client.name)

2419

if self.server.use_dbus:

2420

# Emit D-Bus signal

2421

client.NeedApproval(

2422

client.approval_delay.total_seconds()

2423

* 1000, client.approved_by_default)

2424

else:

2425

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

1728

2426

client.name)

1729

2427

if self.server.use_dbus:

1730

2428

# Emit D-Bus signal

1731

client.NeedApproval(

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

1734

else:

1735

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

1736

client.name)

1737

if self.server.use_dbus:

1738

# Emit D-Bus signal

1739

2429

client.Rejected("Denied")

1740

2430

return

1741

1742

#wait until timeout or approved

2431

2432

# wait until timeout or approved

1743

2433

time = datetime.datetime.now()

1744

2434

client.changedstate.acquire()

1745

(client.changedstate.wait

1746

(float(client.timedelta_to_milliseconds(delay)

1747

/ 1000)))

2435

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

1748

2436

client.changedstate.release()

1749

2437

time2 = datetime.datetime.now()

1750

2438

if (time2 - time) >= delay:

1751

2439

if not client.approved_by_default:

1752

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

1753

" waiting for approval",

1754

client.name)

2440

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

2441

" waiting for approval",

2442

client.name)

1755

2443

if self.server.use_dbus:

1756

2444

# Emit D-Bus signal

1757

2445

client.Rejected("Approval timed out")

1760

2448

break

1761

2449

else:

1762

2450

delay -= time2 - time

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

1777

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

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

1778

2459

# bump the timeout using extended_timeout

1779

2460

client.bump_timeout(client.extended_timeout)

1780

2461

if self.server.use_dbus:

1781

2462

# Emit D-Bus signal

1782

2463

client.GotSecret()

1783

2464

1784

2465

finally:

1785

2466

if approval_required:

1786

2467

client.approvals_pending -= 1

1787

2468

try:

1788

2469

session.bye()

1789

except gnutls.errors.GNUTLSError as error:

1790

logger.warning("GnuTLS bye failed",

1791

exc_info=error)

1792

2470

except gnutls.Error as error:

2471

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

2472

1793

2473

@staticmethod

1794

2474

def peer_certificate(session):

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1802

2491

list_size = ctypes.c_uint(1)

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

1805

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

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1806

2494

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

1807

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

1808

" certificate")

2495

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

1809

2496

if list_size.value == 0:

1810

2497

return None

1811

2498

cert = cert_list[0]

1812

2499

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

1813

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

1814

2536

@staticmethod

1815

2537

def fingerprint(openpgp):

1816

2538

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1817

2539

# New GnuTLS "datum" with the OpenPGP public key

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2540

datum = gnutls.datum_t(

2541

ctypes.cast(ctypes.c_char_p(openpgp),

2542

ctypes.POINTER(ctypes.c_ubyte)),

2543

ctypes.c_uint(len(openpgp)))

1823

2544

# New empty GnuTLS certificate

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1827

2547

# Import the OpenPGP public key into the certificate

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1832

2550

# Verify the self signature in the key

1833

2551

crtverify = ctypes.c_uint()

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1837

2554

if crtverify.value != 0:

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1841

2558

# New buffer for the fingerprint

1842

2559

buf = ctypes.create_string_buffer(20)

1843

2560

buf_len = ctypes.c_size_t()

1844

2561

# Get the fingerprint from the certificate into the buffer

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2562

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

2563

ctypes.byref(buf_len))

1848

2564

# Deinit the certificate

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2565

gnutls.openpgp_crt_deinit(crt)

1850

2566

# Convert the buffer to a Python bytestring

1851

2567

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

1852

2568

# Convert the bytestring to hexadecimal notation

1854

2570

return hex_fpr

1855

2571

1856

2572

1857

class MultiprocessingMixIn(object):

2573

class MultiprocessingMixIn:

1858

2574

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

2575

1859

2576

def sub_process_main(self, request, address):

1860

2577

try:

1861

2578

self.finish_request(request, address)

1862

2579

except Exception:

1863

2580

self.handle_error(request, address)

1864

2581

self.close_request(request)

1865

2582

1866

2583

def process_request(self, request, address):

1867

2584

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

1868

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

1869

args = (request, address))

2585

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

2586

args=(request, address))

1870

2587

proc.start()

1871

2588

return proc

1872

2589

1873

2590

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1875

2592

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

2593

1876

2594

def process_request(self, request, client_address):

1877

2595

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

1878

2596

1879

2597

This function creates a new pipe in self.pipe

1880

2598

"""

1881

2599

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1882

2600

1883

2601

proc = MultiprocessingMixIn.process_request(self, request,

1884

2602

client_address)

1885

2603

self.child_pipe.close()

1886

2604

self.add_pipe(parent_pipe, proc)

1887

2605

1888

2606

def add_pipe(self, parent_pipe, proc):

1889

2607

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

1890

raise NotImplementedError

2608

raise NotImplementedError()

1891

2609

1892

2610

1893

2611

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1894

socketserver.TCPServer, object):

1895

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

1896

2612

socketserver.TCPServer):

2613

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

2614

1897

2615

Attributes:

1898

2616

enabled: Boolean; whether this server is activated yet

1899

2617

interface: None or a network interface name (string)

1900

2618

use_ipv6: Boolean; to use IPv6 or not

1901

2619

"""

2620

1902

2621

def __init__(self, server_address, RequestHandlerClass,

1903

interface=None, use_ipv6=True):

2622

interface=None,

2623

use_ipv6=True,

2624

socketfd=None):

2625

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

2626

creating a new one with socket.socket().

2627

"""

1904

2628

self.interface = interface

1905

2629

if use_ipv6:

1906

2630

self.address_family = socket.AF_INET6

2631

if socketfd is not None:

2632

# Save the file descriptor

2633

self.socketfd = socketfd

2634

# Save the original socket.socket() function

2635

self.socket_socket = socket.socket

2636

2637

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

2638

#

2639

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

2640

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

2641

# patching socket.socket.)

2642

#

2643

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

2644

@functools.wraps(socket.socket)

2645

def socket_wrapper(*args, **kwargs):

2646

# Restore original function so subsequent calls are

2647

# not affected.

2648

socket.socket = self.socket_socket

2649

del self.socket_socket

2650

# This time only, return a new socket object from the

2651

# saved file descriptor.

2652

return socket.fromfd(self.socketfd, *args, **kwargs)

2653

# Replace socket.socket() function with wrapper

2654

socket.socket = socket_wrapper

2655

# The socketserver.TCPServer.__init__ will call

2656

# socket.socket(), which might be our replacement,

2657

# socket_wrapper(), if socketfd was set.

1907

2658

socketserver.TCPServer.__init__(self, server_address,

1908

2659

RequestHandlerClass)

2660

1909

2661

def server_bind(self):

1910

2662

"""This overrides the normal server_bind() function

1911

2663

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

1912

2664

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

2665

global SO_BINDTODEVICE

1913

2666

if self.interface is not None:

1914

2667

if SO_BINDTODEVICE is None:

1915

logger.error("SO_BINDTODEVICE does not exist;"

1916

" cannot bind to interface %s",

1917

self.interface)

1918

else:

1919

try:

1920

self.socket.setsockopt(socket.SOL_SOCKET,

1921

SO_BINDTODEVICE,

1922

str(self.interface

1923

+ '\0'))

1924

except socket.error as error:

1925

if error[0] == errno.EPERM:

1926

logger.error("No permission to"

1927

" bind to interface %s",

1928

self.interface)

1929

elif error[0] == errno.ENOPROTOOPT:

1930

logger.error("SO_BINDTODEVICE not available;"

1931

" cannot bind to interface %s",

1932

self.interface)

1933

else:

1934

raise

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

1935

2688

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

1936

2689

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

1937

2692

if not self.server_address[0]:

1938

2693

if self.address_family == socket.AF_INET6:

1939

any_address = "::" # in6addr_any

2694

any_address = "::" # in6addr_any

1940

2695

else:

1941

any_address = socket.INADDR_ANY

2696

any_address = "0.0.0.0" # INADDR_ANY

1942

2697

self.server_address = (any_address,

1943

2698

self.server_address[1])

1944

2699

elif not self.server_address[1]:

1945

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

1946

0)

2700

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

1947

2701

# if self.interface:

1948

2702

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

1949

2703

# 0, # port

1955

2709

1956

2710

class MandosServer(IPv6_TCPServer):

1957

2711

"""Mandos server.

1958

2712

1959

2713

Attributes:

1960

2714

clients: set of Client objects

1961

2715

gnutls_priority GnuTLS priority string

1962

2716

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

1963

1964

Assumes a gobject.MainLoop event loop.

2717

2718

Assumes a GLib.MainLoop event loop.

1965

2719

"""

2720

1966

2721

def __init__(self, server_address, RequestHandlerClass,

1967

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

1968

gnutls_priority=None, use_dbus=True):

2722

interface=None,

2723

use_ipv6=True,

2724

clients=None,

2725

gnutls_priority=None,

2726

use_dbus=True,

2727

socketfd=None):

1969

2728

self.enabled = False

1970

2729

self.clients = clients

1971

2730

if self.clients is None:

1974

2733

self.gnutls_priority = gnutls_priority

1975

2734

IPv6_TCPServer.__init__(self, server_address,

1976

2735

RequestHandlerClass,

1977

interface = interface,

1978

use_ipv6 = use_ipv6)

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

1979

2740

def server_activate(self):

1980

2741

if self.enabled:

1981

2742

return socketserver.TCPServer.server_activate(self)

1982

2743

1983

2744

def enable(self):

1984

2745

self.enabled = True

1985

2746

1986

2747

def add_pipe(self, parent_pipe, proc):

1987

2748

# Call "handle_ipc" for both data and EOF events

1988

gobject.io_add_watch(parent_pipe.fileno(),

1989

gobject.IO_IN | gobject.IO_HUP,

1990

functools.partial(self.handle_ipc,

1991

parent_pipe =

1992

parent_pipe,

1993

proc = proc))

1994

1995

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

1996

proc = None, client_object=None):

2749

GLib.io_add_watch(

2750

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

2751

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

2752

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2756

def handle_ipc(self, source, condition,

2757

parent_pipe=None,

2758

proc=None,

2759

client_object=None):

1997

2760

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

1998

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

2761

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

1999

2762

# Wait for other process to exit

2000

2763

proc.join()

2001

2764

return False

2002

2765

2003

2766

# Read a request from the child

2004

2767

request = parent_pipe.recv()

2005

2768

command = request[0]

2006

2007

if command == 'init':

2008

fpr = request[1]

2009

address = request[2]

2010

2011

for c in self.clients.itervalues():

2012

if c.fingerprint == fpr:

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2013

2783

client = c

2014

2784

break

2015

2785

else:

2016

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

2017

"dress: %s", fpr, address)

2786

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

2787

" %s", key_id or fpr, address)

2018

2788

if self.use_dbus:

2019

2789

# Emit D-Bus signal

2020

mandos_dbus_service.ClientNotFound(fpr,

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2021

2791

address[0])

2022

2792

parent_pipe.send(False)

2023

2793

return False

2024

2025

gobject.io_add_watch(parent_pipe.fileno(),

2026

gobject.IO_IN | gobject.IO_HUP,

2027

functools.partial(self.handle_ipc,

2028

parent_pipe =

2029

parent_pipe,

2030

proc = proc,

2031

client_object =

2032

client))

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2798

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2033

2802

parent_pipe.send(True)

2034

2803

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

2035

2804

# same fileno

2036

2805

return False

2037

if command == 'funcall':

2806

if command == "funcall":

2038

2807

funcname = request[1]

2039

2808

args = request[2]

2040

2809

kwargs = request[3]

2041

2042

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

2810

2811

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

2043

2812

funcname)(*args,

2044

**kwargs)))

2045

2046

if command == 'getattr':

2813

**kwargs)))

2814

2815

if command == "getattr":

2047

2816

attrname = request[1]

2048

if callable(client_object.__getattribute__(attrname)):

2049

parent_pipe.send(('function',))

2817

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2050

2820

else:

2051

parent_pipe.send(('data', client_object

2052

.__getattribute__(attrname)))

2053

2054

if command == 'setattr':

2821

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2055

2825

attrname = request[1]

2056

2826

value = request[2]

2057

2827

setattr(client_object, attrname, value)

2058

2828

2059

2829

return True

2060

2830

2061

2831

2832

def rfc3339_duration_to_delta(duration):

2833

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

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2851

"""

2852

2853

# Parsing an RFC 3339 duration with regular expressions is not

2854

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

2855

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

2856

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

2857

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

2858

# avoid excessive use of external libraries.

2859

2860

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

2861

Token = collections.namedtuple("Token", (

2862

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

2863

# a "group" containing digits

2864

"value", # datetime.timedelta or None

2865

"followers")) # Tokens valid after this token

2866

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

2867

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

2868

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

2869

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

2870

datetime.timedelta(seconds=1),

2871

frozenset((token_end, )))

2872

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

2873

datetime.timedelta(minutes=1),

2874

frozenset((token_second, token_end)))

2875

token_hour = Token(re.compile(r"(\d+)H"),

2876

datetime.timedelta(hours=1),

2877

frozenset((token_minute, token_end)))

2878

token_time = Token(re.compile(r"T"),

2879

None,

2880

frozenset((token_hour, token_minute,

2881

token_second)))

2882

token_day = Token(re.compile(r"(\d+)D"),

2883

datetime.timedelta(days=1),

2884

frozenset((token_time, token_end)))

2885

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

2886

datetime.timedelta(weeks=4),

2887

frozenset((token_day, token_end)))

2888

token_year = Token(re.compile(r"(\d+)Y"),

2889

datetime.timedelta(weeks=52),

2890

frozenset((token_month, token_end)))

2891

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

2892

datetime.timedelta(weeks=1),

2893

frozenset((token_end, )))

2894

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

2895

frozenset((token_year, token_month,

2896

token_day, token_time,

2897

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2901

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2906

# Loop until end token is found

2907

while found_token is not token_end:

2908

# Search for any currently valid tokens

2909

for token in followers:

2910

match = token.regexp.match(s)

2911

if match is not None:

2912

# Token found

2913

if token.value is not None:

2914

# Value found, parse digits

2915

factor = int(match.group(1), 10)

2916

# Add to value so far

2917

value += factor * token.value

2918

# Strip token from string

2919

s = token.regexp.sub("", s, 1)

2920

# Go to found token

2921

found_token = token

2922

# Set valid next tokens

2923

followers = found_token.followers

2924

break

2925

else:

2926

# No currently valid tokens were found

2927

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

2928

.format(duration))

2929

# End token found

2930

return value

2931

2932

2062

2933

def string_to_delta(interval):

2063

2934

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

2064

2065

>>> string_to_delta('7d')

2066

datetime.timedelta(7)

2067

>>> string_to_delta('60s')

2068

datetime.timedelta(0, 60)

2069

>>> string_to_delta('60m')

2070

datetime.timedelta(0, 3600)

2071

>>> string_to_delta('24h')

2072

datetime.timedelta(1)

2073

>>> string_to_delta('1w')

2074

datetime.timedelta(7)

2075

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

2076

datetime.timedelta(0, 330)

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2077

2948

"""

2949

2950

try:

2951

return rfc3339_duration_to_delta(interval)

2952

except ValueError:

2953

pass

2954

2078

2955

timevalue = datetime.timedelta(0)

2079

2956

for s in interval.split():

2080

2957

try:

2081

suffix = unicode(s[-1])

2958

suffix = s[-1]

2082

2959

value = int(s[:-1])

2083

2960

if suffix == "d":

2084

2961

delta = datetime.timedelta(value)

2091

2968

elif suffix == "w":

2092

2969

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

2093

2970

else:

2094

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

2095

.format(suffix))

2096

except (ValueError, IndexError) as e:

2971

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

2972

except IndexError as e:

2097

2973

raise ValueError(*(e.args))

2098

2974

timevalue += delta

2099

2975

return timevalue

2100

2976

2101

2977

2102

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

2978

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

2103

2979

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

2104

2980

2105

2981

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

2106

2982

if os.fork():

2107

2983

sys.exit()

2115

2991

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

2116

2992

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

2117

2993

raise OSError(errno.ENODEV,

2118

"{0} not a character device"

2994

"{} not a character device"

2119

2995

.format(os.devnull))

2120

2996

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

2121

2997

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

2125

3001

2126

3002

2127

3003

def main():

2128

3004

2129

3005

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

2130

3006

# Parsing of options, both command line and config file

2131

3007

2132

3008

parser = argparse.ArgumentParser()

2133

3009

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

2134

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

3010

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

2135

3011

help="show version number and exit")

2136

3012

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

2137

3013

help="Bind to interface IF")

2143

3019

help="Run self-test")

2144

3020

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

2145

3021

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

2146

" to terminal")

3022

" to terminal", default=None)

2147

3023

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

2148

3024

help="Debug level for stdout output")

2149

3025

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

2156

3032

" files")

2157

3033

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

2158

3034

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

2159

" system bus interface")

3035

" system bus interface", default=None)

2160

3036

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

2161

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

3037

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

3038

default=None)

2162

3039

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

2163

3040

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

2164

" state")

3041

" state", default=None)

3042

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

3043

help="Specify a file descriptor to a network"

3044

" socket to use instead of creating one")

2165

3045

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

2166

3046

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

2167

3047

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

3048

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

3049

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

3050

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

3051

default=None)

3052

2168

3053

options = parser.parse_args()

2169

2170

if options.check:

2171

import doctest

2172

doctest.testmod()

2173

sys.exit()

2174

3054

2175

3055

# Default values for config file for server-global settings

2176

server_defaults = { "interface": "",

2177

"address": "",

2178

"port": "",

2179

"debug": "False",

2180

"priority":

2181

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

2182

"servicename": "Mandos",

2183

"use_dbus": "True",

2184

"use_ipv6": "True",

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

2188

}

2189

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2190

3079

# Parse config file for server-global settings

2191

server_config = configparser.SafeConfigParser(server_defaults)

3080

server_config = configparser.ConfigParser(server_defaults)

2192

3081

del server_defaults

2193

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

2194

"mandos.conf"))

2195

# Convert the SafeConfigParser object to a dict

3082

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

3083

# Convert the ConfigParser object to a dict

2196

3084

server_settings = server_config.defaults()

2197

3085

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

2198

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

3086

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

3087

"foreground", "zeroconf"):

2199

3088

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

2200

3089

option)

2201

3090

if server_settings["port"]:

2202

3091

server_settings["port"] = server_config.getint("DEFAULT",

2203

3092

"port")

3093

if server_settings["socket"]:

3094

server_settings["socket"] = server_config.getint("DEFAULT",

3095

"socket")

3096

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

3097

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

3098

# happen with a supplied network socket.

3099

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

3100

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

3101

["socket"])

2204

3102

del server_config

2205

3103

2206

3104

# Override the settings from the config file with command line

2207

3105

# options, if set.

2208

3106

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

2209

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

2210

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

2211

"statedir"):

3107

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

3108

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

3109

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

2212

3110

value = getattr(options, option)

2213

3111

if value is not None:

2214

3112

server_settings[option] = value

2215

3113

del options

2216

3114

# Force all strings to be unicode

2217

3115

for option in server_settings.keys():

2218

if type(server_settings[option]) is str:

2219

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

3116

if isinstance(server_settings[option], bytes):

3117

server_settings[option] = (server_settings[option]

3118

.decode("utf-8"))

3119

# Force all boolean options to be boolean

3120

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

3121

"foreground", "zeroconf"):

3122

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

3123

# Debug implies foreground

3124

if server_settings["debug"]:

3125

server_settings["foreground"] = True

2220

3126

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

2221

3127

2222

3128

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

2223

3129

3130

if (not server_settings["zeroconf"]

3131

and not (server_settings["port"]

3132

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

3133

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

3134

2224

3135

# For convenience

2225

3136

debug = server_settings["debug"]

2226

3137

debuglevel = server_settings["debuglevel"]

2228

3139

use_ipv6 = server_settings["use_ipv6"]

2229

3140

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

2230

3141

stored_state_file)

2231

3142

foreground = server_settings["foreground"]

3143

zeroconf = server_settings["zeroconf"]

3144

2232

3145

if debug:

2233

3146

initlogger(debug, logging.DEBUG)

2234

3147

else:

2237

3150

else:

2238

3151

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

2239

3152

initlogger(debug, level)

2240

3153

2241

3154

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

2242

syslogger.setFormatter(logging.Formatter

2243

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

2244

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

2245

.format(server_settings

2246

["servicename"])))

2247

3155

syslogger.setFormatter(

3156

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

3157

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

3158

server_settings["servicename"])))

3159

2248

3160

# Parse config file with clients

2249

client_config = configparser.SafeConfigParser(Client

2250

.client_defaults)

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2251

3162

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

2252

3163

"clients.conf"))

2253

3164

2254

3165

global mandos_dbus_service

2255

3166

mandos_dbus_service = None

2256

2257

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

2258

server_settings["port"]),

2259

ClientHandler,

2260

interface=(server_settings["interface"]

2261

or None),

2262

use_ipv6=use_ipv6,

2263

gnutls_priority=

2264

server_settings["priority"],

2265

use_dbus=use_dbus)

2266

if not debug:

2267

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

3167

3168

socketfd = None

3169

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

3170

socketfd = server_settings["socket"]

3171

tcp_server = MandosServer(

3172

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

3173

ClientHandler,

3174

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

3175

use_ipv6=use_ipv6,

3176

gnutls_priority=server_settings["priority"],

3177

use_dbus=use_dbus,

3178

socketfd=socketfd)

3179

if not foreground:

3180

pidfilename = "/run/mandos.pid"

3181

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

3182

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

3183

pidfile = None

2268

3184

try:

2269

pidfile = open(pidfilename, "w")

3185

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

2270

3186

except IOError as e:

2271

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

2272

exc_info=e)

2273

2274

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

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2275

3193

try:

2276

3194

uid = pwd.getpwnam(name).pw_uid

2277

gid = pwd.getpwnam(name).pw_gid

3195

gid = pwd.getpwnam(group).pw_gid

2278

3196

break

2279

3197

except KeyError:

2280

3198

continue

2284

3202

try:

2285

3203

os.setgid(gid)

2286

3204

os.setuid(uid)

3205

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

2287

3206

except OSError as error:

2288

if error[0] != errno.EPERM:

2289

raise error

2290

3207

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

3208

os.strerror(error.errno))

3209

if error.errno != errno.EPERM:

3210

raise

3211

2291

3212

if debug:

2292

3213

# Enable all possible GnuTLS debugging

2293

3214

2294

3215

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

2295

3216

# - GnuTLS manual

2296

gnutls.library.functions.gnutls_global_set_log_level(11)

2297

2298

@gnutls.library.types.gnutls_log_func

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2299

3220

def debug_gnutls(level, string):

2300

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

2301

2302

(gnutls.library.functions

2303

.gnutls_global_set_log_function(debug_gnutls))

2304

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2305

3226

# Redirect stdin so all checkers get /dev/null

2306

3227

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

2307

3228

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

2308

3229

if null > 2:

2309

3230

os.close(null)

2310

3231

2311

3232

# Need to fork before connecting to D-Bus

2312

if not debug:

3233

if not foreground:

2313

3234

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

2314

3235

daemon()

2315

2316

gobject.threads_init()

2317

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2318

3242

global main_loop

2319

3243

# From the Avahi example code

2320

3244

DBusGMainLoop(set_as_default=True)

2321

main_loop = gobject.MainLoop()

3245

main_loop = GLib.MainLoop()

2322

3246

bus = dbus.SystemBus()

2323

3247

# End of Avahi example code

2324

3248

if use_dbus:

2325

3249

try:

2326

3250

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

2327

bus, do_not_queue=True)

2328

old_bus_name = (dbus.service.BusName

2329

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

2330

do_not_queue=True))

2331

except dbus.exceptions.NameExistsException as e:

2332

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

3251

bus,

3252

do_not_queue=True)

3253

old_bus_name = dbus.service.BusName(

3254

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

3255

do_not_queue=True)

3256

except dbus.exceptions.DBusException as e:

3257

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

2333

3258

use_dbus = False

2334

3259

server_settings["use_dbus"] = False

2335

3260

tcp_server.use_dbus = False

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2341

if server_settings["interface"]:

2342

service.interface = (if_nametoindex

2343

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

2344

3261

if zeroconf:

3262

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

3268

if server_settings["interface"]:

3269

service.interface = if_nametoindex(

3270

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

3271

2345

3272

global multiprocessing_manager

2346

3273

multiprocessing_manager = multiprocessing.Manager()

2347

3274

2348

3275

client_class = Client

2349

3276

if use_dbus:

2350

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

2351

3277

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

3278

2352

3279

client_settings = Client.config_parser(client_config)

2353

3280

old_client_settings = {}

2354

3281

clients_data = {}

2355

3282

3283

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

3284

global wnull

3285

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

3286

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

3287

# mode

3288

if debug or not foreground:

3289

wnull.close()

3290

2356

3291

# Get client data and settings from last running state.

2357

3292

if server_settings["restore"]:

2358

3293

try:

2359

3294

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

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2362

3345

os.remove(stored_state_path)

2363

3346

except IOError as e:

2364

3347

if e.errno == errno.ENOENT:

2365

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

2366

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

3348

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

3349

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

2367

3350

else:

2368

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

2369

exc_info=e)

3351

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

3352

exc_info=e)

2370

3353

raise

2371

3354

except EOFError as e:

2372

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

2373

"EOFError:", exc_info=e)

2374

3355

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

3356

exc_info=e)

3357

2375

3358

with PGPEngine() as pgp:

2376

for client_name, client in clients_data.iteritems():

3359

for client_name, client in clients_data.items():

3360

# Skip removed clients

3361

if client_name not in client_settings:

3362

continue

3363

2377

3364

# Decide which value to use after restoring saved state.

2378

3365

# We have three different values: Old config file,

2379

3366

# new config file, and saved state.

2384

3371

# For each value in new config, check if it

2385

3372

# differs from the old config value (Except for

2386

3373

# the "secret" attribute)

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

3374

if (name != "secret"

3375

and (value !=

3376

old_client_settings[client_name][name])):

2390

3377

client[name] = value

2391

3378

except KeyError:

2392

3379

pass

2393

3380

2394

3381

# Clients who has passed its expire date can still be

2395

# enabled if its last checker was successful. Clients

3382

# enabled if its last checker was successful. A Client

2396

3383

# whose checker succeeded before we stored its state is

2397

3384

# assumed to have successfully run all checkers during

2398

3385

# downtime.

2399

3386

if client["enabled"]:

2400

3387

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

2401

3388

if not client["last_checked_ok"]:

2402

logger.warning(

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

2406

3392

client["enabled"] = False

2407

3393

elif client["last_checker_status"] != 0:

2408

logger.warning(

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2413

3398

client["enabled"] = False

2414

3399

else:

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

2418

logger.debug("Last checker succeeded,"

2419

" keeping {0} enabled"

2420

.format(client_name))

3400

client["expires"] = (

3401

datetime.datetime.utcnow()

3402

+ client["timeout"])

3403

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

3404

" enabled", client_name)

2421

3405

try:

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

3406

client["secret"] = pgp.decrypt(

3407

client["encrypted_secret"],

3408

client_settings[client_name]["secret"])

2426

3409

except PGPError:

2427

3410

# If decryption fails, we use secret from new settings

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

3411

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

3412

client_name)

3413

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

3414

["secret"])

3415

2433

3416

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

2434

3417

for client_name in (set(old_client_settings)

2435

3418

- set(client_settings)):

2437

3420

for client_name in (set(client_settings)

2438

3421

- set(old_client_settings)):

2439

3422

clients_data[client_name] = client_settings[client_name]

2440

3423

2441

3424

# Create all client objects

2442

for client_name, client in clients_data.iteritems():

3425

for client_name, client in clients_data.items():

2443

3426

tcp_server.clients[client_name] = client_class(

2444

name = client_name, settings = client)

2445

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2446

3431

if not tcp_server.clients:

2447

logger.warning("No clients defined")

2448

2449

if not debug:

2450

try:

2451

with pidfile:

2452

pid = os.getpid()

2453

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

2454

del pidfile

2455

except IOError:

2456

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

2457

pidfilename, pid)

2458

except NameError:

2459

# "pidfile" was never created

2460

pass

3432

log.warning("No clients defined")

3433

3434

if not foreground:

3435

if pidfile is not None:

3436

pid = os.getpid()

3437

try:

3438

with pidfile:

3439

print(pid, file=pidfile)

3440

except IOError:

3441

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

3442

pidfilename, pid)

3443

del pidfile

2461

3444

del pidfilename

2462

signal.signal(signal.SIGINT, signal.SIG_IGN)

2463

2464

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

2465

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

2466

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2467

3450

if use_dbus:

2468

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

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

3451

3452

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2471

3455

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

3456

2472

3457

def __init__(self):

2473

3458

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

3459

2474

3460

_interface = "se.recompile.Mandos"

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

3461

2482

3462

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

2483

3463

def ClientAdded(self, objpath):

2484

3464

"D-Bus signal"

2485

3465

pass

2486

3466

2487

3467

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

2488

def ClientNotFound(self, fingerprint, address):

3468

def ClientNotFound(self, key_id, address):

2489

3469

"D-Bus signal"

2490

3470

pass

2491

3471

3472

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

3473

"true"})

2492

3474

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

2493

3475

def ClientRemoved(self, objpath, name):

2494

3476

"D-Bus signal"

2495

3477

pass

2496

3478

3479

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

3480

"true"})

2497

3481

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

2498

3482

def GetAllClients(self):

2499

3483

"D-Bus method"

2500

return dbus.Array(c.dbus_object_path

2501

for c in

2502

tcp_server.clients.itervalues())

2503

3484

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2504

3489

@dbus.service.method(_interface,

2505

3490

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

2506

3491

def GetAllClientsWithProperties(self):

2507

3492

"D-Bus method"

2508

3493

return dbus.Dictionary(

2509

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

2510

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

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2511

3497

signature="oa{sv}")

2512

3498

2513

3499

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

2514

3500

def RemoveClient(self, object_path):

2515

3501

"D-Bus method"

2516

for c in tcp_server.clients.itervalues():

3502

for c in tcp_server.clients.values():

2517

3503

if c.dbus_object_path == object_path:

2518

3504

del tcp_server.clients[c.name]

2519

3505

c.remove_from_connection()

2520

# Don't signal anything except ClientRemoved

3506

# Don't signal the disabling

2521

3507

c.disable(quiet=True)

2522

# Emit D-Bus signal

2523

self.ClientRemoved(object_path, c.name)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2524

3510

return

2525

3511

raise KeyError(object_path)

2526

3512

2527

3513

del _interface

2528

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2529

3551

mandos_dbus_service = MandosDBusService()

2530

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2531

3558

def cleanup():

2532

3559

"Cleanup function; run on exit"

2533

service.cleanup()

2534

2535

multiprocessing.active_children()

3560

if zeroconf:

3561

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

2536

3565

if not (tcp_server.clients or client_settings):

2537

3566

return

2538

3567

2539

3568

# Store client before exiting. Secrets are encrypted with key

2540

3569

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

2541

3570

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

2542

3571

clients = {}

2543

3572

with PGPEngine() as pgp:

2544

for client in tcp_server.clients.itervalues():

3573

for client in tcp_server.clients.values():

2545

3574

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

2546

3575

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

2547

3576

key)

2548

3577

client_dict = {}

2549

3578

2550

3579

# A list of attributes that can not be pickled

2551

3580

# + secret.

2552

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

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

3581

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

3582

"checker", "server_settings"}

3583

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

3584

.Object):

2556

3585

exclude.add(name)

2557

3586

2558

3587

client_dict["encrypted_secret"] = (client

2559

3588

.encrypted_secret)

2560

3589

for attr in client.client_structure:

2561

3590

if attr not in exclude:

2562

3591

client_dict[attr] = getattr(client, attr)

2563

3592

2564

3593

clients[client.name] = client_dict

2565

3594

del client_settings[client.name]["secret"]

2566

3595

2567

3596

try:

2568

with (tempfile.NamedTemporaryFile

2569

(mode='wb', suffix=".pickle", prefix='clients-',

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

pickle.dump((clients, client_settings), stored_state)

2573

tempname=stored_state.name

3597

with tempfile.NamedTemporaryFile(

3598

mode="wb",

3599

suffix=".pickle",

3600

prefix="clients-",

3601

dir=os.path.dirname(stored_state_path),

3602

delete=False) as stored_state:

3603

pickle.dump((clients, client_settings), stored_state,

3604

protocol=2)

3605

tempname = stored_state.name

2574

3606

os.rename(tempname, stored_state_path)

2575

3607

except (IOError, OSError) as e:

2576

3608

if not debug:

2579

3611

except NameError:

2580

3612

pass

2581

3613

if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):

2582

logger.warning("Could not save persistent state: {0}"

2583

.format(os.strerror(e.errno)))

3614

log.warning("Could not save persistent state: %s",

3615

os.strerror(e.errno))

2584

3616

else:

2585

logger.warning("Could not save persistent state:",

2586

exc_info=e)

2587

raise e

2588

3617

log.warning("Could not save persistent state:",

3618

exc_info=e)

3619

raise

3620

2589

3621

# Delete all clients, and settings from config

2590

3622

while tcp_server.clients:

2591

3623

name, client = tcp_server.clients.popitem()

2592

3624

if use_dbus:

2593

3625

client.remove_from_connection()

2594

# Don't signal anything except ClientRemoved

3626

# Don't signal the disabling

2595

3627

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

2596

3629

if use_dbus:

2597

# Emit D-Bus signal

2598

mandos_dbus_service.ClientRemoved(client

2599

.dbus_object_path,

2600

client.name)

3630

mandos_dbus_service.client_removed_signal(client)

2601

3631

client_settings.clear()

2602

3632

2603

3633

atexit.register(cleanup)

2604

2605

for client in tcp_server.clients.itervalues():

3634

3635

for client in tcp_server.clients.values():

2606

3636

if use_dbus:

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2609

3639

# Need to initiate checking of clients

2610

3640

if client.enabled:

2611

client.init_checker()

2612

3641

client.init_checker(randomize_start=True)

3642

2613

3643

tcp_server.enable()

2614

3644

tcp_server.server_activate()

2615

3645

2616

3646

# Find out what port we got

2617

service.port = tcp_server.socket.getsockname()[1]

3647

if zeroconf:

3648

service.port = tcp_server.socket.getsockname()[1]

2618

3649

if use_ipv6:

2619

logger.info("Now listening on address %r, port %d,"

2620

" flowinfo %d, scope_id %d",

2621

*tcp_server.socket.getsockname())

3650

log.info("Now listening on address %r, port %d, flowinfo %d,"

3651

" scope_id %d", *tcp_server.socket.getsockname())

2622

3652

else: # IPv4

2623

logger.info("Now listening on address %r, port %d",

2624

*tcp_server.socket.getsockname())

2625

2626

#service.interface = tcp_server.socket.getsockname()[3]

2627

3653

log.info("Now listening on address %r, port %d",

3654

*tcp_server.socket.getsockname())

3655

3656

# service.interface = tcp_server.socket.getsockname()[3]

3657

2628

3658

try:

2629

# From the Avahi example code

2630

try:

2631

service.activate()

2632

except dbus.exceptions.DBusException as error:

2633

logger.critical("D-Bus Exception", exc_info=error)

2634

cleanup()

2635

sys.exit(1)

2636

# End of Avahi example code

2637

2638

gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,

2639

lambda *args, **kwargs:

2640

(tcp_server.handle_request

2641

(*args[2:], **kwargs) or True))

2642

2643

logger.debug("Starting main loop")

3659

if zeroconf:

3660

# From the Avahi example code

3661

try:

3662

service.activate()

3663

except dbus.exceptions.DBusException as error:

3664

log.critical("D-Bus Exception", exc_info=error)

3665

cleanup()

3666

sys.exit(1)

3667

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

GLib.IOChannel.unix_new(tcp_server.fileno()),

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

lambda *args, **kwargs: (tcp_server.handle_request

3673

(*args[2:], **kwargs) or True))

3674

3675

log.debug("Starting main loop")

2644

3676

main_loop.run()

2645

3677

except AvahiError as error:

2646

logger.critical("Avahi Error", exc_info=error)

3678

log.critical("Avahi Error", exc_info=error)

2647

3679

cleanup()

2648

3680

sys.exit(1)

2649

3681

except KeyboardInterrupt:

2650

3682

if debug:

2651

3683

print("", file=sys.stderr)

2652

logger.debug("Server received KeyboardInterrupt")

2653

logger.debug("Server exiting")

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2654

3686

# Must run before the D-Bus bus name gets deregistered

2655

3687

cleanup()

2656

3688

2657

if __name__ == '__main__':

2658

main()

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

parser.add_argument("--check", action="store_true")

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

if not (unittest.main(argv=[""], exit=False)

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

# Call using ./scriptname --test [--verbose]

3719

unittest.main(argv=[""], testLoader=ExtraTestLoader())

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

# (if (not (funcall run-tests-in-test-buffer default-directory

3731

# extra))

3732

# (funcall show-test-buffer-in-test-window)

3733

# (funcall remove-test-window)

3734

# (if extra (message "Extra tests run successfully!"))))

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

# (with-current-buffer (get-buffer-create "*Test*")

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

# (let ((inhibit-read-only t))

3744

# (process-file-shell-command

3745

# (funcall get-command-line extra) nil "*Test*"))))

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

# (shell-quote-argument (funcall get-script-name))))

3752

# (format

3753

# (concat "%s --check" (if extra " --prefix=atest" ""))

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

# (if (fboundp 'file-local-name)

3758

# (file-local-name (buffer-file-name))

3759

# (or (file-remote-p (buffer-file-name) 'localname)

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

# (let ((test-window (get-buffer-window "*Test*")))

3764

# (if test-window (delete-window test-window))))

3765

# show-test-buffer-in-test-window:

3766

# (lambda ()

3767

# (when (not (get-buffer-window-list "*Test*"))

3768

# (setq next-error-last-buffer (get-buffer "*Test*"))

3769

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3770

# (display-buffer-overriding-action

3771

# `((display-buffer-in-side-window) (side . ,side)

3772

# (window-height . fit-window-to-buffer)

3773

# (window-width . fit-window-to-buffer))))

3774

# (display-buffer "*Test*"))))

3775

# eval:

3776

# (progn

3777

# (let* ((run-extra-tests (lambda () (interactive)

3778

# (funcall run-tests t)))

3779

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3780

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3781

# (setq minor-mode-overriding-map-alist

3782

# (cons `(run-tests . ,outer-keymap)

3783

# minor-mode-overriding-map-alist)))

3784

# (add-hook 'after-save-hook run-tests 90 t))

3785

# End: