/mandos/release : revision 237.7.157

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

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

82

import GnuPGInterface

83

84

try:

122

85

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

86

except AttributeError:

124

87

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

88

from IN import SO_BINDTODEVICE

128

89

except ImportError:

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"

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

147

93

stored_state_file = "clients.pickle"

148

94

149

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

150

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

151

syslogger = None

95

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

152

99

153

100

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

156

104

except (OSError, AttributeError):

157

158

105

def if_nametoindex(interface):

159

106

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

160

107

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

161

108

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

162

109

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

165

114

return interface_index

166

115

167

116

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

184

117

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

185

118

"""init logger and add loglevel"""

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

119

191

120

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

121

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

122

' %(message)s'))

123

logger.addHandler(syslogger)

124

196

125

if debug:

197

126

console = logging.StreamHandler()

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)

127

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

128

' [%(process)d]:'

129

' %(levelname)s:'

130

' %(message)s'))

131

logger.addHandler(console)

132

logger.setLevel(level)

204

133

205

134

206

135

class PGPError(Exception):

208

137

pass

209

138

210

139

211

class PGPEngine:

140

class PGPEngine(object):

212

141

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

213

214

142

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

215

144

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

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

235

152

def __enter__(self):

236

153

return self

237

154

238

155

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

239

156

self._cleanup()

240

157

return False

241

158

242

159

def __del__(self):

243

160

self._cleanup()

244

161

245

162

def _cleanup(self):

246

163

if self.tempdir is not None:

247

164

# Delete contents of tempdir

248

165

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

249

topdown=False):

166

topdown = False):

250

167

for filename in files:

251

168

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

252

169

for dirname in dirs:

254

171

# Remove tempdir

255

172

os.rmdir(self.tempdir)

256

173

self.tempdir = None

257

174

258

175

def password_encode(self, password):

259

176

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

260

177

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

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

178

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

179

269

180

def encrypt(self, data, password):

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)

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

285

195

return ciphertext

286

196

287

197

def decrypt(self, data, password):

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)

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

303

212

return decrypted_plaintext

304

213

305

214

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

332

215

class AvahiError(Exception):

333

216

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

334

217

self.value = value

335

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

336

**kwargs)

337

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

338

221

339

222

class AvahiServiceError(AvahiError):

340

223

pass

341

224

342

343

225

class AvahiGroupError(AvahiError):

344

226

pass

345

227

346

228

347

class AvahiService:

229

class AvahiService(object):

348

230

"""An Avahi (Zeroconf) service.

349

231

350

232

Attributes:

351

233

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

352

234

Used to optionally bind to the specified interface.

353

354

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

355

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

235

236

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

237

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

356

238

port: integer; what port to announce

357

239

TXT: list of strings; TXT record for the service

358

240

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

364

246

server: D-Bus Server

365

247

bus: dbus.SystemBus()

366

248

"""

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

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

379

254

self.interface = interface

380

255

self.name = name

381

256

self.type = servicetype

390

265

self.server = None

391

266

self.bus = bus

392

267

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

268

269

def rename(self):

395

270

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

396

271

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

272

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

273

" after %i retries, exiting.",

274

self.rename_count)

400

275

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

278

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

279

self.name)

280

self.remove()

281

try:

282

self.add()

283

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

403

287

self.rename_count += 1

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

289

def remove(self):

421

290

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

422

291

if self.entry_group_state_changed_match is not None:

424

293

self.entry_group_state_changed_match = None

425

294

if self.group is not None:

426

295

self.group.Reset()

427

296

428

297

def add(self):

429

298

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

430

299

self.remove()

435

304

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

305

self.entry_group_state_changed_match = (

437

306

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

307

'StateChanged', self.entry_group_state_changed))

308

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

309

self.name, self.type)

441

310

self.group.AddService(

442

311

self.interface,

443

312

self.protocol,

447

316

dbus.UInt16(self.port),

448

317

avahi.string_array_to_txt_array(self.TXT))

449

318

self.group.Commit()

450

319

451

320

def entry_group_state_changed(self, state, error):

452

321

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

453

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

454

322

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

323

455

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

325

logger.debug("Zeroconf service established.")

457

326

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

327

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

459

328

self.rename()

460

329

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

463

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

464

330

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

331

unicode(error))

332

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

333

.format(error))

334

465

335

def cleanup(self):

466

336

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

467

337

if self.group is not None:

472

342

pass

473

343

self.group = None

474

344

self.remove()

475

345

476

346

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

477

347

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

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

}

348

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

485

356

if state in bad_states:

486

357

if bad_states[state] is not None:

487

358

if error is None:

488

log.error(bad_states[state])

359

logger.error(bad_states[state])

489

360

else:

490

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

361

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

491

362

self.cleanup()

492

363

elif state == avahi.SERVER_RUNNING:

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

self.add()

504

365

else:

505

366

if error is None:

506

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

367

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

507

368

else:

508

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

509

369

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

370

510

371

def activate(self):

511

372

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

512

373

if self.server is None:

516

377

follow_name_owner_changes=True),

517

378

avahi.DBUS_INTERFACE_SERVER)

518

379

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

380

self.server_state_changed)

520

381

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

521

382

522

383

523

384

class AvahiServiceToSyslog(AvahiService):

524

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

385

def rename(self):

525

386

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

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

531

392

return ret

532

393

533

394

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:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

875

403

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

876

404

877

405

Attributes:

878

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

406

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

879

407

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

880

408

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

885

413

checker_command: string; External command which is run to check

886

414

if client lives. %() expansions are done at

887

415

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

888

416

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

889

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

890

418

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

891

419

client_structure: Object describing what attributes a client has

892

420

and is used for storing the client at exit

893

421

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

895

423

enabled: bool()

896

424

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

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

uniquely identify the client

900

426

host: string; available for use by the checker command

901

427

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

902

428

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

904

430

last_checker_status: integer between 0 and 255 reflecting exit

905

431

status of last checker. -1 reflects crashed

906

432

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

909

433

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

910

434

911

435

D-Bus identifiers

916

440

runtime_expansions: Allowed attributes for runtime expansion.

917

441

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

918

442

disabled, or None

919

server_settings: The server_settings dict from main()

920

443

"""

921

444

922

445

runtime_expansions = ("approval_delay", "approval_duration",

923

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

446

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

924

447

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

925

448

"last_approval_request", "last_checked_ok",

926

449

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

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

939

476

@staticmethod

940

477

def config_parser(config):

941

478

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

948

485

for client_name in config.sections():

949

486

section = dict(config.items(client_name))

950

487

client = settings[client_name] = {}

951

488

952

489

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

953

490

# Reformat values from string types to Python types

954

491

client["approved_by_default"] = config.getboolean(

955

492

client_name, "approved_by_default")

956

493

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

957

494

"enabled")

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

496

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

965

497

.replace(" ", ""))

966

498

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

499

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

970

500

elif "secfile" in section:

971

501

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

972

502

(section["secfile"])),

973

503

"rb") as secfile:

974

504

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

975

505

else:

976

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

506

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

977

507

.format(section))

978

508

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

979

509

client["extended_timeout"] = string_to_delta(

987

517

client["last_approval_request"] = None

988

518

client["last_checked_ok"] = None

989

519

client["last_checker_status"] = -2

990

520

991

521

return settings

992

993

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

522

523

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

994

524

self.name = name

995

if server_settings is None:

996

server_settings = {}

997

self.server_settings = server_settings

998

525

# adding all client settings

999

for setting, value in settings.items():

526

for setting, value in settings.iteritems():

1000

527

setattr(self, setting, value)

1001

528

1002

529

if self.enabled:

1003

530

if not hasattr(self, "last_enabled"):

1004

531

self.last_enabled = datetime.datetime.utcnow()

1008

535

else:

1009

536

self.last_enabled = None

1010

537

self.expires = None

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)

538

539

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

543

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

1015

544

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

1016

545

datetime.datetime.utcnow())

1017

546

1018

547

# attributes specific for this server instance

1019

548

self.checker = None

1020

549

self.checker_initiator_tag = None

1023

552

self.current_checker_command = None

1024

553

self.approved = None

1025

554

self.approvals_pending = 0

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

1030

560

if not attr.startswith("_")]

1031

561

self.client_structure.append("client_structure")

1032

1033

for name, t in inspect.getmembers(

1034

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

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

1035

567

if not name.startswith("_"):

1036

568

self.client_structure.append(name)

1037

569

1038

570

# Send notice to process children that client state has changed

1039

571

def send_changedstate(self):

1040

572

with self.changedstate:

1041

573

self.changedstate.notify_all()

1042

574

1043

575

def enable(self):

1044

576

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

1045

577

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

1050

582

self.last_enabled = datetime.datetime.utcnow()

1051

583

self.init_checker()

1052

584

self.send_changedstate()

1053

585

1054

586

def disable(self, quiet=True):

1055

587

"""Disable this client."""

1056

588

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

1057

589

return False

1058

590

if not quiet:

1059

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

591

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

1060

592

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

1061

GLib.source_remove(self.disable_initiator_tag)

593

gobject.source_remove(self.disable_initiator_tag)

1062

594

self.disable_initiator_tag = None

1063

595

self.expires = None

1064

596

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

1065

GLib.source_remove(self.checker_initiator_tag)

597

gobject.source_remove(self.checker_initiator_tag)

1066

598

self.checker_initiator_tag = None

1067

599

self.stop_checker()

1068

600

self.enabled = False

1069

601

if not quiet:

1070

602

self.send_changedstate()

1071

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

603

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

1072

604

return False

1073

605

1074

606

def __del__(self):

1075

607

self.disable()

1076

608

1077

609

def init_checker(self):

1078

610

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

1079

611

# and every interval from then on.

1080

612

if self.checker_initiator_tag is not None:

1081

GLib.source_remove(self.checker_initiator_tag)

1082

self.checker_initiator_tag = GLib.timeout_add(

1083

random.randrange(int(self.interval.total_seconds() * 1000

1084

+ 1)),

1085

self.start_checker)

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1086

617

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

1087

618

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

1090

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

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1091

623

# Also start a new checker *right now*.

1092

624

self.start_checker()

1093

1094

def checker_callback(self, source, condition, connection,

1095

command):

625

626

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

1096

627

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

1097

# Read return code from connection (see call_pipe)

1098

returncode = connection.recv()

1099

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

1102

628

self.checker_callback_tag = None

1103

629

self.checker = None

1104

1105

if returncode >= 0:

1106

self.last_checker_status = returncode

1107

self.last_checker_signal = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1108

632

if self.last_checker_status == 0:

1109

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

633

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

634

vars(self))

1110

635

self.checked_ok()

1111

636

else:

1112

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

637

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

638

vars(self))

1113

639

else:

1114

640

self.last_checker_status = -1

1115

self.last_checker_signal = -returncode

1116

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

1117

return False

1118

641

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

642

vars(self))

643

1119

644

def checked_ok(self):

1120

645

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

1121

646

self.last_checked_ok = datetime.datetime.utcnow()

1122

647

self.last_checker_status = 0

1123

self.last_checker_signal = None

1124

648

self.bump_timeout()

1125

649

1126

650

def bump_timeout(self, timeout=None):

1127

651

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

1128

652

if timeout is None:

1129

653

timeout = self.timeout

1130

654

if self.disable_initiator_tag is not None:

1131

GLib.source_remove(self.disable_initiator_tag)

655

gobject.source_remove(self.disable_initiator_tag)

1132

656

self.disable_initiator_tag = None

1133

657

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

1134

self.disable_initiator_tag = GLib.timeout_add(

1135

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1136

661

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

1137

662

1138

663

def need_approval(self):

1139

664

self.last_approval_request = datetime.datetime.utcnow()

1140

665

1141

666

def start_checker(self):

1142

667

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

1143

668

1144

669

If a checker already exists, leave it running and do

1145

670

nothing."""

1146

671

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

1151

676

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

1152

677

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

1153

678

# should be.

1154

1155

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

1156

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

1157

self.checker.join()

1158

self.checker = None

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1159

693

# Start a new checker if needed

1160

694

if self.checker is None:

1161

695

# Escape attributes for the shell

1162

escaped_attrs = {

1163

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

1164

for attr in self.runtime_expansions}

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1165

700

try:

1166

701

command = self.checker_command % escaped_attrs

1167

702

except TypeError as error:

1168

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

1169

