/mandos/release : revision 237.7.816

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

from future_builtins import *

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

38

41

39

import SocketServer as socketserver

42

import sys

43

import unittest

44

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

40

51

import socket

41

import argparse

42

52

import datetime

43

53

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

52

58

import re

53

import os

54

59

import signal

55

60

import subprocess

56

61

import atexit

57

62

import stat

58

import logging

59

63

import logging.handlers

60

64

import pwd

61

65

import contextlib

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

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

92

147

stored_state_file = "clients.pickle"

93

148

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

149

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

150

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

151

syslogger = None

98

152

99

153

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

103

156

except (OSError, AttributeError):

157

104

158

def if_nametoindex(interface):

105

159

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

106

160

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

107

161

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

108

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

163

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

164

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

113

165

return interface_index

114

166

115

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

116

184

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

117

185

"""init logger and add loglevel"""

118

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

syslogger.setFormatter(logging.Formatter

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

124

196

if debug:

125

197

console = logging.StreamHandler()

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

132

204

133

205

134

206

class PGPError(Exception):

136

208

pass

137

209

138

210

139

class PGPEngine(object):

211

class PGPEngine:

140

212

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

213

141

214

def __init__(self):

142

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

382

522

383

523

class AvahiServiceToSyslog(AvahiService):

384

def rename(self):

524

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

385

525

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

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

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

391

531

return ret

392

532

393

533

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

399

400

401

class Client(object):

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

402

875

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

403

876

404

877

Attributes:

405

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

878

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

406

879

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

407

880

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

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

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

412

885

checker_command: string; External command which is run to check

413

886

if client lives. %() expansions are done at

414

887

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

415

888

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

416

checker_initiator_tag: a gobject event source tag, or None

889

checker_initiator_tag: a GLib event source tag, or None

417

890

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

418

891

client_structure: Object describing what attributes a client has

419

892

and is used for storing the client at exit

420

893

current_checker_command: string; current running checker_command

421

disable_initiator_tag: a gobject event source tag, or None

894

disable_initiator_tag: a GLib event source tag, or None

422

895

enabled: bool()

423

896

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

424

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

425

900

host: string; available for use by the checker command

426

901

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

427

902

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

429

904

last_checker_status: integer between 0 and 255 reflecting exit

430

905

status of last checker. -1 reflects crashed

431

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

432

909

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

433

910

434

911

D-Bus identifiers

439

916

runtime_expansions: Allowed attributes for runtime expansion.

440

917

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

441

918

disabled, or None

919

server_settings: The server_settings dict from main()

442

920

"""

443

921

444

922

runtime_expansions = ("approval_delay", "approval_duration",

445

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

923

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

446

924

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

447

925

"last_approval_request", "last_checked_ok",

448

926

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

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

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

475

939

@staticmethod

476

940

def config_parser(config):

477

941

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

484

948

for client_name in config.sections():

485

949

section = dict(config.items(client_name))

486

950

client = settings[client_name] = {}

487

951

488

952

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

489

953

# Reformat values from string types to Python types

490

954

client["approved_by_default"] = config.getboolean(

491

955

client_name, "approved_by_default")

492

956

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

493

957

"enabled")

494

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

495

964

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

496

965

.replace(" ", ""))

497

966

if "secret" in section:

498

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

967

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

968

.encode("utf-8"),

969

"base64")

499

970

elif "secfile" in section:

500

971

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

501

972

(section["secfile"])),

502

973

"rb") as secfile:

503

974

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

504

975

else:

505

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

976

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

506

977

.format(section))

507

978

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

508

979

client["extended_timeout"] = string_to_delta(

516

987

client["last_approval_request"] = None

517

988

client["last_checked_ok"] = None

518

989

client["last_checker_status"] = -2

519

990

520

991

return settings

521

522

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

992

993

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

523

994

self.name = name

995

if server_settings is None:

996

server_settings = {}

997

self.server_settings = server_settings

524

998

# adding all client settings

525

for setting, value in settings.iteritems():

999

for setting, value in settings.items():

526

1000

setattr(self, setting, value)

527

1001

528

1002

if self.enabled:

529

1003

if not hasattr(self, "last_enabled"):

530

1004

self.last_enabled = datetime.datetime.utcnow()

534

1008

else:

535

1009

self.last_enabled = None

536

1010

self.expires = None

537

538

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

542

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

1011

1012

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

1013

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

1014

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

543

1015

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

544

1016

datetime.datetime.utcnow())

545

1017

546

1018

# attributes specific for this server instance

547

1019

self.checker = None

548

1020

self.checker_initiator_tag = None

551

1023

self.current_checker_command = None

552

1024

self.approved = None

553

1025

self.approvals_pending = 0

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

559

1030

if not attr.startswith("_")]

560

1031

self.client_structure.append("client_structure")

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

1032

1033

for name, t in inspect.getmembers(

1034

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

566

1035

if not name.startswith("_"):

567

1036

self.client_structure.append(name)

568

1037

569

1038

# Send notice to process children that client state has changed

570

1039

def send_changedstate(self):

571

1040

with self.changedstate:

572

1041

self.changedstate.notify_all()

573

1042

574

1043

def enable(self):

575

1044

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

576

1045

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

577

1046

# Already enabled

578

1047

return

579

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

580

1048

self.enabled = True

581

1049

self.last_enabled = datetime.datetime.utcnow()

582

1050

self.init_checker()

583

1051

self.send_changedstate()

584

1052

585

1053

def disable(self, quiet=True):

586

1054

"""Disable this client."""

587

1055

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

588

1056

return False

589

1057

if not quiet:

590

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

1058

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

591

1059

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

592

gobject.source_remove(self.disable_initiator_tag)

1060

GLib.source_remove(self.disable_initiator_tag)

593

1061

self.disable_initiator_tag = None

594

1062

self.expires = None

595

1063

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

596

gobject.source_remove(self.checker_initiator_tag)

1064

GLib.source_remove(self.checker_initiator_tag)

597

1065

self.checker_initiator_tag = None

598

1066

self.stop_checker()

599

1067

self.enabled = False

600

1068

if not quiet:

601

1069

self.send_changedstate()

602

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

1070

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

603

1071

return False

604

1072

605

1073

def __del__(self):

606

1074

self.disable()

607

608

def init_checker(self):

609

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

610

# and every interval from then on.

1075

1076

def init_checker(self, randomize_start=False):

1077

# Schedule a new checker to be started a randomly selected

1078

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

1079

# the startup of checkers over time when the server is

1080

# started.

611

1081

if self.checker_initiator_tag is not None:

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

616

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

1082

GLib.source_remove(self.checker_initiator_tag)

1083

interval_milliseconds = int(self.interval.total_seconds()

1084

* 1000)

1085

if randomize_start:

1086

delay_milliseconds = random.randrange(

1087

interval_milliseconds + 1)

1088

else:

1089

delay_milliseconds = interval_milliseconds

1090

self.checker_initiator_tag = GLib.timeout_add(

1091

delay_milliseconds, self.start_checker, randomize_start)

1092

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

1093

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

1094

# expire at the soonest one interval after a checker was

1095

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

1096

# time might have to be extended.

1097

now = datetime.datetime.utcnow()

1098

self.expires = now + delay + self.interval

1099

# Schedule a disable() at expire time

617

1100

if self.disable_initiator_tag is not None:

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

622

# Also start a new checker *right now*.

623

self.start_checker()

624

625

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

1101

GLib.source_remove(self.disable_initiator_tag)

1102

self.disable_initiator_tag = GLib.timeout_add(

1103

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

1104

self.disable)

1105

1106

def checker_callback(self, source, condition, connection,

1107

command):

626

1108

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

1109

# Read return code from connection (see call_pipe)

1110

returncode = connection.recv()

1111

connection.close()

1112

if self.checker is not None:

1113

self.checker.join()

627

1114

self.checker_callback_tag = None

628

1115

self.checker = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1116

1117

if returncode >= 0:

1118

self.last_checker_status = returncode

1119

self.last_checker_signal = None

631

1120

if self.last_checker_status == 0:

632

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

633

vars(self))

1121

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

634

1122

self.checked_ok()

635

1123

else:

636

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

637

vars(self))

1124

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

638

1125

else:

639

1126

self.last_checker_status = -1

640

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

641

vars(self))

642

1127

self.last_checker_signal = -returncode

1128

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

1129

return False

1130

643

1131

def checked_ok(self):

644

1132

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

645

1133

self.last_checked_ok = datetime.datetime.utcnow()

646

1134

self.last_checker_status = 0

1135

self.last_checker_signal = None

647

1136

self.bump_timeout()

648

1137

649

1138

def bump_timeout(self, timeout=None):

650

1139

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

651

1140

if timeout is None:

652

1141

timeout = self.timeout

653

1142

if self.disable_initiator_tag is not None:

654

gobject.source_remove(self.disable_initiator_tag)

1143

GLib.source_remove(self.disable_initiator_tag)

655

1144

self.disable_initiator_tag = None

656

1145

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1146

self.disable_initiator_tag = GLib.timeout_add(

1147

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

660

1148

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

661

1149

662

1150

def need_approval(self):

663

1151

self.last_approval_request = datetime.datetime.utcnow()

664

665

def start_checker(self):

1152

1153

def start_checker(self, start_was_randomized=False):

666

1154

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

667

1155

668

1156

If a checker already exists, leave it running and do

669

1157

nothing."""

670

1158

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

675

1163

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

676

1164

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

677

1165

# should be.

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1166

1167

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

1168

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

1169

self.checker.join()

1170

self.checker = None

692

1171

# Start a new checker if needed

693

1172

if self.checker is None:

694

1173

# Escape attributes for the shell

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1174

escaped_attrs = {

1175

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

1176

for attr in self.runtime_expansions}

699

1177

try:

700

1178

command = self.checker_command % escaped_attrs

701

1179

except TypeError as error:

702

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

703

self.checker_command, exc_info=error)

704

return True # Try again later

1180

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

1181

self.checker_command, exc_info=error)

1182

return True # Try again later

705

1183

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

718

exc_info=error)

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1184

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

1185

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

1186

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

1187

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

1188

# always replaced by /dev/null.)

1189

# The exception is when not debugging but nevertheless

1190

# running in the foreground; use the previously

1191

# created wnull.

1192

popen_args = {"close_fds": True,

1193

"shell": True,

1194

"cwd": "/"}

1195

if (not self.server_settings["debug"]

1196

and self.server_settings["foreground"]):

1197

popen_args.update({"stdout": wnull,

1198

"stderr": wnull})

1199

pipe = multiprocessing.Pipe(duplex=False)

1200

self.checker = multiprocessing.Process(

1201

target=call_pipe,

1202

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

1203

kwargs=popen_args)

1204

self.checker.start()

1205

self.checker_callback_tag = GLib.io_add_watch(

1206

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

1207

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1208

self.checker_callback, pipe[0], command)

1209

if start_was_randomized:

1210

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

1211

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

1212

# interval from then on.

1213

now = datetime.datetime.utcnow()

1214

self.checker_initiator_tag = GLib.timeout_add(

1215

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

1216

self.start_checker)

1217

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

1218

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

1219

return False

1220

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

730

1221

return True

731

1222

732

1223

def stop_checker(self):

733

1224

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

734

1225

if self.checker_callback_tag:

735

gobject.source_remove(self.checker_callback_tag)

1226

GLib.source_remove(self.checker_callback_tag)

736

1227

self.checker_callback_tag = None

737

1228

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

738

1229

return

739

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

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1230

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

1231

self.checker.terminate()

748

1232

self.checker = None

749

1233

750

1234

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1235

def dbus_service_property(dbus_interface,

1236

signature="v",

1237

access="readwrite",

1238

byte_arrays=False):

753

1239

