/mandos/release : revision 237.7.174

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

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

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

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

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

147

92

stored_state_file = "clients.pickle"

148

93

149

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

150

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

151

syslogger = None

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

152

98

153

99

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

156

103

except (OSError, AttributeError):

157

158

104

def if_nametoindex(interface):

159

105

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

160

106

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

161

107

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

162

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

165

113

return interface_index

166

114

167

115

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

116

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

185

117

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

118

191

119

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

196

124

if debug:

197

125

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)

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

204

132

205

133

206

134

class PGPError(Exception):

208

136

pass

209

137

210

138

211

class PGPEngine:

139

class PGPEngine(object):

212

140

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

213

214

141

def __init__(self):

215

142

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

143

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

145

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

235

149

def __enter__(self):

236

150

return self

237

151

238

152

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

239

153

self._cleanup()

240

154

return False

241

155

242

156

def __del__(self):

243

157

self._cleanup()

244

158

245

159

def _cleanup(self):

246

160

if self.tempdir is not None:

247

161

# Delete contents of tempdir

248

162

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

249

topdown=False):

163

topdown = False):

250

164

for filename in files:

251

165

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

252

166

for dirname in dirs:

254

168

# Remove tempdir

255

169

os.rmdir(self.tempdir)

256

170

self.tempdir = None

257

171

258

172

def password_encode(self, password):

259

173

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

260

174

# 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

175

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

176

269

177

def encrypt(self, data, password):

270

178

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

273

181

passfile.write(passphrase)

274

182

passfile.flush()

275

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

276

"--passphrase-file",

183

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

184

'--passphrase-file',

277

185

passfile.name]

278

186

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

283

191

if proc.returncode != 0:

284

192

raise PGPError(err)

285

193

return ciphertext

286

194

287

195

def decrypt(self, data, password):

288

196

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

291

199

passfile.write(passphrase)

292

200

passfile.flush()

293

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

294

"--passphrase-file",

201

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

202

'--passphrase-file',

295

203

passfile.name]

296

204

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

301

210

if proc.returncode != 0:

302

211

raise PGPError(err)

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

235

236

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

355

237

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

356

238

port: integer; what port to announce

357

239

TXT: list of strings; TXT record for the service

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

918

442

disabled, or None

919

443

server_settings: The server_settings dict from main()

920

444

"""

921

445

922

446

runtime_expansions = ("approval_delay", "approval_duration",

923

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

447

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

924

448

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

925

449

"last_approval_request", "last_checked_ok",

926

450

"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

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

939

477

@staticmethod

940

478

def config_parser(config):

941

479

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

948

486

for client_name in config.sections():

949

487

section = dict(config.items(client_name))

950

488

client = settings[client_name] = {}

951

489

952

490

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

953

491

# Reformat values from string types to Python types

954

492

client["approved_by_default"] = config.getboolean(

955

493

client_name, "approved_by_default")

956

494

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

957

495

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

496

964

497

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

965

498

.replace(" ", ""))

966

499

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

500

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

970

501

elif "secfile" in section:

971

502

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

972

503

(section["secfile"])),

973

504

"rb") as secfile:

974

505

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

975

506

else:

976

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

507

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

977

508

.format(section))

978

509

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

979

510

client["extended_timeout"] = string_to_delta(

987

518

client["last_approval_request"] = None

988

519

client["last_checked_ok"] = None

989

520

client["last_checker_status"] = -2

990

521

991

522

return settings

992

993

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

523

524

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

994

525

self.name = name

995

526

if server_settings is None:

996

527

server_settings = {}

997

528

self.server_settings = server_settings

998

529

# adding all client settings

999

for setting, value in settings.items():

530

for setting, value in settings.iteritems():

1000

531

setattr(self, setting, value)

1001

532

1002

533

if self.enabled:

1003

534

if not hasattr(self, "last_enabled"):

1004

535

self.last_enabled = datetime.datetime.utcnow()

1008

539

else:

1009

540

self.last_enabled = None

1010

541

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)

542

543

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

547

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

1015

548

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

1016

549

datetime.datetime.utcnow())

1017

550

1018

551

# attributes specific for this server instance

1019

552

self.checker = None

1020

553

self.checker_initiator_tag = None

1023

556

self.current_checker_command = None

1024

557

self.approved = None

1025

558

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

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

1030

564

if not attr.startswith("_")]

1031

565

self.client_structure.append("client_structure")

1032

1033

for name, t in inspect.getmembers(

1034

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

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

1035

571

if not name.startswith("_"):

1036

572

self.client_structure.append(name)

1037

573

1038

574

# Send notice to process children that client state has changed

1039

575

def send_changedstate(self):

1040

576

with self.changedstate:

1041

577

self.changedstate.notify_all()

1042

578

1043

579

def enable(self):

1044

580

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

1045

581

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

1046

582

# Already enabled

1047

583

return

584

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

1048

585

self.enabled = True

1049

586

self.last_enabled = datetime.datetime.utcnow()

1050

587

self.init_checker()

1051

588

self.send_changedstate()

1052

589

1053

590

def disable(self, quiet=True):

1054

591

"""Disable this client."""

1055

592

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

1056

593

return False

1057

594

if not quiet:

1058

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

595

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

1059

596

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

1060

GLib.source_remove(self.disable_initiator_tag)

597

gobject.source_remove(self.disable_initiator_tag)

1061

598

self.disable_initiator_tag = None

1062

599

self.expires = None

1063

600

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

1064

GLib.source_remove(self.checker_initiator_tag)

601

gobject.source_remove(self.checker_initiator_tag)

1065

602

self.checker_initiator_tag = None

1066

603

self.stop_checker()

1067

604

self.enabled = False

1068

605

if not quiet:

1069

606

self.send_changedstate()

1070

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

607

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

1071

608

return False

1072

609

1073

610

def __del__(self):

1074

611

self.disable()

1075

1076

def init_checker(self, randomize_start=False):

1077

# Schedule a new checker to be started a randomly selected

1078

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

1079

# the startup of checkers over time when the server is

1080

# started.

612

613

def init_checker(self):

614

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

615

# and every interval from then on.

1081

616

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

interval_milliseconds = int(self.interval.total_seconds()

1084

* 1000)

1085

if randomize_start:

1086

delay_milliseconds = random.randrange(

1087

interval_milliseconds + 1)

1088

else:

1089

delay_milliseconds = interval_milliseconds

1090

self.checker_initiator_tag = GLib.timeout_add(

1091

delay_milliseconds, self.start_checker, randomize_start)

1092

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

1093

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

1094

# expire at the soonest one interval after a checker was

1095

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

1096

# time might have to be extended.

1097

now = datetime.datetime.utcnow()

1098

self.expires = now + delay + self.interval

1099

# Schedule a disable() at expire time

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

621

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

1100

622

if self.disable_initiator_tag is not None:

1101

GLib.source_remove(self.disable_initiator_tag)

1102

self.disable_initiator_tag = GLib.timeout_add(

1103

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

1104

self.disable)

1105

1106

def checker_callback(self, source, condition, connection,

1107

command):

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

627

# Also start a new checker *right now*.

628

self.start_checker()

629

630

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

1108

631

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

1109

# Read return code from connection (see call_pipe)

1110

returncode = connection.recv()

1111

connection.close()

1112

if self.checker is not None:

1113

self.checker.join()

1114

632

self.checker_callback_tag = None

1115

633

self.checker = None

1116

1117

if returncode >= 0:

1118

self.last_checker_status = returncode

1119

self.last_checker_signal = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1120

636

if self.last_checker_status == 0:

1121

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

637

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

638

vars(self))

1122

639

self.checked_ok()

1123

640

else:

1124

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

641

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

642

vars(self))

1125

643

else:

1126

644

self.last_checker_status = -1

1127

self.last_checker_signal = -returncode

1128

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

1129

return False

1130

645

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

646

vars(self))

647

1131

648

def checked_ok(self):

1132

649

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

1133

650

self.last_checked_ok = datetime.datetime.utcnow()

1134

651

self.last_checker_status = 0

1135

self.last_checker_signal = None

1136

652

self.bump_timeout()

1137

653

1138

654

def bump_timeout(self, timeout=None):

1139

655

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

1140

656

if timeout is None:

1141

657

timeout = self.timeout

1142

658

if self.disable_initiator_tag is not None:

1143

GLib.source_remove(self.disable_initiator_tag)

659

gobject.source_remove(self.disable_initiator_tag)

1144

660

self.disable_initiator_tag = None

1145

661

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

1146

self.disable_initiator_tag = GLib.timeout_add(

1147

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1148

665

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

1149

666

1150

667

def need_approval(self):

1151

668

self.last_approval_request = datetime.datetime.utcnow()

1152

1153

def start_checker(self, start_was_randomized=False):

669

670

def start_checker(self):

1154

671

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

1155

672

1156

673

If a checker already exists, leave it running and do

1157

674

nothing."""

1158

675

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

1163

680

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

1164

681

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

1165

682

# should be.

1166

1167

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

1168

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

1169

self.checker.join()

1170

self.checker = None

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1171

697

# Start a new checker if needed

1172

698

if self.checker is None:

1173

699

# Escape attributes for the shell

1174

escaped_attrs = {

1175

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

1176

for attr in self.runtime_expansions}

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1177

704

try:

1178

705

command = self.checker_command % escaped_attrs

1179

706

except TypeError as error:

1180

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

1181

self.checker_command, exc_info=error)

1182

return True # Try again later

707

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1183

710

self.current_checker_command = command

1184

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

1185

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

1186

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

1187

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

1188

# always replaced by /dev/null.)

1189

# The exception is when not debugging but nevertheless

1190

# running in the foreground; use the previously

1191

# created wnull.

1192

popen_args = {"close_fds": True,

1193

"shell": True,

1194

"cwd": "/"}

1195

if (not self.server_settings["debug"]

1196

and self.server_settings["foreground"]):

1197

popen_args.update({"stdout": wnull,

1198

"stderr": wnull})

1199

pipe = multiprocessing.Pipe(duplex=False)

1200

self.checker = multiprocessing.Process(

1201

target=call_pipe,

1202

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

1203

kwargs=popen_args)

1204

self.checker.start()

1205

self.checker_callback_tag = GLib.io_add_watch(

1206

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

1207

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1208

self.checker_callback, pipe[0], command)

1209

if start_was_randomized:

1210

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

1211

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

1212

# interval from then on.

1213

now = datetime.datetime.utcnow()

1214

self.checker_initiator_tag = GLib.timeout_add(

1215

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

1216

self.start_checker)

1217

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

1218

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

1219

return False

1220

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

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1221

753

return True

1222

754

1223

755

def stop_checker(self):

1224

756

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

1225

757

if self.checker_callback_tag:

1226

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1227

759

self.checker_callback_tag = None

1228

760

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

1229

761

return

1230

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

1231

self.checker.terminate()

762

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1232

771

self.checker = None

1233

772

1234

773

1235

def dbus_service_property(dbus_interface,

1236

signature="v",

1237

access="readwrite",

1238

byte_arrays=False):

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1239