self.checker_command, exc_info=error)

1170

return True # Try again later

703

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1171

706

self.current_checker_command = command

1172

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

1173

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

1174

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

1175

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

1176

# always replaced by /dev/null.)

1177

# The exception is when not debugging but nevertheless

1178

# running in the foreground; use the previously

1179

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

1183

if (not self.server_settings["debug"]

1184

and self.server_settings["foreground"]):

1185

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

1188

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

1192

self.checker.start()

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

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

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1196

self.checker_callback, pipe[0], command)

1197

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

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

self.checker_callback_tag = (gobject.child_watch_add

721

(self.checker.pid,

722

self.checker_callback,

723

data=command))

724

# The checker may have completed before the gobject

725

# watch was added. Check for this.

726

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

727

if pid:

728

gobject.source_remove(self.checker_callback_tag)

729

self.checker_callback(pid, status, command)

730

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

1198

731

return True

1199

732

1200

733

def stop_checker(self):

1201

734

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

1202

735

if self.checker_callback_tag:

1203

GLib.source_remove(self.checker_callback_tag)

736

gobject.source_remove(self.checker_callback_tag)

1204

737

self.checker_callback_tag = None

1205

738

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

1206

739

return

1207

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

1208

self.checker.terminate()

740

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

741

try:

742

self.checker.terminate()

743

#time.sleep(0.5)

744

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

745

# self.checker.kill()

746

except OSError as error:

747

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

748

raise

1209

749

self.checker = None

1210

750

1211

751

1212

def dbus_service_property(dbus_interface,

1213

signature="v",

1214

access="readwrite",

1215

byte_arrays=False):

752

def dbus_service_property(dbus_interface, signature="v",

753

access="readwrite", byte_arrays=False):

1216

754

"""Decorators for marking methods of a DBusObjectWithProperties to

1217

755

become properties on the D-Bus.

1218

756

1219

757

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

1220

758

and with one argument by "Set".

1221

759

1222

760

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

1223

761

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

1224

762

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

1227

765

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

1228

766

if byte_arrays and signature != "ay":

1229

767

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

1230

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

1231

768

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

1232

769

def decorator(func):

1233

770

func._dbus_is_property = True

1234

771

func._dbus_interface = dbus_interface

1237

774

func._dbus_name = func.__name__

1238

775

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

1239

776

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

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

777

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1241

778

return func

1242

1243

779

return decorator

1244

780

1245

781

1246

782

def dbus_interface_annotations(dbus_interface):

1247

783

"""Decorator for marking functions returning interface annotations

1248

784

1249

785

Usage:

1250

786

1251

787

@dbus_interface_annotations("org.example.Interface")

1252

788

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

1253

789

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

1254

790

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

1255

791

"false"}

1256

792

"""

1257

1258

793

def decorator(func):

1259

794

func._dbus_is_interface = True

1260

795

func._dbus_interface = dbus_interface

1261

796

func._dbus_name = dbus_interface

1262

797

return func

1263

1264

798

return decorator

1265

799

1266

800

1267

801

def dbus_annotations(annotations):

1268

802

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

1269

803

Usage:

1270

1271

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

1272

"org.freedesktop.DBus.Property."

1273

"EmitsChangedSignal": "false"})

804

1274

805

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

1275

806

access="r")

807

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

808

"org.freedesktop.DBus.Property."

809

"EmitsChangedSignal": "false"})

1276

810

def Property_dbus_property(self):

1277

811

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

1280

812

"""

1281

1282

813

def decorator(func):

1283

814

func._dbus_annotations = annotations

1284

815

return func

1285

1286

816

return decorator

1287

817

1288

818

1289

819

class DBusPropertyException(dbus.exceptions.DBusException):

1290

820

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

1291

821

"""

1292

pass

822

def __unicode__(self):

823

return unicode(str(self))

1293

824

1294

825

1295

826

class DBusPropertyAccessException(DBusPropertyException):

1304

835

pass

1305

836

1306

837

1307

class DBusObjectWithAnnotations(dbus.service.Object):

1308

"""A D-Bus object with annotations.

1309

1310

Classes inheriting from this can use the dbus_annotations

1311

decorator to add annotations to methods or signals.

838

class DBusObjectWithProperties(dbus.service.Object):

839

"""A D-Bus object with properties.

840

841

Classes inheriting from this can use the dbus_service_property

842

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

843

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

1312

844

"""

1313

845

1314

846

@staticmethod

1315

847

def _is_dbus_thing(thing):

1316

848

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

1317

849

1318

850

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

1319

851

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

1320

852

"""

1321

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

853

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

1322

854

False)

1323

855

1324

856

def _get_all_dbus_things(self, thing):

1325

857

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

1326

858

"""

1327

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

859

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

860

name),

1328

861

athing.__get__(self))

1329

862

for cls in self.__class__.__mro__

1330

863

for name, athing in

1331

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

1332

1333

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1337

def Introspect(self, object_path, connection):

1338

"""Overloading of standard D-Bus method.

1339

1340

Inserts annotation tags on methods and signals.

1341

"""

1342

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

1343

connection)

1344

try:

1345

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

1346

1347

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

1348

# Add annotation tags

1349

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

1350

for tag in if_tag.getElementsByTagName(typ):

1351

annots = dict()

1352

for name, prop in (self.

1353

_get_all_dbus_things(typ)):

1354

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

1355

and prop._dbus_interface

1356

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

1357

annots.update(getattr(

1358

prop, "_dbus_annotations", {}))

1359

for name, value in annots.items():

1360

ann_tag = document.createElement(

1361

"annotation")

1362

ann_tag.setAttribute("name", name)

1363

ann_tag.setAttribute("value", value)

1364

tag.appendChild(ann_tag)

1365

# Add interface annotation tags

1366

for annotation, value in dict(

1367

itertools.chain.from_iterable(

1368

annotations().items()

1369

for name, annotations

1370

in self._get_all_dbus_things("interface")

1371

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

1372

)).items():

1373

ann_tag = document.createElement("annotation")

1374

ann_tag.setAttribute("name", annotation)

1375

ann_tag.setAttribute("value", value)

1376

if_tag.appendChild(ann_tag)

1377

# Fix argument name for the Introspect method itself

1378

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1380

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

1381

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

1382

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

1383

if (arg.getAttribute("direction")

1384

== "out"):

1385

arg.setAttribute("name",

1386

"xml_data")

1387

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

1388

document.unlink()

1389

except (AttributeError, xml.dom.DOMException,

1390

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1393

return xmlstring

1394

1395

1396

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

"""A D-Bus object with properties.

1398

1399

Classes inheriting from this can use the dbus_service_property

1400

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

1401

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

1402

"""

1403

864

inspect.getmembers(cls,

865

self._is_dbus_thing(thing)))

866

1404

867

def _get_dbus_property(self, interface_name, property_name):

1405

868

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

1406

869

property with the specified name and interface.

1407

870

"""

1408

for cls in self.__class__.__mro__:

1409

for name, value in inspect.getmembers(

1410

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

871

for cls in self.__class__.__mro__:

872

for name, value in (inspect.getmembers

873

(cls,

874

self._is_dbus_thing("property"))):

1411

875

if (value._dbus_name == property_name

1412

876

and value._dbus_interface == interface_name):

1413

877

return value.__get__(self)

1414

878

1415

879

# No such property

1416

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

1417

self.dbus_object_path, interface_name, property_name))

1418

1419

@classmethod

1420

def _get_all_interface_names(cls):

1421

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

1422

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

1423

"_dbus_interface", None)

1424

for x in (inspect.getmro(cls))

1425

for attr in dir(x))

1426

if name is not None)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="ss",

880

raise DBusPropertyNotFound(self.dbus_object_path + ":"

881

+ interface_name + "."

882

+ property_name)

883

884

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

1430

885

out_signature="v")

1431

886

def Get(self, interface_name, property_name):

1432

887

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

1438

893

if not hasattr(value, "variant_level"):

1439

894

return value

1440

895

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

1441

896

1442

897

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

1443

898

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

1444

899

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

1450

905

# The byte_arrays option is not supported yet on

1451

906

# signatures other than "ay".

1452

907

if prop._dbus_signature != "ay":

1453

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

1454

"'ay' signature {!r}"

1455

.format(prop._dbus_signature))

1456

value = dbus.ByteArray(bytes(value))

908

raise ValueError

909

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

910

for byte in value))

1457

911

prop(value)

1458

1459

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

in_signature="s",

912

913

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

1461

914

out_signature="a{sv}")

1462

915

def GetAll(self, interface_name):

1463

916

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

1464

917

standard.

1465

918

1466

919

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

1467

920

"""

1468

921

properties = {}

1478

931

if not hasattr(value, "variant_level"):

1479

932

properties[name] = value

1480

933

continue

1481

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

934

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

935

value.variant_level+1)

1483

936

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

1484

1485

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

1486

def PropertiesChanged(self, interface_name, changed_properties,

1487

invalidated_properties):

1488

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

1489

standard.

1490

"""

1491

pass

1492

937

1493

938

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1494

939

out_signature="s",

1495

path_keyword="object_path",

1496

connection_keyword="connection")

940

path_keyword='object_path',

941

connection_keyword='connection')

1497

942

def Introspect(self, object_path, connection):

1498

943

"""Overloading of standard D-Bus method.

1499

944

1500

945

Inserts property tags and interface annotation tags.

1501

946

"""

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

947

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

948

connection)

1505

949

try:

1506

950

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

1507

1508

951

def make_tag(document, name, prop):

1509

952

e = document.createElement("property")

1510

953

e.setAttribute("name", name)

1511

954

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

1512

955

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

1513

956

return e

1514

1515

957

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

1516

958

# Add property tags

1517

959

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

1520

962

if prop._dbus_interface

1521

963

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

1522

964

if_tag.appendChild(tag)

1523

# Add annotation tags for properties

1524

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

1525

annots = dict()

1526

for name, prop in self._get_all_dbus_things(

1527

"property"):

1528

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

1529

and prop._dbus_interface

1530

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

1531

annots.update(getattr(

1532

prop, "_dbus_annotations", {}))

1533

for name, value in annots.items():

1534

ann_tag = document.createElement(

1535

"annotation")

1536

ann_tag.setAttribute("name", name)

1537

ann_tag.setAttribute("value", value)

1538

tag.appendChild(ann_tag)

965

# Add annotation tags

966

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

967

for tag in if_tag.getElementsByTagName(typ):

968

annots = dict()

969

for name, prop in (self.

970

_get_all_dbus_things(typ)):

971

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

972

and prop._dbus_interface

973

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

974

annots.update(getattr

975

(prop,

976

"_dbus_annotations",

977

{}))

978

for name, value in annots.iteritems():

979

ann_tag = document.createElement(

980

"annotation")

981

ann_tag.setAttribute("name", name)

982

ann_tag.setAttribute("value", value)

983

tag.appendChild(ann_tag)

984

# Add interface annotation tags

985

for annotation, value in dict(

986

itertools.chain.from_iterable(

987

annotations().iteritems()

988

for name, annotations in

989

self._get_all_dbus_things("interface")

990

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

991

)).iteritems():

992

ann_tag = document.createElement("annotation")

993

ann_tag.setAttribute("name", annotation)

994

ann_tag.setAttribute("value", value)

995

if_tag.appendChild(ann_tag)

1539

996

# Add the names to the return values for the

1540

997

# "org.freedesktop.DBus.Properties" methods

1541

998

if (if_tag.getAttribute("name")

1555

1012

document.unlink()

1556

1013

except (AttributeError, xml.dom.DOMException,

1557

1014

xml.parsers.expat.ExpatError) as error:

1558

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

1559

exc_info=error)

1560

return xmlstring

1561

1562

1563

try:

1564

dbus.OBJECT_MANAGER_IFACE

1565

except AttributeError:

1566

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

1567

1568

1569

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

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

1571

1572

Classes inheriting from this exposes the standard

1573

GetManagedObjects call and the InterfacesAdded and

1574

InterfacesRemoved signals on the standard

1575

"org.freedesktop.DBus.ObjectManager" interface.

1576

1577

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

1578

manually.

1579

"""

1580

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1582

def GetManagedObjects(self):

1583

"""This function must be overridden"""

1584

raise NotImplementedError()

1585

1586

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1588

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

pass

1590

1591

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

1592

def InterfacesRemoved(self, object_path, interfaces):