"""Decorators for marking methods of a DBusObjectWithProperties to

754

1240

become properties on the D-Bus.

755

1241

756

1242

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

757

1243

and with one argument by "Set".

758

1244

759

1245

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

760

1246

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

761

1247

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

764

1250

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

765

1251

if byte_arrays and signature != "ay":

766

1252

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

767

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

1253

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

1254

768

1255

def decorator(func):

769

1256

func._dbus_is_property = True

770

1257

func._dbus_interface = dbus_interface

773

1260

func._dbus_name = func.__name__

774

1261

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

775

1262

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

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1263

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

777

1264

return func

1265

778

1266

return decorator

779

1267

780

1268

781

1269

def dbus_interface_annotations(dbus_interface):

782

1270

"""Decorator for marking functions returning interface annotations

783

1271

784

1272

Usage:

785

1273

786

1274

@dbus_interface_annotations("org.example.Interface")

787

1275

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

788

1276

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

789

1277

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

790

1278

"false"}

791

1279

"""

1280

792

1281

def decorator(func):

793

1282

func._dbus_is_interface = True

794

1283

func._dbus_interface = dbus_interface

795

1284

func._dbus_name = dbus_interface

796

1285

return func

1286

797

1287

return decorator

798

1288

799

1289

800

1290

def dbus_annotations(annotations):

801

1291

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

802

1292

Usage:

803

1293

1294

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

1295

"org.freedesktop.DBus.Property."

1296

"EmitsChangedSignal": "false"})

804

1297

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

805

1298

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

809

1299

def Property_dbus_property(self):

810

1300

return dbus.Boolean(False)

1301

1302

See also the DBusObjectWithAnnotations class.

811

1303

"""

1304

812

1305

def decorator(func):

813

1306

func._dbus_annotations = annotations

814

1307

return func

1308

815

1309

return decorator

816

1310

817

1311

818

1312

class DBusPropertyException(dbus.exceptions.DBusException):

819

1313

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

820

1314

"""

821

def __unicode__(self):

822

return unicode(str(self))

1315

pass

823

1316

824

1317

825

1318

class DBusPropertyAccessException(DBusPropertyException):

834

1327

pass

835

1328

836

1329

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1330

class DBusObjectWithAnnotations(dbus.service.Object):

1331

"""A D-Bus object with annotations.

1332

1333

Classes inheriting from this can use the dbus_annotations

1334

decorator to add annotations to methods or signals.

843

1335

"""

844

1336

845

1337

@staticmethod

846

1338

def _is_dbus_thing(thing):

847

1339

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

848

1340

849

1341

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

850

1342

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

851

1343

"""

852

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

1344

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

853

1345

False)

854

1346

855

1347

def _get_all_dbus_things(self, thing):

856

1348

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

857

1349

"""

858

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

859

name),

1350

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

860

1351

athing.__get__(self))

861

1352

for cls in self.__class__.__mro__

862

1353

for name, athing in

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1354

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

1355

1356

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1357

out_signature="s",

1358

path_keyword="object_path",

1359

connection_keyword="connection")

1360

def Introspect(self, object_path, connection):

1361

"""Overloading of standard D-Bus method.

1362

1363

Inserts annotation tags on methods and signals.

1364

"""

1365

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

1366

connection)

1367

try:

1368

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

1369

1370

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

1371

# Add annotation tags

1372

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

1373

for tag in if_tag.getElementsByTagName(typ):

1374

annots = dict()

1375

for name, prop in (self.

1376

_get_all_dbus_things(typ)):

1377

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

1378

and prop._dbus_interface

1379

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

1380

annots.update(getattr(

1381

prop, "_dbus_annotations", {}))

1382

for name, value in annots.items():

1383

ann_tag = document.createElement(

1384

"annotation")

1385

ann_tag.setAttribute("name", name)

1386

ann_tag.setAttribute("value", value)

1387

tag.appendChild(ann_tag)

1388

# Add interface annotation tags

1389

for annotation, value in dict(

1390

itertools.chain.from_iterable(

1391

annotations().items()

1392

for name, annotations

1393

in self._get_all_dbus_things("interface")

1394

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

1395

)).items():

1396

ann_tag = document.createElement("annotation")

1397

ann_tag.setAttribute("name", annotation)

1398

ann_tag.setAttribute("value", value)

1399

if_tag.appendChild(ann_tag)

1400

# Fix argument name for the Introspect method itself

1401

if (if_tag.getAttribute("name")

1402

== dbus.INTROSPECTABLE_IFACE):

1403

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

1404

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

1405

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

1406

if (arg.getAttribute("direction")

1407

== "out"):

1408

arg.setAttribute("name",

1409

"xml_data")

1410

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

1411

document.unlink()

1412

except (AttributeError, xml.dom.DOMException,

1413

xml.parsers.expat.ExpatError) as error:

1414

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

1415

exc_info=error)

1416

return xmlstring

1417

1418

1419

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1420

"""A D-Bus object with properties.

1421

1422

Classes inheriting from this can use the dbus_service_property

1423

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

1424

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

1425

"""

1426

866

1427

def _get_dbus_property(self, interface_name, property_name):

867

1428

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

868

1429

property with the specified name and interface.

869

1430

"""

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1431

for cls in self.__class__.__mro__:

1432

for name, value in inspect.getmembers(

1433

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

874

1434

if (value._dbus_name == property_name

875

1435

and value._dbus_interface == interface_name):

876

1436

return value.__get__(self)

877

1437

878

1438

# No such property

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1439

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

1440

self.dbus_object_path, interface_name, property_name))

1441

1442

@classmethod

1443

def _get_all_interface_names(cls):

1444

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

1445

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

1446

"_dbus_interface", None)

1447

for x in (inspect.getmro(cls))

1448

for attr in dir(x))

1449

if name is not None)

1450

1451

@dbus.service.method(dbus.PROPERTIES_IFACE,

1452

in_signature="ss",

884

1453

out_signature="v")

885

1454

def Get(self, interface_name, property_name):

886

1455

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

892

1461

if not hasattr(value, "variant_level"):

893

1462

return value

894

1463

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

895

1464

896

1465

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

897

1466

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

898

1467

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

904

1473

# The byte_arrays option is not supported yet on

905

1474

# signatures other than "ay".

906

1475

if prop._dbus_signature != "ay":

907

raise ValueError

908

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

909

for byte in value))

1476

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

1477

"'ay' signature {!r}"

1478

.format(prop._dbus_signature))

1479

value = dbus.ByteArray(bytes(value))

910

1480

prop(value)

911

912

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

1481

1482

@dbus.service.method(dbus.PROPERTIES_IFACE,

1483

in_signature="s",

913

1484

out_signature="a{sv}")

914

1485

def GetAll(self, interface_name):

915

1486

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

916

1487

standard.

917

1488

918

1489

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

919

1490

"""

920

1491

properties = {}

930

1501

if not hasattr(value, "variant_level"):

931

1502

properties[name] = value

932

1503

continue

933

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

934

value.variant_level+1)

1504

properties[name] = type(value)(

1505

value, variant_level=value.variant_level + 1)

935

1506

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

936

1507

1508

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

1509

def PropertiesChanged(self, interface_name, changed_properties,

1510

invalidated_properties):

1511

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

1512

standard.

1513

"""

1514

pass

1515

937

1516

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

938

1517

out_signature="s",

939

path_keyword='object_path',

940

connection_keyword='connection')

1518

path_keyword="object_path",

1519

connection_keyword="connection")

941

1520

def Introspect(self, object_path, connection):

942

1521

"""Overloading of standard D-Bus method.

943

1522

944

1523

Inserts property tags and interface annotation tags.

945

1524

"""

946

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

947

connection)

1525

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1526

object_path,

1527

connection)

948

1528

try:

949

1529

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

1530

950

1531

def make_tag(document, name, prop):

951

1532

e = document.createElement("property")

952

1533

e.setAttribute("name", name)

953

1534

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

954

1535

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

955

1536

return e

1537

956

1538

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

957

1539

# Add property tags

958

1540

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

961

1543

if prop._dbus_interface

962

1544

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

963

1545

if_tag.appendChild(tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1546

# Add annotation tags for properties

1547

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

1548

annots = dict()

1549

for name, prop in self._get_all_dbus_things(

1550

"property"):

1551

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

1552

and prop._dbus_interface

1553

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

1554

annots.update(getattr(

1555

prop, "_dbus_annotations", {}))

1556

for name, value in annots.items():

1557

ann_tag = document.createElement(

1558

"annotation")

1559

ann_tag.setAttribute("name", name)

1560

ann_tag.setAttribute("value", value)

1561

tag.appendChild(ann_tag)

995

1562

# Add the names to the return values for the

996

1563

# "org.freedesktop.DBus.Properties" methods

997

1564

if (if_tag.getAttribute("name")

1011

1578

document.unlink()

1012

1579

except (AttributeError, xml.dom.DOMException,

1013

1580

xml.parsers.expat.ExpatError) as error:

1014

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

1015

exc_info=error)

1016

return xmlstring

1017

1018

1019

def datetime_to_dbus (dt, variant_level=0):

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

try:

1587

dbus.OBJECT_MANAGER_IFACE

1588

except AttributeError:

1589

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

1590

1591

1592

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1593

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

1594

1595

Classes inheriting from this exposes the standard

1596

GetManagedObjects call and the InterfacesAdded and

1597

InterfacesRemoved signals on the standard

1598

"org.freedesktop.DBus.ObjectManager" interface.

1599

1600

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

1601

manually.

1602

"""

1603

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1604

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

1605

def GetManagedObjects(self):

1606

"""This function must be overridden"""

1607

raise NotImplementedError()

1608

1609

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def InterfacesAdded(self, object_path, interfaces_and_properties):

1612

pass

1613

1614

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

1615

def InterfacesRemoved(self, object_path, interfaces):

1616

pass

1617

1618

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1619

out_signature="s",

1620

path_keyword="object_path",

1621

connection_keyword="connection")

1622

def Introspect(self, object_path, connection):

1623

"""Overloading of standard D-Bus method.

1624

1625

Override return argument name of GetManagedObjects to be

1626

"objpath_interfaces_and_properties"

1627

"""

1628

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1629

object_path,

1630

connection)

1631

try:

1632

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

1633

1634

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

1635

# Fix argument name for the GetManagedObjects method

1636

if (if_tag.getAttribute("name")

1637

== dbus.OBJECT_MANAGER_IFACE):

1638

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

1639

if (cn.getAttribute("name")

1640

== "GetManagedObjects"):

1641

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

1642

if (arg.getAttribute("direction")

1643

== "out"):

1644

arg.setAttribute(

1645

"name",

1646

"objpath_interfaces"

1647

"_and_properties")

1648

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

1649

document.unlink()

1650

except (AttributeError, xml.dom.DOMException,

1651

xml.parsers.expat.ExpatError) as error:

1652

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

1653

exc_info=error)

1654

return xmlstring

1655

1656

1657

def datetime_to_dbus(dt, variant_level=0):

1020

1658

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

1021

1659

if dt is None:

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1660

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

1661

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

1025

1662

1026

1663

1027

1664

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1029

1666

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

1030

1667

interface names according to the "alt_interface_names" mapping.

1031

1668

Usage:

1032

1033

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

1034

"net.example.AlternateInterface"})

1669

1670

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

1671

"net.example.AlternateInterface"})

1035

1672

class SampleDBusObject(dbus.service.Object):

1036

1673

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

1037

1674

def SampleDBusMethod():

1038

1675

pass

1039

1676

1040

1677

The above "SampleDBusMethod" on "SampleDBusObject" will be

1041

1678

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

1042

1679

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

1043

1680

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

1044

1681

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

1045

1682

1046

1683

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

1047

1684

(from DBusObjectWithProperties) and interfaces (from the

1048

1685

dbus_interface_annotations decorator).

1049

1686

"""

1687

1050

1688

def wrapper(cls):

1051

1689

for orig_interface_name, alt_interface_name in (

1052

alt_interface_names.iteritems()):

1690

alt_interface_names.items()):

1053

1691

attr = {}

1054

1692

interface_names = set()

1055

1693

# Go though all attributes of the class

1057

1695

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

1058

1696

# with the wrong interface name

1059

1697

if (not hasattr(attribute, "_dbus_interface")

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1698

or not attribute._dbus_interface.startswith(

1699

orig_interface_name)):

1062

1700

continue

1063

1701

# Create an alternate D-Bus interface name based on

1064

1702

# the current name

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1703

