/mandos/release : revision 237.7.190

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

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.

265

179

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

266

180

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

267

181

return encoded

268

182

269

183

def encrypt(self, data, password):

270

184

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

273

187

passfile.write(passphrase)

274

188

passfile.flush()

275

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

276

"--passphrase-file",

189

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

190

'--passphrase-file',

277

191

passfile.name]

278

192

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

283

197

if proc.returncode != 0:

284

198

raise PGPError(err)

285

199

return ciphertext

286

200

287

201

def decrypt(self, data, password):

288

202

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

291

205

passfile.write(passphrase)

292

206

passfile.flush()

293

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

294

"--passphrase-file",

207

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

208

'--passphrase-file',

295

209

passfile.name]

296

210

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

301

216

if proc.returncode != 0:

302

217

raise PGPError(err)

303

218

return decrypted_plaintext

304

219

305

220

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

221

class AvahiError(Exception):

333

222

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

334

223

self.value = value

335

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

336

**kwargs)

337

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

338

227

339

228

class AvahiServiceError(AvahiError):

340

229

pass

341

230

342

343

231

class AvahiGroupError(AvahiError):

344

232

pass

345

233

346

234

347

class AvahiService:

235

class AvahiService(object):

348

236

"""An Avahi (Zeroconf) service.

349

237

350

238

Attributes:

351

239

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

352

240

Used to optionally bind to the specified interface.

353

354

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

241

242

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

355

243

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

356

244

port: integer; what port to announce

357

245

TXT: list of strings; TXT record for the service

364

252

server: D-Bus Server

365

253

bus: dbus.SystemBus()

366

254

"""

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

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

379

260

self.interface = interface

380

261

self.name = name

381

262

self.type = servicetype

390

271

self.server = None

391

272

self.bus = bus

392

273

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

274

275

def rename(self):

395

276

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

396

277

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)

278

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

279

" after %i retries, exiting.",

280

self.rename_count)

400

281

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

284

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

285

self.name)

286

self.remove()

287

try:

288

self.add()

289

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

403

293

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

294

420

295

def remove(self):

421

296

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

422

297

if self.entry_group_state_changed_match is not None:

424

299

self.entry_group_state_changed_match = None

425

300

if self.group is not None:

426

301

self.group.Reset()

427

302

428

303

def add(self):

429

304

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

430

305

self.remove()

435

310

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

311

self.entry_group_state_changed_match = (

437

312

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)

313

'StateChanged', self.entry_group_state_changed))

314

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

315

self.name, self.type)

441

316

self.group.AddService(

442

317

self.interface,

443

318

self.protocol,

447

322

dbus.UInt16(self.port),

448

323

avahi.string_array_to_txt_array(self.TXT))

449

324

self.group.Commit()

450

325

451

326

def entry_group_state_changed(self, state, error):

452

327

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

453

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

454

328

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

329

455

330

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

331

logger.debug("Zeroconf service established.")

457

332

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

333

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

459

334

self.rename()

460

335

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

336

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

337

unicode(error))

338

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

339

.format(error))

340

465

341

def cleanup(self):

466

342

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

467

343

if self.group is not None:

472

348

pass

473

349

self.group = None

474

350

self.remove()

475

351

476

352

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

477

353

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

}

354

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

485

362

if state in bad_states:

486

363

if bad_states[state] is not None:

487

364

if error is None:

488

log.error(bad_states[state])

365

logger.error(bad_states[state])

489

366

else:

490

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

367

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

491

368

self.cleanup()

492

369

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)

370

self.add()

504

371

else:

505

372

if error is None:

506

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

373

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

507

374

else:

508

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

509

375

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

376

510

377

def activate(self):

511

378

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

512

379

if self.server is None:

516

383

follow_name_owner_changes=True),

517

384

avahi.DBUS_INTERFACE_SERVER)

518

385

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

386

self.server_state_changed)

520

387

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

521

388

522

389

523

390

class AvahiServiceToSyslog(AvahiService):

524

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

391

def rename(self):

525

392

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

531

398

return ret

532

399

533

400

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:

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

406

407

408

class Client(object):

875

409

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

876

410

877

411

Attributes:

878

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

412

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

879

413

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

880

414

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

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

885

419

checker_command: string; External command which is run to check

886

420

if client lives. %() expansions are done at

887

421

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

888

422

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

889

checker_initiator_tag: a GLib event source tag, or None

423

checker_initiator_tag: a gobject event source tag, or None

890

424

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

891

425

client_structure: Object describing what attributes a client has

892

426

and is used for storing the client at exit

893

427

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

428

disable_initiator_tag: a gobject event source tag, or None

895

429

enabled: bool()

896

430

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

431

uniquely identify the client

900

432

host: string; available for use by the checker command

901

433

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

902

434

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

904

436

last_checker_status: integer between 0 and 255 reflecting exit

905

437

status of last checker. -1 reflects crashed

906

438

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

439

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

910

440

911

441

D-Bus identifiers

918

448

disabled, or None

919

449

server_settings: The server_settings dict from main()

920

450

"""

921

451

922

452

runtime_expansions = ("approval_delay", "approval_duration",

923

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

453

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

924

454

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

925

455

"last_approval_request", "last_checked_ok",

926

456

"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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

939

483

@staticmethod

940

484

def config_parser(config):

941

485

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

948

492

for client_name in config.sections():

949

493

section = dict(config.items(client_name))

950

494

client = settings[client_name] = {}

951

495

952

496

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

953

497

# Reformat values from string types to Python types

954

498

client["approved_by_default"] = config.getboolean(

955

499

client_name, "approved_by_default")

956

500

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

957

501

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

964

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

965

"").upper()

502

503

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

966

504

.replace(" ", ""))

967

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

968

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

969

" fingerprint", client_name)

970

del settings[client_name]

971

continue

972

505

if "secret" in section:

973

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

974

.encode("utf-8"),

975

"base64")

506

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

976

507

elif "secfile" in section:

977

508

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

978

509

(section["secfile"])),

979

510

"rb") as secfile:

980

511

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

981

512

else:

982

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

513

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

983

514

.format(section))

984

515

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

985

516

client["extended_timeout"] = string_to_delta(

993

524

client["last_approval_request"] = None

994

525

client["last_checked_ok"] = None

995

526

client["last_checker_status"] = -2

996

527

997

528

return settings

998

999

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

529

530

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

1000

531

self.name = name

1001

532

if server_settings is None:

1002

533

server_settings = {}

1003

534

self.server_settings = server_settings

1004

535

# adding all client settings

1005

for setting, value in settings.items():

536

for setting, value in settings.iteritems():

1006

537

setattr(self, setting, value)

1007

538

1008

539

if self.enabled:

1009

540

if not hasattr(self, "last_enabled"):

1010

541

self.last_enabled = datetime.datetime.utcnow()

1014

545

else:

1015

546

self.last_enabled = None

1016

547

self.expires = None

1017

1018

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

1019

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

1020

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

548

549

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

553

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

1021

554

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

1022

555

datetime.datetime.utcnow())

1023

556

1024

557

# attributes specific for this server instance

1025

558

self.checker = None

1026

559

self.checker_initiator_tag = None

1029

562

self.current_checker_command = None

1030

563

self.approved = None

1031

564

self.approvals_pending = 0

1032

self.changedstate = multiprocessing_manager.Condition(

1033

multiprocessing_manager.Lock())

1034

self.client_structure = [attr

1035

for attr in self.__dict__.keys()

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

1036

570

if not attr.startswith("_")]

1037

571

self.client_structure.append("client_structure")

1038

1039

for name, t in inspect.getmembers(

1040

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

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

1041

577

if not name.startswith("_"):

1042

578

self.client_structure.append(name)

1043

579

1044

580

# Send notice to process children that client state has changed

1045

581

def send_changedstate(self):

1046

582

with self.changedstate:

1047

583

self.changedstate.notify_all()

1048

584

1049

585

def enable(self):

1050

586

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

1051

587

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

1052

588

# Already enabled

1053

589

return

590

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

1054

591

self.enabled = True

1055

592

self.last_enabled = datetime.datetime.utcnow()

1056

593

self.init_checker()

1057

594

self.send_changedstate()

1058

595

1059

596

def disable(self, quiet=True):

1060

597

"""Disable this client."""

1061

598

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

1062

599

return False

1063

600

if not quiet:

1064

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

601

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

1065

602

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

1066

GLib.source_remove(self.disable_initiator_tag)

603

gobject.source_remove(self.disable_initiator_tag)

1067

604

self.disable_initiator_tag = None

1068

605

self.expires = None

1069

606

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

1070

GLib.source_remove(self.checker_initiator_tag)

607

gobject.source_remove(self.checker_initiator_tag)

1071

608

self.checker_initiator_tag = None

1072

609

self.stop_checker()

1073

610

self.enabled = False

1074

611

if not quiet:

1075

612

self.send_changedstate()

1076

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

613

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

1077

614

return False

1078

615

1079

616

def __del__(self):

1080

617

self.disable()

1081

1082

def init_checker(self, randomize_start=False):

1083

# Schedule a new checker to be started a randomly selected

1084

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

1085

# the startup of checkers over time when the server is

1086

# started.

618

619

def init_checker(self):

620

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

621

# and every interval from then on.

1087

622

if self.checker_initiator_tag is not None:

1088

GLib.source_remove(self.checker_initiator_tag)

1089

interval_milliseconds = int(self.interval.total_seconds()

1090

* 1000)

1091

if randomize_start:

1092

delay_milliseconds = random.randrange(

1093

interval_milliseconds + 1)

1094

else:

1095

delay_milliseconds = interval_milliseconds

1096

self.checker_initiator_tag = GLib.timeout_add(

1097

delay_milliseconds, self.start_checker, randomize_start)

1098

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

1099

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

1100

# expire at the soonest one interval after a checker was

1101

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

1102

# time might have to be extended.

1103

now = datetime.datetime.utcnow()

1104

self.expires = now + delay + self.interval

1105

# Schedule a disable() at expire time

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

627

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

1106

628

if self.disable_initiator_tag is not None:

1107

GLib.source_remove(self.disable_initiator_tag)

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

1110

self.disable)

1111

1112

def checker_callback(self, source, condition, connection,

1113

command):

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

633

# Also start a new checker *right now*.

634

self.start_checker()

635

636

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

1114

637

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

1115

# Read return code from connection (see call_pipe)

1116

returncode = connection.recv()

1117

connection.close()

1118

if self.checker is not None:

1119

self.checker.join()

1120

638

self.checker_callback_tag = None

1121

639

self.checker = None

1122

1123

if returncode >= 0:

1124

self.last_checker_status = returncode

1125

self.last_checker_signal = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1126

642

if self.last_checker_status == 0:

1127

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

643

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

644

vars(self))

1128

645

self.checked_ok()

1129

646

else:

1130

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

647

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

648

vars(self))

1131

649

else:

1132

650

self.last_checker_status = -1

1133

self.last_checker_signal = -returncode

1134

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

1135

return False

1136

651

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

652

vars(self))

653

1137

654

def checked_ok(self):

1138

655

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

1139

656

self.last_checked_ok = datetime.datetime.utcnow()

1140

657

self.last_checker_status = 0

1141

self.last_checker_signal = None

1142

658

self.bump_timeout()

1143

659

1144

660

def bump_timeout(self, timeout=None):

1145

661

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

1146

662

if timeout is None:

1147

663

timeout = self.timeout

1148

664

if self.disable_initiator_tag is not None:

1149

GLib.source_remove(self.disable_initiator_tag)

665

gobject.source_remove(self.disable_initiator_tag)

1150

666

self.disable_initiator_tag = None

1151

667

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

1152

self.disable_initiator_tag = GLib.timeout_add(

1153

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1154

671

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

1155

672

1156

673

def need_approval(self):

1157

674

self.last_approval_request = datetime.datetime.utcnow()

1158

1159

def start_checker(self, start_was_randomized=False):

675

676

def start_checker(self):

1160

677

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

1161

678

1162

679

If a checker already exists, leave it running and do

1163

680

nothing."""

1164

681

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

1169

686

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

1170

687

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

1171

688

# should be.

1172

1173

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

1174

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

1175

self.checker.join()

1176

self.checker = None