1593

pass

1594

1595

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1599

def Introspect(self, object_path, connection):

1600

"""Overloading of standard D-Bus method.

1601

1602

Override return argument name of GetManagedObjects to be

1603

"objpath_interfaces_and_properties"

1604

"""

1605

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1606

object_path,

1607

connection)

1608

try:

1609

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

1610

1611

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

1612

# Fix argument name for the GetManagedObjects method

1613

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1615

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

1616

if (cn.getAttribute("name")

1617

== "GetManagedObjects"):

1618

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

1619

if (arg.getAttribute("direction")

1620

== "out"):

1621

arg.setAttribute(

1622

"name",

1623

"objpath_interfaces"

1624

"_and_properties")

1625

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

1626

document.unlink()

1627

except (AttributeError, xml.dom.DOMException,

1628

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1015

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

1016

exc_info=error)

1631

1017

return xmlstring

1632

1018

1633

1019

1634

1020

def datetime_to_dbus(dt, variant_level=0):

1635

1021

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

1636

1022

if dt is None:

1637

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

1638

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

1023

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

1024

return dbus.String(dt.isoformat(),

1025

variant_level=variant_level)

1639

1026

1640

1027

1641

1028

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1643

1030

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

1644

1031

interface names according to the "alt_interface_names" mapping.

1645

1032

Usage:

1646

1033

1647

1034

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

1648

1035

"net.example.AlternateInterface"})

1649

1036

class SampleDBusObject(dbus.service.Object):

1650

1037

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

1651

1038

def SampleDBusMethod():

1652

1039

pass

1653

1040

1654

1041

The above "SampleDBusMethod" on "SampleDBusObject" will be

1655

1042

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

1656

1043

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

1657

1044

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

1658

1045

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

1659

1046

1660

1047

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

1661

1048

(from DBusObjectWithProperties) and interfaces (from the

1662

1049

dbus_interface_annotations decorator).

1663

1050

"""

1664

1665

1051

def wrapper(cls):

1666

1052

for orig_interface_name, alt_interface_name in (

1667

alt_interface_names.items()):

1053

alt_interface_names.iteritems()):

1668

1054

attr = {}

1669

1055

interface_names = set()

1670

1056

# Go though all attributes of the class

1672

1058

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

1673

1059

# with the wrong interface name

1674

1060

if (not hasattr(attribute, "_dbus_interface")

1675

or not attribute._dbus_interface.startswith(

1676

orig_interface_name)):

1061

or not attribute._dbus_interface

1062

.startswith(orig_interface_name)):

1677

1063

continue

1678

1064

# Create an alternate D-Bus interface name based on

1679

1065

# the current name

1680

alt_interface = attribute._dbus_interface.replace(

1681

orig_interface_name, alt_interface_name)

1066

alt_interface = (attribute._dbus_interface

1067

.replace(orig_interface_name,

1068

alt_interface_name))

1682

1069

interface_names.add(alt_interface)

1683

1070

# Is this a D-Bus signal?

1684

1071

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

1685

# Extract the original non-method undecorated

1686

# function by black magic

1687

if sys.version_info.major == 2:

1688

nonmethod_func = (dict(

1072

# Extract the original non-method function by

1073

# black magic

1074

nonmethod_func = (dict(

1689

1075

zip(attribute.func_code.co_freevars,

1690

attribute.__closure__))

1691

["func"].cell_contents)

1692

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1076

attribute.__closure__))["func"]

1077

.cell_contents)

1697

1078

# Create a new, but exactly alike, function

1698

1079

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

1699

1080

# with the alternate D-Bus interface name

1700

new_function = copy_function(nonmethod_func)

1701

new_function = (dbus.service.signal(

1702

alt_interface,

1703

attribute._dbus_signature)(new_function))

1081

new_function = (dbus.service.signal

1082

(alt_interface,

1083

attribute._dbus_signature)

1084

(types.FunctionType(

1085

nonmethod_func.func_code,

1086

nonmethod_func.func_globals,

1087

nonmethod_func.func_name,

1088

nonmethod_func.func_defaults,

1089

nonmethod_func.func_closure)))

1704

1090

# Copy annotations, if any

1705

1091

try:

1706

new_function._dbus_annotations = dict(

1707

attribute._dbus_annotations)

1092

new_function._dbus_annotations = (

1093

dict(attribute._dbus_annotations))

1708

1094

except AttributeError:

1709

1095

pass

1710

1711

1096

# Define a creator of a function to call both the

1712

1097

# original and alternate functions, so both the

1713

1098

# original and alternate signals gets sent when

1716

1101

"""This function is a scope container to pass

1717

1102

func1 and func2 to the "call_both" function

1718

1103

outside of its arguments"""

1719

1720

@functools.wraps(func2)

1721

1104

def call_both(*args, **kwargs):

1722

1105

"""This function will emit two D-Bus

1723

1106

signals by calling func1 and func2"""

1724

1107

func1(*args, **kwargs)

1725

1108

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1728

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

1729

if name.startswith("_dbus_"):

1730

setattr(call_both, name, attr)

1731

1732

1109

return call_both

1733

1110

# Create the "call_both" function and add it to

1734

1111

# the class

1739

1116

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

1740

1117

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

1741

1118

# to the class.

1742

attr[attrname] = (

1743

dbus.service.method(

1744

alt_interface,

1745

attribute._dbus_in_signature,

1746

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1119

attr[attrname] = (dbus.service.method

1120

(alt_interface,

1121

attribute._dbus_in_signature,

1122

attribute._dbus_out_signature)

1123

(types.FunctionType

1124

(attribute.func_code,

1125

attribute.func_globals,

1126

attribute.func_name,

1127

attribute.func_defaults,

1128

attribute.func_closure)))

1748

1129

# Copy annotations, if any

1749

1130

try:

1750

attr[attrname]._dbus_annotations = dict(

1751

attribute._dbus_annotations)

1131

attr[attrname]._dbus_annotations = (

1132

dict(attribute._dbus_annotations))

1752

1133

except AttributeError:

1753

1134

pass

1754

1135

# Is this a D-Bus property?

1757

1138

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

1758

1139

# property with the alternate D-Bus interface

1759

1140

# name. Add it to the class.

1760

attr[attrname] = (dbus_service_property(

1761

alt_interface, attribute._dbus_signature,

1762

attribute._dbus_access,

1763

attribute._dbus_get_args_options

1764

["byte_arrays"])

1765

(copy_function(attribute)))

1141

attr[attrname] = (dbus_service_property

1142

(alt_interface,

1143

attribute._dbus_signature,

1144

attribute._dbus_access,

1145

attribute

1146

._dbus_get_args_options

1147

["byte_arrays"])

1148

(types.FunctionType

1149

(attribute.func_code,

1150

attribute.func_globals,

1151

attribute.func_name,

1152

attribute.func_defaults,

1153

attribute.func_closure)))

1766

1154

# Copy annotations, if any

1767

1155

try:

1768

attr[attrname]._dbus_annotations = dict(

1769

attribute._dbus_annotations)

1156

attr[attrname]._dbus_annotations = (

1157

dict(attribute._dbus_annotations))

1770

1158

except AttributeError:

1771

1159

pass

1772

1160

# Is this a D-Bus interface?

1775

1163

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

1776

1164

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

1777

1165

# to the class.

1778

attr[attrname] = (

1779

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1166

attr[attrname] = (dbus_interface_annotations

1167

(alt_interface)

1168

(types.FunctionType

1169

(attribute.func_code,

1170

attribute.func_globals,

1171

attribute.func_name,

1172

attribute.func_defaults,

1173

attribute.func_closure)))

1781

1174

if deprecate:

1782

1175

# Deprecate all alternate interfaces

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1176

iname="_AlternateDBusNames_interface_annotation{0}"

1784

1177

for interface_name in interface_names:

1785

1786

1178

@dbus_interface_annotations(interface_name)

1787

1179

def func(self):

1788

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

1789

"true"}

1180

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

1181

"true" }

1790

1182

# Find an unused name

1791

1183

for aname in (iname.format(i)

1792

1184

for i in itertools.count()):

1796

1188

if interface_names:

1797

1189

# Replace the class with a new subclass of it with

1798

1190

# methods, signals, etc. as created above.

1799

if sys.version_info.major == 2:

1800

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

1801

(cls, ), attr)

1802

else:

1803

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

1804

(cls, ), attr)

1191

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

1192

(cls,), attr)

1805

1193

return cls

1806

1807

1194

return wrapper

1808

1195

1809

1196

1810

1197

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

1811

"se.bsnet.fukt.Mandos"})

1198

"se.bsnet.fukt.Mandos"})

1812

1199

class ClientDBus(Client, DBusObjectWithProperties):

1813

1200

"""A Client class using D-Bus

1814

1201

1815

1202

Attributes:

1816

1203

dbus_object_path: dbus.ObjectPath

1817

1204

bus: dbus.SystemBus()

1818

1205

"""

1819

1206

1820

1207

runtime_expansions = (Client.runtime_expansions

1821

+ ("dbus_object_path", ))

1822

1823

_interface = "se.recompile.Mandos.Client"

1824

1208

+ ("dbus_object_path",))

1209

1825

1210

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

1826

1827

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

1211

1212

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

1828

1213

self.bus = bus

1829

1214

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

1830

1215

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

1831

1216

# the D-Bus

1832

client_object_name = str(self.name).translate(

1217

client_object_name = unicode(self.name).translate(

1833

1218

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

1834

1219

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

1835

self.dbus_object_path = dbus.ObjectPath(

1836

"/clients/" + client_object_name)

1220

self.dbus_object_path = (dbus.ObjectPath

1221

("/clients/" + client_object_name))

1837

1222

DBusObjectWithProperties.__init__(self, self.bus,

1838

1223

self.dbus_object_path)

1839

1840

def notifychangeproperty(transform_func, dbus_name,

1841

type_func=lambda x: x,

1842

variant_level=1,

1843

invalidate_only=False,

1844

_interface=_interface):

1224

1225

def notifychangeproperty(transform_func,

1226

dbus_name, type_func=lambda x: x,

1227

variant_level=1):

1845

1228

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

1846

1229

its changes to DBus.

1847

1230

1848

1231

transform_fun: Function that takes a value and a variant_level

1849

1232

and transforms it to a D-Bus type.

1850

1233

dbus_name: D-Bus name of the variable

1852

1235

to the D-Bus. Default: no transform

1853

1236

variant_level: D-Bus variant level. Default: 1

1854

1237

"""

1855

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

1856

1238

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

1857

1239

def setter(self, value):

1858

1240

if hasattr(self, "dbus_object_path"):

1859

1241

if (not hasattr(self, attrname) or

1860

1242

type_func(getattr(self, attrname, None))

1861

1243

!= type_func(value)):

1862

if invalidate_only:

1863

self.PropertiesChanged(

1864

_interface, dbus.Dictionary(),

1865

dbus.Array((dbus_name, )))

1866

else:

1867

dbus_value = transform_func(

1868

type_func(value),

1869

variant_level=variant_level)

1870

self.PropertyChanged(dbus.String(dbus_name),

1871

dbus_value)

1872

self.PropertiesChanged(

1873

_interface,

1874

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

1875

dbus_value}),

1876

dbus.Array())

1244

dbus_value = transform_func(type_func(value),

1245

variant_level

1246

=variant_level)

1247

self.PropertyChanged(dbus.String(dbus_name),

1248

dbus_value)

1877

1249

setattr(self, attrname, value)

1878

1250

1879

1251

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

1880

1252

1881

1253

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1882

1254

approvals_pending = notifychangeproperty(dbus.Boolean,

1883

1255

"ApprovalPending",

1884

type_func=bool)

1256

type_func = bool)

1885

1257

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

1886

1258

last_enabled = notifychangeproperty(datetime_to_dbus,

1887

1259

"LastEnabled")

1888

checker = notifychangeproperty(

1889

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1260

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

1261

type_func = lambda checker:

1262

checker is not None)

1891

1263

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1892

1264

"LastCheckedOK")

1893

1265

last_checker_status = notifychangeproperty(dbus.Int16,

1896

1268

datetime_to_dbus, "LastApprovalRequest")

1897

1269

approved_by_default = notifychangeproperty(dbus.Boolean,

1898

1270

"ApprovedByDefault")

1899

approval_delay = notifychangeproperty(

1900

dbus.UInt64, "ApprovalDelay",

1901

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

1271

approval_delay = notifychangeproperty(dbus.UInt64,

1272

"ApprovalDelay",

1273

type_func =

1274

timedelta_to_milliseconds)

1902

1275

approval_duration = notifychangeproperty(

1903

1276

dbus.UInt64, "ApprovalDuration",

1904

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

1277

type_func = timedelta_to_milliseconds)

1905

1278

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

1906

timeout = notifychangeproperty(

1907

dbus.UInt64, "Timeout",

1908

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

1279

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

1280

type_func =

1281

timedelta_to_milliseconds)

1909

1282

extended_timeout = notifychangeproperty(

1910

1283

dbus.UInt64, "ExtendedTimeout",

1911

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

1912

interval = notifychangeproperty(

1913

dbus.UInt64, "Interval",

1914

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

1284

type_func = timedelta_to_milliseconds)

1285

interval = notifychangeproperty(dbus.UInt64,

1286

"Interval",

1287

type_func =

1288

timedelta_to_milliseconds)

1915

1289

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

1916

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

1917

invalidate_only=True)

1918

1290

1919

1291

del notifychangeproperty

1920

1292

1921

1293

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

1922

1294

try:

1923

1295

self.remove_from_connection()

1926

1298

if hasattr(DBusObjectWithProperties, "__del__"):

1927

1299

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

1928

1300

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

1929

1930

def checker_callback(self, source, condition,

1931

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

1932

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

1933

connection, command, *args,

1934

**kwargs)

1935

exitstatus = self.last_checker_status

1936

if exitstatus >= 0:

1301

1302

def checker_callback(self, pid, condition, command,

1303

*args, **kwargs):

1304

self.checker_callback_tag = None

1305

self.checker = None

1306

if os.WIFEXITED(condition):

1307

exitstatus = os.WEXITSTATUS(condition)

1937

1308

# Emit D-Bus signal

1938

1309

self.CheckerCompleted(dbus.Int16(exitstatus),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1310

dbus.Int64(condition),

1941

1311

dbus.String(command))

1942

1312

else:

1943

1313

# Emit D-Bus signal

1944

1314

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

1945

dbus.Int64(

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1315

dbus.Int64(condition),

1949

1316

dbus.String(command))

1950

return ret

1951

1317

1318

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

1319

*args, **kwargs)

1320

1952

1321

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

1953

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

1322

old_checker = self.checker

1323

if self.checker is not None:

1324

old_checker_pid = self.checker.pid

1325

else:

1326

old_checker_pid = None

1954

1327

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

1955

1328

# Only if new checker process was started

1956

1329

if (self.checker is not None

1958

1331

# Emit D-Bus signal

1959

1332

self.CheckerStarted(self.current_checker_command)

1960

1333

return r

1961

1334

1962

1335

def _reset_approved(self):

1963

1336

self.approved = None

1964

1337

return False

1965

1338

1966

1339

def approve(self, value=True):

1967

1340

self.approved = value

1968

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

1969

* 1000), self._reset_approved)

1341

gobject.timeout_add(timedelta_to_milliseconds

1342

(self.approval_duration),

1343

self._reset_approved)

1970

1344

self.send_changedstate()

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1345

1346

## D-Bus methods, signals & properties

1347

_interface = "se.recompile.Mandos.Client"

1348

1349

## Interfaces

1350

1351

@dbus_interface_annotations(_interface)

1352

def _foo(self):

1353

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

1354

"false"}

1355

1356

## Signals

1357

1978

1358

# CheckerCompleted - signal

1979

1359

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

1980

1360

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

1981

1361

"D-Bus signal"

1982

1362

pass

1983

1363

1984

1364

# CheckerStarted - signal

1985

1365

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

1986

1366

def CheckerStarted(self, command):

1987

1367

"D-Bus signal"

1988

1368

pass

1989

1369

1990

1370

# PropertyChanged - signal

1991

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

1992

1371

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

1993

1372

def PropertyChanged(self, property, value):

1994

1373

"D-Bus signal"

1995

1374

pass

1996

1375

1997

1376

# GotSecret - signal

1998

1377

@dbus.service.signal(_interface)

1999

1378

def GotSecret(self):

2002

1381

server to mandos-client

2003

1382

"""

2004

1383

pass

2005

1384

2006

1385

# Rejected - signal

2007

1386

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

2008

1387

def Rejected(self, reason):

2009

1388

"D-Bus signal"

2010

1389

pass

2011

1390

2012

1391

# NeedApproval - signal

2013

1392

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

2014

1393

def NeedApproval(self, timeout, default):

2015

1394

"D-Bus signal"

2016

1395

return self.need_approval()

2017

2018

# Methods

2019

1396

1397

## Methods

1398

2020

1399

# Approve - method

2021

1400

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

2022

1401

def Approve(self, value):

2023

1402

self.approve(value)

2024

1403

2025

1404

# CheckedOK - method

2026

1405

@dbus.service.method(_interface)

2027

1406

def CheckedOK(self):

2028

1407

self.checked_ok()

2029

1408

2030

1409

# Enable - method

2031

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

2032

1410

@dbus.service.method(_interface)

2033

1411

def Enable(self):

2034

1412

"D-Bus method"

2035

1413

self.enable()

2036

1414

2037

1415

# StartChecker - method

2038

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

2039

1416

@dbus.service.method(_interface)

2040

1417

def StartChecker(self):

2041

1418

"D-Bus method"

2042

1419

self.start_checker()

2043

1420

2044

1421

# Disable - method

2045

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

2046

1422

@dbus.service.method(_interface)

2047

1423

def Disable(self):

2048

1424

"D-Bus method"

2049

1425

self.disable()

2050

1426

2051

1427

# StopChecker - method

2052

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

2053

1428

@dbus.service.method(_interface)

2054

1429

def StopChecker(self):

2055

1430

self.stop_checker()

2056

2057

# Properties

2058

1431

1432

## Properties

1433

2059

1434

# ApprovalPending - property

2060

1435

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

2061

1436

def ApprovalPending_dbus_property(self):

2062

1437

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

2063

1438

2064

1439

# ApprovedByDefault - property

2065

@dbus_service_property(_interface,

2066

signature="b",

1440

@dbus_service_property(_interface, signature="b",

2067

1441

access="readwrite")

2068

1442

def ApprovedByDefault_dbus_property(self, value=None):

2069

1443

if value is None: # get

2070

1444

return dbus.Boolean(self.approved_by_default)

2071

1445

self.approved_by_default = bool(value)

2072

1446

2073

1447

# ApprovalDelay - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1448

@dbus_service_property(_interface, signature="t",

2076

1449

access="readwrite")

2077

1450

def ApprovalDelay_dbus_property(self, value=None):

2078

1451

if value is None: # get

2079

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

2080

* 1000)

1452

return dbus.UInt64(self.approval_delay_milliseconds())

2081

1453

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

2082

1454

2083

1455

# ApprovalDuration - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1456

@dbus_service_property(_interface, signature="t",

2086

1457

access="readwrite")

2087

1458

def ApprovalDuration_dbus_property(self, value=None):

2088

1459

if value is None: # get

2089

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

2090

* 1000)

1460

return dbus.UInt64(timedelta_to_milliseconds(

1461

self.approval_duration))

2091

1462

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

2092

1463

2093

1464

# Name - property

2094

@dbus_annotations(

2095

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

2096

1465

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

2097

1466

def Name_dbus_property(self):

2098

1467

return dbus.String(self.name)

2099

2100

# KeyID - property

2101

@dbus_annotations(

2102

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

2103

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

2104

def KeyID_dbus_property(self):

2105

return dbus.String(self.key_id)

2106

1468

2107

1469

# Fingerprint - property

2108

@dbus_annotations(

2109

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

2110

1470

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

2111

1471

def Fingerprint_dbus_property(self):

2112

1472

return dbus.String(self.fingerprint)

2113

1473

2114

1474

# Host - property

2115

@dbus_service_property(_interface,

2116

signature="s",

1475

@dbus_service_property(_interface, signature="s",

2117

1476

access="readwrite")

2118

1477

def Host_dbus_property(self, value=None):

2119

1478

if value is None: # get

2120

1479

return dbus.String(self.host)

2121

self.host = str(value)

2122

1480

self.host = unicode(value)

1481

2123

1482

# Created - property

2124

@dbus_annotations(

2125

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

2126

1483

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

2127

1484

def Created_dbus_property(self):

2128

1485

return datetime_to_dbus(self.created)

2129

1486

2130

1487

# LastEnabled - property

2131

1488

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

2132

1489

def LastEnabled_dbus_property(self):

2133

1490

return datetime_to_dbus(self.last_enabled)

2134

1491

2135

1492

# Enabled - property

2136

@dbus_service_property(_interface,

2137

signature="b",

1493

@dbus_service_property(_interface, signature="b",

2138

1494

access="readwrite")

2139

1495

def Enabled_dbus_property(self, value=None):

2140

1496

if value is None: # get

2143

1499

self.enable()

2144

1500

else:

2145

1501

self.disable()

2146

1502

2147

1503

# LastCheckedOK - property

2148

@dbus_service_property(_interface,

2149

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2150

1505

access="readwrite")

2151

1506

def LastCheckedOK_dbus_property(self, value=None):

2152

1507

if value is not None:

2153

1508

self.checked_ok()

2154

1509

return

2155

1510

return datetime_to_dbus(self.last_checked_ok)

2156

1511

2157

1512

# LastCheckerStatus - property

2158

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

1513

@dbus_service_property(_interface, signature="n",

1514

access="read")

2159

1515

def LastCheckerStatus_dbus_property(self):

2160

1516

return dbus.Int16(self.last_checker_status)

2161

1517

2162

1518

# Expires - property

2163

1519

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

2164

1520

def Expires_dbus_property(self):

2165

1521

return datetime_to_dbus(self.expires)

2166

1522

2167

1523

# LastApprovalRequest - property

2168

1524

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

2169

1525

def LastApprovalRequest_dbus_property(self):

2170

1526

return datetime_to_dbus(self.last_approval_request)

2171

1527

2172

1528

# Timeout - property

2173

@dbus_service_property(_interface,

2174

signature="t",

1529

@dbus_service_property(_interface, signature="t",

2175

1530

access="readwrite")

2176

1531

def Timeout_dbus_property(self, value=None):

2177

1532

if value is None: # get

2178

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

1533

return dbus.UInt64(self.timeout_milliseconds())

2179

1534

old_timeout = self.timeout

2180

1535

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

2181

1536

# Reschedule disabling

2189

1544

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

2190

1545

is None):

2191

1546

return

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

2194

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

2195

self.disable)

2196

1547

gobject.source_remove(self.disable_initiator_tag)

1548

self.disable_initiator_tag = (

1549

gobject.timeout_add(

1550

timedelta_to_milliseconds(self.expires - now),

1551

self.disable))

1552

2197

1553

# ExtendedTimeout - property

2198

@dbus_service_property(_interface,

2199

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2200

1555

access="readwrite")

2201

1556

def ExtendedTimeout_dbus_property(self, value=None):

2202

1557

if value is None: # get

2203

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

2204

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2205

1559

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

2206

1560

2207

1561

# Interval - property

2208

@dbus_service_property(_interface,

2209

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2210

1563

access="readwrite")

2211

1564

def Interval_dbus_property(self, value=None):

2212

1565

if value is None: # get

2213

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

1566

return dbus.UInt64(self.interval_milliseconds())

2214

1567

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

2215

1568

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

2216

1569

return

2217

1570

if self.enabled:

2218

1571

# Reschedule checker run

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

2221

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2224

1577

# Checker - property

2225

@dbus_service_property(_interface,

2226

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2227

1579

access="readwrite")

2228

1580

def Checker_dbus_property(self, value=None):

2229

1581

if value is None: # get

2230

1582

return dbus.String(self.checker_command)

2231

self.checker_command = str(value)

2232

1583

self.checker_command = unicode(value)

1584

2233

1585

# CheckerRunning - property

2234

@dbus_service_property(_interface,

2235

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2236

1587

access="readwrite")

2237

1588

def CheckerRunning_dbus_property(self, value=None):

2238

1589

if value is None: # get

2241

1592

self.start_checker()

2242

1593

else:

2243

1594

self.stop_checker()

2244

1595

2245

1596

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

2249

1597

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

2250

1598

def ObjectPath_dbus_property(self):

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2253

1601

# Secret = property

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

2257

@dbus_service_property(_interface,

2258

signature="ay",

2259

access="write",

2260

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2261

1604

def Secret_dbus_property(self, value):

2262

self.secret = bytes(value)

2263

1605

self.secret = str(value)

1606

2264

1607

del _interface

2265

1608

2266

1609

2267

class ProxyClient:

2268

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

1610

class ProxyClient(object):

1611

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

2269

1612

self._pipe = child_pipe

2270

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

1613

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

2271

1614

if not self._pipe.recv():

2272

raise KeyError(key_id or fpr)

2273

1615

raise KeyError()

1616

2274

1617

def __getattribute__(self, name):

2275

if name == "_pipe":

1618

if name == '_pipe':

2276

1619

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

2277

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

1620

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

2278

1621

data = self._pipe.recv()

2279

if data[0] == "data":

1622

if data[0] == 'data':

2280

1623

return data[1]

2281

if data[0] == "function":

2282

1624

if data[0] == 'function':

2283

1625

def func(*args, **kwargs):

2284

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

1626

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

2285

1627

return self._pipe.recv()[1]

2286

2287

1628

return func

2288

1629

2289

1630

def __setattr__(self, name, value):

2290

if name == "_pipe":

1631

if name == '_pipe':

2291

1632

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

2292

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

1633

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

2293

1634

2294

1635

2295

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2296

1637

"""A class to handle client connections.

2297

1638

2298

1639

Instantiated once for each connection to handle it.

2299

1640

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

2300

1641

2301

1642

def handle(self):

2302

1643

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

2303

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

2304

str(self.client_address))

2305

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

2306

2307

session = gnutls.ClientSession(self.request)

2308

2309

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

2310

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

2311

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

2312

# "+DHE-DSS"))

1644

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

1645

unicode(self.client_address))

1646

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

1647

self.server.child_pipe.fileno())

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2313

1663

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

2314

1664

priority = self.server.gnutls_priority

2315

1665

if priority is None:

2316

1666

priority = "NORMAL"

2317

gnutls.priority_set_direct(session,

2318

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

2319

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2320

1671

# Start communication using the Mandos protocol

2321

1672

# Get protocol number

2322

1673

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

2323

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

1674

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

2324

1675

try:

2325

1676

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

2326

raise RuntimeError(line)

1677

raise RuntimeError

2327

1678

except (ValueError, IndexError, RuntimeError) as error:

2328

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

1679

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

2329

1680

return

2330

1681

2331

1682

# Start GnuTLS connection

2332

1683

try:

2333

1684

session.handshake()

2334

except gnutls.Error as error:

2335

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

1685

except gnutls.errors.GNUTLSError as error:

1686

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

2336

1687

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

2337

1688

# established. Just abandon the request.

2338

1689

return

2339

log.debug("Handshake succeeded")

2340

1690

logger.debug("Handshake succeeded")

1691

2341

1692

approval_required = False

2342

1693

try:

2343

if gnutls.has_rawpk:

2344

fpr = b""

2345

try:

2346

key_id = self.key_id(

2347

self.peer_certificate(session))

2348

except (TypeError, gnutls.Error) as error:

2349

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

2350

return

2351

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

2352

key_id.decode("utf-8",

2353

errors="replace"))

2354

2355

else:

2356

key_id = b""

2357

try:

2358

fpr = self.fingerprint(

2359

self.peer_certificate(session))

2360

except (TypeError, gnutls.Error) as error:

2361

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

2362

return

2363

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

2364

2365

try:

2366

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2367

1705

self.client_address)

2368

1706

except KeyError:

2369

1707

return

2370

1708

2371

1709

if client.approval_delay:

2372

1710

delay = client.approval_delay

2373

1711

client.approvals_pending += 1

2374

1712

approval_required = True

2375

1713

2376

1714

while True:

2377

1715

if not client.enabled:

2378

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

1716

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

1717

client.name)

2379

1718

if self.server.use_dbus:

2380

1719

# Emit D-Bus signal

2381

1720

client.Rejected("Disabled")

2382

1721

return

2383

1722

2384

1723

if client.approved or not client.approval_delay:

2385

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2386

1725

break

2387

1726

elif client.approved is None:

2388

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

2389

client.name)

1727

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

1728

client.name)

2390

1729

if self.server.use_dbus:

2391

1730

# Emit D-Bus signal

2392

1731

client.NeedApproval(

2393

client.approval_delay.total_seconds()

2394

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2395

1734

else:

2396

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

2397

client.name)

1735

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

1736

client.name)

2398

1737

if self.server.use_dbus:

2399

1738

# Emit D-Bus signal

2400

1739

client.Rejected("Denied")

2401

1740

return

2402

2403

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2404

1743

time = datetime.datetime.now()

2405

1744

client.changedstate.acquire()

2406

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

1745

client.changedstate.wait(

1746

float(timedelta_to_milliseconds(delay)

1747

/ 1000))

2407

1748

client.changedstate.release()

2408

1749

time2 = datetime.datetime.now()

2409

1750

if (time2 - time) >= delay:

2410

1751

if not client.approved_by_default:

2411

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

2412

" waiting for approval",

2413

client.name)

1752

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

1753

" waiting for approval",

1754

client.name)

2414

1755

if self.server.use_dbus:

2415

1756

# Emit D-Bus signal

2416

1757

client.Rejected("Approval timed out")

2419

1760

break

2420

1761

else:

2421

1762

delay -= time2 - time

2422

2423

try:

2424

session.send(client.secret)

2425

except gnutls.Error as error:

2426

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

2427

return

2428

2429

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

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

1777

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

2430

1778

# bump the timeout using extended_timeout

2431

1779

client.bump_timeout(client.extended_timeout)

2432

1780

if self.server.use_dbus:

2433

1781

# Emit D-Bus signal

2434

1782

client.GotSecret()

2435

1783

2436

1784

finally:

2437

1785

if approval_required:

2438

1786

client.approvals_pending -= 1

2439

1787

try:

2440

1788

session.bye()

2441

except gnutls.Error as error:

2442

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

2443

1789

except gnutls.errors.GNUTLSError as error:

1790

logger.warning("GnuTLS bye failed",

1791

exc_info=error)

1792

2444

1793

@staticmethod

2445

1794

def peer_certificate(session):

2446

"Return the peer's certificate as a bytestring"

2447

try:

2448

cert_type = gnutls.certificate_type_get2(

2449

session, gnutls.CTYPE_PEERS)

2450

except AttributeError:

2451

cert_type = gnutls.certificate_type_get(session)

2452

if gnutls.has_rawpk:

2453

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2454

else:

2455

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2456

# If not a valid certificate type...

2457

if cert_type not in valid_cert_types:

2458

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

2459

valid_cert_types)

2460

# ...return invalid data

2461

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2462

1802

list_size = ctypes.c_uint(1)

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

1805

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

2465

1806

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

2466

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

1807

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

1808

" certificate")

2467

1809

if list_size.value == 0:

2468

1810

return None

2469

1811

cert = cert_list[0]

2470

1812

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

2471

2472

@staticmethod

2473

def key_id(certificate):

2474

"Convert a certificate bytestring to a hexdigit key ID"

2475

# New GnuTLS "datum" with the public key

2476

datum = gnutls.datum_t(

2477

ctypes.cast(ctypes.c_char_p(certificate),

2478

ctypes.POINTER(ctypes.c_ubyte)),

2479

ctypes.c_uint(len(certificate)))

2480

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

2481

# New empty GnuTLS certificate

2482

pubkey = gnutls.pubkey_t()

2483

gnutls.pubkey_init(ctypes.byref(pubkey))

2484

# Import the raw public key into the certificate

2485

gnutls.pubkey_import(pubkey,

2486

ctypes.byref(datum),

2487

gnutls.X509_FMT_DER)

2488

# New buffer for the key ID

2489

buf = ctypes.create_string_buffer(32)

2490

buf_len = ctypes.c_size_t(len(buf))

2491

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

2492

gnutls.pubkey_get_key_id(

2493

pubkey,

2494

gnutls.KEYID_USE_SHA256,

2495

ctypes.cast(ctypes.byref(buf),

2496

ctypes.POINTER(ctypes.c_ubyte)),

2497

ctypes.byref(buf_len))

2498

# Deinit the certificate

2499

gnutls.pubkey_deinit(pubkey)

2500

2501

# Convert the buffer to a Python bytestring

2502

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

2503

# Convert the bytestring to hexadecimal notation

2504

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

2505

return hex_key_id

2506

1813

2507

1814

@staticmethod

2508

1815

def fingerprint(openpgp):

2509

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2510

1817

# New GnuTLS "datum" with the OpenPGP public key

2511

datum = gnutls.datum_t(

2512

ctypes.cast(ctypes.c_char_p(openpgp),

2513

ctypes.POINTER(ctypes.c_ubyte)),

2514

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2515

1823

# New empty GnuTLS certificate

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2518

1827

# Import the OpenPGP public key into the certificate

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2521

1832

# Verify the self signature in the key

2522

1833

crtverify = ctypes.c_uint()

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2525

1837

if crtverify.value != 0:

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2529

1841

# New buffer for the fingerprint

2530

1842

buf = ctypes.create_string_buffer(20)

2531

1843

buf_len = ctypes.c_size_t()

2532

1844

# Get the fingerprint from the certificate into the buffer

2533

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

2534

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2535

1848

# Deinit the certificate

2536

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2537

1850

# Convert the buffer to a Python bytestring

2538

1851

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

2539

1852

# Convert the bytestring to hexadecimal notation

2541

1854

return hex_fpr

2542

1855

2543

1856

2544

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2545

1858

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

2546

2547

1859

def sub_process_main(self, request, address):

2548

1860

try:

2549

1861

self.finish_request(request, address)

2550

1862

except Exception:

2551

1863

self.handle_error(request, address)

2552

1864

self.close_request(request)

2553

1865

2554

1866

def process_request(self, request, address):

2555

1867

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

2556

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

2557

args=(request, address))

1868

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

1869

args = (request, address))

2558

1870

proc.start()

2559

1871

return proc

2560

1872

2561

1873

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2563

1875

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

2564

2565

1876

def process_request(self, request, client_address):

2566

1877

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

2567

1878

2568

1879

This function creates a new pipe in self.pipe

2569

1880

"""

2570

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2571

1882

2572

1883

proc = MultiprocessingMixIn.process_request(self, request,

2573

1884

client_address)

2574

1885

self.child_pipe.close()

2575

1886

self.add_pipe(parent_pipe, proc)

2576

1887

2577

1888

def add_pipe(self, parent_pipe, proc):

2578

1889

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

2579

raise NotImplementedError()

1890

raise NotImplementedError

2580

1891

2581

1892

2582

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2583

socketserver.TCPServer):

2584

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

2585

1894

socketserver.TCPServer, object):

1895

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

1896

2586

1897

Attributes:

2587

1898

enabled: Boolean; whether this server is activated yet

2588

1899

interface: None or a network interface name (string)

2589

1900

use_ipv6: Boolean; to use IPv6 or not

2590

1901

"""

2591

2592

1902

def __init__(self, server_address, RequestHandlerClass,

2593

interface=None,

2594

use_ipv6=True,

2595

socketfd=None):

1903

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

2596

1904

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

2597

1905

creating a new one with socket.socket().

2598

1906

"""

2604

1912

self.socketfd = socketfd

2605

1913

# Save the original socket.socket() function

2606

1914

self.socket_socket = socket.socket

2607

2608

1915

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

2609

#

1916

#

2610

1917

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

2611

1918

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

2612

1919

# patching socket.socket.)

2613

#

1920

#

2614

1921

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

2615

1922

@functools.wraps(socket.socket)

2616

1923

def socket_wrapper(*args, **kwargs):

2628

1935

# socket_wrapper(), if socketfd was set.

2629

1936

socketserver.TCPServer.__init__(self, server_address,

2630

1937

RequestHandlerClass)

2631

1938

2632

1939

def server_bind(self):

2633

1940

"""This overrides the normal server_bind() function

2634

1941

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

2635

1942

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

2636

global SO_BINDTODEVICE

2637

1943

if self.interface is not None:

2638

1944

if SO_BINDTODEVICE is None:

2639

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

2640

# common enough.

2641

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

2642