alt_interface = attribute._dbus_interface.replace(

1704

orig_interface_name, alt_interface_name)

1068

1705

interface_names.add(alt_interface)

1069

1706

# Is this a D-Bus signal?

1070

1707

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

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1708

# Extract the original non-method undecorated

1709

# function by black magic

1710

if sys.version_info.major == 2:

1711

nonmethod_func = (dict(

1074

1712

zip(attribute.func_code.co_freevars,

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1713

attribute.__closure__))

1714

["func"].cell_contents)

1715

else:

1716

nonmethod_func = (dict(

1717

zip(attribute.__code__.co_freevars,

1718

attribute.__closure__))

1719

["func"].cell_contents)

1077

1720

# Create a new, but exactly alike, function

1078

1721

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

1079

1722

# with the alternate D-Bus interface name

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1723

new_function = copy_function(nonmethod_func)

1724

new_function = (dbus.service.signal(

1725

alt_interface,

1726

attribute._dbus_signature)(new_function))

1089

1727

# Copy annotations, if any

1090

1728

try:

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1729

new_function._dbus_annotations = dict(

1730

attribute._dbus_annotations)

1093

1731

except AttributeError:

1094

1732

pass

1733

1095

1734

# Define a creator of a function to call both the

1096

1735

# original and alternate functions, so both the

1097

1736

# original and alternate signals gets sent when

1100

1739

"""This function is a scope container to pass

1101

1740

func1 and func2 to the "call_both" function

1102

1741

outside of its arguments"""

1742

1743

@functools.wraps(func2)

1103

1744

def call_both(*args, **kwargs):

1104

1745

"""This function will emit two D-Bus

1105

1746

signals by calling func1 and func2"""

1106

1747

func1(*args, **kwargs)

1107

1748

func2(*args, **kwargs)

1749

# Make wrapper function look like a D-Bus

1750

# signal

1751

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

1752

if name.startswith("_dbus_"):

1753

setattr(call_both, name, attr)

1754

1108

1755

return call_both

1109

1756

# Create the "call_both" function and add it to

1110

1757

# the class

1115

1762

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

1116

1763

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

1117

1764

# to the class.

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1765

attr[attrname] = (

1766

dbus.service.method(

1767

alt_interface,

1768

attribute._dbus_in_signature,

1769

attribute._dbus_out_signature)

1770

(copy_function(attribute)))

1128

1771

# Copy annotations, if any

1129

1772

try:

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1132

1775

except AttributeError:

1133

1776

pass

1134

1777

# Is this a D-Bus property?

1137

1780

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

1138

1781

# property with the alternate D-Bus interface

1139

1782

# name. Add it to the class.

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1783

attr[attrname] = (dbus_service_property(

1784

alt_interface, attribute._dbus_signature,

1785

attribute._dbus_access,

1786

attribute._dbus_get_args_options

1787

["byte_arrays"])

1788

(copy_function(attribute)))

1153

1789

# Copy annotations, if any

1154

1790

try:

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1791

attr[attrname]._dbus_annotations = dict(

1792

attribute._dbus_annotations)

1157

1793

except AttributeError:

1158

1794

pass

1159

1795

# Is this a D-Bus interface?

1162

1798

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

1163

1799

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

1164

1800

# to the class.

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1801

attr[attrname] = (

1802

dbus_interface_annotations(alt_interface)

1803

(copy_function(attribute)))

1173

1804

if deprecate:

1174

1805

# Deprecate all alternate interfaces

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1806

iname = "_AlternateDBusNames_interface_annotation{}"

1176

1807

for interface_name in interface_names:

1808

1177

1809

@dbus_interface_annotations(interface_name)

1178

1810

def func(self):

1179

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

1180

"true" }

1811

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

1812

"true"}

1181

1813

# Find an unused name

1182

1814

for aname in (iname.format(i)

1183

1815

for i in itertools.count()):

1187

1819

if interface_names:

1188

1820

# Replace the class with a new subclass of it with

1189

1821

# methods, signals, etc. as created above.

1190

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

1191

(cls,), attr)

1822

if sys.version_info.major == 2:

1823

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

1824

(cls, ), attr)

1825

else:

1826

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

1827

(cls, ), attr)

1192

1828

return cls

1829

1193

1830

return wrapper

1194

1831

1195

1832

1196

1833

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

1197

"se.bsnet.fukt.Mandos"})

1834

"se.bsnet.fukt.Mandos"})

1198

1835

class ClientDBus(Client, DBusObjectWithProperties):

1199

1836

"""A Client class using D-Bus

1200

1837

1201

1838

Attributes:

1202

1839

dbus_object_path: dbus.ObjectPath

1203

1840

bus: dbus.SystemBus()

1204

1841

"""

1205

1842

1206

1843

runtime_expansions = (Client.runtime_expansions

1207

+ ("dbus_object_path",))

1208

1844

+ ("dbus_object_path", ))

1845

1846

_interface = "se.recompile.Mandos.Client"

1847

1209

1848

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

1210

1211

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

1849

1850

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

1212

1851

self.bus = bus

1213

1852

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

1214

1853

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

1215

1854

# the D-Bus

1216