689

690

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

691

try:

692

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

1177

704

# Start a new checker if needed

1178

705

if self.checker is None:

1179

706

# Escape attributes for the shell

1180

escaped_attrs = {

1181

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

1182

for attr in self.runtime_expansions}

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

1183

711

try:

1184

712

command = self.checker_command % escaped_attrs

1185

713

except TypeError as error:

1186

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

1187

self.checker_command, exc_info=error)

1188

return True # Try again later

714

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

1189

717

self.current_checker_command = command

1190

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

1191

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

1192

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

1193

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

1194

# always replaced by /dev/null.)

1195

# The exception is when not debugging but nevertheless

1196

# running in the foreground; use the previously

1197

# created wnull.

1198

popen_args = {"close_fds": True,

1199

"shell": True,

1200

"cwd": "/"}

1201

if (not self.server_settings["debug"]

1202

and self.server_settings["foreground"]):

1203

popen_args.update({"stdout": wnull,

1204

"stderr": wnull})

1205

pipe = multiprocessing.Pipe(duplex=False)

1206

self.checker = multiprocessing.Process(

1207

target=call_pipe,

1208

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

1209

kwargs=popen_args)

1210

self.checker.start()

1211

self.checker_callback_tag = GLib.io_add_watch(

1212

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

1213

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1214

self.checker_callback, pipe[0], command)

1215

if start_was_randomized:

1216

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

1217

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

1218

# interval from then on.

1219

now = datetime.datetime.utcnow()

1220

self.checker_initiator_tag = GLib.timeout_add(

1221

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

1222

self.start_checker)

1223

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

1224

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

1225

return False

1226

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

718

try:

719

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

720

command, self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

759

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

1227

760

return True

1228

761

1229

762

def stop_checker(self):

1230

763

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

1231

764

if self.checker_callback_tag:

1232

GLib.source_remove(self.checker_callback_tag)

765

gobject.source_remove(self.checker_callback_tag)

1233

766

self.checker_callback_tag = None

1234

767

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

1235

768

return

1236

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

1237

self.checker.terminate()

769

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

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

1238

778

self.checker = None

1239

779

1240

780

1241

def dbus_service_property(dbus_interface,

1242

signature="v",

1243

access="readwrite",

1244

byte_arrays=False):

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1245

783

"""Decorators for marking methods of a DBusObjectWithProperties to

1246

784

become properties on the D-Bus.

1247

785

1248

786

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

1249

787

and with one argument by "Set".

1250

788

1251

789

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

1252

790

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

1253

791

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

1256

794

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

1257

795

if byte_arrays and signature != "ay":

1258

796

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

1259

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

1260

797

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

1261

798

def decorator(func):

1262

799

func._dbus_is_property = True

1263

800

func._dbus_interface = dbus_interface

1266

803

func._dbus_name = func.__name__

1267

804

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

1268

805

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

1269

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1270

807

return func

1271

1272

808

return decorator

1273

809

1274

810

1275

811

def dbus_interface_annotations(dbus_interface):

1276

812

"""Decorator for marking functions returning interface annotations

1277

813

1278

814

Usage:

1279

815

1280

816

@dbus_interface_annotations("org.example.Interface")

1281

817

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

1282

818

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

1283

819

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

1284

820

"false"}

1285

821

"""

1286

1287

822

def decorator(func):

1288

823

func._dbus_is_interface = True

1289

824

func._dbus_interface = dbus_interface

1290

825

func._dbus_name = dbus_interface

1291

826

return func

1292

1293

827

return decorator

1294

828

1295

829

1296

830

def dbus_annotations(annotations):

1297

831

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

1298

832

Usage:

1299

1300

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

1301

"org.freedesktop.DBus.Property."

1302

"EmitsChangedSignal": "false"})

833

1303

834

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

1304

835

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

1305

839

def Property_dbus_property(self):

1306

840

return dbus.Boolean(False)

1307

1308

See also the DBusObjectWithAnnotations class.

1309

841

"""

1310

1311

842

def decorator(func):

1312

843

func._dbus_annotations = annotations

1313

844

return func

1314

1315

845

return decorator

1316

846

1317

847

1318

848

class DBusPropertyException(dbus.exceptions.DBusException):

1319

849

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

1320

850

"""

1321

pass

851

def __unicode__(self):

852

return unicode(str(self))

1322

853

1323

854

1324

855

class DBusPropertyAccessException(DBusPropertyException):

1333

864

pass

1334

865

1335

866

1336

class DBusObjectWithAnnotations(dbus.service.Object):

1337

"""A D-Bus object with annotations.

1338

1339

Classes inheriting from this can use the dbus_annotations

1340

decorator to add annotations to methods or signals.

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

869

870

Classes inheriting from this can use the dbus_service_property

871

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

872

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

1341

873

"""

1342

874

1343

875

@staticmethod

1344

876

def _is_dbus_thing(thing):

1345

877

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

1346

878

1347

879

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

1348

880

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

1349

881

"""

1350

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

882

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

1351

883

False)

1352

884

1353

885

def _get_all_dbus_things(self, thing):

1354

886

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

1355

887

"""

1356

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

888

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

889

name),

1357

890

athing.__get__(self))

1358

891

for cls in self.__class__.__mro__

1359

892

for name, athing in

1360

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

1361

1362

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1363

out_signature="s",

1364

path_keyword="object_path",

1365

connection_keyword="connection")

1366

def Introspect(self, object_path, connection):

1367

"""Overloading of standard D-Bus method.

1368

1369

Inserts annotation tags on methods and signals.

1370

"""

1371

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

1372

connection)

1373

try:

1374

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

1375

1376

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

1377

# Add annotation tags

1378

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

1379

for tag in if_tag.getElementsByTagName(typ):

1380

annots = dict()

1381

for name, prop in (self.

1382

_get_all_dbus_things(typ)):

1383

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

1384

and prop._dbus_interface

1385

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

1386

annots.update(getattr(

1387

prop, "_dbus_annotations", {}))

1388

for name, value in annots.items():

1389

ann_tag = document.createElement(

1390

"annotation")

1391

ann_tag.setAttribute("name", name)

1392

ann_tag.setAttribute("value", value)

1393

tag.appendChild(ann_tag)

1394

# Add interface annotation tags

1395

for annotation, value in dict(

1396

itertools.chain.from_iterable(

1397

annotations().items()

1398

for name, annotations

1399

in self._get_all_dbus_things("interface")

1400

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

1401

)).items():

1402

ann_tag = document.createElement("annotation")

1403

ann_tag.setAttribute("name", annotation)

1404

ann_tag.setAttribute("value", value)

1405

if_tag.appendChild(ann_tag)

1406

# Fix argument name for the Introspect method itself

1407

if (if_tag.getAttribute("name")

1408

== dbus.INTROSPECTABLE_IFACE):

1409

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

1410

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

1411

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

1412

if (arg.getAttribute("direction")

1413

== "out"):

1414

arg.setAttribute("name",

1415

"xml_data")

1416

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

1417

document.unlink()

1418

except (AttributeError, xml.dom.DOMException,

1419

xml.parsers.expat.ExpatError) as error:

1420

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

1421

exc_info=error)

1422

return xmlstring

1423

1424

1425

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1426

"""A D-Bus object with properties.

1427

1428

Classes inheriting from this can use the dbus_service_property

1429

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

1430

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

1431

"""

1432

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

1433

896

def _get_dbus_property(self, interface_name, property_name):

1434

897

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

1435

898

property with the specified name and interface.

1436

899

"""

1437

for cls in self.__class__.__mro__:

1438

for name, value in inspect.getmembers(

1439

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

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

1440

904

if (value._dbus_name == property_name

1441

905

and value._dbus_interface == interface_name):

1442

906

return value.__get__(self)

1443

907

1444

908

# No such property

1445

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

1446

self.dbus_object_path, interface_name, property_name))

1447

1448

@classmethod

1449

def _get_all_interface_names(cls):

1450

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

1451

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

1452

"_dbus_interface", None)

1453

for x in (inspect.getmro(cls))

1454

for attr in dir(x))

1455

if name is not None)

1456

1457

@dbus.service.method(dbus.PROPERTIES_IFACE,

1458

in_signature="ss",

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

912

913

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

1459

914

out_signature="v")

1460

915

def Get(self, interface_name, property_name):

1461

916

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

1467

922

if not hasattr(value, "variant_level"):

1468

923

return value

1469

924

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

1470

925

1471

926

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

1472

927

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

1473

928

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

1479

934

# The byte_arrays option is not supported yet on

1480

935

# signatures other than "ay".

1481

936

if prop._dbus_signature != "ay":

1482

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

1483

"'ay' signature {!r}"

1484

.format(prop._dbus_signature))

1485

value = dbus.ByteArray(bytes(value))

937

raise ValueError

938

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

939

for byte in value))

1486

940

prop(value)

1487

1488

@dbus.service.method(dbus.PROPERTIES_IFACE,

1489

in_signature="s",

941

942

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

1490

943

out_signature="a{sv}")

1491

944

def GetAll(self, interface_name):

1492

945

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

1493

946

standard.

1494

947

1495

948

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

1496

949

"""

1497

950

properties = {}

1507

960

if not hasattr(value, "variant_level"):

1508

961

properties[name] = value

1509

962

continue

1510

properties[name] = type(value)(

1511

value, variant_level=value.variant_level + 1)

963

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

964

value.variant_level+1)

1512

965

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

1513

1514

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

1515

def PropertiesChanged(self, interface_name, changed_properties,

1516

invalidated_properties):

1517

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

1518

standard.

1519

"""

1520

pass

1521

966

1522

967

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1523

968

out_signature="s",

1524

path_keyword="object_path",

1525

connection_keyword="connection")

969

path_keyword='object_path',

970

connection_keyword='connection')

1526

971

def Introspect(self, object_path, connection):

1527

972

"""Overloading of standard D-Bus method.

1528

973

1529

974

Inserts property tags and interface annotation tags.

1530

975

"""

1531

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1532

object_path,

1533

connection)

976

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

977

connection)

1534

978

try:

1535

979

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

1536

1537

980

def make_tag(document, name, prop):

1538

981

e = document.createElement("property")

1539

982

e.setAttribute("name", name)

1540

983

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

1541

984

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

1542

985

return e

1543

1544

986

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

1545

987

# Add property tags

1546

988

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

1549

991

if prop._dbus_interface

1550

992

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

1551

993

if_tag.appendChild(tag)

1552

# Add annotation tags for properties

1553

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

1554

annots = dict()

1555

for name, prop in self._get_all_dbus_things(

1556

"property"):

1557

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

1558

and prop._dbus_interface

1559

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

1560

annots.update(getattr(

1561

prop, "_dbus_annotations", {}))

1562

for name, value in annots.items():

1563

ann_tag = document.createElement(

1564

"annotation")

1565

ann_tag.setAttribute("name", name)

1566

ann_tag.setAttribute("value", value)

1567

tag.appendChild(ann_tag)

994

# Add annotation tags

995

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

996

for tag in if_tag.getElementsByTagName(typ):

997

annots = dict()

998

for name, prop in (self.

999

_get_all_dbus_things(typ)):

1000

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

1001

and prop._dbus_interface

1002

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

1003

annots.update(getattr

1004

(prop,

1005

"_dbus_annotations",

1006

{}))

1007

for name, value in annots.iteritems():

1008

ann_tag = document.createElement(

1009

"annotation")

1010

ann_tag.setAttribute("name", name)

1011

ann_tag.setAttribute("value", value)

1012

tag.appendChild(ann_tag)

1013

# Add interface annotation tags

1014

for annotation, value in dict(

1015

itertools.chain.from_iterable(

1016

annotations().iteritems()

1017

for name, annotations in

1018

self._get_all_dbus_things("interface")

1019

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

1020

)).iteritems():

1021

ann_tag = document.createElement("annotation")

1022

ann_tag.setAttribute("name", annotation)

1023

ann_tag.setAttribute("value", value)

1024

if_tag.appendChild(ann_tag)

1568

1025

# Add the names to the return values for the

1569

1026

# "org.freedesktop.DBus.Properties" methods

1570

1027