SO_BINDTODEVICE = 25

2643

try:

2644

self.socket.setsockopt(

2645

socket.SOL_SOCKET, SO_BINDTODEVICE,

2646

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

2647

except socket.error as error:

2648

if error.errno == errno.EPERM:

2649

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

2650

self.interface)

2651

elif error.errno == errno.ENOPROTOOPT:

2652

log.error("SO_BINDTODEVICE not available; cannot"

2653

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

2654

elif error.errno == errno.ENODEV:

2655

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

2656

" bind", self.interface)

2657

else:

2658

raise

1945

logger.error("SO_BINDTODEVICE does not exist;"

1946

" cannot bind to interface %s",

1947

self.interface)

1948

else:

1949

try:

1950

self.socket.setsockopt(socket.SOL_SOCKET,

1951

SO_BINDTODEVICE,

1952

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

1953

except socket.error as error:

1954

if error.errno == errno.EPERM:

1955

logger.error("No permission to bind to"

1956

" interface %s", self.interface)

1957

elif error.errno == errno.ENOPROTOOPT:

1958

logger.error("SO_BINDTODEVICE not available;"

1959

" cannot bind to interface %s",

1960

self.interface)

1961

elif error.errno == errno.ENODEV:

1962

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

1963

" cannot bind", self.interface)

1964

else:

1965

raise

2659

1966

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

2660

1967

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2663

1968

if not self.server_address[0]:

2664

1969

if self.address_family == socket.AF_INET6:

2665

any_address = "::" # in6addr_any

1970

any_address = "::" # in6addr_any

2666

1971

else:

2667

any_address = "0.0.0.0" # INADDR_ANY

1972

any_address = socket.INADDR_ANY

2668

1973

self.server_address = (any_address,

2669

1974

self.server_address[1])

2670

1975

elif not self.server_address[1]:

2671

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

1976

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

1977

0)

2672

1978

# if self.interface:

2673

1979

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

2674

1980

# 0, # port

2680

1986

2681

1987

class MandosServer(IPv6_TCPServer):

2682

1988

"""Mandos server.

2683

1989

2684

1990

Attributes:

2685

1991

clients: set of Client objects

2686

1992

gnutls_priority GnuTLS priority string

2687

1993

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

2688

2689

Assumes a GLib.MainLoop event loop.

1994

1995

Assumes a gobject.MainLoop event loop.

2690

1996

"""

2691

2692

1997

def __init__(self, server_address, RequestHandlerClass,

2693

interface=None,

2694

use_ipv6=True,

2695

clients=None,

2696

gnutls_priority=None,

2697

use_dbus=True,

2698

socketfd=None):

1998

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

1999

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

2699

2000

self.enabled = False

2700

2001

self.clients = clients

2701

2002

if self.clients is None:

2704

2005

self.gnutls_priority = gnutls_priority

2705

2006

IPv6_TCPServer.__init__(self, server_address,

2706

2007

RequestHandlerClass,

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

2008

interface = interface,

2009

use_ipv6 = use_ipv6,

2010

socketfd = socketfd)

2711

2011

def server_activate(self):

2712

2012

if self.enabled:

2713

2013

return socketserver.TCPServer.server_activate(self)

2714

2014

2715

2015

def enable(self):

2716

2016

self.enabled = True

2717

2017

2718

2018

def add_pipe(self, parent_pipe, proc):

2719

2019

# Call "handle_ipc" for both data and EOF events

2720

GLib.io_add_watch(

2721

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

2722

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

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2727

def handle_ipc(self, source, condition,

2728

parent_pipe=None,

2729

proc=None,

2730

client_object=None):

2020

gobject.io_add_watch(parent_pipe.fileno(),

2021

gobject.IO_IN | gobject.IO_HUP,

2022

functools.partial(self.handle_ipc,

2023

parent_pipe =

2024

parent_pipe,

2025

proc = proc))

2026

2027

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

2028

proc = None, client_object=None):

2731

2029

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

2732

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

2030

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

2733

2031

# Wait for other process to exit

2734

2032

proc.join()

2735

2033

return False

2736

2034

2737

2035

# Read a request from the child

2738

2036

request = parent_pipe.recv()

2739

2037

command = request[0]

2740

2741

if command == "init":

2742

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

2743

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

2744

address = request[3]

2745

2746

for c in self.clients.values():

2747

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2748

"27AE41E4649B934CA495991B7852B855"):

2749

continue

2750

if key_id and c.key_id == key_id:

2751

client = c

2752

break

2753

if fpr and c.fingerprint == fpr:

2038

2039

if command == 'init':

2040

fpr = request[1]

2041

address = request[2]

2042

2043

for c in self.clients.itervalues():

2044

if c.fingerprint == fpr:

2754

2045

client = c

2755

2046

break

2756

2047

else:

2757

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

2758

" %s", key_id or fpr, address)

2048

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

2049

"dress: %s", fpr, address)

2759

2050

if self.use_dbus:

2760

2051

# Emit D-Bus signal

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2052

mandos_dbus_service.ClientNotFound(fpr,

2762

2053

address[0])

2763

2054

parent_pipe.send(False)

2764

2055

return False

2765

2766

GLib.io_add_watch(

2767

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

2768

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

2769

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2056

2057

gobject.io_add_watch(parent_pipe.fileno(),

2058

gobject.IO_IN | gobject.IO_HUP,

2059

functools.partial(self.handle_ipc,

2060

parent_pipe =

2061

parent_pipe,

2062

proc = proc,

2063

client_object =

2064

client))

2773

2065

parent_pipe.send(True)

2774

2066

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

2775

2067

# same fileno

2776

2068

return False

2777

if command == "funcall":

2069

if command == 'funcall':

2778

2070

funcname = request[1]

2779

2071

args = request[2]

2780

2072

kwargs = request[3]

2781

2782

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

2073

2074

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

2783

2075

funcname)(*args,

2784

**kwargs)))

2785

2786

if command == "getattr":

2076

**kwargs)))

2077

2078

if command == 'getattr':

2787

2079

attrname = request[1]

2788

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2080

if callable(client_object.__getattribute__(attrname)):

2081

parent_pipe.send(('function',))

2791

2082

else:

2792

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2083

parent_pipe.send(('data', client_object

2084

.__getattribute__(attrname)))

2085

2086

if command == 'setattr':

2796

2087

attrname = request[1]

2797

2088

value = request[2]

2798

2089

setattr(client_object, attrname, value)

2799

2090

2800

2091

return True

2801

2092

2802

2093

2803

2094

def rfc3339_duration_to_delta(duration):

2804

2095

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

2805

2806

>>> timedelta = datetime.timedelta

2807

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

2808

True

2809

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

2810

True

2811

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

2812

True

2813

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

2814

True

2815

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

2816

True

2817

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

2818

True

2819

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

2820

True

2821

>>> del timedelta

2096

2097

>>> rfc3339_duration_to_delta("P7D")

2098

datetime.timedelta(7)

2099

>>> rfc3339_duration_to_delta("PT60S")

2100

datetime.timedelta(0, 60)

2101

>>> rfc3339_duration_to_delta("PT60M")

2102

datetime.timedelta(0, 3600)

2103

>>> rfc3339_duration_to_delta("PT24H")

2104

datetime.timedelta(1)

2105

>>> rfc3339_duration_to_delta("P1W")

2106

datetime.timedelta(7)

2107

>>> rfc3339_duration_to_delta("PT5M30S")

2108

datetime.timedelta(0, 330)

2109

>>> rfc3339_duration_to_delta("P1DT3M20S")

2110

datetime.timedelta(1, 200)

2822

2111

"""

2823

2112

2824

2113

# Parsing an RFC 3339 duration with regular expressions is not

2825

2114

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

2826

2115

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

2827

2116

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

2828

2117

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

2829

2118

# avoid excessive use of external libraries.

2830

2119

2831

2120

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

2832

Token = collections.namedtuple("Token", (

2833

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

2834

# a "group" containing digits

2835

"value", # datetime.timedelta or None

2836

"followers")) # Tokens valid after this token

2121

Token = collections.namedtuple("Token",

2122

("regexp", # To match token; if

2123

# "value" is not None,

2124

# must have a "group"

2125

# containing digits

2126

"value", # datetime.timedelta or

2127

# None

2128

"followers")) # Tokens valid after

2129

# this token

2837

2130

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

2838

2131

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

2839

2132

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

2840

2133

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

2841

2134

datetime.timedelta(seconds=1),

2842

frozenset((token_end, )))

2135

frozenset((token_end,)))

2843

2136

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

2844

2137

datetime.timedelta(minutes=1),

2845

2138

frozenset((token_second, token_end)))

2861

2154

frozenset((token_month, token_end)))

2862

2155

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

2863

2156

datetime.timedelta(weeks=1),

2864

frozenset((token_end, )))

2157

frozenset((token_end,)))

2865

2158

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

2866

2159

frozenset((token_year, token_month,

2867

2160

token_day, token_time,

2868

token_week)))

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2161

token_week))),

2162

# Define starting values

2163

value = datetime.timedelta() # Value so far

2872

2164

found_token = None

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2165

followers = frozenset(token_duration,) # Following valid tokens

2166

s = duration # String left to parse

2877

2167

# Loop until end token is found

2878

2168

while found_token is not token_end:

2879

2169

# Search for any currently valid tokens

2895

2185

break

2896

2186

else:

2897

2187

# No currently valid tokens were found

2898

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

2899

.format(duration))

2188

raise ValueError("Invalid RFC 3339 duration")

2900

2189

# End token found

2901

2190

return value

2902

2191

2903

2192

2904

2193

def string_to_delta(interval):

2905

2194

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

2906

2907

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

2908

True

2909

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

2910

True

2911

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

2912

True

2913

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

2914

True

2915

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

2916

True

2917

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

2918

True

2195

2196

>>> string_to_delta('7d')

2197

datetime.timedelta(7)

2198

>>> string_to_delta('60s')

2199

datetime.timedelta(0, 60)

2200

>>> string_to_delta('60m')

2201

datetime.timedelta(0, 3600)

2202

>>> string_to_delta('24h')

2203

datetime.timedelta(1)

2204

>>> string_to_delta('1w')

2205

datetime.timedelta(7)

2206

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

2207

datetime.timedelta(0, 330)

2919

2208

"""

2920

2209

2921

2210

try:

2922

2211

return rfc3339_duration_to_delta(interval)

2923

2212

except ValueError:

2924

2213

pass

2925

2214

2926

2215

timevalue = datetime.timedelta(0)

2927

2216

for s in interval.split():

2928

2217

try:

2929

suffix = s[-1]

2218

suffix = unicode(s[-1])

2930

2219

value = int(s[:-1])

2931

2220

if suffix == "d":

2932

2221

delta = datetime.timedelta(value)

2939

2228

elif suffix == "w":

2940

2229

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

2941

2230

else:

2942

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

2943

except IndexError as e:

2231

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

2232

.format(suffix))

2233

except (ValueError, IndexError) as e:

2944

2234

raise ValueError(*(e.args))

2945

2235

timevalue += delta

2946

2236

return timevalue

2947

2237

2948

2238

2949

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

2239

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

2950

2240

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

2951

2241

2952

2242

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

2953

2243

if os.fork():

2954

2244

sys.exit()

2962

2252

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

2963

2253

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

2964

2254

raise OSError(errno.ENODEV,

2965

"{} not a character device"

2255

"{0} not a character device"

2966

2256

.format(os.devnull))

2967

2257

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

2968

2258

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

2972

2262

2973

2263

2974

2264

def main():

2975

2265

2976

2266

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

2977

2267

# Parsing of options, both command line and config file

2978

2268

2979

2269

parser = argparse.ArgumentParser()

2980

2270

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

2981

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

2271

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

2982

2272

help="show version number and exit")

2983

2273

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

2984

2274

help="Bind to interface IF")

2990

2280

help="Run self-test")

2991

2281

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

2992

2282

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

2993

" to terminal", default=None)

2283

" to terminal")

2994

2284

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

2995

2285

help="Debug level for stdout output")

2996

2286

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

3003

2293

" files")

3004

2294

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

3005

2295

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

3006

" system bus interface", default=None)

2296

" system bus interface")

3007

2297

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

3008

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

3009

default=None)

2298

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

3010

2299

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

3011

2300

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

3012

" state", default=None)

2301

" state")

3013