776

"""Decorators for marking methods of a DBusObjectWithProperties to

1240

777

become properties on the D-Bus.

1241

778

1242

779

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

1243

780

and with one argument by "Set".

1244

781

1245

782

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

1246

783

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

1247

784

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

1250

787

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

1251

788

if byte_arrays and signature != "ay":

1252

789

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

1253

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

1254

790

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

1255

791

def decorator(func):

1256

792

func._dbus_is_property = True

1257

793

func._dbus_interface = dbus_interface

1260

796

func._dbus_name = func.__name__

1261

797

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

1262

798

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

1263

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1264

800

return func

1265

1266

801

return decorator

1267

802

1268

803

1269

804

def dbus_interface_annotations(dbus_interface):

1270

805

"""Decorator for marking functions returning interface annotations

1271

806

1272

807

Usage:

1273

808

1274

809

@dbus_interface_annotations("org.example.Interface")

1275

810

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

1276

811

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

1277

812

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

1278

813

"false"}

1279

814

"""

1280

1281

815

def decorator(func):

1282

816

func._dbus_is_interface = True

1283

817

func._dbus_interface = dbus_interface

1284

818

func._dbus_name = dbus_interface

1285

819

return func

1286

1287

820

return decorator

1288

821

1289

822

1290

823

def dbus_annotations(annotations):

1291

824

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

1292

825

Usage:

1293

1294

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

1295

"org.freedesktop.DBus.Property."

1296

"EmitsChangedSignal": "false"})

826

1297

827

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

1298

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

1299

832

def Property_dbus_property(self):

1300

833

return dbus.Boolean(False)

1301

1302

See also the DBusObjectWithAnnotations class.

1303

834

"""

1304

1305

835

def decorator(func):

1306

836

func._dbus_annotations = annotations

1307

837

return func

1308

1309

838

return decorator

1310

839

1311

840

1312

841

class DBusPropertyException(dbus.exceptions.DBusException):

1313

842

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

1314

843

"""

1315

pass

844

def __unicode__(self):

845

return unicode(str(self))

1316

846

1317

847

1318

848

class DBusPropertyAccessException(DBusPropertyException):

1327

857

pass

1328

858

1329

859

1330

class DBusObjectWithAnnotations(dbus.service.Object):

1331

"""A D-Bus object with annotations.

1332

1333

Classes inheriting from this can use the dbus_annotations

1334

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1335

866

"""

1336

867

1337

868

@staticmethod

1338

869

def _is_dbus_thing(thing):

1339

870

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

1340

871

1341

872

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

1342

873

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

1343

874

"""

1344

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

875

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

1345

876

False)

1346

877

1347

878

def _get_all_dbus_things(self, thing):

1348

879

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

1349

880

"""

1350

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

881

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

882

name),

1351

883

athing.__get__(self))

1352

884

for cls in self.__class__.__mro__

1353

885

for name, athing in

1354

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

1355

1356

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1357

out_signature="s",

1358

path_keyword="object_path",

1359

connection_keyword="connection")

1360

def Introspect(self, object_path, connection):

1361

"""Overloading of standard D-Bus method.

1362

1363

Inserts annotation tags on methods and signals.

1364

"""

1365

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

1366

connection)

1367

try:

1368

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

1369

1370

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

1371

# Add annotation tags

1372

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

1373

for tag in if_tag.getElementsByTagName(typ):

1374

annots = dict()

1375

for name, prop in (self.

1376

_get_all_dbus_things(typ)):

1377

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

1378

and prop._dbus_interface

1379

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

1380

annots.update(getattr(

1381

prop, "_dbus_annotations", {}))

1382

for name, value in annots.items():

1383

ann_tag = document.createElement(

1384

"annotation")

1385

ann_tag.setAttribute("name", name)

1386

ann_tag.setAttribute("value", value)

1387

tag.appendChild(ann_tag)

1388

# Add interface annotation tags

1389

for annotation, value in dict(

1390

itertools.chain.from_iterable(

1391

annotations().items()

1392

for name, annotations

1393

in self._get_all_dbus_things("interface")

1394

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

1395

)).items():

1396

ann_tag = document.createElement("annotation")

1397

ann_tag.setAttribute("name", annotation)

1398

ann_tag.setAttribute("value", value)

1399

if_tag.appendChild(ann_tag)

1400

# Fix argument name for the Introspect method itself

1401

if (if_tag.getAttribute("name")

1402

== dbus.INTROSPECTABLE_IFACE):

1403

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

1404

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

1405

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

1406

if (arg.getAttribute("direction")

1407

== "out"):

1408

arg.setAttribute("name",

1409

"xml_data")

1410

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

1411

document.unlink()

1412

except (AttributeError, xml.dom.DOMException,

1413

xml.parsers.expat.ExpatError) as error:

1414

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

1415

exc_info=error)

1416

return xmlstring

1417

1418

1419

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1420

"""A D-Bus object with properties.

1421

1422

Classes inheriting from this can use the dbus_service_property

1423

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

1424

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

1425

"""

1426

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1427

889

def _get_dbus_property(self, interface_name, property_name):

1428

890

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

1429

891

property with the specified name and interface.

1430

892

"""

1431

for cls in self.__class__.__mro__:

1432

for name, value in inspect.getmembers(

1433

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

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1434

897

if (value._dbus_name == property_name

1435

898

and value._dbus_interface == interface_name):

1436

899

return value.__get__(self)

1437

900

1438

901

# No such property

1439

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

1440

self.dbus_object_path, interface_name, property_name))

1441

1442

@classmethod

1443

def _get_all_interface_names(cls):

1444

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

1445

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

1446

"_dbus_interface", None)

1447

for x in (inspect.getmro(cls))

1448

for attr in dir(x))

1449

if name is not None)

1450

1451

@dbus.service.method(dbus.PROPERTIES_IFACE,

1452

in_signature="ss",

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1453

907

out_signature="v")

1454

908

def Get(self, interface_name, property_name):

1455

909

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

1461

915

if not hasattr(value, "variant_level"):

1462

916

return value

1463

917

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

1464

918

1465

919

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

1466

920

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

1467

921

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

1473

927

# The byte_arrays option is not supported yet on

1474

928

# signatures other than "ay".

1475

929

if prop._dbus_signature != "ay":

1476

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

1477

"'ay' signature {!r}"

1478

.format(prop._dbus_signature))

1479

value = dbus.ByteArray(bytes(value))

930

raise ValueError

931

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

932

for byte in value))

1480

933

prop(value)

1481

1482

@dbus.service.method(dbus.PROPERTIES_IFACE,

1483

in_signature="s",

934

935

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

1484

936

out_signature="a{sv}")

1485

937

def GetAll(self, interface_name):

1486

938

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

1487

939

standard.

1488

940

1489

941

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

1490

942

"""

1491

943

properties = {}

1501

953

if not hasattr(value, "variant_level"):

1502

954

properties[name] = value

1503

955

continue

1504

properties[name] = type(value)(

1505

value, variant_level=value.variant_level + 1)

956

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

957

value.variant_level+1)

1506

958

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

1507

1508

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

1509

def PropertiesChanged(self, interface_name, changed_properties,

1510

invalidated_properties):

1511

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

1512

standard.

1513

"""

1514

pass

1515

959

1516

960

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1517

961

out_signature="s",

1518

path_keyword="object_path",

1519

connection_keyword="connection")

962

path_keyword='object_path',

963

connection_keyword='connection')

1520

964

def Introspect(self, object_path, connection):

1521

965

"""Overloading of standard D-Bus method.

1522

966

1523

967

Inserts property tags and interface annotation tags.

1524

968

"""

1525

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1526

object_path,

1527

connection)

969

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

970

connection)

1528

971

try:

1529

972

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

1530

1531

973

def make_tag(document, name, prop):

1532

974

e = document.createElement("property")

1533

975

e.setAttribute("name", name)

1534

976

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

1535

977

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

1536

978

return e

1537

1538

979

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

1539

980

# Add property tags

1540

981

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

1543

984

if prop._dbus_interface

1544

985

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

1545

986

if_tag.appendChild(tag)

1546

# Add annotation tags for properties

1547

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

1548

annots = dict()

1549

for name, prop in self._get_all_dbus_things(

1550

"property"):

1551

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

1552

and prop._dbus_interface

1553

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

1554

annots.update(getattr(

1555

prop, "_dbus_annotations", {}))

1556

for name, value in annots.items():

1557

ann_tag = document.createElement(

1558

"annotation")

1559

ann_tag.setAttribute("name", name)

1560

ann_tag.setAttribute("value", value)

1561

tag.appendChild(ann_tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1562

1018

# Add the names to the return values for the

1563

1019

# "org.freedesktop.DBus.Properties" methods

1564

1020

if (if_tag.getAttribute("name")

1578

1034

document.unlink()

1579

1035

except (AttributeError, xml.dom.DOMException,

1580

1036

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

try:

1587

dbus.OBJECT_MANAGER_IFACE

1588

except AttributeError:

1589

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

1590

1591

1592

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1593

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

1594

1595

Classes inheriting from this exposes the standard

1596

GetManagedObjects call and the InterfacesAdded and

1597

InterfacesRemoved signals on the standard

1598

"org.freedesktop.DBus.ObjectManager" interface.

1599

1600

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

1601

manually.

1602

"""

1603

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1604

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

1605

def GetManagedObjects(self):

1606

"""This function must be overridden"""

1607

raise NotImplementedError()

1608

1609

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def InterfacesAdded(self, object_path, interfaces_and_properties):

1612

pass

1613

1614

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

1615

def InterfacesRemoved(self, object_path, interfaces):

1616

pass

1617

1618

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1619

out_signature="s",

1620

path_keyword="object_path",

1621

connection_keyword="connection")

1622

def Introspect(self, object_path, connection):

1623

"""Overloading of standard D-Bus method.

1624

1625

Override return argument name of GetManagedObjects to be

1626

"objpath_interfaces_and_properties"

1627

"""

1628

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1629

object_path,

1630

connection)

1631

try:

1632

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

1633

1634

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

1635

# Fix argument name for the GetManagedObjects method

1636

if (if_tag.getAttribute("name")

1637

== dbus.OBJECT_MANAGER_IFACE):

1638

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

1639

if (cn.getAttribute("name")

1640

== "GetManagedObjects"):

1641

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

1642

if (arg.getAttribute("direction")

1643

== "out"):

1644

arg.setAttribute(

1645

"name",

1646

"objpath_interfaces"

1647

"_and_properties")

1648

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

1649

document.unlink()

1650

except (AttributeError, xml.dom.DOMException,

1651

xml.parsers.expat.ExpatError) as error:

1652

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

1653

exc_info=error)

1037

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

1038

exc_info=error)

1654

1039

return xmlstring

1655

1040

1656

1041

1657

1042

def datetime_to_dbus(dt, variant_level=0):

1658

1043

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

1659

1044

if dt is None:

1660

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

1661

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

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1662

1048

1663

1049

1664

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1666

1052

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

1667

1053

interface names according to the "alt_interface_names" mapping.

1668

1054

Usage:

1669

1055

1670

1056

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

1671

1057

"net.example.AlternateInterface"})

1672

1058

class SampleDBusObject(dbus.service.Object):

1673

1059

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

1674

1060

def SampleDBusMethod():

1675

1061

pass

1676

1062

1677

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1678

1064

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

1679

1065

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

1680

1066

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

1681

1067

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

1682

1068

1683

1069

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

1684

1070

(from DBusObjectWithProperties) and interfaces (from the

1685

1071

dbus_interface_annotations decorator).

1686

1072

"""

1687

1688

1073

def wrapper(cls):

1689

1074

for orig_interface_name, alt_interface_name in (

1690

alt_interface_names.items()):

1075

alt_interface_names.iteritems()):

1691

1076

attr = {}

1692

1077

interface_names = set()

1693

1078

# Go though all attributes of the class

1695

1080

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

1696

1081

# with the wrong interface name

1697

1082

if (not hasattr(attribute, "_dbus_interface")

1698

or not attribute._dbus_interface.startswith(

1699

orig_interface_name)):

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1700

1085

continue

1701

1086

# Create an alternate D-Bus interface name based on

1702

1087

# the current name

1703

alt_interface = attribute._dbus_interface.replace(

1704

orig_interface_name, alt_interface_name)

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1705

1091

interface_names.add(alt_interface)

1706

1092

# Is this a D-Bus signal?

1707

1093

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

1708

1094

# Extract the original non-method undecorated

1709

1095

# function by black magic

1710

if sys.version_info.major == 2:

1711

nonmethod_func = (dict(

1096

nonmethod_func = (dict(

1712

1097

zip(attribute.func_code.co_freevars,

1713

attribute.__closure__))

1714

["func"].cell_contents)

1715

else:

1716

nonmethod_func = (dict(

1717

zip(attribute.__code__.co_freevars,

1718

attribute.__closure__))

1719

["func"].cell_contents)

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1720

1100

# Create a new, but exactly alike, function

1721

1101

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

1722

1102

# with the alternate D-Bus interface name

1723

new_function = copy_function(nonmethod_func)

1724

new_function = (dbus.service.signal(

1725

alt_interface,

1726

attribute._dbus_signature)(new_function))

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1727

1112

# Copy annotations, if any

1728

1113

try:

1729

new_function._dbus_annotations = dict(

1730

attribute._dbus_annotations)

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1731

1116

except AttributeError:

1732

1117

pass

1733

1734

1118

# Define a creator of a function to call both the

1735

1119

# original and alternate functions, so both the

1736

1120

# original and alternate signals gets sent when

1739

1123

"""This function is a scope container to pass

1740

1124

func1 and func2 to the "call_both" function

1741

1125

outside of its arguments"""

1742

1743

@functools.wraps(func2)

1744

1126

def call_both(*args, **kwargs):

1745

1127

"""This function will emit two D-Bus

1746

1128

signals by calling func1 and func2"""

1747

1129

func1(*args, **kwargs)

1748

1130

func2(*args, **kwargs)

1749

# Make wrapper function look like a D-Bus

1750

# signal

1751

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

1752

if name.startswith("_dbus_"):

1753

setattr(call_both, name, attr)

1754

1755

1131

return call_both

1756

1132

# Create the "call_both" function and add it to

1757

1133

# the class

1762

1138

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

1763

1139

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

1764

1140

# to the class.

1765

attr[attrname] = (

1766

dbus.service.method(

1767

alt_interface,

1768

attribute._dbus_in_signature,

1769

attribute._dbus_out_signature)

1770

(copy_function(attribute)))

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1771

1151

# Copy annotations, if any

1772

1152

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1775

1155

except AttributeError:

1776

1156

pass

1777

1157

# Is this a D-Bus property?

1780

1160

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

1781

1161

# property with the alternate D-Bus interface

1782

1162

# name. Add it to the class.

1783

attr[attrname] = (dbus_service_property(

1784

alt_interface, attribute._dbus_signature,

1785

attribute._dbus_access,

1786

attribute._dbus_get_args_options

1787

["byte_arrays"])

1788

(copy_function(attribute)))

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1789

1176

# Copy annotations, if any

1790

1177

try:

1791

attr[attrname]._dbus_annotations = dict(

1792

attribute._dbus_annotations)

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1793

1180

except AttributeError:

1794

1181

pass

1795

1182

# Is this a D-Bus interface?

1798

1185

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

1799

1186

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

1800

1187

# to the class.

1801

attr[attrname] = (

1802

dbus_interface_annotations(alt_interface)

1803

(copy_function(attribute)))

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1804

1196

if deprecate:

1805

1197

# Deprecate all alternate interfaces

1806

iname = "_AlternateDBusNames_interface_annotation{}"

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1807

1199

for interface_name in interface_names:

1808

1809

1200

@dbus_interface_annotations(interface_name)

1810

1201

def func(self):

1811

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

1812

"true"}

1202

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

1203

"true" }

1813

1204

# Find an unused name

1814

1205

for aname in (iname.format(i)

1815

1206

for i in itertools.count()):

1819

1210

if interface_names:

1820

1211

# Replace the class with a new subclass of it with

1821

1212

# methods, signals, etc. as created above.

1822

if sys.version_info.major == 2:

1823

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

1824

(cls, ), attr)

1825

else:

1826

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

1827

(cls, ), attr)

1213

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

1214

(cls,), attr)

1828

1215

return cls

1829

1830

1216

return wrapper

1831

1217

1832

1218

1833

1219

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

1834

"se.bsnet.fukt.Mandos"})

1220

"se.bsnet.fukt.Mandos"})

1835

1221

class ClientDBus(Client, DBusObjectWithProperties):

1836

1222

"""A Client class using D-Bus

1837

1223

1838

1224

Attributes:

1839

1225

dbus_object_path: dbus.ObjectPath

1840

1226

bus: dbus.SystemBus()

1841

1227

"""

1842

1228

1843

1229

runtime_expansions = (Client.runtime_expansions

1844

+ ("dbus_object_path", ))

1845

1846

_interface = "se.recompile.Mandos.Client"

1847

1230

+ ("dbus_object_path",))

1231

1848

1232

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

1849

1850

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

1233

1234

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

1851

1235

self.bus = bus

1852

1236

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

1853

1237

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

1854

1238

# the D-Bus

1855

client_object_name = str(self.name).translate(

1239

client_object_name = unicode(self.name).translate(

1856

1240

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

1857

1241

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

1858

self.dbus_object_path = dbus.ObjectPath(

1859

"/clients/" + client_object_name)

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1860

1244

DBusObjectWithProperties.__init__(self, self.bus,

1861

1245

self.dbus_object_path)

1862

1863

def notifychangeproperty(transform_func, dbus_name,

1864

type_func=lambda x: x,

1865

variant_level=1,

1866

invalidate_only=False,

1867

_interface=_interface):

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1868

1250

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

1869

1251

its changes to DBus.

1870

1252

1871

1253

transform_fun: Function that takes a value and a variant_level

1872

1254

and transforms it to a D-Bus type.

1873

1255

dbus_name: D-Bus name of the variable

1875

1257

to the D-Bus. Default: no transform

1876

1258

variant_level: D-Bus variant level. Default: 1

1877

1259

"""

1878

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

1879

1260

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

1880

1261

def setter(self, value):

1881

1262

if hasattr(self, "dbus_object_path"):

1882

1263

if (not hasattr(self, attrname) or

1883

1264

type_func(getattr(self, attrname, None))

1884

1265

!= type_func(value)):

1885

if invalidate_only:

1886

self.PropertiesChanged(

1887

_interface, dbus.Dictionary(),

1888

dbus.Array((dbus_name, )))

1889

else:

1890

dbus_value = transform_func(

1891

type_func(value),

1892

variant_level=variant_level)

1893

self.PropertyChanged(dbus.String(dbus_name),

1894

dbus_value)

1895

self.PropertiesChanged(

1896

_interface,

1897

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

1898

dbus_value}),

1899

dbus.Array())

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1900

1271

setattr(self, attrname, value)

1901

1272

1902

1273

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

1903

1274

1904

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1905

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1906

1277

"ApprovalPending",

1907

type_func=bool)

1278

type_func = bool)

1908

1279

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

1909

1280

last_enabled = notifychangeproperty(datetime_to_dbus,

1910

1281

"LastEnabled")

1911

checker = notifychangeproperty(

1912

dbus.Boolean, "CheckerRunning",

1913

type_func=lambda checker: checker is not None)

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1914

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1915

1286

"LastCheckedOK")

1916

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1919

1290

datetime_to_dbus, "LastApprovalRequest")

1920

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1921

1292

"ApprovedByDefault")

1922

approval_delay = notifychangeproperty(

1923

dbus.UInt64, "ApprovalDelay",

1924

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

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1925

1297

approval_duration = notifychangeproperty(

1926

1298

dbus.UInt64, "ApprovalDuration",

1927

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

1299

type_func = timedelta_to_milliseconds)

1928

1300

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

1929

timeout = notifychangeproperty(

1930

dbus.UInt64, "Timeout",

1931

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1932

1304

extended_timeout = notifychangeproperty(

1933

1305

dbus.UInt64, "ExtendedTimeout",

1934

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

1935

interval = notifychangeproperty(

1936

dbus.UInt64, "Interval",

1937

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

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1938

1311

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

1939

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

1940

invalidate_only=True)

1941

1312

1942

1313

del notifychangeproperty

1943

1314

1944

1315

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

1945

1316

try:

1946

1317

self.remove_from_connection()

1949

1320

if hasattr(DBusObjectWithProperties, "__del__"):

1950

1321

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

1951

1322

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

1952

1953

def checker_callback(self, source, condition,

1954

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

1955

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

1956

connection, command, *args,

1957

**kwargs)

1958

exitstatus = self.last_checker_status

1959

if exitstatus >= 0:

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1960

1330

# Emit D-Bus signal

1961

1331

self.CheckerCompleted(dbus.Int16(exitstatus),

1962

# This is specific to GNU libC

1963

dbus.Int64(exitstatus << 8),

1332

dbus.Int64(condition),

1964

1333

dbus.String(command))

1965

1334

else:

1966

1335

# Emit D-Bus signal

1967

1336

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

1968

dbus.Int64(

1969

# This is specific to GNU libC

1970

(exitstatus << 8)

1971

| self.last_checker_signal),

1337

dbus.Int64(condition),

1972

1338

dbus.String(command))

1973

return ret

1974

1339

1340

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

1341

*args, **kwargs)

1342

1975

1343

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

1976

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1977

1349

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

1978

1350

# Only if new checker process was started

1979

1351

if (self.checker is not None

1981

1353

# Emit D-Bus signal

1982

1354

self.CheckerStarted(self.current_checker_command)

1983

1355

return r

1984

1356

1985

1357

def _reset_approved(self):

1986

1358

self.approved = None

1987

1359

return False

1988

1360

1989

1361

def approve(self, value=True):

1990

1362

self.approved = value

1991

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

1992

* 1000), self._reset_approved)

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1993

1366

self.send_changedstate()

1994

1995

# D-Bus methods, signals & properties

1996

1997

# Interfaces

1998

1999

# Signals

2000

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

2001

1380

# CheckerCompleted - signal

2002

1381

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

2003

1382

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

2004

1383

"D-Bus signal"

2005

1384

pass

2006

1385

2007

1386

# CheckerStarted - signal

2008

1387

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

2009

1388

def CheckerStarted(self, command):

2010

1389

"D-Bus signal"

2011

1390

pass

2012

1391

2013

1392

# PropertyChanged - signal

2014

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

2015

1393

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

2016

1394

def PropertyChanged(self, property, value):

2017

1395

"D-Bus signal"

2018

1396

pass

2019

1397

2020

1398

# GotSecret - signal

2021

1399

@dbus.service.signal(_interface)

2022

1400

def GotSecret(self):

2025

1403

server to mandos-client

2026

1404

"""

2027

1405

pass

2028

1406

2029

1407

# Rejected - signal

2030

1408

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

2031

1409

def Rejected(self, reason):

2032

1410

"D-Bus signal"

2033

1411

pass

2034

1412

2035

1413

# NeedApproval - signal

2036

1414

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

2037

1415

def NeedApproval(self, timeout, default):

2038

1416

"D-Bus signal"

2039

1417

return self.need_approval()

2040

2041

# Methods

2042

1418

1419

## Methods

1420

2043

1421

# Approve - method

2044

1422

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

2045

1423

def Approve(self, value):

2046

1424

self.approve(value)

2047

1425

2048

1426

# CheckedOK - method

2049

1427

@dbus.service.method(_interface)

2050

1428

def CheckedOK(self):

2051

1429

self.checked_ok()

2052

1430

2053

1431

# Enable - method

2054

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

2055

1432

@dbus.service.method(_interface)

2056

1433

def Enable(self):

2057

1434

"D-Bus method"

2058

1435

self.enable()

2059

1436

2060

1437

# StartChecker - method

2061

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

2062

1438

@dbus.service.method(_interface)

2063

1439

def StartChecker(self):

2064

1440

"D-Bus method"

2065

1441

self.start_checker()

2066

1442

2067

1443

# Disable - method

2068

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

2069

1444

@dbus.service.method(_interface)

2070

1445

def Disable(self):

2071

1446

"D-Bus method"

2072

1447

self.disable()

2073

1448

2074

1449

# StopChecker - method

2075

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

2076

1450

@dbus.service.method(_interface)

2077

1451

def StopChecker(self):

2078

1452

self.stop_checker()

2079

2080

# Properties

2081

1453

1454

## Properties

1455

2082

1456

# ApprovalPending - property

2083

1457

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

2084

1458

def ApprovalPending_dbus_property(self):

2085

1459

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

2086

1460

2087

1461

# ApprovedByDefault - property

2088

@dbus_service_property(_interface,

2089

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2090

1463

access="readwrite")

2091

1464

def ApprovedByDefault_dbus_property(self, value=None):

2092

1465

if value is None: # get

2093

1466

return dbus.Boolean(self.approved_by_default)

2094

1467

self.approved_by_default = bool(value)

2095

1468

2096

1469

# ApprovalDelay - property

2097

@dbus_service_property(_interface,

2098

signature="t",

1470

@dbus_service_property(_interface, signature="t",

2099

1471

access="readwrite")

2100

1472

def ApprovalDelay_dbus_property(self, value=None):

2101

1473

if value is None: # get

2102

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

2103

* 1000)

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2104

1475

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

2105

1476

2106

1477

# ApprovalDuration - property

2107

@dbus_service_property(_interface,

2108

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2109

1479

access="readwrite")

2110

1480

def ApprovalDuration_dbus_property(self, value=None):

2111

1481

if value is None: # get

2112

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

2113

* 1000)

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2114

1484

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

2115

1485

2116

1486

# Name - property

2117

@dbus_annotations(

2118

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

2119

1487

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

2120

1488

def Name_dbus_property(self):

2121

1489

return dbus.String(self.name)

2122

2123

# KeyID - property

2124

@dbus_annotations(

2125

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

2126

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

2127

def KeyID_dbus_property(self):

2128

return dbus.String(self.key_id)

2129

1490

2130

1491

# Fingerprint - property

2131

@dbus_annotations(

2132

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

2133

1492

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

2134

1493

def Fingerprint_dbus_property(self):

2135

1494

return dbus.String(self.fingerprint)

2136

1495

2137

1496

# Host - property

2138

@dbus_service_property(_interface,

2139

signature="s",

1497

@dbus_service_property(_interface, signature="s",

2140

1498

access="readwrite")

2141

1499

def Host_dbus_property(self, value=None):

2142

1500

if value is None: # get

2143

1501

return dbus.String(self.host)

2144

self.host = str(value)

2145

1502

self.host = unicode(value)

1503

2146

1504

# Created - property

2147

@dbus_annotations(

2148

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

2149

1505

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

2150

1506

def Created_dbus_property(self):

2151

1507

return datetime_to_dbus(self.created)

2152

1508

2153

1509

# LastEnabled - property

2154

1510

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

2155

1511

def LastEnabled_dbus_property(self):

2156

1512

return datetime_to_dbus(self.last_enabled)

2157

1513

2158

1514

# Enabled - property

2159

@dbus_service_property(_interface,

2160

signature="b",

1515

@dbus_service_property(_interface, signature="b",

2161

1516

access="readwrite")

2162

1517

def Enabled_dbus_property(self, value=None):

2163

1518

if value is None: # get

2166

1521

self.enable()

2167

1522

else:

2168

1523

self.disable()

2169

1524

2170

1525

# LastCheckedOK - property

2171

@dbus_service_property(_interface,

2172

signature="s",

1526

@dbus_service_property(_interface, signature="s",

2173

1527

access="readwrite")

2174

1528

def LastCheckedOK_dbus_property(self, value=None):

2175

1529

if value is not None:

2176

1530

self.checked_ok()

2177

1531

return

2178

1532

return datetime_to_dbus(self.last_checked_ok)

2179

1533

2180

1534

# LastCheckerStatus - property

2181

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

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2182

1537

def LastCheckerStatus_dbus_property(self):

2183

1538

return dbus.Int16(self.last_checker_status)

2184

1539

2185

1540

# Expires - property

2186

1541

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

2187

1542

def Expires_dbus_property(self):

2188

1543

return datetime_to_dbus(self.expires)

2189

1544

2190

1545

# LastApprovalRequest - property

2191

1546

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

2192

1547

def LastApprovalRequest_dbus_property(self):

2193

1548

return datetime_to_dbus(self.last_approval_request)

2194

1549

2195

1550

# Timeout - property

2196

@dbus_service_property(_interface,

2197

signature="t",

1551

@dbus_service_property(_interface, signature="t",

2198

1552

access="readwrite")

2199

1553

def Timeout_dbus_property(self, value=None):

2200

1554

if value is None: # get

2201

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

1555

return dbus.UInt64(self.timeout_milliseconds())

2202

1556

old_timeout = self.timeout

2203

1557

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

2204

1558

# Reschedule disabling

2212

1566

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

2213

1567

is None):

2214

1568

return

2215

GLib.source_remove(self.disable_initiator_tag)

2216

self.disable_initiator_tag = GLib.timeout_add(

2217

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

2218

self.disable)

2219

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2220

1575

# ExtendedTimeout - property

2221

@dbus_service_property(_interface,

2222

signature="t",

1576

@dbus_service_property(_interface, signature="t",

2223

1577

access="readwrite")

2224

1578

def ExtendedTimeout_dbus_property(self, value=None):

2225

1579

if value is None: # get

2226

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

2227

* 1000)

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2228

1581

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

2229

1582

2230

1583

# Interval - property

2231

@dbus_service_property(_interface,

2232

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2233

1585

access="readwrite")

2234

1586

def Interval_dbus_property(self, value=None):

2235

1587

if value is None: # get

2236

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

1588

return dbus.UInt64(self.interval_milliseconds())

2237

1589

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

2238

1590

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

2239

1591

return

2240

1592

if self.enabled:

2241

1593

# Reschedule checker run

2242

GLib.source_remove(self.checker_initiator_tag)

2243

self.checker_initiator_tag = GLib.timeout_add(

2244

value, self.start_checker)

2245

self.start_checker() # Start one now, too

2246

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2247

1599

# Checker - property

2248

@dbus_service_property(_interface,

2249

signature="s",

1600

@dbus_service_property(_interface, signature="s",

2250

1601

access="readwrite")

2251

1602

def Checker_dbus_property(self, value=None):

2252

1603

if value is None: # get

2253

1604

return dbus.String(self.checker_command)

2254

self.checker_command = str(value)

2255

1605

self.checker_command = unicode(value)

1606

2256

1607

# CheckerRunning - property

2257

@dbus_service_property(_interface,

2258

signature="b",

1608

@dbus_service_property(_interface, signature="b",

2259

1609

access="readwrite")

2260

1610

def CheckerRunning_dbus_property(self, value=None):

2261

1611

if value is None: # get

2264

1614

self.start_checker()

2265

1615

else:

2266

1616

self.stop_checker()

2267

1617

2268

1618

# ObjectPath - property

2269

@dbus_annotations(

2270

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

2271

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

2272

1619

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

2273

1620

def ObjectPath_dbus_property(self):

2274

return self.dbus_object_path # is already a dbus.ObjectPath

2275

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2276

1623

# Secret = property

2277

@dbus_annotations(

2278

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

2279

"invalidates"})

2280

@dbus_service_property(_interface,

2281

signature="ay",

2282

access="write",

2283

byte_arrays=True)

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2284

1626

def Secret_dbus_property(self, value):

2285

self.secret = bytes(value)

2286

1627

self.secret = str(value)

1628

2287

1629

del _interface

2288

1630

2289

1631

2290

class ProxyClient:

2291

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

1632

class ProxyClient(object):

1633

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

2292

1634

self._pipe = child_pipe

2293

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

1635

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

2294

1636

if not self._pipe.recv():

2295

raise KeyError(key_id or fpr)

2296

1637

raise KeyError()

1638

2297

1639

def __getattribute__(self, name):

2298

if name == "_pipe":

1640

if name == '_pipe':

2299

1641

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

2300

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

1642

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

2301

1643

data = self._pipe.recv()

2302

if data[0] == "data":

1644

if data[0] == 'data':

2303

1645

return data[1]

2304

if data[0] == "function":

2305

1646

if data[0] == 'function':

2306

1647

def func(*args, **kwargs):

2307

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

1648

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

2308

1649

return self._pipe.recv()[1]

2309

2310

1650

return func

2311

1651

2312

1652

def __setattr__(self, name, value):

2313

if name == "_pipe":

1653

if name == '_pipe':

2314

1654

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

2315

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

1655

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

2316

1656

2317

1657

2318

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

2319

1659

"""A class to handle client connections.

2320

1660

2321

1661

Instantiated once for each connection to handle it.

2322

1662

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

2323

1663

2324

1664

def handle(self):

2325

1665

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

2326

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

2327

str(self.client_address))

2328

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

2329

2330

session = gnutls.ClientSession(self.request)

2331

2332

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

2333

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

2334

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

2335

# "+DHE-DSS"))

1666

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

1667

unicode(self.client_address))

1668

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

1669

self.server.child_pipe.fileno())

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2336

1685

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

2337

1686

priority = self.server.gnutls_priority

2338

1687

if priority is None:

2339

1688

priority = "NORMAL"

2340

gnutls.priority_set_direct(session,

2341

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

2342

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2343

1693

# Start communication using the Mandos protocol

2344

1694

# Get protocol number

2345

1695

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

2346

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

1696

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

2347

1697

try:

2348

1698

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

2349

raise RuntimeError(line)

1699

raise RuntimeError

2350

1700

except (ValueError, IndexError, RuntimeError) as error:

2351

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

1701

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

2352

1702

return

2353

1703

2354

1704

# Start GnuTLS connection

2355

1705

try:

2356

1706

session.handshake()

2357

except gnutls.Error as error:

2358

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

1707

except gnutls.errors.GNUTLSError as error:

1708

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

2359

1709

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

2360

1710

# established. Just abandon the request.

2361

1711

return

2362

log.debug("Handshake succeeded")

2363

1712

logger.debug("Handshake succeeded")

1713

2364

1714

approval_required = False

2365

1715

try:

2366

if gnutls.has_rawpk:

2367

fpr = b""

2368

try:

2369

key_id = self.key_id(

2370

self.peer_certificate(session))

2371

except (TypeError, gnutls.Error) as error:

2372

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

2373

return

2374

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

2375

key_id.decode("utf-8",

2376

errors="replace"))

2377

2378

else:

2379

key_id = b""

2380

try:

2381

fpr = self.fingerprint(

2382

self.peer_certificate(session))

2383

except (TypeError, gnutls.Error) as error:

2384

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

2385

return

2386

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

2387

2388

try:

2389

client = ProxyClient(child_pipe, key_id, fpr,

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2390

1727

self.client_address)

2391

1728

except KeyError:

2392

1729

return

2393

1730

2394

1731

if client.approval_delay:

2395

1732

delay = client.approval_delay

2396

1733

client.approvals_pending += 1

2397

1734

approval_required = True

2398

1735

2399

1736

while True:

2400

1737

if not client.enabled:

2401

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

1738

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

1739

client.name)

2402

1740

if self.server.use_dbus:

2403

1741

# Emit D-Bus signal

2404

1742

client.Rejected("Disabled")

2405

1743

return

2406

1744

2407

1745

if client.approved or not client.approval_delay:

2408

# We are approved or approval is disabled

1746

#We are approved or approval is disabled

2409

1747

break

2410

1748

elif client.approved is None:

2411

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

2412

client.name)

1749

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

1750

client.name)

2413

1751

if self.server.use_dbus:

2414

1752

# Emit D-Bus signal

2415

1753

client.NeedApproval(

2416

client.approval_delay.total_seconds()

2417

* 1000, client.approved_by_default)

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2418

1756

else:

2419

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

2420

client.name)

1757

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

1758

client.name)

2421

1759

if self.server.use_dbus:

2422

1760

# Emit D-Bus signal

2423

1761

client.Rejected("Denied")

2424

1762

return

2425

2426

# wait until timeout or approved

1763

1764

#wait until timeout or approved

2427

1765

time = datetime.datetime.now()

2428

1766

client.changedstate.acquire()

2429

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

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2430

1770

client.changedstate.release()

2431

1771

time2 = datetime.datetime.now()

2432

1772

if (time2 - time) >= delay:

2433

1773

if not client.approved_by_default:

2434

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

2435

" waiting for approval",

2436

client.name)

1774

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

1775

" waiting for approval",

1776

client.name)

2437

1777

if self.server.use_dbus:

2438

1778

# Emit D-Bus signal

2439

1779

client.Rejected("Approval timed out")

2442

1782

break

2443

1783

else:

2444

1784

delay -= time2 - time

2445

2446

try:

2447

session.send(client.secret)

2448

except gnutls.Error as error:

2449

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

2450

return

2451

2452

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

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

1799

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

2453

1800

# bump the timeout using extended_timeout

2454

1801

client.bump_timeout(client.extended_timeout)

2455

1802

if self.server.use_dbus:

2456

1803

# Emit D-Bus signal

2457

1804

client.GotSecret()

2458

1805

2459

1806

finally:

2460

1807

if approval_required:

2461

1808

client.approvals_pending -= 1

2462

1809

try:

2463

1810

session.bye()

2464

except gnutls.Error as error:

2465

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

2466

1811

except gnutls.errors.GNUTLSError as error:

1812

logger.warning("GnuTLS bye failed",

1813

exc_info=error)

1814

2467

1815

@staticmethod

2468

1816

def peer_certificate(session):

2469

"Return the peer's certificate as a bytestring"

2470

try:

2471

cert_type = gnutls.certificate_type_get2(

2472

session, gnutls.CTYPE_PEERS)

2473

except AttributeError:

2474

cert_type = gnutls.certificate_type_get(session)

2475

if gnutls.has_rawpk:

2476

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2477

else:

2478

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2479

# If not a valid certificate type...

2480

if cert_type not in valid_cert_types:

2481

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

2482

valid_cert_types)

2483

# ...return invalid data

2484

return b""

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2485

1824

list_size = ctypes.c_uint(1)

2486

cert_list = (gnutls.certificate_get_peers

2487

(session, ctypes.byref(list_size)))

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

1827

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

2488

1828

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

2489

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

1829

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

1830

" certificate")

2490

1831

if list_size.value == 0:

2491

1832

return None

2492

1833

cert = cert_list[0]

2493

1834

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

2494

2495

@staticmethod

2496

def key_id(certificate):

2497

"Convert a certificate bytestring to a hexdigit key ID"

2498

# New GnuTLS "datum" with the public key

2499

datum = gnutls.datum_t(

2500

ctypes.cast(ctypes.c_char_p(certificate),

2501

ctypes.POINTER(ctypes.c_ubyte)),

2502

ctypes.c_uint(len(certificate)))

2503

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

2504

# New empty GnuTLS certificate

2505

pubkey = gnutls.pubkey_t()

2506

gnutls.pubkey_init(ctypes.byref(pubkey))

2507

# Import the raw public key into the certificate

2508

gnutls.pubkey_import(pubkey,

2509

ctypes.byref(datum),

2510

gnutls.X509_FMT_DER)

2511

# New buffer for the key ID

2512

buf = ctypes.create_string_buffer(32)

2513

buf_len = ctypes.c_size_t(len(buf))

2514

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

2515

gnutls.pubkey_get_key_id(

2516

pubkey,

2517

gnutls.KEYID_USE_SHA256,

2518

ctypes.cast(ctypes.byref(buf),

2519

ctypes.POINTER(ctypes.c_ubyte)),

2520

ctypes.byref(buf_len))

2521

# Deinit the certificate

2522

gnutls.pubkey_deinit(pubkey)

2523

2524

# Convert the buffer to a Python bytestring

2525

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

2526

# Convert the bytestring to hexadecimal notation

2527

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

2528

return hex_key_id

2529

1835

2530

1836

@staticmethod

2531

1837

def fingerprint(openpgp):

2532

1838

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2533

1839

# New GnuTLS "datum" with the OpenPGP public key

2534

datum = gnutls.datum_t(

2535

ctypes.cast(ctypes.c_char_p(openpgp),

2536

ctypes.POINTER(ctypes.c_ubyte)),

2537

ctypes.c_uint(len(openpgp)))

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2538

1845

# New empty GnuTLS certificate

2539

crt = gnutls.openpgp_crt_t()

2540

gnutls.openpgp_crt_init(ctypes.byref(crt))

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2541

1849

# Import the OpenPGP public key into the certificate

2542

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

2543

gnutls.OPENPGP_FMT_RAW)

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2544

1854

# Verify the self signature in the key

2545

1855

crtverify = ctypes.c_uint()

2546

gnutls.openpgp_crt_verify_self(crt, 0,

2547

ctypes.byref(crtverify))

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2548

1859

if crtverify.value != 0:

2549

gnutls.openpgp_crt_deinit(crt)

2550

raise gnutls.CertificateSecurityError(code

2551

=crtverify.value)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2552

1863

# New buffer for the fingerprint

2553

1864

buf = ctypes.create_string_buffer(20)

2554

1865

buf_len = ctypes.c_size_t()

2555

1866

# Get the fingerprint from the certificate into the buffer

2556

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

2557

ctypes.byref(buf_len))

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2558

1870

# Deinit the certificate

2559

gnutls.openpgp_crt_deinit(crt)

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2560

1872

# Convert the buffer to a Python bytestring

2561

1873

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

2562

1874

# Convert the bytestring to hexadecimal notation

2564

1876

return hex_fpr

2565

1877

2566

1878

2567

class MultiprocessingMixIn:

1879

class MultiprocessingMixIn(object):

2568

1880

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

2569

2570

1881

def sub_process_main(self, request, address):

2571

1882

try:

2572

1883

self.finish_request(request, address)

2573

1884

except Exception:

2574

1885

self.handle_error(request, address)

2575

1886

self.close_request(request)

2576

1887

2577

1888

def process_request(self, request, address):

2578

1889

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

2579

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

2580

args=(request, address))

1890

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

1891

args = (request, address))

2581

1892

proc.start()

2582

1893

return proc

2583

1894

2584

1895

2585

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2586

1897

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

2587

2588

1898

def process_request(self, request, client_address):

2589

1899

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

2590

1900

2591

1901

This function creates a new pipe in self.pipe

2592

1902

"""

2593

1903

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2594

1904

2595

1905

proc = MultiprocessingMixIn.process_request(self, request,

2596

1906

client_address)

2597

1907

self.child_pipe.close()

2598

1908

self.add_pipe(parent_pipe, proc)

2599

1909

2600

1910

def add_pipe(self, parent_pipe, proc):

2601

1911

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

2602

raise NotImplementedError()

1912

raise NotImplementedError

2603

1913

2604

1914

2605

1915

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2606

socketserver.TCPServer):

2607

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

2608

1916

socketserver.TCPServer, object):

1917

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

1918

2609

1919

Attributes:

2610

1920

enabled: Boolean; whether this server is activated yet

2611

1921

interface: None or a network interface name (string)

2612

1922

use_ipv6: Boolean; to use IPv6 or not

2613

1923

"""

2614

2615

1924

def __init__(self, server_address, RequestHandlerClass,

2616

interface=None,

2617

use_ipv6=True,

2618

socketfd=None):

1925

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

2619

1926

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

2620

1927

creating a new one with socket.socket().

2621

1928

"""

2627

1934

self.socketfd = socketfd

2628

1935

# Save the original socket.socket() function

2629

1936

self.socket_socket = socket.socket

2630

2631

1937

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

2632

#

1938

#

2633

1939

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

2634

1940

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

2635

1941

# patching socket.socket.)

2636

#

1942

#

2637

1943

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

2638

1944

@functools.wraps(socket.socket)

2639

1945

def socket_wrapper(*args, **kwargs):

2651

1957

# socket_wrapper(), if socketfd was set.

2652

1958

socketserver.TCPServer.__init__(self, server_address,

2653

1959

RequestHandlerClass)

2654

1960

2655

1961

def server_bind(self):

2656

1962

"""This overrides the normal server_bind() function

2657

1963

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

2658

1964

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

2659

global SO_BINDTODEVICE

2660

1965

if self.interface is not None:

2661

1966

if SO_BINDTODEVICE is None:

2662

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

2663

# common enough.

2664

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

2665

SO_BINDTODEVICE = 25

2666

try:

2667

self.socket.setsockopt(

2668

socket.SOL_SOCKET, SO_BINDTODEVICE,

2669

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

2670

except socket.error as error:

2671

if error.errno == errno.EPERM:

2672

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

2673

self.interface)

2674

elif error.errno == errno.ENOPROTOOPT:

2675

log.error("SO_BINDTODEVICE not available; cannot"

2676

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

2677

elif error.errno == errno.ENODEV:

2678

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

2679

" bind", self.interface)

2680

else:

2681

raise

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2682

1988

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

2683

1989

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

2684

if self.server_address[1]:

2685

self.allow_reuse_address = True

2686

1990

if not self.server_address[0]:

2687

1991

if self.address_family == socket.AF_INET6:

2688

any_address = "::" # in6addr_any

1992

any_address = "::" # in6addr_any

2689

1993

else:

2690

any_address = "0.0.0.0" # INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

2691

1995

self.server_address = (any_address,

2692

1996

self.server_address[1])

2693

1997

elif not self.server_address[1]:

2694

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

1998

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

1999

0)

2695

2000

# if self.interface:

2696

2001

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

2697

2002

# 0, # port

2703

2008

2704

2009

class MandosServer(IPv6_TCPServer):

2705

2010

"""Mandos server.

2706

2011

2707

2012

Attributes:

2708

2013

clients: set of Client objects

2709

2014

gnutls_priority GnuTLS priority string

2710

2015

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

2711

2712

Assumes a GLib.MainLoop event loop.

2016

2017

Assumes a gobject.MainLoop event loop.

2713

2018

"""

2714

2715

2019

def __init__(self, server_address, RequestHandlerClass,

2716

interface=None,

2717

use_ipv6=True,

2718

clients=None,

2719

gnutls_priority=None,

2720

use_dbus=True,

2721

socketfd=None):

2020

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

2021

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

2722

2022

self.enabled = False

2723

2023

self.clients = clients

2724

2024

if self.clients is None:

2727

2027

self.gnutls_priority = gnutls_priority

2728

2028

IPv6_TCPServer.__init__(self, server_address,

2729

2029

RequestHandlerClass,

2730

interface=interface,

2731

use_ipv6=use_ipv6,

2732

socketfd=socketfd)

2733

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2734

2033

def server_activate(self):

2735

2034

if self.enabled:

2736

2035

return socketserver.TCPServer.server_activate(self)

2737

2036

2738

2037

def enable(self):

2739

2038

self.enabled = True

2740

2039

2741

2040

def add_pipe(self, parent_pipe, proc):

2742

2041

# Call "handle_ipc" for both data and EOF events

2743

GLib.io_add_watch(

2744

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

2745

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

2746

functools.partial(self.handle_ipc,

2747

parent_pipe=parent_pipe,

2748

proc=proc))

2749

2750

def handle_ipc(self, source, condition,

2751

parent_pipe=None,

2752

proc=None,

2753

client_object=None):

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2754

2051

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

2755

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

2052

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

2756

2053

# Wait for other process to exit

2757

2054

proc.join()

2758

2055

return False

2759

2056

2760

2057

# Read a request from the child

2761

2058

request = parent_pipe.recv()

2762

2059

command = request[0]

2763

2764

if command == "init":

2765

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

2766

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

2767

address = request[3]

2768

2769

for c in self.clients.values():

2770

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2771

"27AE41E4649B934CA495991B7852B855"):

2772

continue

2773

if key_id and c.key_id == key_id:

2774

client = c

2775

break

2776

if fpr and c.fingerprint == fpr:

2060

2061

if command == 'init':

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2777

2067

client = c

2778

2068

break

2779

2069

else:

2780

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

2781

" %s", key_id or fpr, address)

2070

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

2071

"dress: %s", fpr, address)

2782

2072

if self.use_dbus:

2783

2073

# Emit D-Bus signal

2784

mandos_dbus_service.ClientNotFound(key_id or fpr,

2074

mandos_dbus_service.ClientNotFound(fpr,

2785

2075

address[0])

2786

2076

parent_pipe.send(False)

2787

2077

return False

2788

2789

GLib.io_add_watch(

2790

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

2791

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

2792

functools.partial(self.handle_ipc,

2793

parent_pipe=parent_pipe,

2794

proc=proc,

2795

client_object=client))

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2796

2087

parent_pipe.send(True)

2797

2088

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

2798

2089

# same fileno

2799

2090

return False

2800

if command == "funcall":

2091

if command == 'funcall':

2801

2092

funcname = request[1]

2802

2093

args = request[2]

2803

2094

kwargs = request[3]

2804

2805

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

2095

2096

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

2806

2097

funcname)(*args,

2807

**kwargs)))

2808

2809

if command == "getattr":

2098

**kwargs)))

2099

2100

if command == 'getattr':

2810

2101

attrname = request[1]

2811

if isinstance(client_object.__getattribute__(attrname),

2812

collections.abc.Callable):

2813

parent_pipe.send(("function", ))

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2814

2104

else:

2815

parent_pipe.send((

2816

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

2817

2818

if command == "setattr":

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2108

if command == 'setattr':

2819

2109

attrname = request[1]

2820

2110

value = request[2]

2821

2111

setattr(client_object, attrname, value)

2822

2112

2823

2113

return True

2824

2114

2825

2115

2826

2116

def rfc3339_duration_to_delta(duration):

2827

2117

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

2828

2829

>>> timedelta = datetime.timedelta

2830

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

2831

True

2832

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

2833

True

2834

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

2835

True

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

>>> del timedelta

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2845

2133

"""

2846

2134

2847

2135

# Parsing an RFC 3339 duration with regular expressions is not

2848

2136

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

2849

2137

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

2850

2138

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

2851

2139

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

2852

2140

# avoid excessive use of external libraries.

2853

2141

2854

2142

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

2855

Token = collections.namedtuple("Token", (

2856

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

2857

# a "group" containing digits

2858

"value", # datetime.timedelta or None

2859

"followers")) # Tokens valid after this token

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2860

2152

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

2861

2153

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

2862

2154

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

2863

2155

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

2864

2156

datetime.timedelta(seconds=1),

2865

frozenset((token_end, )))

2157

frozenset((token_end,)))

2866

2158

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

2867

2159

datetime.timedelta(minutes=1),

2868

2160

frozenset((token_second, token_end)))

2884

2176

frozenset((token_month, token_end)))

2885

2177

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

2886

2178

datetime.timedelta(weeks=1),

2887

frozenset((token_end, )))

2179

frozenset((token_end,)))

2888

2180

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

2889

2181

frozenset((token_year, token_month,

2890

2182

token_day, token_time,

2891

token_week)))

2892

# Define starting values:

2893

# Value so far

2894

value = datetime.timedelta()

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2895

2186

found_token = None

2896

# Following valid tokens

2897

followers = frozenset((token_duration, ))

2898

# String left to parse

2899

s = duration

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2900

2189

# Loop until end token is found

2901

2190

while found_token is not token_end:

2902

2191

# Search for any currently valid tokens

2918

2207

break

2919

2208

else:

2920

2209

# No currently valid tokens were found

2921

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

2922

.format(duration))

2210

raise ValueError("Invalid RFC 3339 duration")

2923

2211

# End token found

2924

2212

return value

2925

2213

2926

2214

2927

2215

def string_to_delta(interval):

2928

2216

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

2929

2930

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

2931

True

2932

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

2933

True

2934

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

2935

True

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2942

2230

"""

2943

2231

2944

2232

try:

2945

2233

return rfc3339_duration_to_delta(interval)

2946

2234

except ValueError:

2947

2235

pass

2948

2236

2949

2237

timevalue = datetime.timedelta(0)

2950

2238

for s in interval.split():

2951

2239

try:

2952

suffix = s[-1]

2240

suffix = unicode(s[-1])

2953

2241

value = int(s[:-1])

2954

2242

if suffix == "d":

2955

2243

delta = datetime.timedelta(value)

2962

2250

elif suffix == "w":

2963

2251

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

2964

2252

else:

2965

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

2966

except IndexError as e:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2967

2256

raise ValueError(*(e.args))

2968

2257

timevalue += delta

2969

2258

return timevalue

2970

2259

2971

2260

2972

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

2261

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

2973

2262

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

2974

2263

2975

2264

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

2976

2265

if os.fork():

2977

2266

sys.exit()

2985

2274

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

2986

2275

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

2987

2276

raise OSError(errno.ENODEV,

2988

"{} not a character device"

2277

"{0} not a character device"

2989

2278

.format(os.devnull))

2990

2279

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

2991

2280

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

2995

2284

2996

2285

2997

2286

def main():

2998

2287

2999

2288

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

3000

2289

# Parsing of options, both command line and config file

3001

2290

3002

2291

parser = argparse.ArgumentParser()

3003

2292

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

3004

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

2293

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

3005

2294

help="show version number and exit")

3006

2295

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

3007

2296

help="Bind to interface IF")

3040

2329

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

3041

2330

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

3042

2331

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

3043

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

3044

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

3045

default=None)

3046

2332

3047

2333

options = parser.parse_args()

3048

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

3049

2340

# Default values for config file for server-global settings

3050

if gnutls.has_rawpk:

3051

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

3052

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

3053

else:

3054

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

3055

":+SIGN-DSA-SHA256")

3056

server_defaults = {"interface": "",

3057

"address": "",

3058

"port": "",

3059

"debug": "False",

3060

"priority": priority,

3061

"servicename": "Mandos",

3062

"use_dbus": "True",

3063

"use_ipv6": "True",

3064

"debuglevel": "",

3065

"restore": "True",

3066

"socket": "",

3067

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

3068

"foreground": "False",

3069

"zeroconf": "True",

3070

}

3071

del priority

3072

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

3073

2357

# Parse config file for server-global settings

3074

server_config = configparser.ConfigParser(server_defaults)

2358

server_config = configparser.SafeConfigParser(server_defaults)

3075

2359

del server_defaults

3076

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

3077

# Convert the ConfigParser object to a dict

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3078

2363

server_settings = server_config.defaults()

3079

2364

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

3080

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

3081

"foreground", "zeroconf"):

2365

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

3082

2366

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

3083

2367

option)

3084

2368

if server_settings["port"]:

3094

2378

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

3095

2379

["socket"])

3096

2380

del server_config

3097

2381

3098

2382

# Override the settings from the config file with command line

3099

2383

# options, if set.

3100

2384

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

3101

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

3102

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

3103

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

2385

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

2386

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

2387

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

3104

2388

value = getattr(options, option)

3105

2389

if value is not None:

3106

2390

server_settings[option] = value

3107

2391

del options

3108

2392

# Force all strings to be unicode

3109

2393

for option in server_settings.keys():

3110

if isinstance(server_settings[option], bytes):

3111

server_settings[option] = (server_settings[option]

3112

.decode("utf-8"))

2394

if type(server_settings[option]) is str:

2395

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

3113

2396

# Force all boolean options to be boolean

3114

2397

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

3115

"foreground", "zeroconf"):

2398

"foreground"):

3116

2399

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

3117

2400

# Debug implies foreground

3118

2401

if server_settings["debug"]:

3119

2402

server_settings["foreground"] = True

3120

2403

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

3121

2404

3122

2405

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

3123

3124

if (not server_settings["zeroconf"]

3125

and not (server_settings["port"]

3126

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

3127

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

3128

2406

3129

2407

# For convenience

3130

2408

debug = server_settings["debug"]

3131

2409

debuglevel = server_settings["debuglevel"]

3134

2412

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

3135

2413

stored_state_file)

3136

2414

foreground = server_settings["foreground"]

3137

zeroconf = server_settings["zeroconf"]

3138

2415

3139

2416

if debug:

3140

2417

initlogger(debug, logging.DEBUG)

3141

2418

else:

3144

2421

else:

3145

2422

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

3146

2423

initlogger(debug, level)

3147

2424

3148

2425

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

3149

syslogger.setFormatter(

3150

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

3151

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

3152

server_settings["servicename"])))

3153

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3154

2432

# Parse config file with clients

3155

client_config = configparser.ConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3156

2435

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

3157

2436

"clients.conf"))

3158

2437

3159

2438

global mandos_dbus_service

3160

2439

mandos_dbus_service = None

3161

3162

socketfd = None

3163

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

3164

socketfd = server_settings["socket"]

3165

tcp_server = MandosServer(

3166

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

3167

ClientHandler,

3168

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

3169

use_ipv6=use_ipv6,

3170

gnutls_priority=server_settings["priority"],

3171

use_dbus=use_dbus,

3172

socketfd=socketfd)

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3173

2452

if not foreground:

3174

2453

pidfilename = "/run/mandos.pid"

3175

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

3176

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

3177

2454

pidfile = None

3178

2455

try:

3179

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

2456

pidfile = open(pidfilename, "w")

3180

2457

except IOError as e:

3181

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

3182

exc_info=e)

3183

3184

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

3185

("mandos", "mandos"),

3186

("nobody", "nogroup")):

2458

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

2459

exc_info=e)

2460

2461

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

3187

2462

try:

3188

2463

uid = pwd.getpwnam(name).pw_uid

3189

gid = pwd.getpwnam(group).pw_gid

2464

gid = pwd.getpwnam(name).pw_gid

3190

2465

break

3191

2466

except KeyError:

3192

2467

continue

3196

2471

try:

3197

2472

os.setgid(gid)

3198

2473

os.setuid(uid)

3199

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

3200

2474

except OSError as error:

3201

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

3202

os.strerror(error.errno))

3203

2475

if error.errno != errno.EPERM:

3204

raise

3205

2476

raise error

2477

3206

2478

if debug:

3207

2479

# Enable all possible GnuTLS debugging

3208

2480

3209

2481

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

3210

2482

# - GnuTLS manual

3211

gnutls.global_set_log_level(11)

3212

3213

@gnutls.log_func

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3214

2486

def debug_gnutls(level, string):

3215

log.debug("GnuTLS: %s",

3216

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

3217

3218

gnutls.global_set_log_function(debug_gnutls)

3219

2487

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3220

2492

# Redirect stdin so all checkers get /dev/null

3221

2493

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

3222

2494

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

3223

2495

if null > 2:

3224

2496

os.close(null)

3225

2497

3226

2498

# Need to fork before connecting to D-Bus

3227

2499

if not foreground:

3228

2500

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

3229

2501

daemon()

3230

3231

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

3232

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

3233

# need to inform GLib that threads will be used.

3234

GLib.threads_init()

3235

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3236

2507

global main_loop

3237

2508

# From the Avahi example code

3238

2509

DBusGMainLoop(set_as_default=True)

3239

main_loop = GLib.MainLoop()

2510

main_loop = gobject.MainLoop()

3240

2511

bus = dbus.SystemBus()

3241

2512

# End of Avahi example code

3242

2513

if use_dbus:

3243

2514

try:

3244

2515

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

3245

bus,

3246

do_not_queue=True)

3247

old_bus_name = dbus.service.BusName(

3248

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

3249

do_not_queue=True)

3250

except dbus.exceptions.DBusException as e:

3251

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

2521

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

3252

2522

use_dbus = False

3253

2523

server_settings["use_dbus"] = False

3254

2524

tcp_server.use_dbus = False

3255

if zeroconf:

3256

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3257

service = AvahiServiceToSyslog(

3258

name=server_settings["servicename"],

3259

servicetype="_mandos._tcp",

3260

protocol=protocol,

3261

bus=bus)

3262

if server_settings["interface"]:

3263

service.interface = if_nametoindex(

3264

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

3265

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3266

2534

global multiprocessing_manager

3267

2535

multiprocessing_manager = multiprocessing.Manager()

3268

2536

3269

2537

client_class = Client

3270

2538

if use_dbus:

3271

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

3272

2539

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

2540

3273

2541

client_settings = Client.config_parser(client_config)

3274

2542

old_client_settings = {}

3275

2543

clients_data = {}

3276

2544

3277

2545

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

3278

2546

global wnull

3279

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

2547

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

3280

2548

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

3281

2549

# mode

3282

2550

if debug or not foreground:

3283

2551

wnull.close()

3284

2552

3285

2553

# Get client data and settings from last running state.

3286

2554

if server_settings["restore"]:

3287

2555

try:

3288

2556

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

3289

if sys.version_info.major == 2:

3290

clients_data, old_client_settings = pickle.load(

3291

stored_state)

3292

else:

3293

bytes_clients_data, bytes_old_client_settings = (

3294

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

3295

# Fix bytes to strings

3296

# clients_data

3297

# .keys()

3298

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

3299

if isinstance(key, bytes)

3300

else key): value

3301

for key, value in

3302

bytes_clients_data.items()}

3303

del bytes_clients_data

3304

for key in clients_data:

3305

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

3306

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

3307

for k, v in

3308

clients_data[key].items()}

3309

clients_data[key] = value

3310

# .client_structure

3311

value["client_structure"] = [

3312

(s.decode("utf-8")

3313

if isinstance(s, bytes)

3314

else s) for s in

3315

value["client_structure"]]

3316

# .name, .host, and .checker_command

3317

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

3318

if isinstance(value[k], bytes):

3319

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

3320

if "key_id" not in value:

3321

value["key_id"] = ""

3322

elif "fingerprint" not in value:

3323

value["fingerprint"] = ""

3324

# old_client_settings

3325

# .keys()

3326

old_client_settings = {

3327

(key.decode("utf-8")

3328

if isinstance(key, bytes)

3329

else key): value

3330

for key, value in

3331

bytes_old_client_settings.items()}

3332

del bytes_old_client_settings

3333

# .host and .checker_command

3334

for value in old_client_settings.values():

3335

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

3336

if isinstance(value[attribute], bytes):

3337

value[attribute] = (value[attribute]

3338

.decode("utf-8"))

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3339

2559

os.remove(stored_state_path)

3340

2560

except IOError as e:

3341

2561

if e.errno == errno.ENOENT:

3342

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

3343

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

2562

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

2563

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

3344

2564

else:

3345

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

3346

exc_info=e)

2565

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

2566

exc_info=e)

3347

2567

raise

3348

2568

except EOFError as e:

3349

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

3350

exc_info=e)

3351

2569

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

2570

"EOFError:", exc_info=e)

2571

3352

2572

with PGPEngine() as pgp:

3353

for client_name, client in clients_data.items():

2573

for client_name, client in clients_data.iteritems():

3354

2574

# Skip removed clients

3355

2575

if client_name not in client_settings:

3356

2576

continue

3357

2577

3358

2578

# Decide which value to use after restoring saved state.

3359

2579

# We have three different values: Old config file,

3360

2580

# new config file, and saved state.

3365

2585

# For each value in new config, check if it

3366

2586

# differs from the old config value (Except for

3367

2587

# the "secret" attribute)

3368

if (name != "secret"

3369

and (value !=

3370

old_client_settings[client_name][name])):

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3371

2591

client[name] = value

3372

2592

except KeyError:

3373

2593

pass

3374

2594

3375

2595

# Clients who has passed its expire date can still be

3376

# enabled if its last checker was successful. A Client

2596

# enabled if its last checker was successful. Clients

3377

2597

# whose checker succeeded before we stored its state is

3378

2598

# assumed to have successfully run all checkers during

3379

2599

# downtime.

3380

2600

if client["enabled"]:

3381

2601

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

3382

2602

if not client["last_checked_ok"]:

3383

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

3384

" never performed a successful"

3385

" checker", client_name)

2603

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3386

2607

client["enabled"] = False

3387

2608

elif client["last_checker_status"] != 0:

3388

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

3389

" last checker failed with error"

3390

" code %s", client_name,

3391

client["last_checker_status"])

2609

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3392

2614

client["enabled"] = False

3393

2615

else:

3394

client["expires"] = (

3395

datetime.datetime.utcnow()

3396

+ client["timeout"])

3397

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

3398

" enabled", client_name)

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

2619

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3399

2622

try:

3400

client["secret"] = pgp.decrypt(

3401

client["encrypted_secret"],

3402

client_settings[client_name]["secret"])

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3403

2627

except PGPError:

3404

2628

# If decryption fails, we use secret from new settings

3405

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

3406

client_name)

3407

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

3408

["secret"])

3409

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3410

2634

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

3411

2635

for client_name in (set(old_client_settings)

3412

2636

- set(client_settings)):

3414

2638

for client_name in (set(client_settings)

3415

2639

- set(old_client_settings)):

3416

2640

clients_data[client_name] = client_settings[client_name]

3417

2641

3418

2642

# Create all client objects

3419

for client_name, client in clients_data.items():

2643

for client_name, client in clients_data.iteritems():

3420

2644

tcp_server.clients[client_name] = client_class(

3421

name=client_name,

3422

settings=client,

3423

server_settings=server_settings)

3424

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3425

2648

if not tcp_server.clients:

3426

log.warning("No clients defined")

3427

2649

logger.warning("No clients defined")

2650

3428

2651

if not foreground:

3429

2652

if pidfile is not None:

3430

pid = os.getpid()

3431

2653

try:

3432

2654

with pidfile:

3433

print(pid, file=pidfile)

2655

pid = os.getpid()

2656

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

3434

2657

except IOError:

3435

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

3436

pidfilename, pid)

2658

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

2659

pidfilename, pid)

3437

2660

del pidfile

3438

2661

del pidfilename

3439

3440

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

3441

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3442

lambda: main_loop.quit() and False)

3443

2662

2663

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

2664

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

2665

3444

2666

if use_dbus:

3445

3446

@alternate_dbus_interfaces(

3447

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

3448

class MandosDBusService(DBusObjectWithObjectManager):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3449

2670

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

3450

3451

2671

def __init__(self):

3452

2672

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

3453

3454

2673

_interface = "se.recompile.Mandos"

3455

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3456

2681

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

3457

2682

def ClientAdded(self, objpath):

3458

2683

"D-Bus signal"

3459

2684

pass

3460

2685

3461

2686

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

3462

def ClientNotFound(self, key_id, address):

2687

def ClientNotFound(self, fingerprint, address):

3463

2688

"D-Bus signal"

3464

2689

pass

3465

3466

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

3467

"true"})

2690

3468

2691

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

3469

2692

def ClientRemoved(self, objpath, name):

3470

2693

"D-Bus signal"

3471

2694

pass

3472

3473

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

3474

"true"})

2695

3475

2696

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

3476

2697

def GetAllClients(self):

3477

2698

"D-Bus method"

3478

return dbus.Array(c.dbus_object_path for c in

3479

tcp_server.clients.values())

3480

3481

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

3482

"true"})

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3483

2703

@dbus.service.method(_interface,

3484

2704

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

3485

2705

def GetAllClientsWithProperties(self):

3486

2706

"D-Bus method"

3487

2707

return dbus.Dictionary(

3488

{c.dbus_object_path: c.GetAll(

3489

"se.recompile.Mandos.Client")

3490

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

2708

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

2709

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

3491

2710

signature="oa{sv}")

3492

2711

3493

2712

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

3494

2713

def RemoveClient(self, object_path):

3495

2714

"D-Bus method"

3496

for c in tcp_server.clients.values():

2715

for c in tcp_server.clients.itervalues():

3497

2716

if c.dbus_object_path == object_path:

3498

2717

del tcp_server.clients[c.name]

3499

2718

c.remove_from_connection()

3500

# Don't signal the disabling

2719

# Don't signal anything except ClientRemoved

3501

2720

c.disable(quiet=True)

3502

# Emit D-Bus signal for removal

3503

self.client_removed_signal(c)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3504

2723

return

3505

2724

raise KeyError(object_path)

3506

2725

3507

2726

del _interface

3508

3509

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3510

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

3511

def GetManagedObjects(self):

3512

"""D-Bus method"""

3513

return dbus.Dictionary(

3514

{client.dbus_object_path:

3515

dbus.Dictionary(

3516

{interface: client.GetAll(interface)

3517

for interface in

3518

client._get_all_interface_names()})

3519

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

3520

3521

def client_added_signal(self, client):

3522

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

3523

if use_dbus:

3524

# New standard signal

3525

self.InterfacesAdded(

3526

client.dbus_object_path,

3527

dbus.Dictionary(

3528

{interface: client.GetAll(interface)

3529

for interface in

3530

client._get_all_interface_names()}))

3531

# Old signal

3532

self.ClientAdded(client.dbus_object_path)

3533

3534

def client_removed_signal(self, client):

3535

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

3536

if use_dbus:

3537

# New standard signal

3538

self.InterfacesRemoved(

3539

client.dbus_object_path,

3540

client._get_all_interface_names())

3541

# Old signal

3542

self.ClientRemoved(client.dbus_object_path,

3543

client.name)

3544

2727

3545

2728

mandos_dbus_service = MandosDBusService()

3546

3547

# Save modules to variables to exempt the modules from being

3548

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

3549

mp = multiprocessing

3550

wn = wnull

3551

2729

3552

2730

def cleanup():

3553

2731

"Cleanup function; run on exit"

3554

if zeroconf:

3555

service.cleanup()

3556

3557

mp.active_children()

3558

wn.close()

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3559

2736

if not (tcp_server.clients or client_settings):

3560

2737

return

3561

2738

3562

2739

# Store client before exiting. Secrets are encrypted with key

3563

2740

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

3564

2741

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

3565

2742

clients = {}

3566

2743

with PGPEngine() as pgp:

3567

for client in tcp_server.clients.values():

2744

for client in tcp_server.clients.itervalues():

3568

2745

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

3569

2746

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

3570

2747

key)

3571

2748

client_dict = {}

3572

2749

3573

2750

# A list of attributes that can not be pickled

3574

2751

# + secret.

3575

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

3576

"checker", "server_settings"}

3577

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

3578

.Object):

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3579

2756

exclude.add(name)

3580

2757

3581

2758

client_dict["encrypted_secret"] = (client

3582

2759

.encrypted_secret)

3583

2760

for attr in client.client_structure:

3584

2761

if attr not in exclude:

3585

2762

client_dict[attr] = getattr(client, attr)

3586

2763

3587

2764

clients[client.name] = client_dict

3588

2765

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

3589

2766

3590

2767

try:

3591

with tempfile.NamedTemporaryFile(

3592

mode="wb",

3593

suffix=".pickle",

3594

prefix="clients-",

3595

dir=os.path.dirname(stored_state_path),

3596

delete=False) as stored_state:

3597

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

3598

protocol=2)

3599

tempname = stored_state.name

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3600

2774

os.rename(tempname, stored_state_path)

3601

2775

except (IOError, OSError) as e:

3602

2776

if not debug:

3605

2779

except NameError:

3606

2780

pass

3607

2781

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

3608

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

3609

os.strerror(e.errno))

2782

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

2783

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

3610

2784

else:

3611

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

3612

exc_info=e)

3613

raise

3614

2785

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

2786

exc_info=e)

2787

raise e

2788

3615

2789

# Delete all clients, and settings from config

3616

2790

while tcp_server.clients:

3617

2791

name, client = tcp_server.clients.popitem()

3618

2792

if use_dbus:

3619

2793

client.remove_from_connection()

3620

# Don't signal the disabling

2794

# Don't signal anything except ClientRemoved

3621

2795

client.disable(quiet=True)

3622

# Emit D-Bus signal for removal

3623

2796

if use_dbus:

3624

mandos_dbus_service.client_removed_signal(client)

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3625

2801

client_settings.clear()

3626

2802

3627

2803

atexit.register(cleanup)

3628

3629

for client in tcp_server.clients.values():

2804

2805

for client in tcp_server.clients.itervalues():

3630

2806

if use_dbus:

3631

# Emit D-Bus signal for adding

3632

mandos_dbus_service.client_added_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3633

2809

# Need to initiate checking of clients

3634

2810

if client.enabled:

3635

client.init_checker(randomize_start=True)

3636

2811

client.init_checker()

2812

3637

2813

tcp_server.enable()

3638

2814

tcp_server.server_activate()

3639

2815

3640

2816

# Find out what port we got

3641

if zeroconf:

3642

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

2817

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

3643

2818

if use_ipv6:

3644

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

3645

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

2819

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

2820

" flowinfo %d, scope_id %d",

2821

*tcp_server.socket.getsockname())

3646

2822

else: # IPv4

3647

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

3648

*tcp_server.socket.getsockname())

3649

3650

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

3651

2823

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

2824

*tcp_server.socket.getsockname())

2825

2826

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

2827

3652

2828

try:

3653

if zeroconf:

3654

# From the Avahi example code

3655

try:

3656

service.activate()

3657

except dbus.exceptions.DBusException as error:

3658

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

3659

cleanup()

3660

sys.exit(1)

3661

# End of Avahi example code

3662

3663

GLib.io_add_watch(

3664

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

3665

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3666

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

3667

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

3668

3669

log.debug("Starting main loop")

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

2843

logger.debug("Starting main loop")

3670

2844

main_loop.run()

3671

2845

except AvahiError as error:

3672

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

2846

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

3673

2847

cleanup()

3674

2848

sys.exit(1)

3675

2849

except KeyboardInterrupt:

3676

2850

if debug:

3677

2851

print("", file=sys.stderr)

3678

log.debug("Server received KeyboardInterrupt")

3679

log.debug("Server exiting")

2852

logger.debug("Server received KeyboardInterrupt")

2853

logger.debug("Server exiting")

3680

2854

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

3681

2855

cleanup()

3682

2856

3683

3684

def parse_test_args():

3685

# type: () -> argparse.Namespace

3686

parser = argparse.ArgumentParser(add_help=False)

3687

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

3688

parser.add_argument("--prefix", )

3689

args, unknown_args = parser.parse_known_args()

3690

if args.check:

3691

# Remove test options from sys.argv

3692

sys.argv[1:] = unknown_args

3693

return args

3694

3695

# Add all tests from doctest strings

3696

def load_tests(loader, tests, none):

3697

import doctest

3698

tests.addTests(doctest.DocTestSuite())

3699

return tests

3700

3701

if __name__ == "__main__":

3702

options = parse_test_args()

3703

try:

3704

if options.check:

3705

extra_test_prefix = options.prefix

3706

if extra_test_prefix is not None:

3707

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

3708

.result.wasSuccessful()):

3709

sys.exit(1)

3710

class ExtraTestLoader(unittest.TestLoader):

3711

testMethodPrefix = extra_test_prefix

3712

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

3713

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

3714

else:

3715

unittest.main(argv=[""])

3716

else:

3717

main()

3718

finally:

3719

logging.shutdown()

3720

3721

# Local Variables:

3722

# run-tests:

3723

# (lambda (&optional extra)

3724

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

3725

# extra))

3726

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

3727

# (funcall remove-test-window)

3728

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

3729

# run-tests-in-test-buffer:

3730

# (lambda (dir &optional extra)

3731

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

3732

# (setq buffer-read-only nil

3733

# default-directory dir)

3734

# (erase-buffer)

3735

# (compilation-mode))

3736

# (let ((process-result

3737

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

3738

# (process-file-shell-command

3739

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

3740

# (and (numberp process-result)

3741

# (= process-result 0))))

3742

# get-command-line:

3743

# (lambda (&optional extra)

3744

# (let ((quoted-script

3745

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

3746

# (format

3747

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

3748

# quoted-script)))

3749

# get-script-name:

3750

# (lambda ()

3751

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

3752

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

3753

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

3754

# (buffer-file-name))))

3755

# remove-test-window:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (lambda ()

3761

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

3762

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

3763

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

3764

# (display-buffer-overriding-action

3765

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

3766

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

3767

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

3768

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

3769

# eval:

3770

# (progn

3771

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

3772

# (funcall run-tests t)))

3773

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

3774

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

3775

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

3776

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

3777

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

3778

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

3779

# End:

2857

if __name__ == '__main__':

2858

main()