if (if_tag.getAttribute("name")

1584

1041

document.unlink()

1585

1042

except (AttributeError, xml.dom.DOMException,

1586

1043

xml.parsers.expat.ExpatError) as error:

1587

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

1588

exc_info=error)

1589

return xmlstring

1590

1591

1592

try:

1593

dbus.OBJECT_MANAGER_IFACE

1594

except AttributeError:

1595

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

1596

1597

1598

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1599

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

1600

1601

Classes inheriting from this exposes the standard

1602

GetManagedObjects call and the InterfacesAdded and

1603

InterfacesRemoved signals on the standard

1604

"org.freedesktop.DBus.ObjectManager" interface.

1605

1606

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

1607

manually.

1608

"""

1609

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def GetManagedObjects(self):

1612

"""This function must be overridden"""

1613

raise NotImplementedError()

1614

1615

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1616

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

1617

def InterfacesAdded(self, object_path, interfaces_and_properties):

1618

pass

1619

1620

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

1621

def InterfacesRemoved(self, object_path, interfaces):

1622

pass

1623

1624

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1625

out_signature="s",

1626

path_keyword="object_path",

1627

connection_keyword="connection")

1628

def Introspect(self, object_path, connection):

1629

"""Overloading of standard D-Bus method.

1630

1631

Override return argument name of GetManagedObjects to be

1632

"objpath_interfaces_and_properties"

1633

"""

1634

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1635

object_path,

1636

connection)

1637

try:

1638

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

1639

1640

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

1641

# Fix argument name for the GetManagedObjects method

1642

if (if_tag.getAttribute("name")

1643

== dbus.OBJECT_MANAGER_IFACE):

1644

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

1645

if (cn.getAttribute("name")

1646

== "GetManagedObjects"):

1647

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

1648

if (arg.getAttribute("direction")

1649

== "out"):

1650

arg.setAttribute(

1651

"name",

1652

"objpath_interfaces"

1653

"_and_properties")

1654

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

1655

document.unlink()

1656

except (AttributeError, xml.dom.DOMException,

1657

xml.parsers.expat.ExpatError) as error:

1658

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

1659

exc_info=error)

1044

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

1045

exc_info=error)

1660

1046

return xmlstring

1661

1047

1662

1048

1663

1049

def datetime_to_dbus(dt, variant_level=0):

1664

1050

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

1665

1051

if dt is None:

1666

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

1667

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

1052

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

1053

return dbus.String(dt.isoformat(),

1054

variant_level=variant_level)

1668

1055

1669

1056

1670

1057

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1672

1059

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

1673

1060

interface names according to the "alt_interface_names" mapping.

1674

1061

Usage:

1675

1062

1676

1063

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

1677

1064

"net.example.AlternateInterface"})

1678

1065

class SampleDBusObject(dbus.service.Object):

1679

1066

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

1680

1067

def SampleDBusMethod():

1681

1068

pass

1682

1069

1683

1070

The above "SampleDBusMethod" on "SampleDBusObject" will be

1684

1071

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

1685

1072

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

1686

1073

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

1687

1074

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

1688

1075

1689

1076

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

1690

1077

(from DBusObjectWithProperties) and interfaces (from the

1691

1078

dbus_interface_annotations decorator).

1692

1079

"""

1693

1694

1080

def wrapper(cls):

1695

1081

for orig_interface_name, alt_interface_name in (

1696

alt_interface_names.items()):

1082

alt_interface_names.iteritems()):

1697

1083

attr = {}

1698

1084

interface_names = set()

1699

1085

# Go though all attributes of the class

1701

1087

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

1702

1088

# with the wrong interface name

1703

1089

if (not hasattr(attribute, "_dbus_interface")

1704

or not attribute._dbus_interface.startswith(

1705

orig_interface_name)):

1090

or not attribute._dbus_interface

1091

.startswith(orig_interface_name)):

1706

1092

continue

1707

1093

# Create an alternate D-Bus interface name based on

1708

1094

# the current name

1709

alt_interface = attribute._dbus_interface.replace(

1710

orig_interface_name, alt_interface_name)

1095

alt_interface = (attribute._dbus_interface

1096

.replace(orig_interface_name,

1097

alt_interface_name))

1711

1098

interface_names.add(alt_interface)

1712

1099

# Is this a D-Bus signal?

1713

1100

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

1714

1101

# Extract the original non-method undecorated

1715

1102

# function by black magic

1716

if sys.version_info.major == 2:

1717

nonmethod_func = (dict(

1103

nonmethod_func = (dict(

1718

1104

zip(attribute.func_code.co_freevars,

1719

attribute.__closure__))

1720

["func"].cell_contents)

1721

else:

1722

nonmethod_func = (dict(

1723

zip(attribute.__code__.co_freevars,

1724

attribute.__closure__))

1725

["func"].cell_contents)

1105

attribute.__closure__))["func"]

1106

.cell_contents)

1726

1107

# Create a new, but exactly alike, function

1727

1108

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

1728

1109

# with the alternate D-Bus interface name

1729

new_function = copy_function(nonmethod_func)

1730

new_function = (dbus.service.signal(

1731

alt_interface,

1732

attribute._dbus_signature)(new_function))

1110

new_function = (dbus.service.signal

1111

(alt_interface,

1112

attribute._dbus_signature)

1113

(types.FunctionType(

1114

nonmethod_func.func_code,

1115

nonmethod_func.func_globals,

1116

nonmethod_func.func_name,

1117

nonmethod_func.func_defaults,

1118

nonmethod_func.func_closure)))

1733

1119

# Copy annotations, if any

1734

1120

try:

1735

new_function._dbus_annotations = dict(

1736

attribute._dbus_annotations)

1121

new_function._dbus_annotations = (

1122

dict(attribute._dbus_annotations))

1737

1123

except AttributeError:

1738

1124

pass

1739

1740

1125

# Define a creator of a function to call both the

1741

1126

# original and alternate functions, so both the

1742

1127

# original and alternate signals gets sent when

1745

1130

"""This function is a scope container to pass

1746

1131

func1 and func2 to the "call_both" function

1747

1132

outside of its arguments"""

1748

1749

@functools.wraps(func2)

1750

1133

def call_both(*args, **kwargs):

1751

1134

"""This function will emit two D-Bus

1752

1135

signals by calling func1 and func2"""

1753

1136

func1(*args, **kwargs)

1754

1137

func2(*args, **kwargs)

1755

# Make wrapper function look like a D-Bus

1756

# signal

1757

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

1758

if name.startswith("_dbus_"):

1759

setattr(call_both, name, attr)

1760

1761

1138

return call_both

1762

1139

# Create the "call_both" function and add it to

1763

1140

# the class

1768

1145

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

1769

1146

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

1770

1147

# to the class.

1771

attr[attrname] = (

1772

dbus.service.method(

1773

alt_interface,

1774

attribute._dbus_in_signature,

1775

attribute._dbus_out_signature)

1776

(copy_function(attribute)))

1148

attr[attrname] = (dbus.service.method

1149

(alt_interface,

1150

attribute._dbus_in_signature,

1151

attribute._dbus_out_signature)

1152

(types.FunctionType

1153

(attribute.func_code,

1154

attribute.func_globals,

1155

attribute.func_name,

1156

attribute.func_defaults,

1157

attribute.func_closure)))

1777

1158

# Copy annotations, if any

1778

1159

try:

1779

attr[attrname]._dbus_annotations = dict(

1780

attribute._dbus_annotations)

1160

attr[attrname]._dbus_annotations = (

1161

dict(attribute._dbus_annotations))

1781

1162

except AttributeError:

1782

1163

pass

1783

1164

# Is this a D-Bus property?

1786

1167

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

1787

1168

# property with the alternate D-Bus interface

1788

1169

# name. Add it to the class.

1789

attr[attrname] = (dbus_service_property(

1790

alt_interface, attribute._dbus_signature,

1791

attribute._dbus_access,

1792

attribute._dbus_get_args_options

1793

["byte_arrays"])

1794

(copy_function(attribute)))

1170

attr[attrname] = (dbus_service_property

1171

(alt_interface,

1172

attribute._dbus_signature,

1173

attribute._dbus_access,

1174

attribute

1175

._dbus_get_args_options

1176

["byte_arrays"])

1177

(types.FunctionType

1178

(attribute.func_code,

1179

attribute.func_globals,

1180

attribute.func_name,

1181

attribute.func_defaults,

1182

attribute.func_closure)))

1795

1183

# Copy annotations, if any

1796

1184

try:

1797

attr[attrname]._dbus_annotations = dict(

1798

attribute._dbus_annotations)

1185

attr[attrname]._dbus_annotations = (

1186

dict(attribute._dbus_annotations))

1799

1187

except AttributeError:

1800

1188

pass

1801

1189

# Is this a D-Bus interface?

1804

1192

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

1805

1193

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

1806

1194

# to the class.

1807

attr[attrname] = (

1808

dbus_interface_annotations(alt_interface)

1809

(copy_function(attribute)))

1195

attr[attrname] = (dbus_interface_annotations

1196

(alt_interface)

1197

(types.FunctionType

1198

(attribute.func_code,

1199

attribute.func_globals,

1200

attribute.func_name,

1201

attribute.func_defaults,

1202

attribute.func_closure)))

1810

1203

if deprecate:

1811

1204

# Deprecate all alternate interfaces

1812

iname = "_AlternateDBusNames_interface_annotation{}"

1205

iname="_AlternateDBusNames_interface_annotation{0}"

1813

1206

for interface_name in interface_names:

1814

1815

1207

@dbus_interface_annotations(interface_name)

1816

1208

def func(self):

1817

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

1818

"true"}

1209

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

1210

"true" }

1819

1211

# Find an unused name

1820

1212

for aname in (iname.format(i)

1821

1213

for i in itertools.count()):

1825

1217

if interface_names:

1826

1218

# Replace the class with a new subclass of it with

1827

1219

# methods, signals, etc. as created above.

1828

if sys.version_info.major == 2:

1829

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

1830

(cls, ), attr)

1831

else:

1832

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

1833

(cls, ), attr)

1220

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

1221

(cls,), attr)

1834

1222

return cls

1835

1836

1223

return wrapper

1837

1224

1838

1225

1839

1226

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

1840

"se.bsnet.fukt.Mandos"})

1227

"se.bsnet.fukt.Mandos"})

1841

1228

class ClientDBus(Client, DBusObjectWithProperties):

1842

1229

"""A Client class using D-Bus

1843

1230

1844

1231

Attributes:

1845

1232

dbus_object_path: dbus.ObjectPath

1846

1233

bus: dbus.SystemBus()

1847

1234

"""

1848

1235

1849

1236

runtime_expansions = (Client.runtime_expansions

1850

+ ("dbus_object_path", ))

1851

1852

_interface = "se.recompile.Mandos.Client"

1853

1237

+ ("dbus_object_path",))

1238

1854

1239

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

1855

1856

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

1240

1241

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

1857

1242

self.bus = bus

1858

1243

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

1859

1244

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

1860

1245

# the D-Bus

1861

client_object_name = str(self.name).translate(

1246

client_object_name = unicode(self.name).translate(

1862

1247

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

1863

1248

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

1864

self.dbus_object_path = dbus.ObjectPath(

1865

"/clients/" + client_object_name)

1249

self.dbus_object_path = (dbus.ObjectPath

1250

("/clients/" + client_object_name))

1866

1251

DBusObjectWithProperties.__init__(self, self.bus,

1867

1252

self.dbus_object_path)

1868

1869

def notifychangeproperty(transform_func, dbus_name,

1870

type_func=lambda x: x,

1871

variant_level=1,

1872

invalidate_only=False,

1873

_interface=_interface):

1253

1254

def notifychangeproperty(transform_func,

1255

dbus_name, type_func=lambda x: x,

1256

variant_level=1):

1874

1257

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

1875

1258

its changes to DBus.

1876

1259

1877

1260

transform_fun: Function that takes a value and a variant_level

1878

1261

and transforms it to a D-Bus type.

1879

1262

dbus_name: D-Bus name of the variable

1881

1264

to the D-Bus. Default: no transform

1882

1265

variant_level: D-Bus variant level. Default: 1

1883

1266

"""

1884

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

1885

1267

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

1886

1268

def setter(self, value):

1887

1269

if hasattr(self, "dbus_object_path"):

1888

1270

if (not hasattr(self, attrname) or

1889

1271

type_func(getattr(self, attrname, None))

1890

1272

!= type_func(value)):

1891

if invalidate_only:

1892

self.PropertiesChanged(

1893

_interface, dbus.Dictionary(),

1894

dbus.Array((dbus_name, )))

1895

else:

1896

dbus_value = transform_func(

1897

type_func(value),

1898

variant_level=variant_level)

1899

self.PropertyChanged(dbus.String(dbus_name),

1900

dbus_value)

1901

self.PropertiesChanged(

1902

_interface,

1903

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

1904

dbus_value}),

1905

dbus.Array())

1273

dbus_value = transform_func(type_func(value),

1274

variant_level

1275

=variant_level)

1276

self.PropertyChanged(dbus.String(dbus_name),

1277

dbus_value)

1906

1278

setattr(self, attrname, value)

1907

1279

1908

1280

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

1909

1281

1910

1282

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1911

1283

approvals_pending = notifychangeproperty(dbus.Boolean,

1912

1284

"ApprovalPending",

1913

type_func=bool)

1285

type_func = bool)

1914

1286

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

1915

1287

last_enabled = notifychangeproperty(datetime_to_dbus,

1916

1288

"LastEnabled")

1917

checker = notifychangeproperty(

1918

dbus.Boolean, "CheckerRunning",

1919

type_func=lambda checker: checker is not None)

1289

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

1290

type_func = lambda checker:

1291

checker is not None)

1920

1292

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1921

1293

"LastCheckedOK")

1922

1294

last_checker_status = notifychangeproperty(dbus.Int16,

1925

1297

datetime_to_dbus, "LastApprovalRequest")

1926

1298

approved_by_default = notifychangeproperty(dbus.Boolean,

1927

1299

"ApprovedByDefault")

1928

approval_delay = notifychangeproperty(

1929

dbus.UInt64, "ApprovalDelay",

1930

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

1300

approval_delay = notifychangeproperty(dbus.UInt64,

1301

"ApprovalDelay",

1302

type_func =

1303

timedelta_to_milliseconds)

1931

1304

approval_duration = notifychangeproperty(

1932

1305

dbus.UInt64, "ApprovalDuration",

1933

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

1306

type_func = timedelta_to_milliseconds)

1934

1307

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

1935

timeout = notifychangeproperty(

1936

dbus.UInt64, "Timeout",

1937

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

1308

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

1309

type_func =

1310

timedelta_to_milliseconds)

1938

1311

extended_timeout = notifychangeproperty(

1939

1312

dbus.UInt64, "ExtendedTimeout",

1940

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

1941

interval = notifychangeproperty(

1942

dbus.UInt64, "Interval",

1943

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

1313

type_func = timedelta_to_milliseconds)

1314

interval = notifychangeproperty(dbus.UInt64,

1315

"Interval",

1316

type_func =

1317

timedelta_to_milliseconds)

1944

1318

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

1945

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

1946

invalidate_only=True)

1947

1319

1948

1320

del notifychangeproperty

1949

1321

1950

1322

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

1951

1323

try:

1952

1324

self.remove_from_connection()

1955

1327

if hasattr(DBusObjectWithProperties, "__del__"):

1956

1328

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

1957

1329

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

1958

1959

def checker_callback(self, source, condition,

1960

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

1961

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

1962

connection, command, *args,

1963

**kwargs)

1964

exitstatus = self.last_checker_status

1965

if exitstatus >= 0:

1330

1331

def checker_callback(self, pid, condition, command,

1332

*args, **kwargs):

1333

self.checker_callback_tag = None

1334

self.checker = None

1335

if os.WIFEXITED(condition):

1336

exitstatus = os.WEXITSTATUS(condition)

1966

1337

# Emit D-Bus signal

1967

1338

self.CheckerCompleted(dbus.Int16(exitstatus),

1968

# This is specific to GNU libC

1969

dbus.Int64(exitstatus << 8),

1339

dbus.Int64(condition),

1970

1340

dbus.String(command))

1971

1341

else:

1972

1342

# Emit D-Bus signal

1973

1343

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

1974

dbus.Int64(

1975

# This is specific to GNU libC

1976

(exitstatus << 8)

1977

| self.last_checker_signal),

1344

dbus.Int64(condition),

1978

1345

dbus.String(command))

1979

return ret

1980

1346

1347

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

1348

*args, **kwargs)

1349

1981

1350

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

1982

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

1351

old_checker = self.checker

1352

if self.checker is not None:

1353

old_checker_pid = self.checker.pid

1354

else:

1355

old_checker_pid = None

1983

1356

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

1984

1357

# Only if new checker process was started

1985

1358

if (self.checker is not None

1987

1360

# Emit D-Bus signal

1988

1361

self.CheckerStarted(self.current_checker_command)

1989

1362

return r

1990

1363

1991

1364

def _reset_approved(self):

1992

1365

self.approved = None

1993

1366

return False

1994

1367

1995

1368

def approve(self, value=True):

1996

1369

self.approved = value

1997

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

1998

* 1000), self._reset_approved)

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1999

1373

self.send_changedstate()

2000

2001

# D-Bus methods, signals & properties

2002

2003

# Interfaces

2004

2005

# Signals

2006

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

2007

1387

# CheckerCompleted - signal

2008

1388

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

2009

1389

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

2010

1390

"D-Bus signal"

2011

1391

pass

2012

1392

2013

1393

# CheckerStarted - signal

2014

1394

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

2015

1395

def CheckerStarted(self, command):

2016

1396

"D-Bus signal"

2017

1397

pass

2018

1398

2019

1399

# PropertyChanged - signal

2020

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

2021

1400

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

2022

1401

def PropertyChanged(self, property, value):

2023

1402

"D-Bus signal"

2024

1403

pass

2025

1404

2026

1405

# GotSecret - signal

2027

1406

@dbus.service.signal(_interface)

2028

1407

def GotSecret(self):

2031

1410

server to mandos-client

2032

1411

"""

2033

1412

pass

2034

1413

2035

1414

# Rejected - signal

2036

1415

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

2037

1416

def Rejected(self, reason):

2038

1417

"D-Bus signal"

2039

1418

pass

2040

1419

2041

1420

# NeedApproval - signal

2042

1421

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

2043

1422

def NeedApproval(self, timeout, default):

2044

1423

"D-Bus signal"

2045

1424

return self.need_approval()

2046

2047

# Methods

2048

1425

1426

## Methods

1427

2049

1428

# Approve - method

2050

1429

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

2051

1430

def Approve(self, value):

2052

1431

self.approve(value)

2053

1432

2054

1433

# CheckedOK - method

2055

1434

@dbus.service.method(_interface)

2056

1435

def CheckedOK(self):

2057

1436

self.checked_ok()

2058

1437

2059

1438

# Enable - method

2060

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

2061

1439

@dbus.service.method(_interface)

2062

1440

def Enable(self):

2063

1441

"D-Bus method"

2064

1442

self.enable()

2065

1443

2066

1444

# StartChecker - method

2067

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

2068

1445

@dbus.service.method(_interface)

2069

1446

def StartChecker(self):

2070

1447

"D-Bus method"

2071

1448

self.start_checker()

2072

1449

2073

1450

# Disable - method

2074

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

2075

1451

@dbus.service.method(_interface)

2076

1452

def Disable(self):

2077

1453

"D-Bus method"

2078

1454

self.disable()

2079

1455

2080

1456

# StopChecker - method

2081

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

2082

1457

@dbus.service.method(_interface)

2083

1458

def StopChecker(self):

2084

1459

self.stop_checker()

2085

2086

# Properties

2087

1460

1461

## Properties

1462

2088

1463

# ApprovalPending - property

2089

1464

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

2090

1465

def ApprovalPending_dbus_property(self):

2091

1466

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

2092

1467

2093

1468

# ApprovedByDefault - property

2094

@dbus_service_property(_interface,

2095

signature="b",

1469

@dbus_service_property(_interface, signature="b",

2096

1470

access="readwrite")

2097

1471

def ApprovedByDefault_dbus_property(self, value=None):

2098

1472

if value is None: # get

2099

1473

return dbus.Boolean(self.approved_by_default)

2100

1474

self.approved_by_default = bool(value)

2101

1475

2102

1476

# ApprovalDelay - property

2103

@dbus_service_property(_interface,

2104

signature="t",

1477

@dbus_service_property(_interface, signature="t",

2105

1478

access="readwrite")

2106

1479

def ApprovalDelay_dbus_property(self, value=None):

2107

1480

if value is None: # get

2108

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

2109

* 1000)

1481

return dbus.UInt64(self.approval_delay_milliseconds())

2110

1482

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

2111

1483

2112

1484

# ApprovalDuration - property

2113

@dbus_service_property(_interface,

2114

signature="t",

1485

@dbus_service_property(_interface, signature="t",

2115

1486

access="readwrite")

2116

1487

def ApprovalDuration_dbus_property(self, value=None):

2117

1488

if value is None: # get

2118

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

2119

* 1000)

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

2120

1491

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

2121

1492

2122

1493

# Name - property

2123

@dbus_annotations(

2124

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

2125

1494

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

2126

1495

def Name_dbus_property(self):

2127

1496

return dbus.String(self.name)

2128

2129

# KeyID - property

2130

@dbus_annotations(

2131

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

2132

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

2133

def KeyID_dbus_property(self):

2134

return dbus.String(self.key_id)

2135

1497

2136

1498

# Fingerprint - property

2137

@dbus_annotations(

2138

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

2139

1499

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

2140

1500

def Fingerprint_dbus_property(self):

2141

1501

return dbus.String(self.fingerprint)

2142

1502

2143

1503

# Host - property

2144

@dbus_service_property(_interface,

2145

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2146

1505

access="readwrite")

2147

1506

def Host_dbus_property(self, value=None):

2148

1507

if value is None: # get

2149

1508

return dbus.String(self.host)

2150

self.host = str(value)

2151

1509

self.host = unicode(value)

1510

2152

1511

# Created - property

2153

@dbus_annotations(

2154

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

2155

1512

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

2156

1513

def Created_dbus_property(self):

2157

1514

return datetime_to_dbus(self.created)

2158

1515

2159

1516

# LastEnabled - property

2160

1517

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

2161

1518

def LastEnabled_dbus_property(self):

2162

1519

return datetime_to_dbus(self.last_enabled)

2163

1520

2164

1521

# Enabled - property

2165

@dbus_service_property(_interface,

2166

signature="b",

1522

@dbus_service_property(_interface, signature="b",

2167

1523

access="readwrite")

2168

1524

def Enabled_dbus_property(self, value=None):

2169

1525

if value is None: # get

2172

1528

self.enable()

2173

1529

else:

2174

1530

self.disable()

2175

1531

2176

1532

# LastCheckedOK - property

2177

@dbus_service_property(_interface,

2178

signature="s",

1533

@dbus_service_property(_interface, signature="s",

2179

1534

access="readwrite")

2180

1535

def LastCheckedOK_dbus_property(self, value=None):

2181

1536

if value is not None:

2182

1537

self.checked_ok()

2183

1538

return

2184

1539

return datetime_to_dbus(self.last_checked_ok)

2185

1540

2186

1541

# LastCheckerStatus - property

2187

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

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2188

1544

def LastCheckerStatus_dbus_property(self):

2189

1545

return dbus.Int16(self.last_checker_status)

2190

1546

2191

1547

# Expires - property

2192

1548

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

2193

1549

def Expires_dbus_property(self):

2194

1550

return datetime_to_dbus(self.expires)

2195

1551

2196

1552

# LastApprovalRequest - property

2197

1553

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

2198

1554

def LastApprovalRequest_dbus_property(self):

2199

1555

return datetime_to_dbus(self.last_approval_request)

2200

1556

2201

1557

# Timeout - property

2202

@dbus_service_property(_interface,

2203

signature="t",

1558

@dbus_service_property(_interface, signature="t",

2204

1559

access="readwrite")

2205

1560

def Timeout_dbus_property(self, value=None):

2206

1561

if value is None: # get

2207

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

1562

return dbus.UInt64(self.timeout_milliseconds())

2208

1563

old_timeout = self.timeout

2209

1564

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

2210

1565

# Reschedule disabling

2218

1573

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

2219

1574

is None):

2220

1575

return

2221

GLib.source_remove(self.disable_initiator_tag)

2222

self.disable_initiator_tag = GLib.timeout_add(

2223

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

2224

self.disable)

2225

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2226

1582

# ExtendedTimeout - property

2227

@dbus_service_property(_interface,

2228

signature="t",

1583

@dbus_service_property(_interface, signature="t",

2229

1584

access="readwrite")

2230

1585

def ExtendedTimeout_dbus_property(self, value=None):

2231

1586

if value is None: # get

2232

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

2233

* 1000)

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2234

1588

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

2235

1589

2236

1590

# Interval - property

2237

@dbus_service_property(_interface,

2238

signature="t",

1591

@dbus_service_property(_interface, signature="t",

2239

1592

access="readwrite")

2240

1593

def Interval_dbus_property(self, value=None):

2241

1594

if value is None: # get

2242

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

1595

return dbus.UInt64(self.interval_milliseconds())

2243

1596

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

2244

1597

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

2245

1598

return

2246

1599

if self.enabled:

2247

1600

# Reschedule checker run

2248

GLib.source_remove(self.checker_initiator_tag)

2249

self.checker_initiator_tag = GLib.timeout_add(

2250

value, self.start_checker)

2251

self.start_checker() # Start one now, too

2252

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2253

1606

# Checker - property

2254

@dbus_service_property(_interface,

2255

signature="s",

1607

@dbus_service_property(_interface, signature="s",

2256

1608

access="readwrite")

2257

1609

def Checker_dbus_property(self, value=None):

2258

1610

if value is None: # get

2259

1611

return dbus.String(self.checker_command)

2260

self.checker_command = str(value)

2261

1612

self.checker_command = unicode(value)

1613

2262

1614

# CheckerRunning - property

2263

@dbus_service_property(_interface,

2264

signature="b",

1615

@dbus_service_property(_interface, signature="b",

2265

1616

access="readwrite")

2266

1617

def CheckerRunning_dbus_property(self, value=None):

2267

1618

if value is None: # get

2270

1621

self.start_checker()

2271

1622

else:

2272

1623

self.stop_checker()

2273

1624

2274

1625

# ObjectPath - property

2275

@dbus_annotations(

2276

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

2277

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

2278

1626

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

2279

1627

def ObjectPath_dbus_property(self):

2280

return self.dbus_object_path # is already a dbus.ObjectPath

2281

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2282

1630

# Secret = property

2283

@dbus_annotations(

2284

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

2285

"invalidates"})

2286

@dbus_service_property(_interface,

2287

signature="ay",

2288

access="write",

2289

byte_arrays=True)

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2290

1633

def Secret_dbus_property(self, value):

2291

self.secret = bytes(value)

2292

1634

self.secret = str(value)

1635

2293

1636

del _interface

2294

1637

2295

1638

2296

class ProxyClient:

2297

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

1639

class ProxyClient(object):

1640

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

2298

1641

self._pipe = child_pipe

2299

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

1642

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

2300

1643

if not self._pipe.recv():

2301

raise KeyError(key_id or fpr)

2302

1644

raise KeyError()

1645

2303

1646

def __getattribute__(self, name):

2304

if name == "_pipe":

1647

if name == '_pipe':

2305

1648

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

2306

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

1649

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

2307

1650

data = self._pipe.recv()

2308

if data[0] == "data":

1651

if data[0] == 'data':

2309

1652

return data[1]

2310

if data[0] == "function":

2311

1653

if data[0] == 'function':

2312

1654

def func(*args, **kwargs):

2313

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

1655

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

2314

1656

return self._pipe.recv()[1]

2315

2316

1657

return func

2317

1658

2318

1659

def __setattr__(self, name, value):

2319

if name == "_pipe":

1660

if name == '_pipe':

2320

1661

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

2321

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

1662

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

2322

1663

2323

1664

2324

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

2325

1666

"""A class to handle client connections.

2326

1667

2327

1668

Instantiated once for each connection to handle it.

2328

1669

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

2329

1670

2330

1671

def handle(self):

2331

1672

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

2332

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

2333

str(self.client_address))

2334

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

2335

2336

session = gnutls.ClientSession(self.request)

2337

2338

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

2339

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

2340

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

2341

# "+DHE-DSS"))

1673

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

1674

unicode(self.client_address))

1675

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

1676

self.server.child_pipe.fileno())

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2342

1692

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

2343

1693

priority = self.server.gnutls_priority

2344

1694

if priority is None:

2345

1695

priority = "NORMAL"

2346

gnutls.priority_set_direct(session,

2347

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

2348

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2349

1700

# Start communication using the Mandos protocol

2350

1701

# Get protocol number

2351

1702

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

2352

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

1703

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

2353

1704

try:

2354

1705

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

2355

1706

raise RuntimeError(line)

2356

1707

except (ValueError, IndexError, RuntimeError) as error:

2357

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

1708

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

2358

1709

return

2359

1710

2360

1711

# Start GnuTLS connection

2361

1712

try:

2362

1713

session.handshake()

2363

except gnutls.Error as error:

2364

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

1714

except gnutls.errors.GNUTLSError as error:

1715

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

2365

1716

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

2366

1717

# established. Just abandon the request.

2367

1718

return

2368

log.debug("Handshake succeeded")

2369

1719

logger.debug("Handshake succeeded")

1720

2370

1721

approval_required = False

2371

1722

try:

2372

if gnutls.has_rawpk:

2373

fpr = b""

2374

try:

2375

key_id = self.key_id(

2376

self.peer_certificate(session))

2377

except (TypeError, gnutls.Error) as error:

2378

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

2379

return

2380

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

2381

key_id.decode("utf-8",

2382

errors="replace"))

2383

2384

else:

2385

key_id = b""

2386

try:

2387

fpr = self.fingerprint(

2388

self.peer_certificate(session))

2389

except (TypeError, gnutls.Error) as error:

2390

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

2391

return

2392

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

2393

2394

try:

2395

client = ProxyClient(child_pipe, key_id, fpr,

1723

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

1728

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

1729

return

1730

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

1731

1732

try:

1733

client = ProxyClient(child_pipe, fpr,

2396

1734

self.client_address)

2397

1735

except KeyError:

2398

1736

return

2399

1737

2400

1738

if client.approval_delay:

2401

1739

delay = client.approval_delay

2402

1740

client.approvals_pending += 1

2403

1741

approval_required = True

2404

1742

2405

1743

while True:

2406

1744

if not client.enabled:

2407

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

1745

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

1746

client.name)

2408

1747

if self.server.use_dbus:

2409

1748

# Emit D-Bus signal

2410

1749

client.Rejected("Disabled")

2411

1750

return

2412

1751

2413

1752

if client.approved or not client.approval_delay:

2414

# We are approved or approval is disabled

1753

#We are approved or approval is disabled

2415

1754

break

2416

1755

elif client.approved is None:

2417

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

2418

client.name)

1756

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

1757

client.name)

2419

1758

if self.server.use_dbus:

2420

1759

# Emit D-Bus signal

2421

1760

client.NeedApproval(

2422

client.approval_delay.total_seconds()

2423

* 1000, client.approved_by_default)

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2424

1763

else:

2425

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

2426

client.name)

1764

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

1765

client.name)

2427

1766

if self.server.use_dbus:

2428

1767

# Emit D-Bus signal

2429

1768

client.Rejected("Denied")

2430

1769

return

2431

2432

# wait until timeout or approved

1770

1771

#wait until timeout or approved

2433

1772

time = datetime.datetime.now()

2434

1773

client.changedstate.acquire()

2435

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

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2436

1777

client.changedstate.release()

2437

1778

time2 = datetime.datetime.now()

2438

1779

if (time2 - time) >= delay:

2439

1780

if not client.approved_by_default:

2440

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

2441

" waiting for approval",

2442

client.name)

1781

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

1782

" waiting for approval",

1783

client.name)

2443

1784

if self.server.use_dbus:

2444

1785

# Emit D-Bus signal

2445

1786

client.Rejected("Approval timed out")

2448

1789

break

2449

1790

else:

2450

1791

delay -= time2 - time

2451

2452

try:

2453

session.send(client.secret)

2454

except gnutls.Error as error:

2455

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

2456

return

2457

2458

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

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

1806

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

2459

1807

# bump the timeout using extended_timeout

2460

1808

client.bump_timeout(client.extended_timeout)

2461

1809

if self.server.use_dbus:

2462

1810

# Emit D-Bus signal

2463

1811

client.GotSecret()

2464

1812

2465

1813

finally:

2466

1814

if approval_required:

2467

1815

client.approvals_pending -= 1

2468

1816

try:

2469

1817

session.bye()

2470

except gnutls.Error as error:

2471

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

2472

1818

except gnutls.errors.GNUTLSError as error:

1819

logger.warning("GnuTLS bye failed",

1820

exc_info=error)

1821

2473

1822

@staticmethod

2474

1823

def peer_certificate(session):

2475

"Return the peer's certificate as a bytestring"

2476

try:

2477

cert_type = gnutls.certificate_type_get2(

2478

session, gnutls.CTYPE_PEERS)

2479

except AttributeError:

2480

cert_type = gnutls.certificate_type_get(session)

2481

if gnutls.has_rawpk:

2482

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2483

else:

2484

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2485

# If not a valid certificate type...

2486

if cert_type not in valid_cert_types:

2487

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

2488

valid_cert_types)

2489

# ...return invalid data

2490

return b""

1824

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

1825

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2491

1831

list_size = ctypes.c_uint(1)

2492

cert_list = (gnutls.certificate_get_peers

2493

(session, ctypes.byref(list_size)))

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

1834

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

2494

1835

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

2495

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

1836

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

1837

" certificate")

2496

1838

if list_size.value == 0:

2497

1839

return None

2498

1840

cert = cert_list[0]

2499

1841

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

2500

2501

@staticmethod

2502

def key_id(certificate):

2503

"Convert a certificate bytestring to a hexdigit key ID"

2504

# New GnuTLS "datum" with the public key

2505

datum = gnutls.datum_t(

2506

ctypes.cast(ctypes.c_char_p(certificate),

2507

ctypes.POINTER(ctypes.c_ubyte)),

2508

ctypes.c_uint(len(certificate)))

2509

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

2510

# New empty GnuTLS certificate

2511

pubkey = gnutls.pubkey_t()

2512

gnutls.pubkey_init(ctypes.byref(pubkey))

2513

# Import the raw public key into the certificate

2514

gnutls.pubkey_import(pubkey,

2515

ctypes.byref(datum),

2516

gnutls.X509_FMT_DER)

2517

# New buffer for the key ID

2518

buf = ctypes.create_string_buffer(32)

2519

buf_len = ctypes.c_size_t(len(buf))

2520

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

2521

gnutls.pubkey_get_key_id(

2522

pubkey,

2523

gnutls.KEYID_USE_SHA256,

2524

ctypes.cast(ctypes.byref(buf),

2525

ctypes.POINTER(ctypes.c_ubyte)),

2526

ctypes.byref(buf_len))

2527

# Deinit the certificate

2528

gnutls.pubkey_deinit(pubkey)

2529

2530

# Convert the buffer to a Python bytestring

2531

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

2532

# Convert the bytestring to hexadecimal notation

2533

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

2534

return hex_key_id

2535

1842

2536

1843

@staticmethod

2537

1844

def fingerprint(openpgp):

2538

1845

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2539

1846

# New GnuTLS "datum" with the OpenPGP public key

2540

datum = gnutls.datum_t(

2541

ctypes.cast(ctypes.c_char_p(openpgp),

2542

ctypes.POINTER(ctypes.c_ubyte)),

2543

ctypes.c_uint(len(openpgp)))

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2544

1852

# New empty GnuTLS certificate

2545

crt = gnutls.openpgp_crt_t()

2546

gnutls.openpgp_crt_init(ctypes.byref(crt))

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2547

1856

# Import the OpenPGP public key into the certificate

2548

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

2549

gnutls.OPENPGP_FMT_RAW)

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2550

1861

# Verify the self signature in the key

2551

1862

crtverify = ctypes.c_uint()

2552

gnutls.openpgp_crt_verify_self(crt, 0,

2553

ctypes.byref(crtverify))

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2554

1866

if crtverify.value != 0:

2555

gnutls.openpgp_crt_deinit(crt)

2556

raise gnutls.CertificateSecurityError(code

2557

=crtverify.value)

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2558

1870

# New buffer for the fingerprint

2559

1871

buf = ctypes.create_string_buffer(20)

2560

1872

buf_len = ctypes.c_size_t()

2561

1873

# Get the fingerprint from the certificate into the buffer

2562

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

2563

ctypes.byref(buf_len))

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2564

1877

# Deinit the certificate

2565

gnutls.openpgp_crt_deinit(crt)

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2566

1879

# Convert the buffer to a Python bytestring

2567

1880

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

2568

1881

# Convert the bytestring to hexadecimal notation

2570

1883

return hex_fpr

2571

1884

2572

1885

2573

class MultiprocessingMixIn:

1886

class MultiprocessingMixIn(object):

2574

1887

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

2575

2576

1888

def sub_process_main(self, request, address):

2577

1889

try:

2578

1890

self.finish_request(request, address)

2579

1891

except Exception:

2580

1892

self.handle_error(request, address)

2581

1893

self.close_request(request)

2582

1894

2583

1895

def process_request(self, request, address):

2584

1896

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

2585

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

2586

args=(request, address))

1897

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

1898

args = (request, address))

2587

1899

proc.start()

2588

1900

return proc

2589

1901

2590

1902

2591

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1903

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2592

1904

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

2593

2594

1905

def process_request(self, request, client_address):

2595

1906

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

2596

1907

2597

1908

This function creates a new pipe in self.pipe

2598

1909

"""

2599

1910

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2600

1911

2601

1912

proc = MultiprocessingMixIn.process_request(self, request,

2602

1913

client_address)

2603

1914

self.child_pipe.close()

2604

1915

self.add_pipe(parent_pipe, proc)

2605

1916

2606

1917

def add_pipe(self, parent_pipe, proc):

2607

1918

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

2608

1919

raise NotImplementedError()

2609

1920

2610

1921

2611

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2612

socketserver.TCPServer):

2613

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

2614

1923

socketserver.TCPServer, object):

1924

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

1925

2615

1926

Attributes:

2616

1927

enabled: Boolean; whether this server is activated yet

2617

1928

interface: None or a network interface name (string)

2618

1929

use_ipv6: Boolean; to use IPv6 or not

2619

1930

"""

2620

2621

1931

def __init__(self, server_address, RequestHandlerClass,

2622

interface=None,

2623

use_ipv6=True,

2624

socketfd=None):

1932

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

2625

1933

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

2626

1934

creating a new one with socket.socket().

2627

1935

"""

2633

1941

self.socketfd = socketfd

2634

1942

# Save the original socket.socket() function

2635

1943

self.socket_socket = socket.socket

2636

2637

1944

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

2638

#

1945

#

2639

1946

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

2640

1947

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

2641

1948

# patching socket.socket.)

2642

#

1949

#

2643

1950

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

2644

1951

@functools.wraps(socket.socket)

2645

1952

def socket_wrapper(*args, **kwargs):

2657

1964

# socket_wrapper(), if socketfd was set.

2658

1965

socketserver.TCPServer.__init__(self, server_address,

2659

1966

RequestHandlerClass)

2660

1967

2661

1968

def server_bind(self):

2662

1969

"""This overrides the normal server_bind() function

2663

1970

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

2664

1971

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

2665

global SO_BINDTODEVICE

2666

1972

if self.interface is not None:

2667

1973

if SO_BINDTODEVICE is None:

2668

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

2669

# common enough.

2670

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

2671

SO_BINDTODEVICE = 25

2672

try:

2673

self.socket.setsockopt(

2674

socket.SOL_SOCKET, SO_BINDTODEVICE,

2675

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

2676

except socket.error as error:

2677

if error.errno == errno.EPERM:

2678

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

2679

self.interface)

2680

elif error.errno == errno.ENOPROTOOPT:

2681

log.error("SO_BINDTODEVICE not available; cannot"

2682

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

2683

elif error.errno == errno.ENODEV:

2684

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

2685

" bind", self.interface)

2686

else:

2687

raise

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2688

1995

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

2689

1996

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

2690

if self.server_address[1]:

2691

self.allow_reuse_address = True

2692

1997

if not self.server_address[0]:

2693

1998

if self.address_family == socket.AF_INET6:

2694

any_address = "::" # in6addr_any

1999

any_address = "::" # in6addr_any

2695

2000

else:

2696

any_address = "0.0.0.0" # INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

2697

2002

self.server_address = (any_address,

2698

2003

self.server_address[1])

2699

2004

elif not self.server_address[1]:

2700

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

2005

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

2006

0)

2701

2007

# if self.interface:

2702

2008

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

2703

2009

# 0, # port

2709

2015

2710

2016

class MandosServer(IPv6_TCPServer):

2711

2017

"""Mandos server.

2712

2018

2713

2019

Attributes:

2714

2020

clients: set of Client objects

2715

2021

gnutls_priority GnuTLS priority string

2716

2022

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

2717

2718

Assumes a GLib.MainLoop event loop.

2023

2024

Assumes a gobject.MainLoop event loop.

2719

2025

"""

2720

2721

2026

def __init__(self, server_address, RequestHandlerClass,

2722

interface=None,

2723

use_ipv6=True,

2724

clients=None,

2725

gnutls_priority=None,

2726

use_dbus=True,

2727

socketfd=None):

2027

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

2028

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

2728

2029

self.enabled = False

2729

2030

self.clients = clients

2730

2031

if self.clients is None:

2733

2034

self.gnutls_priority = gnutls_priority

2734

2035

IPv6_TCPServer.__init__(self, server_address,

2735

2036

RequestHandlerClass,

2736

interface=interface,

2737

use_ipv6=use_ipv6,

2738

socketfd=socketfd)

2739

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2740

2040

def server_activate(self):

2741

2041

if self.enabled:

2742

2042

return socketserver.TCPServer.server_activate(self)

2743

2043

2744

2044

def enable(self):

2745

2045

self.enabled = True

2746

2046

2747

2047

def add_pipe(self, parent_pipe, proc):

2748

2048

# Call "handle_ipc" for both data and EOF events

2749

GLib.io_add_watch(

2750

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

2751

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

2752

functools.partial(self.handle_ipc,

2753

parent_pipe=parent_pipe,

2754

proc=proc))

2755

2756

def handle_ipc(self, source, condition,

2757

parent_pipe=None,

2758

proc=None,

2759

client_object=None):

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2760

2058

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

2761

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

2059

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

2762

2060

# Wait for other process to exit

2763

2061

proc.join()

2764

2062

return False

2765

2063

2766

2064

# Read a request from the child

2767

2065

request = parent_pipe.recv()

2768

2066

command = request[0]

2769

2770

if command == "init":

2771

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

2772

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

2773

address = request[3]

2774

2775

for c in self.clients.values():

2776

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2777

"27AE41E4649B934CA495991B7852B855"):

2778

continue

2779

if key_id and c.key_id == key_id:

2780

client = c

2781

break

2782

if fpr and c.fingerprint == fpr:

2067

2068

if command == 'init':

2069

fpr = request[1]

2070

address = request[2]

2071

2072

for c in self.clients.itervalues():

2073

if c.fingerprint == fpr:

2783

2074

client = c

2784

2075

break

2785

2076

else:

2786

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

2787

" %s", key_id or fpr, address)

2077

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

2078

"dress: %s", fpr, address)

2788

2079

if self.use_dbus:

2789

2080

# Emit D-Bus signal

2790

mandos_dbus_service.ClientNotFound(key_id or fpr,

2081

mandos_dbus_service.ClientNotFound(fpr,

2791

2082

address[0])

2792

2083

parent_pipe.send(False)

2793

2084

return False

2794

2795

GLib.io_add_watch(

2796

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

2797

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

2798

functools.partial(self.handle_ipc,

2799

parent_pipe=parent_pipe,

2800

proc=proc,

2801

client_object=client))

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2802

2094

parent_pipe.send(True)

2803

2095

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

2804

2096

# same fileno

2805

2097

return False

2806

if command == "funcall":

2098

if command == 'funcall':

2807

2099

funcname = request[1]

2808

2100

args = request[2]

2809

2101

kwargs = request[3]

2810

2811

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

2102

2103

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

2812

2104

funcname)(*args,

2813

**kwargs)))

2814

2815

if command == "getattr":

2105

**kwargs)))

2106

2107

if command == 'getattr':

2816

2108

attrname = request[1]

2817

if isinstance(client_object.__getattribute__(attrname),

2818

collections.abc.Callable):

2819

parent_pipe.send(("function", ))

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2820

2111

else:

2821

parent_pipe.send((

2822

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

2823

2824

if command == "setattr":

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2115

if command == 'setattr':

2825

2116

attrname = request[1]

2826

2117

value = request[2]

2827

2118

setattr(client_object, attrname, value)

2828

2119

2829

2120

return True

2830

2121

2831

2122

2832

2123

def rfc3339_duration_to_delta(duration):

2833

2124

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

2834

2835

>>> timedelta = datetime.timedelta

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

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

2845

True

2846

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

2847

True

2848

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

2849

True

2850

>>> del timedelta

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2851

2140

"""

2852

2141

2853

2142

# Parsing an RFC 3339 duration with regular expressions is not

2854

2143

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

2855

2144

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

2856

2145

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

2857

2146

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

2858

2147

# avoid excessive use of external libraries.

2859

2148

2860

2149

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

2861

Token = collections.namedtuple("Token", (

2862

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

2863

# a "group" containing digits

2864

"value", # datetime.timedelta or None

2865

"followers")) # Tokens valid after this token

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2866

2159

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

2867

2160

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

2868

2161

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

2869

2162

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

2870

2163

datetime.timedelta(seconds=1),

2871

frozenset((token_end, )))

2164

frozenset((token_end,)))

2872

2165

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

2873

2166

datetime.timedelta(minutes=1),

2874

2167

frozenset((token_second, token_end)))

2890

2183

frozenset((token_month, token_end)))

2891

2184

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

2892

2185

datetime.timedelta(weeks=1),

2893

frozenset((token_end, )))

2186

frozenset((token_end,)))

2894

2187

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

2895

2188

frozenset((token_year, token_month,

2896

2189

token_day, token_time,

2897

token_week)))

2898

# Define starting values:

2899

# Value so far

2900

value = datetime.timedelta()

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2901

2193

found_token = None

2902

# Following valid tokens

2903

followers = frozenset((token_duration, ))

2904

# String left to parse

2905

s = duration

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2906

2196

# Loop until end token is found

2907

2197

while found_token is not token_end:

2908

2198

# Search for any currently valid tokens

2924

2214

break

2925

2215

else:

2926

2216

# No currently valid tokens were found

2927

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

2928

.format(duration))

2217

raise ValueError("Invalid RFC 3339 duration")

2929

2218

# End token found

2930

2219

return value

2931

2220

2932

2221

2933

2222

def string_to_delta(interval):

2934

2223

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

2935

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2942

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

2943

True

2944

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

2945

True

2946

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

2947

True

2224

2225

>>> string_to_delta('7d')

2226

datetime.timedelta(7)

2227

>>> string_to_delta('60s')

2228

datetime.timedelta(0, 60)

2229

>>> string_to_delta('60m')

2230

datetime.timedelta(0, 3600)

2231

>>> string_to_delta('24h')

2232

datetime.timedelta(1)

2233

>>> string_to_delta('1w')

2234

datetime.timedelta(7)

2235

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

2236

datetime.timedelta(0, 330)

2948

2237

"""

2949

2238

2950

2239

try:

2951

2240

return rfc3339_duration_to_delta(interval)

2952

2241

except ValueError:

2953

2242

pass

2954

2243

2955

2244

timevalue = datetime.timedelta(0)

2956

2245

for s in interval.split():

2957

2246

try:

2958

suffix = s[-1]

2247

suffix = unicode(s[-1])

2959

2248

value = int(s[:-1])

2960

2249

if suffix == "d":

2961

2250

delta = datetime.timedelta(value)

2968

2257

elif suffix == "w":

2969

2258

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

2970

2259

else:

2971

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

2260

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

2261

.format(suffix))

2972

2262

except IndexError as e:

2973

2263

raise ValueError(*(e.args))

2974

2264

timevalue += delta

2975

2265

return timevalue

2976

2266

2977

2267

2978

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

2268

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

2979

2269

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

2980

2270

2981

2271

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

2982

2272

if os.fork():

2983

2273

sys.exit()

2991

2281

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

2992

2282

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

2993

2283

raise OSError(errno.ENODEV,

2994

"{} not a character device"

2284

"{0} not a character device"

2995

2285

.format(os.devnull))

2996

2286

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

2997

2287

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

3001

2291

3002

2292

3003

2293

def main():

3004

2294

3005

2295

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

3006

2296

# Parsing of options, both command line and config file

3007

2297

3008

2298

parser = argparse.ArgumentParser()

3009

2299

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

3010

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

2300

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

3011

2301

help="show version number and exit")

3012

2302

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

3013

2303

help="Bind to interface IF")

3046

2336

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

3047

2337

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

3048

2338

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

3049

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

3050

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

3051

default=None)

3052

2339

3053

2340

options = parser.parse_args()

3054

2341

2342

if options.check:

2343

import doctest

2344

doctest.testmod()

2345

sys.exit()

2346

3055

2347

# Default values for config file for server-global settings

3056

if gnutls.has_rawpk:

3057

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

3058

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

3059

else:

3060

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

3061

":+SIGN-DSA-SHA256")

3062

server_defaults = {"interface": "",

3063

"address": "",

3064

"port": "",

3065

"debug": "False",

3066

"priority": priority,

3067

"servicename": "Mandos",

3068

"use_dbus": "True",

3069

"use_ipv6": "True",

3070

"debuglevel": "",

3071

"restore": "True",

3072

"socket": "",

3073

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

3074

"foreground": "False",

3075

"zeroconf": "True",

3076

}

3077

del priority

3078

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

3079

2364

# Parse config file for server-global settings

3080

server_config = configparser.ConfigParser(server_defaults)

2365

server_config = configparser.SafeConfigParser(server_defaults)

3081

2366

del server_defaults

3082

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

3083

# Convert the ConfigParser object to a dict

2367

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

2368

"mandos.conf"))

2369

# Convert the SafeConfigParser object to a dict

3084

2370

server_settings = server_config.defaults()

3085

2371

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

3086

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

3087

"foreground", "zeroconf"):

2372

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

3088

2373

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

3089

2374

option)

3090

2375

if server_settings["port"]:

3100

2385

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

3101

2386

["socket"])

3102

2387

del server_config

3103

2388

3104

2389

# Override the settings from the config file with command line

3105

2390

# options, if set.

3106

2391

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

3107

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

3108

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

3109

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

2392

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

2393

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

2394

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

3110

2395

value = getattr(options, option)

3111

2396

if value is not None:

3112

2397

server_settings[option] = value

3113

2398

del options

3114

2399

# Force all strings to be unicode

3115

2400

for option in server_settings.keys():

3116

if isinstance(server_settings[option], bytes):

3117

server_settings[option] = (server_settings[option]

3118

.decode("utf-8"))

2401

if type(server_settings[option]) is str:

2402

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

3119

2403

# Force all boolean options to be boolean

3120

2404

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

3121

"foreground", "zeroconf"):

2405

"foreground"):

3122

2406

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

3123

2407

# Debug implies foreground

3124

2408

if server_settings["debug"]:

3125

2409

server_settings["foreground"] = True

3126

2410

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

3127

2411

3128

2412

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

3129

3130

if (not server_settings["zeroconf"]

3131

and not (server_settings["port"]

3132

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

3133

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

3134

2413

3135

2414

# For convenience

3136

2415

debug = server_settings["debug"]

3137

2416

debuglevel = server_settings["debuglevel"]

3140

2419

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

3141

2420

stored_state_file)

3142

2421

foreground = server_settings["foreground"]

3143

zeroconf = server_settings["zeroconf"]

3144

2422

3145

2423

if debug:

3146

2424

initlogger(debug, logging.DEBUG)

3147

2425

else:

3150

2428

else:

3151

2429

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

3152

2430

initlogger(debug, level)

3153

2431

3154

2432

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

3155

syslogger.setFormatter(

3156

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

3157

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

3158

server_settings["servicename"])))

3159

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

3160

2439

# Parse config file with clients

3161

client_config = configparser.ConfigParser(Client.client_defaults)

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

3162

2442

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

3163

2443

"clients.conf"))

3164

2444

3165

2445

global mandos_dbus_service

3166

2446

mandos_dbus_service = None

3167

3168

socketfd = None

3169

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

3170

socketfd = server_settings["socket"]

3171

tcp_server = MandosServer(

3172

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

3173

ClientHandler,

3174

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

3175

use_ipv6=use_ipv6,

3176

gnutls_priority=server_settings["priority"],

3177

use_dbus=use_dbus,

3178

socketfd=socketfd)

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

3179

2459

if not foreground:

3180

2460

pidfilename = "/run/mandos.pid"

3181

2461

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

3182

2462

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

3183

2463

pidfile = None

3184

2464

try:

3185

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

2465

pidfile = open(pidfilename, "w")

3186

2466

except IOError as e:

3187

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

3188

exc_info=e)

3189

3190

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

3191

("mandos", "mandos"),

3192

("nobody", "nogroup")):

2467

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

2468

exc_info=e)

2469

2470

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

3193

2471

try:

3194

2472

uid = pwd.getpwnam(name).pw_uid

3195

gid = pwd.getpwnam(group).pw_gid

2473

gid = pwd.getpwnam(name).pw_gid

3196

2474

break

3197

2475

except KeyError:

3198

2476

continue

3202

2480

try:

3203

2481

os.setgid(gid)

3204

2482

os.setuid(uid)

3205

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

3206

2483

except OSError as error:

3207

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

3208

os.strerror(error.errno))

3209

2484

if error.errno != errno.EPERM:

3210

2485

raise

3211

2486

3212

2487

if debug:

3213

2488

# Enable all possible GnuTLS debugging

3214

2489

3215

2490

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

3216

2491

# - GnuTLS manual

3217

gnutls.global_set_log_level(11)

3218

3219

@gnutls.log_func

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3220

2495

def debug_gnutls(level, string):

3221

log.debug("GnuTLS: %s",

3222

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

3223

3224

gnutls.global_set_log_function(debug_gnutls)

3225

2496

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

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3226

2501

# Redirect stdin so all checkers get /dev/null

3227

2502

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

3228

2503

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

3229

2504

if null > 2:

3230

2505

os.close(null)

3231

2506

3232

2507

# Need to fork before connecting to D-Bus

3233

2508

if not foreground:

3234

2509

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

3235

2510

daemon()

3236

3237

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

3238

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

3239

# need to inform GLib that threads will be used.

3240

GLib.threads_init()

3241

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3242

2516

global main_loop

3243

2517

# From the Avahi example code

3244

2518

DBusGMainLoop(set_as_default=True)

3245

main_loop = GLib.MainLoop()

2519

main_loop = gobject.MainLoop()

3246

2520

bus = dbus.SystemBus()

3247

2521

# End of Avahi example code

3248

2522

if use_dbus:

3249

2523

try:

3250

2524

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

3251

bus,

3252

do_not_queue=True)

3253

old_bus_name = dbus.service.BusName(

3254

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

3255

do_not_queue=True)

3256

except dbus.exceptions.DBusException as e:

3257

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

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

2530

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

3258

2531

use_dbus = False

3259

2532

server_settings["use_dbus"] = False

3260

2533

tcp_server.use_dbus = False

3261

if zeroconf:

3262

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3263

service = AvahiServiceToSyslog(

3264

name=server_settings["servicename"],

3265

servicetype="_mandos._tcp",

3266

protocol=protocol,

3267

bus=bus)

3268

if server_settings["interface"]:

3269

service.interface = if_nametoindex(

3270

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

3271

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3272

2543

global multiprocessing_manager

3273

2544

multiprocessing_manager = multiprocessing.Manager()

3274

2545

3275

2546

client_class = Client

3276

2547

if use_dbus:

3277

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

3278

2548

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

2549

3279

2550

client_settings = Client.config_parser(client_config)

3280

2551

old_client_settings = {}

3281

2552

clients_data = {}

3282

2553

3283

2554

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

3284

2555

global wnull

3285

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

2556

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

3286

2557

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

3287

2558

# mode

3288

2559

if debug or not foreground:

3289

2560

wnull.close()

3290

2561

3291

2562

# Get client data and settings from last running state.

3292

2563

if server_settings["restore"]:

3293

2564

try:

3294

2565

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

3295

if sys.version_info.major == 2:

3296

clients_data, old_client_settings = pickle.load(

3297

stored_state)

3298

else:

3299

bytes_clients_data, bytes_old_client_settings = (

3300

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

3301

# Fix bytes to strings

3302

# clients_data

3303

# .keys()

3304

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

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_clients_data.items()}

3309

del bytes_clients_data

3310

for key in clients_data:

3311

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

3312

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

3313

for k, v in

3314

clients_data[key].items()}

3315

clients_data[key] = value

3316

# .client_structure

3317

value["client_structure"] = [

3318

(s.decode("utf-8")

3319

if isinstance(s, bytes)

3320

else s) for s in

3321

value["client_structure"]]

3322

# .name, .host, and .checker_command

3323

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

3324

if isinstance(value[k], bytes):

3325

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

3326

if "key_id" not in value:

3327

value["key_id"] = ""

3328

elif "fingerprint" not in value:

3329

value["fingerprint"] = ""

3330

# old_client_settings

3331

# .keys()

3332

old_client_settings = {

3333

(key.decode("utf-8")

3334

if isinstance(key, bytes)

3335

else key): value

3336

for key, value in

3337

bytes_old_client_settings.items()}

3338

del bytes_old_client_settings

3339

# .host and .checker_command

3340

for value in old_client_settings.values():

3341

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

3342

if isinstance(value[attribute], bytes):

3343

value[attribute] = (value[attribute]

3344

.decode("utf-8"))

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3345

2568

os.remove(stored_state_path)

3346

2569

except IOError as e:

3347

2570

if e.errno == errno.ENOENT:

3348

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

3349

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

2571

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

2572

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

3350

2573

else:

3351

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

3352

exc_info=e)

2574

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

2575

exc_info=e)

3353

2576

raise

3354

2577

except EOFError as e:

3355

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

3356

exc_info=e)

3357

2578

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

2579

"EOFError:", exc_info=e)

2580

3358

2581

with PGPEngine() as pgp:

3359

for client_name, client in clients_data.items():

2582

for client_name, client in clients_data.iteritems():

3360

2583

# Skip removed clients

3361

2584

if client_name not in client_settings:

3362

2585

continue

3363

2586

3364

2587

# Decide which value to use after restoring saved state.

3365

2588

# We have three different values: Old config file,

3366

2589

# new config file, and saved state.

3371

2594

# For each value in new config, check if it

3372

2595

# differs from the old config value (Except for

3373

2596

# the "secret" attribute)

3374

if (name != "secret"

3375

and (value !=

3376

old_client_settings[client_name][name])):

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3377

2600

client[name] = value

3378

2601

except KeyError:

3379

2602

pass

3380

2603

3381

2604

# Clients who has passed its expire date can still be

3382

# enabled if its last checker was successful. A Client

2605

# enabled if its last checker was successful. Clients

3383

2606

# whose checker succeeded before we stored its state is

3384

2607

# assumed to have successfully run all checkers during

3385

2608

# downtime.

3386

2609

if client["enabled"]:

3387

2610

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

3388

2611

if not client["last_checked_ok"]:

3389

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

3390

" never performed a successful"

3391

" checker", client_name)

2612

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3392

2616

client["enabled"] = False

3393

2617

elif client["last_checker_status"] != 0:

3394

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

3395

" last checker failed with error"

3396

" code %s", client_name,

3397

client["last_checker_status"])

2618

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3398

2623

client["enabled"] = False

3399

2624

else:

3400

client["expires"] = (

3401

datetime.datetime.utcnow()

3402

+ client["timeout"])

3403

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

3404

" enabled", client_name)

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

2628

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3405

2631

try:

3406

client["secret"] = pgp.decrypt(

3407

client["encrypted_secret"],

3408

client_settings[client_name]["secret"])

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3409

2636

except PGPError:

3410

2637

# If decryption fails, we use secret from new settings

3411

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

3412

client_name)

3413

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

3414

["secret"])

3415

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3416

2643

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

3417

2644

for client_name in (set(old_client_settings)

3418

2645

- set(client_settings)):

3420

2647

for client_name in (set(client_settings)

3421

2648

- set(old_client_settings)):

3422

2649

clients_data[client_name] = client_settings[client_name]

3423

2650

3424

2651

# Create all client objects

3425

for client_name, client in clients_data.items():

2652

for client_name, client in clients_data.iteritems():

3426

2653

tcp_server.clients[client_name] = client_class(

3427

name=client_name,

3428

settings=client,

3429

server_settings=server_settings)

3430

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3431

2657

if not tcp_server.clients:

3432

log.warning("No clients defined")

3433

2658

logger.warning("No clients defined")

2659

3434

2660

if not foreground:

3435

2661

if pidfile is not None:

3436

pid = os.getpid()

3437

2662

try:

3438

2663

with pidfile:

3439

print(pid, file=pidfile)

2664

pid = os.getpid()

2665

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

3440

2666

except IOError:

3441

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

3442

pidfilename, pid)

2667

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

2668

pidfilename, pid)

3443

2669

del pidfile

3444

2670

del pidfilename

3445

3446

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

3447

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3448

lambda: main_loop.quit() and False)

3449

2671

2672

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

2673

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

2674

3450

2675

if use_dbus:

3451

3452

@alternate_dbus_interfaces(

3453

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

3454

class MandosDBusService(DBusObjectWithObjectManager):

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3455

2679

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

3456

3457

2680

def __init__(self):

3458

2681

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

3459

3460

2682

_interface = "se.recompile.Mandos"

3461

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3462

2690

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

3463

2691

def ClientAdded(self, objpath):

3464

2692

"D-Bus signal"

3465

2693

pass

3466

2694

3467

2695

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

3468

def ClientNotFound(self, key_id, address):

2696

def ClientNotFound(self, fingerprint, address):

3469

2697

"D-Bus signal"

3470

2698

pass

3471

3472

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

3473

"true"})

2699

3474

2700

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

3475

2701

def ClientRemoved(self, objpath, name):

3476

2702

"D-Bus signal"

3477

2703

pass

3478

3479

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

3480

"true"})

2704

3481

2705

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

3482

2706

def GetAllClients(self):

3483

2707

"D-Bus method"

3484

return dbus.Array(c.dbus_object_path for c in

3485

tcp_server.clients.values())

3486

3487

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

3488

"true"})

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3489

2712

@dbus.service.method(_interface,

3490

2713

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

3491

2714

def GetAllClientsWithProperties(self):

3492

2715

"D-Bus method"

3493

2716

return dbus.Dictionary(

3494

{c.dbus_object_path: c.GetAll(

3495

"se.recompile.Mandos.Client")

3496

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

2717

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

2718

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

3497

2719

signature="oa{sv}")

3498

2720

3499

2721

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

3500

2722

def RemoveClient(self, object_path):

3501

2723

"D-Bus method"

3502

for c in tcp_server.clients.values():

2724

for c in tcp_server.clients.itervalues():

3503

2725

if c.dbus_object_path == object_path:

3504

2726

del tcp_server.clients[c.name]

3505

2727

c.remove_from_connection()

3506

# Don't signal the disabling

2728

# Don't signal anything except ClientRemoved

3507

2729

c.disable(quiet=True)

3508

# Emit D-Bus signal for removal

3509

self.client_removed_signal(c)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3510

2732

return

3511

2733

raise KeyError(object_path)

3512

2734

3513

2735

del _interface

3514

3515

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3516

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

3517

def GetManagedObjects(self):

3518

"""D-Bus method"""

3519

return dbus.Dictionary(

3520

{client.dbus_object_path:

3521

dbus.Dictionary(

3522

{interface: client.GetAll(interface)

3523

for interface in

3524

client._get_all_interface_names()})

3525

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

3526

3527

def client_added_signal(self, client):

3528

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

3529

if use_dbus:

3530

# New standard signal

3531

self.InterfacesAdded(

3532

client.dbus_object_path,

3533

dbus.Dictionary(

3534

{interface: client.GetAll(interface)

3535

for interface in

3536

client._get_all_interface_names()}))

3537

# Old signal

3538

self.ClientAdded(client.dbus_object_path)

3539

3540

def client_removed_signal(self, client):

3541

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

3542

if use_dbus:

3543

# New standard signal

3544

self.InterfacesRemoved(

3545

client.dbus_object_path,

3546

client._get_all_interface_names())

3547

# Old signal

3548

self.ClientRemoved(client.dbus_object_path,

3549

client.name)

3550

2736

3551

2737

mandos_dbus_service = MandosDBusService()

3552

3553

# Save modules to variables to exempt the modules from being

3554

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

3555

mp = multiprocessing

3556

wn = wnull

3557

2738

3558

2739

def cleanup():

3559

2740

"Cleanup function; run on exit"

3560

if zeroconf:

3561

service.cleanup()

3562

3563

mp.active_children()

3564

wn.close()

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3565

2745

if not (tcp_server.clients or client_settings):

3566

2746

return

3567

2747

3568

2748

# Store client before exiting. Secrets are encrypted with key

3569

2749

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

3570

2750

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

3571

2751

clients = {}

3572

2752

with PGPEngine() as pgp:

3573

for client in tcp_server.clients.values():

2753

for client in tcp_server.clients.itervalues():

3574

2754

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

3575

2755

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

3576

2756

key)

3577

2757

client_dict = {}

3578

2758

3579

2759

# A list of attributes that can not be pickled

3580

2760

# + secret.

3581

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

3582

"checker", "server_settings"}

3583

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

3584

.Object):

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3585

2765

exclude.add(name)

3586

2766

3587

2767

client_dict["encrypted_secret"] = (client

3588

2768

.encrypted_secret)

3589

2769

for attr in client.client_structure:

3590

2770

if attr not in exclude:

3591

2771

client_dict[attr] = getattr(client, attr)

3592

2772

3593

2773

clients[client.name] = client_dict

3594

2774

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

3595

2775

3596

2776

try:

3597

with tempfile.NamedTemporaryFile(

3598

mode="wb",

3599

suffix=".pickle",

3600

prefix="clients-",

3601

dir=os.path.dirname(stored_state_path),

3602

delete=False) as stored_state:

3603

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

3604

protocol=2)

3605

tempname = stored_state.name

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3606

2783

os.rename(tempname, stored_state_path)

3607

2784

except (IOError, OSError) as e:

3608

2785

if not debug:

3611

2788

except NameError:

3612

2789

pass

3613

2790

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

3614

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

3615

os.strerror(e.errno))

2791

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

2792

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

3616

2793

else:

3617

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

3618

exc_info=e)

2794

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

2795

exc_info=e)

3619

2796

raise

3620

2797

3621

2798

# Delete all clients, and settings from config

3622

2799

while tcp_server.clients:

3623

2800

name, client = tcp_server.clients.popitem()

3624

2801

if use_dbus:

3625

2802

client.remove_from_connection()

3626

# Don't signal the disabling

2803

# Don't signal anything except ClientRemoved

3627

2804

client.disable(quiet=True)

3628

# Emit D-Bus signal for removal

3629

2805

if use_dbus:

3630

mandos_dbus_service.client_removed_signal(client)

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3631

2810

client_settings.clear()

3632

2811

3633

2812

atexit.register(cleanup)

3634

3635

for client in tcp_server.clients.values():

2813

2814

for client in tcp_server.clients.itervalues():

3636

2815

if use_dbus:

3637

# Emit D-Bus signal for adding

3638

mandos_dbus_service.client_added_signal(client)

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3639

2818

# Need to initiate checking of clients

3640

2819

if client.enabled:

3641

client.init_checker(randomize_start=True)

3642

2820

client.init_checker()

2821

3643

2822

tcp_server.enable()

3644

2823

tcp_server.server_activate()

3645

2824

3646

2825

# Find out what port we got

3647

if zeroconf:

3648

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

2826

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

3649

2827

if use_ipv6:

3650

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

3651

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

2828

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

2829

" flowinfo %d, scope_id %d",

2830

*tcp_server.socket.getsockname())

3652

2831

else: # IPv4

3653

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

3654

*tcp_server.socket.getsockname())

3655

3656

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

3657

2832

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

2833

*tcp_server.socket.getsockname())

2834

2835

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

2836

3658

2837

try:

3659

if zeroconf:

3660

# From the Avahi example code

3661

try:

3662

service.activate()

3663

except dbus.exceptions.DBusException as error:

3664

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

3665

cleanup()

3666

sys.exit(1)

3667

# End of Avahi example code

3668

3669

GLib.io_add_watch(

3670

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

3671

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3672

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

3673

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

3674

3675

log.debug("Starting main loop")

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

2852

logger.debug("Starting main loop")

3676

2853

main_loop.run()

3677

2854

except AvahiError as error:

3678

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

2855

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

3679

2856

cleanup()

3680

2857

sys.exit(1)

3681

2858

except KeyboardInterrupt:

3682

2859

if debug:

3683

2860

print("", file=sys.stderr)

3684

log.debug("Server received KeyboardInterrupt")

3685

log.debug("Server exiting")

2861

logger.debug("Server received KeyboardInterrupt")

2862

logger.debug("Server exiting")

3686

2863

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

3687

2864

cleanup()

3688

2865

3689

3690

def parse_test_args():

3691

# type: () -> argparse.Namespace

3692

parser = argparse.ArgumentParser(add_help=False)

3693

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

3694

parser.add_argument("--prefix", )

3695

args, unknown_args = parser.parse_known_args()

3696

if args.check:

3697

# Remove test options from sys.argv

3698

sys.argv[1:] = unknown_args

3699

return args

3700

3701

# Add all tests from doctest strings

3702

def load_tests(loader, tests, none):

3703

import doctest

3704

tests.addTests(doctest.DocTestSuite())

3705

return tests

3706

3707

if __name__ == "__main__":

3708

options = parse_test_args()

3709

try:

3710

if options.check:

3711

extra_test_prefix = options.prefix

3712

if extra_test_prefix is not None:

3713

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

3714

.result.wasSuccessful()):

3715

sys.exit(1)

3716

class ExtraTestLoader(unittest.TestLoader):

3717

testMethodPrefix = extra_test_prefix

3718

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

3719

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

3720

else:

3721

unittest.main(argv=[""])

3722

else:

3723

main()

3724

finally:

3725

logging.shutdown()

3726

3727

# Local Variables:

3728

# run-tests:

3729

# (lambda (&optional extra)

3730

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

3731

# extra))

3732

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

3733

# (funcall remove-test-window)

3734

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

3735

# run-tests-in-test-buffer:

3736

# (lambda (dir &optional extra)

3737

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

3738

# (setq buffer-read-only nil

3739

# default-directory dir)

3740

# (erase-buffer)

3741

# (compilation-mode))

3742

# (let ((process-result

3743

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

3744

# (process-file-shell-command

3745

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

3746

# (and (numberp process-result)

3747

# (= process-result 0))))

3748

# get-command-line:

3749

# (lambda (&optional extra)

3750

# (let ((quoted-script

3751

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

3752

# (format

3753

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

3754

# quoted-script)))

3755

# get-script-name:

3756

# (lambda ()

3757

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

3758

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

3759

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

3760

# (buffer-file-name))))

3761

# remove-test-window:

3762

# (lambda ()

3763

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

3764

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

3765

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

3766

# (lambda ()

3767

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

3768

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

3769

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

3770

# (display-buffer-overriding-action

3771

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

3772

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

3773

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

3774

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

3775

# eval:

3776

# (progn

3777

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

3778

# (funcall run-tests t)))

3779

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

3780

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

3781

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

3782

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

3783

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

3784

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

3785

# End:

2866

if __name__ == '__main__':

2867

main()