2302

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

3014

2303

help="Specify a file descriptor to a network"

3015

2304

" socket to use instead of creating one")

3016

2305

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

3017

2306

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

3018

2307

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

3019

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

3020

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

3021

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

3022

default=None)

3023

2308

help="Run in foreground")

2309

3024

2310

options = parser.parse_args()

3025

2311

2312

if options.check:

2313

import doctest

2314

doctest.testmod()

2315

sys.exit()

2316

3026

2317

# Default values for config file for server-global settings

3027

if gnutls.has_rawpk:

3028

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

3029

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

3030

else:

3031

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

3032

":+SIGN-DSA-SHA256")

3033

server_defaults = {"interface": "",

3034

"address": "",

3035

"port": "",

3036

"debug": "False",

3037

"priority": priority,

3038

"servicename": "Mandos",

3039

"use_dbus": "True",

3040

"use_ipv6": "True",

3041

"debuglevel": "",

3042

"restore": "True",

3043

"socket": "",

3044

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

3045

"foreground": "False",

3046

"zeroconf": "True",

3047

}

3048

del priority

3049

2318

server_defaults = { "interface": "",

2319

"address": "",

2320

"port": "",

2321

"debug": "False",

2322

"priority":

2323

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

2324

"servicename": "Mandos",

2325

"use_dbus": "True",

2326

"use_ipv6": "True",

2327

"debuglevel": "",

2328

"restore": "True",

2329

"socket": "",

2330

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

2331

"foreground": "False",

2332

}

2333

3050

2334

# Parse config file for server-global settings

3051

server_config = configparser.ConfigParser(server_defaults)

2335

server_config = configparser.SafeConfigParser(server_defaults)

3052

2336

del server_defaults

3053

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

3054

# Convert the ConfigParser object to a dict

2337

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

2338

"mandos.conf"))

2339

# Convert the SafeConfigParser object to a dict

3055

2340

server_settings = server_config.defaults()

3056

2341

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

3057

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

3058

"foreground", "zeroconf"):

2342

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

3059

2343

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

3060

2344

option)

3061

2345

if server_settings["port"]:

3071

2355

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

3072

2356

["socket"])

3073

2357

del server_config

3074

2358

3075

2359

# Override the settings from the config file with command line

3076

2360

# options, if set.

3077

2361

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

3078

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

3079

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

3080

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

2362

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

2363

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

2364

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

3081

2365

value = getattr(options, option)

3082

2366

if value is not None:

3083

2367

server_settings[option] = value

3084

2368

del options

3085

2369

# Force all strings to be unicode

3086

2370

for option in server_settings.keys():

3087

if isinstance(server_settings[option], bytes):

3088

server_settings[option] = (server_settings[option]

3089

.decode("utf-8"))

3090

# Force all boolean options to be boolean

3091

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

3092

"foreground", "zeroconf"):

3093

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

2371

if type(server_settings[option]) is str:

2372

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

3094

2373

# Debug implies foreground

3095

2374

if server_settings["debug"]:

3096

2375

server_settings["foreground"] = True

3097

2376

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

3098

2377

3099

2378

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

3100

3101

if (not server_settings["zeroconf"]

3102

and not (server_settings["port"]

3103

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

3104

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

3105

2379

3106

2380

# For convenience

3107

2381

debug = server_settings["debug"]

3108

2382

debuglevel = server_settings["debuglevel"]

3111

2385

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

3112

2386

stored_state_file)

3113

2387

foreground = server_settings["foreground"]

3114

zeroconf = server_settings["zeroconf"]

3115

2388

3116

2389

if debug:

3117

2390

initlogger(debug, logging.DEBUG)

3118

2391

else:

3121

2394

else:

3122

2395

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

3123

2396

initlogger(debug, level)

3124

2397

3125

2398

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

3126

syslogger.setFormatter(

3127

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

3128

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

3129

server_settings["servicename"])))

3130

2399

syslogger.setFormatter(logging.Formatter

2400

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

2401

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

2402

.format(server_settings

2403

["servicename"])))

2404

3131

2405

# Parse config file with clients

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2406

client_config = configparser.SafeConfigParser(Client

2407

.client_defaults)

3133

2408

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

3134

2409

"clients.conf"))

3135

2410

3136

2411

global mandos_dbus_service

3137

2412

mandos_dbus_service = None

3138

3139

socketfd = None

3140

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

3141

socketfd = server_settings["socket"]

3142

tcp_server = MandosServer(

3143

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

3144

ClientHandler,

3145

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

3146

use_ipv6=use_ipv6,

3147

gnutls_priority=server_settings["priority"],

3148

use_dbus=use_dbus,

3149

socketfd=socketfd)

2413

2414

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

2415

server_settings["port"]),

2416

ClientHandler,

2417

interface=(server_settings["interface"]

2418

or None),

2419

use_ipv6=use_ipv6,

2420

gnutls_priority=

2421

server_settings["priority"],

2422

use_dbus=use_dbus,

2423

socketfd=(server_settings["socket"]

2424

or None))

3150

2425

if not foreground:

3151

pidfilename = "/run/mandos.pid"

3152

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

3153

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

2426

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

3154

2427

pidfile = None

3155

2428

try:

3156

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

2429

pidfile = open(pidfilename, "w")

3157

2430

except IOError as e:

3158

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

3159

exc_info=e)

3160

3161

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

3162

("mandos", "mandos"),

3163

("nobody", "nogroup")):

2431

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

2432

exc_info=e)

2433

2434

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

3164

2435

try:

3165

2436

uid = pwd.getpwnam(name).pw_uid

3166

gid = pwd.getpwnam(group).pw_gid

2437

gid = pwd.getpwnam(name).pw_gid

3167

2438

break

3168

2439

except KeyError:

3169

2440

continue

3173

2444

try:

3174

2445

os.setgid(gid)

3175

2446

os.setuid(uid)

3176

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

3177

2447

except OSError as error:

3178

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

3179

os.strerror(error.errno))

3180

2448

if error.errno != errno.EPERM:

3181

raise

3182

2449

raise error

2450

3183

2451

if debug:

3184

2452

# Enable all possible GnuTLS debugging

3185

2453

3186

2454

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

3187

2455

# - GnuTLS manual

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2456

gnutls.library.functions.gnutls_global_set_log_level(11)

2457

2458

@gnutls.library.types.gnutls_log_func

3191

2459

def debug_gnutls(level, string):

3192

log.debug("GnuTLS: %s",

3193

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

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2460

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

2461

2462

(gnutls.library.functions

2463

.gnutls_global_set_log_function(debug_gnutls))

2464

3197

2465

# Redirect stdin so all checkers get /dev/null

3198

2466

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

3199

2467

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

3200

2468

if null > 2:

3201

2469

os.close(null)

3202

2470

3203

2471

# Need to fork before connecting to D-Bus

3204

2472

if not foreground:

3205

2473

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

3206

2474

daemon()

3207

3208

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

3209

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

3210

# need to inform GLib that threads will be used.

3211

GLib.threads_init()

3212

2475

2476

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

2477

# need to inform gobject that threads will be used.

2478

gobject.threads_init()

2479

3213

2480

global main_loop

3214

2481

# From the Avahi example code

3215

2482

DBusGMainLoop(set_as_default=True)

3216

main_loop = GLib.MainLoop()

2483

main_loop = gobject.MainLoop()

3217

2484

bus = dbus.SystemBus()

3218

2485

# End of Avahi example code

3219

2486

if use_dbus:

3220

2487

try:

3221

2488

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

3222

bus,

3223

do_not_queue=True)

3224

old_bus_name = dbus.service.BusName(

3225

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

3226

do_not_queue=True)

3227

except dbus.exceptions.DBusException as e:

3228

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

2489

bus, do_not_queue=True)

2490

old_bus_name = (dbus.service.BusName

2491

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

2492

do_not_queue=True))

2493

except dbus.exceptions.NameExistsException as e:

2494

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

3229

2495

use_dbus = False

3230

2496

server_settings["use_dbus"] = False

3231

2497

tcp_server.use_dbus = False

3232

if zeroconf:

3233

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3234

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

3239

if server_settings["interface"]:

3240

service.interface = if_nametoindex(

3241

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

3242

2498

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2499

service = AvahiServiceToSyslog(name =

2500

server_settings["servicename"],

2501

servicetype = "_mandos._tcp",

2502

protocol = protocol, bus = bus)

2503

if server_settings["interface"]:

2504

service.interface = (if_nametoindex

2505

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

2506

3243

2507

global multiprocessing_manager

3244

2508

multiprocessing_manager = multiprocessing.Manager()

3245

2509

3246

2510

client_class = Client

3247

2511

if use_dbus:

3248

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

3249

2512

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

2513

3250

2514

client_settings = Client.config_parser(client_config)

3251

2515

old_client_settings = {}

3252

2516

clients_data = {}

3253

3254

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

3255

global wnull

3256

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

3257

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

3258

# mode

3259

if debug or not foreground:

3260

wnull.close()

3261

2517

3262

2518

# Get client data and settings from last running state.

3263

2519

if server_settings["restore"]:

3264

2520

try:

3265

2521

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

3266

if sys.version_info.major == 2:

3267

clients_data, old_client_settings = pickle.load(

3268

stored_state)

3269

else:

3270

bytes_clients_data, bytes_old_client_settings = (

3271

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

3272

# Fix bytes to strings

3273

# clients_data

3274

# .keys()

3275

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

3276

if isinstance(key, bytes)

3277

else key): value

3278

for key, value in

3279

bytes_clients_data.items()}

3280

del bytes_clients_data

3281

for key in clients_data:

3282

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

3283

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

3284

for k, v in

3285

clients_data[key].items()}

3286

clients_data[key] = value

3287

# .client_structure

3288

value["client_structure"] = [

3289

(s.decode("utf-8")

3290

if isinstance(s, bytes)

3291

else s) for s in

3292

value["client_structure"]]

3293

# .name, .host, and .checker_command

3294

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

3295

if isinstance(value[k], bytes):

3296

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

3297

if "key_id" not in value:

3298

value["key_id"] = ""

3299

elif "fingerprint" not in value:

3300

value["fingerprint"] = ""

3301

# old_client_settings

3302

# .keys()

3303

old_client_settings = {

3304

(key.decode("utf-8")

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_old_client_settings.items()}

3309

del bytes_old_client_settings

3310

# .host and .checker_command

3311

for value in old_client_settings.values():

3312

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

3313

if isinstance(value[attribute], bytes):

3314

value[attribute] = (value[attribute]

3315

.decode("utf-8"))

2522

clients_data, old_client_settings = (pickle.load

2523

(stored_state))

3316

2524

os.remove(stored_state_path)

3317

2525

except IOError as e:

3318

2526

if e.errno == errno.ENOENT:

3319

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

3320

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

2527

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

2528

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

3321

2529

else:

3322

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

3323

exc_info=e)

2530

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

2531

exc_info=e)

3324

2532

raise

3325

2533

except EOFError as e:

3326

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

3327

exc_info=e)

3328

2534

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

2535

"EOFError:", exc_info=e)

2536

3329

2537

with PGPEngine() as pgp:

3330

for client_name, client in clients_data.items():

3331

# Skip removed clients

3332

if client_name not in client_settings:

3333

continue

3334

2538

for client_name, client in clients_data.iteritems():

3335

2539

# Decide which value to use after restoring saved state.

3336

2540

# We have three different values: Old config file,

3337

2541

# new config file, and saved state.

3342

2546

# For each value in new config, check if it

3343

2547

# differs from the old config value (Except for

3344

2548

# the "secret" attribute)

3345

if (name != "secret"

3346

and (value !=

3347

old_client_settings[client_name][name])):

2549

if (name != "secret" and

2550

value != old_client_settings[client_name]

2551

[name]):

3348

2552

client[name] = value

3349

2553

except KeyError:

3350

2554

pass

3351

2555

3352

2556

# Clients who has passed its expire date can still be

3353

# enabled if its last checker was successful. A Client

2557

# enabled if its last checker was successful. Clients

3354

2558

# whose checker succeeded before we stored its state is

3355

2559

# assumed to have successfully run all checkers during

3356

2560

# downtime.

3357

2561

if client["enabled"]:

3358

2562

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

3359

2563

if not client["last_checked_ok"]:

3360

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

3361

" never performed a successful"

3362

" checker", client_name)

2564

logger.warning(

2565

"disabling client {0} - Client never "

2566

"performed a successful checker"

2567

.format(client_name))

3363

2568

client["enabled"] = False

3364

2569

elif client["last_checker_status"] != 0:

3365

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

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2570

logger.warning(

2571

"disabling client {0} - Client "

2572

"last checker failed with error code {1}"

2573

.format(client_name,

2574

client["last_checker_status"]))

3369

2575

client["enabled"] = False

3370

2576

else:

3371

client["expires"] = (

3372

datetime.datetime.utcnow()

3373

+ client["timeout"])

3374

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

3375

" enabled", client_name)

2577

client["expires"] = (datetime.datetime

2578

.utcnow()

2579

+ client["timeout"])

2580

logger.debug("Last checker succeeded,"

2581

" keeping {0} enabled"

2582

.format(client_name))

3376

2583

try:

3377

client["secret"] = pgp.decrypt(

3378

client["encrypted_secret"],

3379

client_settings[client_name]["secret"])

2584

client["secret"] = (

2585

pgp.decrypt(client["encrypted_secret"],

2586

client_settings[client_name]

2587

["secret"]))

3380

2588

except PGPError:

3381

2589

# If decryption fails, we use secret from new settings

3382

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

3383

client_name)

3384

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

3385

["secret"])

3386

2590

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

2591

.format(client_name))

2592

client["secret"] = (

2593

client_settings[client_name]["secret"])

2594

3387

2595

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

3388

2596

for client_name in (set(old_client_settings)

3389

2597

- set(client_settings)):

3391

2599

for client_name in (set(client_settings)

3392

2600

- set(old_client_settings)):

3393

2601

clients_data[client_name] = client_settings[client_name]

3394

2602

3395

2603

# Create all client objects

3396

for client_name, client in clients_data.items():

2604

for client_name, client in clients_data.iteritems():

3397

2605

tcp_server.clients[client_name] = client_class(

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2606

name = client_name, settings = client)

2607

3402

2608

if not tcp_server.clients:

3403

log.warning("No clients defined")

3404

2609

logger.warning("No clients defined")

2610

3405

2611

if not foreground:

3406

2612

if pidfile is not None:

3407

pid = os.getpid()

3408

2613

try:

3409

2614

with pidfile:

3410

print(pid, file=pidfile)

2615

pid = os.getpid()

2616

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

3411

2617

except IOError:

3412

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

3413

pidfilename, pid)

2618

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

2619

pidfilename, pid)

3414

2620

del pidfile

3415

2621

del pidfilename

3416

3417

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

3418

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3419

lambda: main_loop.quit() and False)

3420

2622

2623

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

2624

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

2625

3421

2626

if use_dbus:

3422

3423

@alternate_dbus_interfaces(

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2627

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

2628

"se.bsnet.fukt.Mandos"})

2629

class MandosDBusService(DBusObjectWithProperties):

3426

2630

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

3427

3428

2631

def __init__(self):

3429

2632

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

3430

3431

2633

_interface = "se.recompile.Mandos"

3432

2634

2635

@dbus_interface_annotations(_interface)

2636

def _foo(self):

2637

return { "org.freedesktop.DBus.Property"

2638

".EmitsChangedSignal":

2639

"false"}

2640

3433

2641

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

3434

2642

def ClientAdded(self, objpath):

3435

2643

"D-Bus signal"

3436

2644

pass

3437

2645

3438

2646

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

3439

def ClientNotFound(self, key_id, address):

2647

def ClientNotFound(self, fingerprint, address):

3440

2648

"D-Bus signal"

3441

2649

pass

3442

3443

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

3444

"true"})

2650

3445

2651

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

3446

2652

def ClientRemoved(self, objpath, name):

3447

2653

"D-Bus signal"

3448

2654

pass

3449

3450

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

3451

"true"})

2655

3452

2656

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

3453

2657

def GetAllClients(self):

3454

2658

"D-Bus method"

3455

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2659

return dbus.Array(c.dbus_object_path

2660

for c in

2661

tcp_server.clients.itervalues())

2662

3460

2663

@dbus.service.method(_interface,

3461

2664

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

3462

2665

def GetAllClientsWithProperties(self):

3463

2666

"D-Bus method"

3464

2667

return dbus.Dictionary(

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2668

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

2669

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

3468

2670

signature="oa{sv}")

3469

2671

3470

2672

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

3471

2673

def RemoveClient(self, object_path):

3472

2674

"D-Bus method"

3473

for c in tcp_server.clients.values():

2675

for c in tcp_server.clients.itervalues():

3474

2676

if c.dbus_object_path == object_path:

3475

2677

del tcp_server.clients[c.name]

3476

2678

c.remove_from_connection()

3477

# Don't signal the disabling

2679

# Don't signal anything except ClientRemoved

3478

2680

c.disable(quiet=True)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2681

# Emit D-Bus signal

2682

self.ClientRemoved(object_path, c.name)

3481

2683

return

3482

2684

raise KeyError(object_path)

3483

2685

3484

2686

del _interface

3485

3486

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3488

def GetManagedObjects(self):

3489

"""D-Bus method"""

3490

return dbus.Dictionary(

3491

{client.dbus_object_path:

3492

dbus.Dictionary(

3493

{interface: client.GetAll(interface)

3494

for interface in

3495

client._get_all_interface_names()})

3496

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

3497

3498

def client_added_signal(self, client):

3499

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

3500

if use_dbus:

3501

# New standard signal

3502

self.InterfacesAdded(

3503

client.dbus_object_path,

3504

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3508

# Old signal

3509

self.ClientAdded(client.dbus_object_path)

3510

3511

def client_removed_signal(self, client):

3512

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

3513

if use_dbus:

3514

# New standard signal

3515

self.InterfacesRemoved(

3516

client.dbus_object_path,

3517

client._get_all_interface_names())

3518

# Old signal

3519

self.ClientRemoved(client.dbus_object_path,

3520

client.name)

3521

2687

3522

2688

mandos_dbus_service = MandosDBusService()

3523

3524

# Save modules to variables to exempt the modules from being

3525

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

3526

mp = multiprocessing

3527

wn = wnull

3528

2689

3529

2690

def cleanup():

3530

2691

"Cleanup function; run on exit"

3531

if zeroconf:

3532

service.cleanup()

3533

3534

mp.active_children()

3535

wn.close()

2692

service.cleanup()

2693

2694

multiprocessing.active_children()

3536

2695

if not (tcp_server.clients or client_settings):

3537

2696

return

3538

2697

3539

2698

# Store client before exiting. Secrets are encrypted with key

3540

2699

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

3541

2700

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

3542

2701

clients = {}

3543

2702

with PGPEngine() as pgp:

3544

for client in tcp_server.clients.values():

2703

for client in tcp_server.clients.itervalues():

3545

2704

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

3546

2705

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

3547

2706

key)

3548

2707

client_dict = {}

3549

2708

3550

2709

# A list of attributes that can not be pickled

3551

2710

# + secret.

3552

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

3553

"checker", "server_settings"}

3554

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

3555

.Object):

2711

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

2712

"checker"))

2713

for name, typ in (inspect.getmembers

2714

(dbus.service.Object)):

3556

2715

exclude.add(name)

3557

2716

3558

2717

client_dict["encrypted_secret"] = (client

3559

2718

.encrypted_secret)

3560

2719

for attr in client.client_structure:

3561

2720

if attr not in exclude:

3562

2721

client_dict[attr] = getattr(client, attr)

3563

2722

3564

2723

clients[client.name] = client_dict

3565

2724

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

3566

2725

3567

2726

try:

3568

with tempfile.NamedTemporaryFile(

3569

mode="wb",

3570

suffix=".pickle",

3571

prefix="clients-",

3572

dir=os.path.dirname(stored_state_path),

3573

delete=False) as stored_state:

3574

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

3575

protocol=2)

3576

tempname = stored_state.name

2727

with (tempfile.NamedTemporaryFile

2728

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

2729

dir=os.path.dirname(stored_state_path),

2730

delete=False)) as stored_state:

2731

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

2732

tempname=stored_state.name

3577

2733

os.rename(tempname, stored_state_path)

3578

2734

except (IOError, OSError) as e:

3579

2735

if not debug:

3582

2738

except NameError:

3583

2739

pass

3584

2740

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

3585

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

3586

os.strerror(e.errno))

2741

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

2742

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

3587

2743

else:

3588

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

3589

exc_info=e)

3590

raise

3591

2744

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

2745

exc_info=e)

2746

raise e

2747

3592

2748

# Delete all clients, and settings from config

3593

2749

while tcp_server.clients:

3594

2750

name, client = tcp_server.clients.popitem()

3595

2751

if use_dbus:

3596

2752

client.remove_from_connection()

3597

# Don't signal the disabling

2753

# Don't signal anything except ClientRemoved

3598

2754

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

3600

2755

if use_dbus:

3601

mandos_dbus_service.client_removed_signal(client)

2756

# Emit D-Bus signal

2757

mandos_dbus_service.ClientRemoved(client

2758

.dbus_object_path,

2759

client.name)

3602

2760

client_settings.clear()

3603

2761

3604

2762

atexit.register(cleanup)

3605

3606

for client in tcp_server.clients.values():

2763

2764

for client in tcp_server.clients.itervalues():

3607

2765

if use_dbus:

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2766

# Emit D-Bus signal

2767

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3610

2768

# Need to initiate checking of clients

3611

2769

if client.enabled:

3612

2770

client.init_checker()

3613

2771

3614

2772

tcp_server.enable()

3615

2773

tcp_server.server_activate()

3616

2774

3617

2775

# Find out what port we got

3618

if zeroconf:

3619

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

2776

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

3620

2777

if use_ipv6:

3621

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

3622

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

2778

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

2779

" flowinfo %d, scope_id %d",

2780

*tcp_server.socket.getsockname())

3623

2781

else: # IPv4

3624

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

3625

*tcp_server.socket.getsockname())

3626

3627

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

3628

2782

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

2783

*tcp_server.socket.getsockname())

2784

2785

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

2786

3629

2787

try:

3630

if zeroconf:

3631

# From the Avahi example code

3632

try:

3633

service.activate()

3634

except dbus.exceptions.DBusException as error:

3635

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

3636

cleanup()

3637

sys.exit(1)

3638

# End of Avahi example code

3639

3640

GLib.io_add_watch(

3641

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

3642

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3643

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

3644

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

3645

3646

log.debug("Starting main loop")

2788

# From the Avahi example code

2789

try:

2790

service.activate()

2791

except dbus.exceptions.DBusException as error:

2792

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

2793

cleanup()

2794

sys.exit(1)

2795

# End of Avahi example code

2796

2797

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

2798

lambda *args, **kwargs:

2799

(tcp_server.handle_request

2800

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

2801

2802

logger.debug("Starting main loop")

3647

2803

main_loop.run()

3648

2804

except AvahiError as error:

3649

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

2805

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

3650

2806

cleanup()

3651

2807

sys.exit(1)

3652

2808

except KeyboardInterrupt:

3653

2809

if debug:

3654

2810

print("", file=sys.stderr)

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2811

logger.debug("Server received KeyboardInterrupt")

2812

logger.debug("Server exiting")

3657

2813

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

3658

2814

cleanup()

3659

2815

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

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

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

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

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

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

3690

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

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

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

3702

# extra))

3703

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

3704

# (funcall remove-test-window)

3705

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

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

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

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

# (let ((process-result

3714

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

3715

# (process-file-shell-command

3716

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

3717

# (and (numberp process-result)

3718

# (= process-result 0))))

3719

# get-command-line:

3720

# (lambda (&optional extra)

3721

# (let ((quoted-script

3722

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

3723

# (format

3724

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

3725

# quoted-script)))

3726

# get-script-name:

3727

# (lambda ()

3728

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

3729

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

3730

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

3731

# (buffer-file-name))))

3732

# remove-test-window:

3733

# (lambda ()

3734

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

3735

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

3736

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

3737

# (lambda ()

3738

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

3739

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

3740

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

3741

# (display-buffer-overriding-action

3742

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

3743

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

3744

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

3745

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

3746

# eval:

3747

# (progn

3748

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

3749

# (funcall run-tests t)))

3750

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

3751

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

3752

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

3753

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

3754

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

3755

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

3756

# End:

2816

if __name__ == '__main__':

2817

main()