client_object_name = unicode(self.name).translate(

1855

client_object_name = str(self.name).translate(

1217

1856

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

1218

1857

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

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1858

self.dbus_object_path = dbus.ObjectPath(

1859

"/clients/" + client_object_name)

1221

1860

DBusObjectWithProperties.__init__(self, self.bus,

1222

1861

self.dbus_object_path)

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1862

1863

def notifychangeproperty(transform_func, dbus_name,

1864

type_func=lambda x: x,

1865

variant_level=1,

1866

invalidate_only=False,

1867

_interface=_interface):

1227

1868

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

1228

1869

its changes to DBus.

1229

1870

1230

1871

transform_fun: Function that takes a value and a variant_level

1231

1872

and transforms it to a D-Bus type.

1232

1873

dbus_name: D-Bus name of the variable

1234

1875

to the D-Bus. Default: no transform

1235

1876

variant_level: D-Bus variant level. Default: 1

1236

1877

"""

1237

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

1878

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

1879

1238

1880

def setter(self, value):

1239

1881

if hasattr(self, "dbus_object_path"):

1240

1882

if (not hasattr(self, attrname) or

1241

1883

type_func(getattr(self, attrname, None))

1242

1884

!= type_func(value)):

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1885

if invalidate_only:

1886

self.PropertiesChanged(

1887

_interface, dbus.Dictionary(),

1888

dbus.Array((dbus_name, )))

1889

else:

1890

dbus_value = transform_func(

1891

type_func(value),

1892

variant_level=variant_level)

1893

self.PropertyChanged(dbus.String(dbus_name),

1894

dbus_value)

1895

self.PropertiesChanged(

1896

_interface,

1897

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

1898

dbus_value}),

1899

dbus.Array())

1248

1900

setattr(self, attrname, value)

1249

1901

1250

1902

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

1251

1903

1252

1904

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1253

1905

approvals_pending = notifychangeproperty(dbus.Boolean,

1254

1906

"ApprovalPending",

1255

type_func = bool)

1907

type_func=bool)

1256

1908

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

1257

1909

last_enabled = notifychangeproperty(datetime_to_dbus,

1258

1910

"LastEnabled")

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1911

checker = notifychangeproperty(

1912

dbus.Boolean, "CheckerRunning",

1913

type_func=lambda checker: checker is not None)

1262

1914

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1263

1915

"LastCheckedOK")

1264

1916

last_checker_status = notifychangeproperty(dbus.Int16,

1267

1919

datetime_to_dbus, "LastApprovalRequest")

1268

1920

approved_by_default = notifychangeproperty(dbus.Boolean,

1269

1921

"ApprovedByDefault")

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1922

approval_delay = notifychangeproperty(

1923

dbus.UInt64, "ApprovalDelay",

1924

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

1274

1925

approval_duration = notifychangeproperty(

1275

1926

dbus.UInt64, "ApprovalDuration",

1276

type_func = timedelta_to_milliseconds)

1927

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

1277

1928

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1929

timeout = notifychangeproperty(

1930

dbus.UInt64, "Timeout",

1931

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

1281

1932

extended_timeout = notifychangeproperty(

1282

1933

dbus.UInt64, "ExtendedTimeout",

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1934

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

1935

interval = notifychangeproperty(

1936

dbus.UInt64, "Interval",

1937

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

1288

1938

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

1289

1939

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

1940

invalidate_only=True)

1941

1290

1942

del notifychangeproperty

1291

1943

1292

1944

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

1293

1945

try:

1294

1946

self.remove_from_connection()

1297

1949

if hasattr(DBusObjectWithProperties, "__del__"):

1298

1950

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

1299

1951

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

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1952

1953

def checker_callback(self, source, condition,

1954

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

1955

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

1956

connection, command, *args,

1957

**kwargs)

1958

exitstatus = self.last_checker_status

1959

if exitstatus >= 0:

1307

1960

# Emit D-Bus signal

1308

1961

self.CheckerCompleted(dbus.Int16(exitstatus),

1309

dbus.Int64(condition),

1962

# This is specific to GNU libC

1963

dbus.Int64(exitstatus << 8),

1310

1964

dbus.String(command))

1311

1965

else:

1312

1966

# Emit D-Bus signal

1313

1967

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

1314

dbus.Int64(condition),

1968

dbus.Int64(

1969

# This is specific to GNU libC

1970

(exitstatus << 8)

1971

| self.last_checker_signal),

1315

1972

dbus.String(command))

1316

1317

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

1318

*args, **kwargs)

1319

1973

return ret

1974

1320

1975

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1976

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

1326

1977

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

1327

1978

# Only if new checker process was started

1328

1979

if (self.checker is not None

1330

1981

# Emit D-Bus signal

1331

1982

self.CheckerStarted(self.current_checker_command)

1332

1983

return r

1333

1984

1334

1985

def _reset_approved(self):

1335

1986

self.approved = None

1336

1987

return False

1337

1988

1338

1989

def approve(self, value=True):

1339

1990

self.approved = value

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1991

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

1992

* 1000), self._reset_approved)

1343

1993

self.send_changedstate()

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1994

1995

# D-Bus methods, signals & properties

1996

1997

# Interfaces

1998

1999

# Signals

2000

1357

2001

# CheckerCompleted - signal

1358

2002

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

1359

2003

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

1360

2004

"D-Bus signal"

1361

2005

pass

1362

2006

1363

2007

# CheckerStarted - signal

1364

2008

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

1365

2009

def CheckerStarted(self, command):

1366

2010

"D-Bus signal"

1367

2011

pass

1368

2012

1369

2013

# PropertyChanged - signal

2014

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

1370

2015

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

1371

2016

def PropertyChanged(self, property, value):

1372

2017

"D-Bus signal"

1373

2018

pass

1374

2019

1375

2020

# GotSecret - signal

1376

2021

@dbus.service.signal(_interface)

1377

2022

def GotSecret(self):

1380

2025

server to mandos-client

1381

2026

"""

1382

2027

pass

1383

2028

1384

2029

# Rejected - signal

1385

2030

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

1386

2031

def Rejected(self, reason):

1387

2032

"D-Bus signal"

1388

2033

pass

1389

2034

1390

2035

# NeedApproval - signal

1391

2036

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

1392

2037

def NeedApproval(self, timeout, default):

1393

2038

"D-Bus signal"

1394

2039

return self.need_approval()

1395

1396

## Methods

1397

2040

2041

# Methods

2042

1398

2043

# Approve - method

1399

2044

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

1400

2045

def Approve(self, value):

1401

2046

self.approve(value)

1402

2047

1403

2048

# CheckedOK - method

1404

2049

@dbus.service.method(_interface)

1405

2050

def CheckedOK(self):

1406

2051

self.checked_ok()

1407

2052

1408

2053

# Enable - method

2054

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

1409

2055

@dbus.service.method(_interface)

1410

2056

def Enable(self):

1411

2057

"D-Bus method"

1412

2058

self.enable()

1413

2059

1414

2060

# StartChecker - method

2061

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

1415

2062

@dbus.service.method(_interface)

1416

2063

def StartChecker(self):

1417

2064

"D-Bus method"

1418

2065

self.start_checker()

1419

2066

1420

2067

# Disable - method

2068

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

1421

2069

@dbus.service.method(_interface)

1422

2070

def Disable(self):

1423

2071

"D-Bus method"

1424

2072

self.disable()

1425

2073

1426

2074

# StopChecker - method

2075

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

1427

2076

@dbus.service.method(_interface)

1428

2077

def StopChecker(self):

1429

2078

self.stop_checker()

1430

1431

## Properties

1432

2079

2080

# Properties

2081

1433

2082

# ApprovalPending - property

1434

2083

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

1435

2084

def ApprovalPending_dbus_property(self):

1436

2085

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

1437

2086

1438

2087

# ApprovedByDefault - property

1439

@dbus_service_property(_interface, signature="b",

2088

@dbus_service_property(_interface,

2089

signature="b",

1440

2090

access="readwrite")

1441

2091

def ApprovedByDefault_dbus_property(self, value=None):

1442

2092

if value is None: # get

1443

2093

return dbus.Boolean(self.approved_by_default)

1444

2094

self.approved_by_default = bool(value)

1445

2095

1446

2096

# ApprovalDelay - property

1447

@dbus_service_property(_interface, signature="t",

2097

@dbus_service_property(_interface,

2098

signature="t",

1448

2099

access="readwrite")

1449

2100

def ApprovalDelay_dbus_property(self, value=None):

1450

2101

if value is None: # get

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2102

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

2103

* 1000)

1452

2104

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

1453

2105

1454

2106

# ApprovalDuration - property

1455

@dbus_service_property(_interface, signature="t",

2107

@dbus_service_property(_interface,

2108

signature="t",

1456

2109

access="readwrite")

1457

2110

def ApprovalDuration_dbus_property(self, value=None):

1458

2111

if value is None: # get

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2112

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

2113

* 1000)

1461

2114

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

1462

2115

1463

2116

# Name - property

2117

@dbus_annotations(

2118

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

1464

2119

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

1465

2120

def Name_dbus_property(self):

1466

2121

return dbus.String(self.name)

1467

2122

2123

# KeyID - property

2124

@dbus_annotations(

2125

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

2126

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

2127

def KeyID_dbus_property(self):

2128

return dbus.String(self.key_id)

2129

1468

2130

# Fingerprint - property

2131

@dbus_annotations(

2132

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

1469

2133

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

1470

2134

def Fingerprint_dbus_property(self):

1471

2135

return dbus.String(self.fingerprint)

1472

2136

1473

2137

# Host - property

1474

@dbus_service_property(_interface, signature="s",

2138

@dbus_service_property(_interface,

2139

signature="s",

1475

2140

access="readwrite")

1476

2141

def Host_dbus_property(self, value=None):

1477

2142

if value is None: # get

1478

2143

return dbus.String(self.host)

1479

self.host = unicode(value)

1480

2144

self.host = str(value)

2145

1481

2146

# Created - property

2147

@dbus_annotations(

2148

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

1482

2149

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

1483

2150

def Created_dbus_property(self):

1484

2151

return datetime_to_dbus(self.created)

1485

2152

1486

2153

# LastEnabled - property

1487

2154

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

1488

2155

def LastEnabled_dbus_property(self):

1489

2156

return datetime_to_dbus(self.last_enabled)

1490

2157

1491

2158

# Enabled - property

1492

@dbus_service_property(_interface, signature="b",

2159

@dbus_service_property(_interface,

2160

signature="b",

1493

2161

access="readwrite")

1494

2162

def Enabled_dbus_property(self, value=None):

1495

2163

if value is None: # get

1498

2166

self.enable()

1499

2167

else:

1500

2168

self.disable()

1501

2169

1502

2170

# LastCheckedOK - property

1503

@dbus_service_property(_interface, signature="s",

2171

@dbus_service_property(_interface,

2172

signature="s",

1504

2173

access="readwrite")

1505

2174

def LastCheckedOK_dbus_property(self, value=None):

1506

2175

if value is not None:

1507

2176

self.checked_ok()

1508

2177

return

1509

2178

return datetime_to_dbus(self.last_checked_ok)

1510

2179

1511

2180

# LastCheckerStatus - property

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2181

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

1514

2182

def LastCheckerStatus_dbus_property(self):

1515

2183

return dbus.Int16(self.last_checker_status)

1516

2184

1517

2185

# Expires - property

1518

2186

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

1519

2187

def Expires_dbus_property(self):

1520

2188

return datetime_to_dbus(self.expires)

1521

2189

1522

2190

# LastApprovalRequest - property

1523

2191

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

1524

2192

def LastApprovalRequest_dbus_property(self):

1525

2193

return datetime_to_dbus(self.last_approval_request)

1526

2194

1527

2195

# Timeout - property

1528

@dbus_service_property(_interface, signature="t",

2196

@dbus_service_property(_interface,

2197

signature="t",

1529

2198

access="readwrite")

1530

2199

def Timeout_dbus_property(self, value=None):

1531

2200

if value is None: # get

1532

return dbus.UInt64(self.timeout_milliseconds())

2201

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

1533

2202

old_timeout = self.timeout

1534

2203

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

1535

2204

# Reschedule disabling

1543

2212

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

1544

2213

is None):

1545

2214

return

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

2215

GLib.source_remove(self.disable_initiator_tag)

2216

self.disable_initiator_tag = GLib.timeout_add(

2217

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

2218

self.disable)

2219

1552

2220

# ExtendedTimeout - property

1553

@dbus_service_property(_interface, signature="t",

2221

@dbus_service_property(_interface,

2222

signature="t",

1554

2223

access="readwrite")

1555

2224

def ExtendedTimeout_dbus_property(self, value=None):

1556

2225

if value is None: # get

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2226

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

2227

* 1000)

1558

2228

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

1559

2229

1560

2230

# Interval - property

1561

@dbus_service_property(_interface, signature="t",

2231

@dbus_service_property(_interface,

2232

signature="t",

1562

2233

access="readwrite")

1563

2234

def Interval_dbus_property(self, value=None):

1564

2235

if value is None: # get

1565

return dbus.UInt64(self.interval_milliseconds())

2236

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

1566

2237

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

1567

2238

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

1568

2239

return

1569

2240

if self.enabled:

1570

2241

# Reschedule checker run

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

2242

GLib.source_remove(self.checker_initiator_tag)

2243

self.checker_initiator_tag = GLib.timeout_add(

2244

value, self.start_checker)

2245

self.start_checker() # Start one now, too

2246

1576

2247

# Checker - property

1577

@dbus_service_property(_interface, signature="s",

2248

@dbus_service_property(_interface,

2249

signature="s",

1578

2250

access="readwrite")

1579

2251

def Checker_dbus_property(self, value=None):

1580

2252

if value is None: # get

1581

2253

return dbus.String(self.checker_command)

1582

self.checker_command = unicode(value)

1583

2254

self.checker_command = str(value)

2255

1584

2256

# CheckerRunning - property

1585

@dbus_service_property(_interface, signature="b",

2257

@dbus_service_property(_interface,

2258

signature="b",

1586

2259

access="readwrite")

1587

2260

def CheckerRunning_dbus_property(self, value=None):

1588

2261

if value is None: # get

1591

2264

self.start_checker()

1592

2265

else:

1593

2266

self.stop_checker()

1594

2267

1595

2268

# ObjectPath - property

2269

@dbus_annotations(

2270

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

2271

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

1596

2272

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

1597

2273

def ObjectPath_dbus_property(self):

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2274

return self.dbus_object_path # is already a dbus.ObjectPath

2275

1600

2276

# Secret = property

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2277

@dbus_annotations(

2278

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

2279

"invalidates"})

2280

@dbus_service_property(_interface,

2281

signature="ay",

2282

access="write",

2283

byte_arrays=True)

1603

2284

def Secret_dbus_property(self, value):

1604

self.secret = str(value)

1605

2285

self.secret = bytes(value)

2286

1606

2287

del _interface

1607

2288

1608

2289

1609

class ProxyClient(object):

1610

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

2290

class ProxyClient:

2291

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

1611

2292

self._pipe = child_pipe

1612

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

2293

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

1613

2294

if not self._pipe.recv():

1614

raise KeyError()

1615

2295

raise KeyError(key_id or fpr)

2296

1616

2297

def __getattribute__(self, name):

1617

if name == '_pipe':

2298

if name == "_pipe":

1618

2299

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

1619

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

2300

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

1620

2301

data = self._pipe.recv()

1621

if data[0] == 'data':

2302

if data[0] == "data":

1622

2303

return data[1]

1623

if data[0] == 'function':

2304

if data[0] == "function":

2305

1624

2306

def func(*args, **kwargs):

1625

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

2307

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

1626

2308

return self._pipe.recv()[1]

2309

1627

2310

return func

1628

2311

1629

2312

def __setattr__(self, name, value):

1630

if name == '_pipe':

2313

if name == "_pipe":

1631

2314

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

1632

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

2315

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

1633

2316

1634

2317

1635

2318

class ClientHandler(socketserver.BaseRequestHandler, object):

1636

2319

"""A class to handle client connections.

1637

2320

1638

2321

Instantiated once for each connection to handle it.

1639

2322

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

1640

2323

1641

2324

def handle(self):

1642

2325

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

1643

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

1644

unicode(self.client_address))

1645

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

1646

self.server.child_pipe.fileno())

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2326

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

2327

str(self.client_address))

2328

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

2329

2330

session = gnutls.ClientSession(self.request)

2331

2332

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

2333

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

2334

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

2335

# "+DHE-DSS"))

1662

2336

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

1663

2337

priority = self.server.gnutls_priority

1664

2338

if priority is None:

1665

2339

priority = "NORMAL"

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2340

gnutls.priority_set_direct(session,

2341

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

2342

1670

2343

# Start communication using the Mandos protocol

1671

2344

# Get protocol number

1672

2345

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

1673

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

2346

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

1674

2347

try:

1675

2348

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

1676

raise RuntimeError

2349

raise RuntimeError(line)

1677

2350

except (ValueError, IndexError, RuntimeError) as error:

1678

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

2351

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

1679

2352

return

1680

2353

1681

2354

# Start GnuTLS connection

1682

2355

try:

1683

2356

session.handshake()

1684

except gnutls.errors.GNUTLSError as error:

1685

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

2357

except gnutls.Error as error:

2358

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

1686

2359

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

1687

2360

# established. Just abandon the request.

1688

2361

return

1689

logger.debug("Handshake succeeded")

1690

2362

log.debug("Handshake succeeded")

2363

1691

2364

approval_required = False

1692

2365

try:

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

2366

if gnutls.has_rawpk:

2367

fpr = b""

2368

try:

2369

key_id = self.key_id(

2370

self.peer_certificate(session))

2371

except (TypeError, gnutls.Error) as error:

2372

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

2373

return

2374

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

2375

key_id.decode("utf-8",

2376

errors="replace"))

2377

2378

else:

2379

key_id = b""

2380

try:

2381

fpr = self.fingerprint(

2382

self.peer_certificate(session))

2383

except (TypeError, gnutls.Error) as error:

2384

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

2385

return

2386

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

2387

2388

try:

2389

client = ProxyClient(child_pipe, key_id, fpr,

1704

2390

self.client_address)

1705

2391

except KeyError:

1706

2392

return

1707

2393

1708

2394

if client.approval_delay:

1709

2395

delay = client.approval_delay

1710

2396

client.approvals_pending += 1

1711

2397

approval_required = True

1712

2398

1713

2399

while True:

1714

2400

if not client.enabled:

1715

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

1716

client.name)

2401

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

1717

2402

if self.server.use_dbus:

1718

2403

# Emit D-Bus signal

1719

2404

client.Rejected("Disabled")

1720

2405

return

1721

2406

1722

2407

if client.approved or not client.approval_delay:

1723

#We are approved or approval is disabled

2408

# We are approved or approval is disabled

1724

2409

break

1725

2410

elif client.approved is None:

1726

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

2411

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

2412

client.name)

2413

if self.server.use_dbus:

2414

# Emit D-Bus signal

2415

client.NeedApproval(

2416

client.approval_delay.total_seconds()

2417

* 1000, client.approved_by_default)

2418

else:

2419

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

1727

2420

client.name)

1728

2421

if self.server.use_dbus:

1729

2422

# Emit D-Bus signal

1730

client.NeedApproval(

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

1733

else:

1734

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

1735

client.name)

1736

if self.server.use_dbus:

1737

# Emit D-Bus signal

1738

2423

client.Rejected("Denied")

1739

2424

return

1740

1741

#wait until timeout or approved

2425

2426

# wait until timeout or approved

1742

2427

time = datetime.datetime.now()

1743

2428

client.changedstate.acquire()

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2429

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

1747

2430

client.changedstate.release()

1748

2431

time2 = datetime.datetime.now()

1749

2432

if (time2 - time) >= delay:

1750

2433

if not client.approved_by_default:

1751

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

1752

" waiting for approval",

1753

client.name)

2434

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

2435

" waiting for approval",

2436

client.name)

1754

2437

if self.server.use_dbus:

1755

2438

# Emit D-Bus signal

1756

2439

client.Rejected("Approval timed out")

1759

2442

break

1760

2443

else:

1761

2444

delay -= time2 - time

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

1776

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

2445

2446

try:

2447

session.send(client.secret)

2448

except gnutls.Error as error:

2449

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

2450

return

2451

2452

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

1777

2453

# bump the timeout using extended_timeout

1778

2454

client.bump_timeout(client.extended_timeout)

1779

2455

if self.server.use_dbus:

1780

2456

# Emit D-Bus signal

1781

2457

client.GotSecret()

1782

2458

1783

2459

finally:

1784

2460

if approval_required:

1785

2461

client.approvals_pending -= 1

1786

2462

try:

1787

2463

session.bye()

1788

except gnutls.errors.GNUTLSError as error:

1789

logger.warning("GnuTLS bye failed",

1790

exc_info=error)

1791

2464

except gnutls.Error as error:

2465

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

2466

1792

2467

@staticmethod

1793

2468

def peer_certificate(session):

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2469

"Return the peer's certificate as a bytestring"

2470

try:

2471

cert_type = gnutls.certificate_type_get2(

2472

session, gnutls.CTYPE_PEERS)

2473

except AttributeError:

2474

cert_type = gnutls.certificate_type_get(session)

2475

if gnutls.has_rawpk:

2476

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2477

else:

2478

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2479

# If not a valid certificate type...

2480

if cert_type not in valid_cert_types:

2481

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

2482

valid_cert_types)

2483

# ...return invalid data

2484

return b""

1801

2485

list_size = ctypes.c_uint(1)

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

1804

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

2486

cert_list = (gnutls.certificate_get_peers

2487

(session, ctypes.byref(list_size)))

1805

2488

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

1806

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

1807

" certificate")

2489

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

1808

2490

if list_size.value == 0:

1809

2491

return None

1810

2492

cert = cert_list[0]

1811

2493

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

1812

2494

2495

@staticmethod

2496

def key_id(certificate):

2497

"Convert a certificate bytestring to a hexdigit key ID"

2498

# New GnuTLS "datum" with the public key

2499

datum = gnutls.datum_t(

2500

ctypes.cast(ctypes.c_char_p(certificate),

2501

ctypes.POINTER(ctypes.c_ubyte)),

2502

ctypes.c_uint(len(certificate)))

2503

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

2504

# New empty GnuTLS certificate

2505

pubkey = gnutls.pubkey_t()

2506

gnutls.pubkey_init(ctypes.byref(pubkey))

2507

# Import the raw public key into the certificate

2508

gnutls.pubkey_import(pubkey,

2509

ctypes.byref(datum),

2510

gnutls.X509_FMT_DER)

2511

# New buffer for the key ID

2512

buf = ctypes.create_string_buffer(32)

2513

buf_len = ctypes.c_size_t(len(buf))

2514

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

2515

gnutls.pubkey_get_key_id(

2516

pubkey,

2517

gnutls.KEYID_USE_SHA256,

2518

ctypes.cast(ctypes.byref(buf),

2519

ctypes.POINTER(ctypes.c_ubyte)),

2520

ctypes.byref(buf_len))

2521

# Deinit the certificate

2522

gnutls.pubkey_deinit(pubkey)

2523

2524

# Convert the buffer to a Python bytestring

2525

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

2526

# Convert the bytestring to hexadecimal notation

2527

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

2528

return hex_key_id

2529

1813

2530

@staticmethod

1814

2531

def fingerprint(openpgp):

1815

2532

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1816

2533

# New GnuTLS "datum" with the OpenPGP public key

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2534

datum = gnutls.datum_t(

2535

ctypes.cast(ctypes.c_char_p(openpgp),

2536

ctypes.POINTER(ctypes.c_ubyte)),

2537

ctypes.c_uint(len(openpgp)))

1822

2538

# New empty GnuTLS certificate

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2539

crt = gnutls.openpgp_crt_t()

2540

gnutls.openpgp_crt_init(ctypes.byref(crt))

1826

2541

# Import the OpenPGP public key into the certificate

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2542

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

2543

gnutls.OPENPGP_FMT_RAW)

1831

2544

# Verify the self signature in the key

1832

2545

crtverify = ctypes.c_uint()

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2546

gnutls.openpgp_crt_verify_self(crt, 0,

2547

ctypes.byref(crtverify))

1836

2548

if crtverify.value != 0:

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2549

gnutls.openpgp_crt_deinit(crt)

2550

raise gnutls.CertificateSecurityError(code

2551

=crtverify.value)

1840

2552

# New buffer for the fingerprint

1841

2553

buf = ctypes.create_string_buffer(20)

1842

2554

buf_len = ctypes.c_size_t()

1843

2555

# Get the fingerprint from the certificate into the buffer

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2556

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

2557

ctypes.byref(buf_len))

1847

2558

# Deinit the certificate

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2559

gnutls.openpgp_crt_deinit(crt)

1849

2560

# Convert the buffer to a Python bytestring

1850

2561

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

1851

2562

# Convert the bytestring to hexadecimal notation

1853

2564

return hex_fpr

1854

2565

1855

2566

1856

class MultiprocessingMixIn(object):

2567

class MultiprocessingMixIn:

1857

2568

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

2569

1858

2570

def sub_process_main(self, request, address):

1859

2571

try:

1860

2572

self.finish_request(request, address)

1861

2573

except Exception:

1862

2574

self.handle_error(request, address)

1863

2575

self.close_request(request)

1864

2576

1865

2577

def process_request(self, request, address):

1866

2578

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

1867

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

1868

args = (request, address))

2579

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

2580

args=(request, address))

1869

2581

proc.start()

1870

2582

return proc

1871

2583

1872

2584

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2585

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

2586

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

2587

1875

2588

def process_request(self, request, client_address):

1876

2589

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

1877

2590

1878

2591

This function creates a new pipe in self.pipe

1879

2592

"""

1880

2593

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1881

2594

1882

2595

proc = MultiprocessingMixIn.process_request(self, request,

1883

2596

client_address)

1884

2597

self.child_pipe.close()

1885

2598

self.add_pipe(parent_pipe, proc)

1886

2599

1887

2600

def add_pipe(self, parent_pipe, proc):

1888

2601

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

1889

raise NotImplementedError

2602

raise NotImplementedError()

1890

2603

1891

2604

1892

2605

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1893

socketserver.TCPServer, object):

1894

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

1895

2606

socketserver.TCPServer):

2607

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

2608

1896

2609

Attributes:

1897

2610

enabled: Boolean; whether this server is activated yet

1898

2611

interface: None or a network interface name (string)

1899

2612

use_ipv6: Boolean; to use IPv6 or not

1900

2613

"""

2614

1901

2615

def __init__(self, server_address, RequestHandlerClass,

1902

interface=None, use_ipv6=True):

2616

interface=None,

2617

use_ipv6=True,

2618

socketfd=None):

2619

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

2620

creating a new one with socket.socket().

2621

"""

1903

2622

self.interface = interface

1904

2623

if use_ipv6:

1905

2624

self.address_family = socket.AF_INET6

2625

if socketfd is not None:

2626

# Save the file descriptor

2627

self.socketfd = socketfd

2628

# Save the original socket.socket() function

2629

self.socket_socket = socket.socket

2630

2631

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

2632

#

2633

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

2634

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

2635

# patching socket.socket.)

2636

#

2637

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

2638

@functools.wraps(socket.socket)

2639

def socket_wrapper(*args, **kwargs):

2640

# Restore original function so subsequent calls are

2641

# not affected.

2642

socket.socket = self.socket_socket

2643

del self.socket_socket

2644

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

2645

# saved file descriptor.

2646

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

2647

# Replace socket.socket() function with wrapper

2648

socket.socket = socket_wrapper

2649

# The socketserver.TCPServer.__init__ will call

2650

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

2651

# socket_wrapper(), if socketfd was set.

1906

2652

socketserver.TCPServer.__init__(self, server_address,

1907

2653

RequestHandlerClass)

2654

1908

2655

def server_bind(self):

1909

2656

"""This overrides the normal server_bind() function

1910

2657

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

1911

2658

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

2659

global SO_BINDTODEVICE

1912

2660

if self.interface is not None:

1913

2661

if SO_BINDTODEVICE is None:

1914

logger.error("SO_BINDTODEVICE does not exist;"

1915

" cannot bind to interface %s",

1916

self.interface)

1917

else:

1918

try:

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1920

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1923

except socket.error as error:

1924

if error.errno == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1928

elif error.errno == errno.ENOPROTOOPT:

1929

logger.error("SO_BINDTODEVICE not available;"

1930

" cannot bind to interface %s",

1931

self.interface)

1932

elif error.errno == errno.ENODEV:

1933

logger.error("Interface %s does not"

1934

" exist, cannot bind",

1935

self.interface)

1936

else:

1937

raise

2662

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

2663

# common enough.

2664

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

2665

SO_BINDTODEVICE = 25

2666

try:

2667

self.socket.setsockopt(

2668

socket.SOL_SOCKET, SO_BINDTODEVICE,

2669

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

2670

except socket.error as error:

2671

if error.errno == errno.EPERM:

2672

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

2673

self.interface)

2674

elif error.errno == errno.ENOPROTOOPT:

2675

log.error("SO_BINDTODEVICE not available; cannot"

2676

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

2677

elif error.errno == errno.ENODEV:

2678

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

2679

" bind", self.interface)

2680

else:

2681

raise

1938

2682

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

1939

2683

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

2684

if self.server_address[1]:

2685

self.allow_reuse_address = True

1940

2686

if not self.server_address[0]:

1941

2687

if self.address_family == socket.AF_INET6:

1942

any_address = "::" # in6addr_any

2688

any_address = "::" # in6addr_any

1943

2689

else:

1944

any_address = socket.INADDR_ANY

2690

any_address = "0.0.0.0" # INADDR_ANY

1945

2691

self.server_address = (any_address,

1946

2692

self.server_address[1])

1947

2693

elif not self.server_address[1]:

1948

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

1949

0)

2694

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

1950

2695

# if self.interface:

1951

2696

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

1952

2697

# 0, # port

1958

2703

1959

2704

class MandosServer(IPv6_TCPServer):

1960

2705

"""Mandos server.

1961

2706

1962

2707

Attributes:

1963

2708

clients: set of Client objects

1964

2709

gnutls_priority GnuTLS priority string

1965

2710

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

1966

1967

Assumes a gobject.MainLoop event loop.

2711

2712

Assumes a GLib.MainLoop event loop.

1968

2713

"""

2714

1969

2715

def __init__(self, server_address, RequestHandlerClass,

1970

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

1971

gnutls_priority=None, use_dbus=True):

2716

interface=None,

2717

use_ipv6=True,

2718

clients=None,

2719

gnutls_priority=None,

2720

use_dbus=True,

2721

socketfd=None):

1972

2722

self.enabled = False

1973

2723

self.clients = clients

1974

2724

if self.clients is None:

1977

2727

self.gnutls_priority = gnutls_priority

1978

2728

IPv6_TCPServer.__init__(self, server_address,

1979

2729

RequestHandlerClass,

1980

interface = interface,

1981

use_ipv6 = use_ipv6)

2730

interface=interface,

2731

use_ipv6=use_ipv6,

2732

socketfd=socketfd)

2733

1982

2734

def server_activate(self):

1983

2735

if self.enabled:

1984

2736

return socketserver.TCPServer.server_activate(self)

1985

2737

1986

2738

def enable(self):

1987

2739

self.enabled = True

1988

2740

1989

2741

def add_pipe(self, parent_pipe, proc):

1990

2742

# Call "handle_ipc" for both data and EOF events

1991

gobject.io_add_watch(parent_pipe.fileno(),

1992

gobject.IO_IN | gobject.IO_HUP,

1993

functools.partial(self.handle_ipc,

1994

parent_pipe =

1995

parent_pipe,

1996

proc = proc))

1997

1998

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

1999

proc = None, client_object=None):

2743

GLib.io_add_watch(

2744

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

2745

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

2746

functools.partial(self.handle_ipc,

2747

parent_pipe=parent_pipe,

2748

proc=proc))

2749

2750

def handle_ipc(self, source, condition,

2751

parent_pipe=None,

2752

proc=None,

2753

client_object=None):

2000

2754

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

2001

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

2755

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

2002

2756

# Wait for other process to exit

2003

2757

proc.join()

2004

2758

return False

2005

2759

2006

2760

# Read a request from the child

2007

2761

request = parent_pipe.recv()

2008

2762

command = request[0]

2009

2010

if command == 'init':

2011

fpr = request[1]

2012

address = request[2]

2013

2014

for c in self.clients.itervalues():

2015

if c.fingerprint == fpr:

2763

2764

if command == "init":

2765

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

2766

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

2767

address = request[3]

2768

2769

for c in self.clients.values():

2770

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2771

"27AE41E4649B934CA495991B7852B855"):

2772

continue

2773

if key_id and c.key_id == key_id:

2774

client = c

2775

break

2776

if fpr and c.fingerprint == fpr:

2016

2777

client = c

2017

2778

break

2018

2779

else:

2019

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

2020

"dress: %s", fpr, address)

2780

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

2781

" %s", key_id or fpr, address)

2021

2782

if self.use_dbus:

2022

2783

# Emit D-Bus signal

2023

mandos_dbus_service.ClientNotFound(fpr,

2784

mandos_dbus_service.ClientNotFound(key_id or fpr,

2024

2785

address[0])

2025

2786

parent_pipe.send(False)

2026

2787

return False

2027

2028

gobject.io_add_watch(parent_pipe.fileno(),

2029

gobject.IO_IN | gobject.IO_HUP,

2030

functools.partial(self.handle_ipc,

2031

parent_pipe =

2032

parent_pipe,

2033

proc = proc,

2034

client_object =

2035

client))

2788

2789

GLib.io_add_watch(

2790

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

2791

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

2792

functools.partial(self.handle_ipc,

2793

parent_pipe=parent_pipe,

2794

proc=proc,

2795

client_object=client))

2036

2796

parent_pipe.send(True)

2037

2797

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

2038

2798

# same fileno

2039

2799

return False

2040

if command == 'funcall':

2800

if command == "funcall":

2041

2801

funcname = request[1]

2042

2802

args = request[2]

2043

2803

kwargs = request[3]

2044

2045

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

2804

2805

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

2046

2806

funcname)(*args,

2047

**kwargs)))

2048

2049

if command == 'getattr':

2807

**kwargs)))

2808

2809

if command == "getattr":

2050

2810

attrname = request[1]

2051

if callable(client_object.__getattribute__(attrname)):

2052

parent_pipe.send(('function',))

2811

if isinstance(client_object.__getattribute__(attrname),

2812

collections.abc.Callable):

2813

parent_pipe.send(("function", ))

2053

2814

else:

2054

parent_pipe.send(('data', client_object

2055

.__getattribute__(attrname)))

2056

2057

if command == 'setattr':

2815

parent_pipe.send((

2816

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

2817

2818

if command == "setattr":

2058

2819

attrname = request[1]

2059

2820

value = request[2]

2060

2821

setattr(client_object, attrname, value)

2061

2822

2062

2823

return True

2063

2824

2064

2825

2826

def rfc3339_duration_to_delta(duration):

2827

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

2828

2829

>>> timedelta = datetime.timedelta

2830

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

2831

True

2832

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

2833

True

2834

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

2835

True

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

>>> del timedelta

2845

"""

2846

2847

# Parsing an RFC 3339 duration with regular expressions is not

2848

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

2849

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

2850

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

2851

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

2852

# avoid excessive use of external libraries.

2853

2854

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

2855

Token = collections.namedtuple("Token", (

2856

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

2857

# a "group" containing digits

2858

"value", # datetime.timedelta or None

2859

"followers")) # Tokens valid after this token

2860

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

2861

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

2862

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

2863

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

2864

datetime.timedelta(seconds=1),

2865

frozenset((token_end, )))

2866

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

2867

datetime.timedelta(minutes=1),

2868

frozenset((token_second, token_end)))

2869

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

2870

datetime.timedelta(hours=1),

2871

frozenset((token_minute, token_end)))

2872

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

2873

None,

2874

frozenset((token_hour, token_minute,

2875

token_second)))

2876

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

2877

datetime.timedelta(days=1),

2878

frozenset((token_time, token_end)))

2879

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

2880

datetime.timedelta(weeks=4),

2881

frozenset((token_day, token_end)))

2882

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

2883

datetime.timedelta(weeks=52),

2884

frozenset((token_month, token_end)))

2885

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

2886

datetime.timedelta(weeks=1),

2887

frozenset((token_end, )))

2888

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

2889

frozenset((token_year, token_month,

2890

token_day, token_time,

2891

token_week)))

2892

# Define starting values:

2893

# Value so far

2894

value = datetime.timedelta()

2895

found_token = None

2896

# Following valid tokens

2897

followers = frozenset((token_duration, ))

2898

# String left to parse

2899

s = duration

2900

# Loop until end token is found

2901

while found_token is not token_end:

2902

# Search for any currently valid tokens

2903

for token in followers:

2904

match = token.regexp.match(s)

2905

if match is not None:

2906

# Token found

2907

if token.value is not None:

2908

# Value found, parse digits

2909

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

2910

# Add to value so far

2911

value += factor * token.value

2912

# Strip token from string

2913

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

2914

# Go to found token

2915

found_token = token

2916

# Set valid next tokens

2917

followers = found_token.followers

2918

break

2919

else:

2920

# No currently valid tokens were found

2921

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

2922

.format(duration))

2923

# End token found

2924

return value

2925

2926

2065

2927

def string_to_delta(interval):

2066

2928

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

2067

2068

>>> string_to_delta('7d')

2069

datetime.timedelta(7)

2070

>>> string_to_delta('60s')

2071

datetime.timedelta(0, 60)

2072

>>> string_to_delta('60m')

2073

datetime.timedelta(0, 3600)

2074

>>> string_to_delta('24h')

2075

datetime.timedelta(1)

2076

>>> string_to_delta('1w')

2077

datetime.timedelta(7)

2078

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

2079

datetime.timedelta(0, 330)

2929

2930

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

2931

True

2932

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

2933

True

2934

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

2935

True

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2080

2942

"""

2943

2944

try:

2945

return rfc3339_duration_to_delta(interval)

2946

except ValueError:

2947

pass

2948

2081

2949

timevalue = datetime.timedelta(0)

2082

2950

for s in interval.split():

2083

2951

try:

2084

suffix = unicode(s[-1])

2952

suffix = s[-1]

2085

2953

value = int(s[:-1])

2086

2954

if suffix == "d":

2087

2955

delta = datetime.timedelta(value)

2094

2962

elif suffix == "w":

2095

2963

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

2096

2964

else:

2097

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

2098

.format(suffix))

2099

except (ValueError, IndexError) as e:

2965

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

2966

except IndexError as e:

2100

2967

raise ValueError(*(e.args))

2101

2968

timevalue += delta

2102

2969

return timevalue

2103

2970

2104

2971

2105

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

2972

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

2106

2973

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

2107

2974

2108

2975

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

2109

2976

if os.fork():

2110

2977

sys.exit()

2118

2985

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

2119

2986

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

2120

2987

raise OSError(errno.ENODEV,

2121

"{0} not a character device"

2988

"{} not a character device"

2122

2989

.format(os.devnull))

2123

2990

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

2124

2991

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

2128

2995

2129

2996

2130

2997

def main():

2131

2998

2132

2999

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

2133

3000

# Parsing of options, both command line and config file

2134

3001

2135

3002

parser = argparse.ArgumentParser()

2136

3003

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

2137

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

3004

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

2138

3005

help="show version number and exit")

2139

3006

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

2140

3007

help="Bind to interface IF")

2146

3013

help="Run self-test")

2147

3014

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

2148

3015

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

2149

" to terminal")

3016

" to terminal", default=None)

2150

3017

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

2151

3018

help="Debug level for stdout output")

2152

3019

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

2159

3026

" files")

2160

3027

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

2161

3028

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

2162

" system bus interface")

3029

" system bus interface", default=None)

2163

3030

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

2164

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

3031

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

3032

default=None)

2165

3033

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

2166

3034

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

2167

" state")

3035

" state", default=None)

3036

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

3037

help="Specify a file descriptor to a network"

3038

" socket to use instead of creating one")

2168

3039

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

2169

3040

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

2170

3041

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

3042

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

3043

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

3044

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

3045

default=None)

3046

2171

3047

options = parser.parse_args()

2172

2173

if options.check:

2174

import doctest

2175

doctest.testmod()

2176

sys.exit()

2177

3048

2178

3049

# Default values for config file for server-global settings

2179

server_defaults = { "interface": "",

2180

"address": "",

2181

"port": "",

2182

"debug": "False",

2183

"priority":

2184

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

2185

"servicename": "Mandos",

2186

"use_dbus": "True",

2187

"use_ipv6": "True",

2188

"debuglevel": "",

2189

"restore": "True",

2190

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

2191

}

2192

3050

if gnutls.has_rawpk:

3051

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

3052

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

3053

else:

3054

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

3055

":+SIGN-DSA-SHA256")

3056

server_defaults = {"interface": "",

3057

"address": "",

3058

"port": "",

3059

"debug": "False",

3060

"priority": priority,

3061

"servicename": "Mandos",

3062

"use_dbus": "True",

3063

"use_ipv6": "True",

3064

"debuglevel": "",

3065

"restore": "True",

3066

"socket": "",

3067

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

3068

"foreground": "False",

3069

"zeroconf": "True",

3070

}

3071

del priority

3072

2193

3073

# Parse config file for server-global settings

2194

server_config = configparser.SafeConfigParser(server_defaults)

3074

server_config = configparser.ConfigParser(server_defaults)

2195

3075

del server_defaults

2196

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

2197

"mandos.conf"))

2198

# Convert the SafeConfigParser object to a dict

3076

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

3077

# Convert the ConfigParser object to a dict

2199

3078

server_settings = server_config.defaults()

2200

3079

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

2201

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

3080

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

3081

"foreground", "zeroconf"):

2202

3082

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

2203

3083

option)

2204

3084

if server_settings["port"]:

2205

3085

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

2206

3086

"port")

3087

if server_settings["socket"]:

3088

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

3089

"socket")

3090

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

3091

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

3092

# happen with a supplied network socket.

3093

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

3094

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

3095

["socket"])

2207

3096

del server_config

2208

3097

2209

3098

# Override the settings from the config file with command line

2210

3099

# options, if set.

2211

3100

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

2212

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

2213

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

2214

"statedir"):

3101

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

3102

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

3103

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

2215

3104

value = getattr(options, option)

2216

3105

if value is not None:

2217

3106

server_settings[option] = value

2218

3107

del options

2219

3108

# Force all strings to be unicode

2220

3109

for option in server_settings.keys():

2221

if type(server_settings[option]) is str:

2222

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

3110

if isinstance(server_settings[option], bytes):

3111

server_settings[option] = (server_settings[option]

3112

.decode("utf-8"))

3113

# Force all boolean options to be boolean

3114

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

3115

"foreground", "zeroconf"):

3116

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

3117

# Debug implies foreground

3118

if server_settings["debug"]:

3119

server_settings["foreground"] = True

2223

3120

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

2224

3121

2225

3122

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

2226

3123

3124

if (not server_settings["zeroconf"]

3125

and not (server_settings["port"]

3126

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

3127

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

3128

2227

3129

# For convenience

2228

3130

debug = server_settings["debug"]

2229

3131

debuglevel = server_settings["debuglevel"]

2231

3133

use_ipv6 = server_settings["use_ipv6"]

2232

3134

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

2233

3135

stored_state_file)

2234

3136

foreground = server_settings["foreground"]

3137

zeroconf = server_settings["zeroconf"]

3138

2235

3139

if debug:

2236

3140

initlogger(debug, logging.DEBUG)

2237

3141

else:

2240

3144

else:

2241

3145

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

2242

3146

initlogger(debug, level)

2243

3147

2244

3148

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

2245

syslogger.setFormatter(logging.Formatter

2246

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

2247

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

2248

.format(server_settings

2249

["servicename"])))

2250

3149

syslogger.setFormatter(

3150

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

3151

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

3152

server_settings["servicename"])))

3153

2251

3154

# Parse config file with clients

2252

client_config = configparser.SafeConfigParser(Client

2253

.client_defaults)

3155

client_config = configparser.ConfigParser(Client.client_defaults)

2254

3156

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

2255

3157

"clients.conf"))

2256

3158

2257

3159

global mandos_dbus_service

2258

3160

mandos_dbus_service = None

2259

2260

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

2261

server_settings["port"]),

2262

ClientHandler,

2263

interface=(server_settings["interface"]

2264

or None),

2265

use_ipv6=use_ipv6,

2266

gnutls_priority=

2267

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

3161

3162

socketfd = None

3163

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

3164

socketfd = server_settings["socket"]

3165

tcp_server = MandosServer(

3166

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

3167

ClientHandler,

3168

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

3169

use_ipv6=use_ipv6,

3170

gnutls_priority=server_settings["priority"],

3171

use_dbus=use_dbus,

3172

socketfd=socketfd)

3173

if not foreground:

3174

pidfilename = "/run/mandos.pid"

3175

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

3176

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

3177

pidfile = None

2271

3178

try:

2272

pidfile = open(pidfilename, "w")

3179

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

2273

3180

except IOError as e:

2274

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

2275

exc_info=e)

2276

2277

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

3181

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

3182

exc_info=e)

3183

3184

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

3185

("mandos", "mandos"),

3186

("nobody", "nogroup")):

2278

3187

try:

2279

3188

uid = pwd.getpwnam(name).pw_uid

2280

gid = pwd.getpwnam(name).pw_gid

3189

gid = pwd.getpwnam(group).pw_gid

2281

3190

break

2282

3191

except KeyError:

2283

3192

continue

2287

3196

try:

2288

3197

os.setgid(gid)

2289

3198

os.setuid(uid)

3199

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

2290

3200

except OSError as error:

3201

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

3202

os.strerror(error.errno))

2291

3203

if error.errno != errno.EPERM:

2292

raise error

2293

3204

raise

3205

2294

3206

if debug:

2295

3207

# Enable all possible GnuTLS debugging

2296

3208

2297

3209

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

2298

3210

# - GnuTLS manual

2299

gnutls.library.functions.gnutls_global_set_log_level(11)

2300

2301

@gnutls.library.types.gnutls_log_func

3211

gnutls.global_set_log_level(11)

3212

3213

@gnutls.log_func

2302

3214

def debug_gnutls(level, string):

2303

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

2304

2305

(gnutls.library.functions

2306

.gnutls_global_set_log_function(debug_gnutls))

2307

3215

log.debug("GnuTLS: %s",

3216

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

3217

3218

gnutls.global_set_log_function(debug_gnutls)

3219

2308

3220

# Redirect stdin so all checkers get /dev/null

2309

3221

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

2310

3222

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

2311

3223

if null > 2:

2312

3224

os.close(null)

2313

3225

2314

3226

# Need to fork before connecting to D-Bus

2315

if not debug:

3227

if not foreground:

2316

3228

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

2317

3229

daemon()

2318

2319

gobject.threads_init()

2320

3230

3231

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

3232

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

3233

# need to inform GLib that threads will be used.

3234

GLib.threads_init()

3235

2321

3236

global main_loop

2322

3237

# From the Avahi example code

2323

3238

DBusGMainLoop(set_as_default=True)

2324

main_loop = gobject.MainLoop()

3239

main_loop = GLib.MainLoop()

2325

3240

bus = dbus.SystemBus()

2326

3241

# End of Avahi example code

2327

3242

if use_dbus:

2328

3243

try:

2329

3244

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

2330

bus, do_not_queue=True)

2331

old_bus_name = (dbus.service.BusName

2332

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

2333

do_not_queue=True))

2334

except dbus.exceptions.NameExistsException as e:

2335

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

3245

bus,

3246

do_not_queue=True)

3247

old_bus_name = dbus.service.BusName(

3248

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

3249

do_not_queue=True)

3250

except dbus.exceptions.DBusException as e:

3251

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

2336

3252

use_dbus = False

2337

3253

server_settings["use_dbus"] = False

2338

3254

tcp_server.use_dbus = False

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2347

3255

if zeroconf:

3256

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3257

service = AvahiServiceToSyslog(

3258

name=server_settings["servicename"],

3259

servicetype="_mandos._tcp",

3260

protocol=protocol,

3261

bus=bus)

3262

if server_settings["interface"]:

3263

service.interface = if_nametoindex(

3264

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

3265

2348

3266

global multiprocessing_manager

2349

3267

multiprocessing_manager = multiprocessing.Manager()

2350

3268

2351

3269

client_class = Client

2352

3270

if use_dbus:

2353

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

2354

3271

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

3272

2355

3273

client_settings = Client.config_parser(client_config)

2356

3274

old_client_settings = {}

2357

3275

clients_data = {}

2358

3276

3277

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

3278

global wnull

3279

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

3280

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

3281

# mode

3282

if debug or not foreground:

3283

wnull.close()

3284

2359

3285

# Get client data and settings from last running state.

2360

3286

if server_settings["restore"]:

2361

3287

try:

2362

3288

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

2363

clients_data, old_client_settings = (pickle.load

2364

(stored_state))

3289

if sys.version_info.major == 2:

3290

clients_data, old_client_settings = pickle.load(

3291

stored_state)

3292

else:

3293

bytes_clients_data, bytes_old_client_settings = (

3294

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

3295

# Fix bytes to strings

3296

# clients_data

3297

# .keys()

3298

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

3299

if isinstance(key, bytes)

3300

else key): value

3301

for key, value in

3302

bytes_clients_data.items()}

3303

del bytes_clients_data

3304

for key in clients_data:

3305

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

3306

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

3307

for k, v in

3308

clients_data[key].items()}

3309

clients_data[key] = value

3310

# .client_structure

3311

value["client_structure"] = [

3312

(s.decode("utf-8")

3313

if isinstance(s, bytes)

3314

else s) for s in

3315

value["client_structure"]]

3316

# .name, .host, and .checker_command

3317

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

3318

if isinstance(value[k], bytes):

3319

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

3320

if "key_id" not in value:

3321

value["key_id"] = ""

3322

elif "fingerprint" not in value:

3323

value["fingerprint"] = ""

3324

# old_client_settings

3325

# .keys()

3326

old_client_settings = {

3327

(key.decode("utf-8")

3328

if isinstance(key, bytes)

3329

else key): value

3330

for key, value in

3331

bytes_old_client_settings.items()}

3332

del bytes_old_client_settings

3333

# .host and .checker_command

3334

for value in old_client_settings.values():

3335

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

3336

if isinstance(value[attribute], bytes):

3337

value[attribute] = (value[attribute]

3338

.decode("utf-8"))

2365

3339

os.remove(stored_state_path)

2366

3340

except IOError as e:

2367

3341

if e.errno == errno.ENOENT:

2368

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

2369

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

3342

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

3343

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

2370

3344

else:

2371

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

2372

exc_info=e)

3345

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

3346

exc_info=e)

2373

3347

raise

2374

3348

except EOFError as e:

2375

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

2376

"EOFError:", exc_info=e)

2377

3349

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

3350

exc_info=e)

3351

2378

3352

with PGPEngine() as pgp:

2379

for client_name, client in clients_data.iteritems():

3353

for client_name, client in clients_data.items():

3354

# Skip removed clients

3355

if client_name not in client_settings:

3356

continue

3357

2380

3358

# Decide which value to use after restoring saved state.

2381

3359

# We have three different values: Old config file,

2382

3360

# new config file, and saved state.

2387

3365

# For each value in new config, check if it

2388

3366

# differs from the old config value (Except for

2389

3367

# the "secret" attribute)

2390

if (name != "secret" and

2391

value != old_client_settings[client_name]

2392

[name]):

3368

if (name != "secret"

3369

and (value !=

3370

old_client_settings[client_name][name])):

2393

3371

client[name] = value

2394

3372

except KeyError:

2395

3373

pass

2396

3374

2397

3375

# Clients who has passed its expire date can still be

2398

# enabled if its last checker was successful. Clients

3376

# enabled if its last checker was successful. A Client

2399

3377

# whose checker succeeded before we stored its state is

2400

3378

# assumed to have successfully run all checkers during

2401

3379

# downtime.

2402

3380

if client["enabled"]:

2403

3381

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

2404

3382

if not client["last_checked_ok"]:

2405

logger.warning(

2406

"disabling client {0} - Client never "

2407

"performed a successful checker"

2408

.format(client_name))

3383

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

3384

" never performed a successful"

3385

" checker", client_name)

2409

3386

client["enabled"] = False

2410

3387

elif client["last_checker_status"] != 0:

2411

logger.warning(

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2414

.format(client_name,

2415

client["last_checker_status"]))

3388

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

3389

" last checker failed with error"

3390

" code %s", client_name,

3391

client["last_checker_status"])

2416

3392

client["enabled"] = False

2417

3393

else:

2418

client["expires"] = (datetime.datetime

2419

.utcnow()

2420

+ client["timeout"])

2421

logger.debug("Last checker succeeded,"

2422

" keeping {0} enabled"

2423

.format(client_name))

3394

client["expires"] = (

3395

datetime.datetime.utcnow()

3396

+ client["timeout"])

3397

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

3398

" enabled", client_name)

2424

3399

try:

2425

client["secret"] = (

2426

pgp.decrypt(client["encrypted_secret"],

2427

client_settings[client_name]

2428

["secret"]))

3400

client["secret"] = pgp.decrypt(

3401

client["encrypted_secret"],

3402

client_settings[client_name]["secret"])

2429

3403

except PGPError:

2430

3404

# If decryption fails, we use secret from new settings

2431

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

2432

.format(client_name))

2433

client["secret"] = (

2434

client_settings[client_name]["secret"])

2435

3405

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

3406

client_name)

3407

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

3408

["secret"])

3409

2436

3410

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

2437

3411

for client_name in (set(old_client_settings)

2438

3412

- set(client_settings)):

2440

3414

for client_name in (set(client_settings)

2441

3415

- set(old_client_settings)):

2442

3416

clients_data[client_name] = client_settings[client_name]

2443

3417

2444

3418

# Create all client objects

2445

for client_name, client in clients_data.iteritems():

3419

for client_name, client in clients_data.items():

2446

3420

tcp_server.clients[client_name] = client_class(

2447

name = client_name, settings = client)

2448

3421

name=client_name,

3422

settings=client,

3423

server_settings=server_settings)

3424

2449

3425

if not tcp_server.clients:

2450

logger.warning("No clients defined")

2451

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

3426

log.warning("No clients defined")

3427

3428

if not foreground:

3429

if pidfile is not None:

3430

pid = os.getpid()

3431

try:

3432

with pidfile:

3433

print(pid, file=pidfile)

3434

except IOError:

3435

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

3436

pidfilename, pid)

3437

del pidfile

2464

3438

del pidfilename

2465

2466

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

2467

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

2468

3439

3440

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

3441

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3442

lambda: main_loop.quit() and False)

3443

2469

3444

if use_dbus:

2470

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

2471

"se.bsnet.fukt.Mandos"})

2472

class MandosDBusService(DBusObjectWithProperties):

3445

3446

@alternate_dbus_interfaces(

3447

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

3448

class MandosDBusService(DBusObjectWithObjectManager):

2473

3449

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

3450

2474

3451

def __init__(self):

2475

3452

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

3453

2476

3454

_interface = "se.recompile.Mandos"

2477

2478

@dbus_interface_annotations(_interface)

2479

def _foo(self):

2480

return { "org.freedesktop.DBus.Property"

2481

".EmitsChangedSignal":

2482

"false"}

2483

3455

2484

3456

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

2485

3457

def ClientAdded(self, objpath):

2486

3458

"D-Bus signal"

2487

3459

pass

2488

3460

2489

3461

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

2490

def ClientNotFound(self, fingerprint, address):

3462

def ClientNotFound(self, key_id, address):

2491

3463

"D-Bus signal"

2492

3464

pass

2493

3465

3466

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

3467

"true"})

2494

3468

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

2495

3469

def ClientRemoved(self, objpath, name):

2496

3470

"D-Bus signal"

2497

3471

pass

2498

3472

3473

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

3474

"true"})

2499

3475

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

2500

3476

def GetAllClients(self):

2501

3477

"D-Bus method"

2502

return dbus.Array(c.dbus_object_path

2503

for c in

2504

tcp_server.clients.itervalues())

2505

3478

return dbus.Array(c.dbus_object_path for c in

3479

tcp_server.clients.values())

3480

3481

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

3482

"true"})

2506

3483

@dbus.service.method(_interface,

2507

3484

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

2508

3485

def GetAllClientsWithProperties(self):

2509

3486

"D-Bus method"

2510

3487

return dbus.Dictionary(

2511

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

2512

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

3488

{c.dbus_object_path: c.GetAll(

3489

"se.recompile.Mandos.Client")

3490

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

2513

3491

signature="oa{sv}")

2514

3492

2515

3493

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

2516

3494

def RemoveClient(self, object_path):

2517

3495

"D-Bus method"

2518

for c in tcp_server.clients.itervalues():

3496

for c in tcp_server.clients.values():

2519

3497

if c.dbus_object_path == object_path:

2520

3498

del tcp_server.clients[c.name]

2521

3499

c.remove_from_connection()

2522

# Don't signal anything except ClientRemoved

3500

# Don't signal the disabling

2523

3501

c.disable(quiet=True)

2524

# Emit D-Bus signal

2525

self.ClientRemoved(object_path, c.name)

3502

# Emit D-Bus signal for removal

3503

self.client_removed_signal(c)

2526

3504

return

2527

3505

raise KeyError(object_path)

2528

3506

2529

3507

del _interface

2530

3508

3509

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3510

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

3511

def GetManagedObjects(self):

3512

"""D-Bus method"""

3513

return dbus.Dictionary(

3514

{client.dbus_object_path:

3515

dbus.Dictionary(

3516

{interface: client.GetAll(interface)

3517

for interface in

3518

client._get_all_interface_names()})

3519

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

3520

3521

def client_added_signal(self, client):

3522

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

3523

if use_dbus:

3524

# New standard signal

3525

self.InterfacesAdded(

3526

client.dbus_object_path,

3527

dbus.Dictionary(

3528

{interface: client.GetAll(interface)

3529

for interface in

3530

client._get_all_interface_names()}))

3531

# Old signal

3532

self.ClientAdded(client.dbus_object_path)

3533

3534

def client_removed_signal(self, client):

3535

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

3536

if use_dbus:

3537

# New standard signal

3538

self.InterfacesRemoved(

3539

client.dbus_object_path,

3540

client._get_all_interface_names())

3541

# Old signal

3542

self.ClientRemoved(client.dbus_object_path,

3543

client.name)

3544

2531

3545

mandos_dbus_service = MandosDBusService()

2532

3546

3547

# Save modules to variables to exempt the modules from being

3548

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

3549

mp = multiprocessing

3550

wn = wnull

3551

2533

3552

def cleanup():

2534

3553

"Cleanup function; run on exit"

2535

service.cleanup()

2536

2537

multiprocessing.active_children()

3554

if zeroconf:

3555

service.cleanup()

3556

3557

mp.active_children()

3558

wn.close()

2538

3559

if not (tcp_server.clients or client_settings):

2539

3560

return

2540

3561

2541

3562

# Store client before exiting. Secrets are encrypted with key

2542

3563

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

2543

3564

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

2544

3565

clients = {}

2545

3566

with PGPEngine() as pgp:

2546

for client in tcp_server.clients.itervalues():

3567

for client in tcp_server.clients.values():

2547

3568

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

2548

3569

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

2549

3570

key)

2550

3571

client_dict = {}

2551

3572

2552

3573

# A list of attributes that can not be pickled

2553

3574

# + secret.

2554

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

2555

"checker"))

2556

for name, typ in (inspect.getmembers

2557

(dbus.service.Object)):

3575

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

3576

"checker", "server_settings"}

3577

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

3578

.Object):

2558

3579

exclude.add(name)

2559

3580

2560

3581

client_dict["encrypted_secret"] = (client

2561

3582

.encrypted_secret)

2562

3583

for attr in client.client_structure:

2563

3584

if attr not in exclude:

2564

3585

client_dict[attr] = getattr(client, attr)

2565

3586

2566

3587

clients[client.name] = client_dict

2567

3588

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

2568

3589

2569

3590

try:

2570

with (tempfile.NamedTemporaryFile

2571

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

2572

dir=os.path.dirname(stored_state_path),

2573

delete=False)) as stored_state:

2574

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

2575

tempname=stored_state.name

3591

with tempfile.NamedTemporaryFile(

3592

mode="wb",

3593

suffix=".pickle",

3594

prefix="clients-",

3595

dir=os.path.dirname(stored_state_path),

3596

delete=False) as stored_state:

3597

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

3598

protocol=2)

3599

tempname = stored_state.name

2576

3600

os.rename(tempname, stored_state_path)

2577

3601

except (IOError, OSError) as e:

2578

3602

if not debug:

2581

3605

except NameError:

2582

3606

pass

2583

3607

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

2584

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

2585

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

3608

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

3609

os.strerror(e.errno))

2586

3610

else:

2587

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

2588

exc_info=e)

2589

raise e

2590

3611

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

3612

exc_info=e)

3613

raise

3614

2591

3615

# Delete all clients, and settings from config

2592

3616

while tcp_server.clients:

2593

3617

name, client = tcp_server.clients.popitem()

2594

3618

if use_dbus:

2595

3619

client.remove_from_connection()

2596

# Don't signal anything except ClientRemoved

3620

# Don't signal the disabling

2597

3621

client.disable(quiet=True)

3622

# Emit D-Bus signal for removal

2598

3623

if use_dbus:

2599

# Emit D-Bus signal

2600

mandos_dbus_service.ClientRemoved(client

2601

.dbus_object_path,

2602

client.name)

3624

mandos_dbus_service.client_removed_signal(client)

2603

3625

client_settings.clear()

2604

3626

2605

3627

atexit.register(cleanup)

2606

2607

for client in tcp_server.clients.itervalues():

3628

3629

for client in tcp_server.clients.values():

2608

3630

if use_dbus:

2609

# Emit D-Bus signal

2610

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3631

# Emit D-Bus signal for adding

3632

mandos_dbus_service.client_added_signal(client)

2611

3633

# Need to initiate checking of clients

2612

3634

if client.enabled:

2613

client.init_checker()

2614

3635

client.init_checker(randomize_start=True)

3636

2615

3637

tcp_server.enable()

2616

3638

tcp_server.server_activate()

2617

3639

2618

3640

# Find out what port we got

2619

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

3641

if zeroconf:

3642

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

2620

3643

if use_ipv6:

2621

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

2622

" flowinfo %d, scope_id %d",

2623

*tcp_server.socket.getsockname())

3644

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

3645

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

2624

3646

else: # IPv4

2625

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

2626

*tcp_server.socket.getsockname())

2627

2628

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

2629

3647

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

3648

*tcp_server.socket.getsockname())

3649

3650

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

3651

2630

3652

try:

2631

# From the Avahi example code

2632

try:

2633

service.activate()

2634

except dbus.exceptions.DBusException as error:

2635

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

2636

cleanup()

2637

sys.exit(1)

2638

# End of Avahi example code

2639

2640

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

2641

lambda *args, **kwargs:

2642

(tcp_server.handle_request

2643

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

2644

2645

logger.debug("Starting main loop")

3653

if zeroconf:

3654

# From the Avahi example code

3655

try:

3656

service.activate()

3657

except dbus.exceptions.DBusException as error:

3658

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

3659

cleanup()

3660

sys.exit(1)

3661

# End of Avahi example code

3662

3663

GLib.io_add_watch(

3664

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

3665

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3666

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

3667

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

3668

3669

log.debug("Starting main loop")

2646

3670

main_loop.run()

2647

3671

except AvahiError as error:

2648

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

3672

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

2649

3673

cleanup()

2650

3674

sys.exit(1)

2651

3675

except KeyboardInterrupt:

2652

3676

if debug:

2653

3677

print("", file=sys.stderr)

2654

logger.debug("Server received KeyboardInterrupt")

2655

logger.debug("Server exiting")

3678

log.debug("Server received KeyboardInterrupt")

3679

log.debug("Server exiting")

2656

3680

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

2657

3681

cleanup()

2658

3682

2659

if __name__ == '__main__':

2660

main()

3683

3684

def parse_test_args():

3685

# type: () -> argparse.Namespace

3686

parser = argparse.ArgumentParser(add_help=False)

3687

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

3688

parser.add_argument("--prefix", )

3689

args, unknown_args = parser.parse_known_args()

3690

if args.check:

3691

# Remove test options from sys.argv

3692

sys.argv[1:] = unknown_args

3693

return args

3694

3695

# Add all tests from doctest strings

3696

def load_tests(loader, tests, none):

3697

import doctest

3698

tests.addTests(doctest.DocTestSuite())

3699

return tests

3700

3701

if __name__ == "__main__":

3702

options = parse_test_args()

3703

try:

3704

if options.check:

3705

extra_test_prefix = options.prefix

3706

if extra_test_prefix is not None:

3707

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

3708

.result.wasSuccessful()):

3709

sys.exit(1)

3710

class ExtraTestLoader(unittest.TestLoader):

3711

testMethodPrefix = extra_test_prefix

3712

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

3713

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

3714

else:

3715

unittest.main(argv=[""])

3716

else:

3717

main()

3718

finally:

3719

logging.shutdown()

3720

3721

# Local Variables:

3722

# run-tests:

3723

# (lambda (&optional extra)

3724

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

3725

# extra))

3726

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

3727

# (funcall remove-test-window)

3728

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

3729

# run-tests-in-test-buffer:

3730

# (lambda (dir &optional extra)

3731

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

3732

# (setq buffer-read-only nil

3733

# default-directory dir)

3734

# (erase-buffer)

3735

# (compilation-mode))

3736

# (let ((process-result

3737

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

3738

# (process-file-shell-command

3739

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

3740

# (and (numberp process-result)

3741

# (= process-result 0))))

3742

# get-command-line:

3743

# (lambda (&optional extra)

3744

# (let ((quoted-script

3745

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

3746

# (format

3747

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

3748

# quoted-script)))

3749

# get-script-name:

3750

# (lambda ()

3751

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

3752

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

3753

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

3754

# (buffer-file-name))))

3755

# remove-test-window:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (lambda ()

3761

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

3762

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

3763

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

3764

# (display-buffer-overriding-action

3765

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

3766

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

3767

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

3768

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

3769

# eval:

3770

# (progn

3771

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

3772

# (funcall run-tests t)))

3773

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

3774

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

3775

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

3776

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

3777

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

3778

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

3779

# End: