/mandos/trunk : revision 579

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

import collections

79

import codecs

80

import random

81

import shlex

82

71

83

72

import dbus

84

73

import dbus.service

85

import gi

86

from gi.repository import GLib

74

import gobject

75

import avahi

87

76

from dbus.mainloop.glib import DBusGMainLoop

88

77

import ctypes

89

78

import ctypes.util

90

79

import xml.dom.minidom

91

80

import inspect

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

81

import GnuPGInterface

82

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

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

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

142

self.gnupg = GnuPGInterface.GnuPG()

215

143

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

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

235

151

def __enter__(self):

236

152

return self

237

238

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

153

154

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

239

155

self._cleanup()

240

156

return False

241

157

242

158

def __del__(self):

243

159

self._cleanup()

244

160

245

161

def _cleanup(self):

246

162

if self.tempdir is not None:

247

163

# Delete contents of tempdir

248

164

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

249

topdown=False):

165

topdown = False):

250

166

for filename in files:

251

167

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

252

168

for dirname in dirs:

254

170

# Remove tempdir

255

171

os.rmdir(self.tempdir)

256

172

self.tempdir = None

257

173

258

174

def password_encode(self, password):

259

175

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

260

176

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

261

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

262

if len(encoded) > 2048:

263

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

264

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

265

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

266

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

267

return encoded

268

177

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

178

269

179

def encrypt(self, data, password):

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

"--passphrase-file",

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

285

194

return ciphertext

286

195

287

196

def decrypt(self, data, password):

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

"--passphrase-file",

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

303

211

return decrypted_plaintext

304

212

305

213

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

214

class AvahiError(Exception):

333

215

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

334

216

self.value = value

335

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

336

**kwargs)

337

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

338

220

339

221

class AvahiServiceError(AvahiError):

340

222

pass

341

223

342

343

224

class AvahiGroupError(AvahiError):

344

225

pass

345

226

346

227

347

class AvahiService:

228

class AvahiService(object):

348

229

"""An Avahi (Zeroconf) service.

349

230

350

231

Attributes:

351

232

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

352

233

Used to optionally bind to the specified interface.

353

354

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

355

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

234

235

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

236

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

356

237

port: integer; what port to announce

357

238

TXT: list of strings; TXT record for the service

358

239

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

364

245

server: D-Bus Server

365

246

bus: dbus.SystemBus()

366

247

"""

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

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

379

253

self.interface = interface

380

254

self.name = name

381

255

self.type = servicetype

390

264

self.server = None

391

265

self.bus = bus

392

266

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

267

268

def rename(self):

395

269

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

396

270

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)

271

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

272

" after %i retries, exiting.",

273

self.rename_count)

400

274

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

277

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

278

self.name)

279

self.remove()

280

try:

281

self.add()

282

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

403

286

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

287

420

288

def remove(self):

421

289

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

422

290

if self.entry_group_state_changed_match is not None:

424

292

self.entry_group_state_changed_match = None

425

293

if self.group is not None:

426

294

self.group.Reset()

427

295

428

296

def add(self):

429

297

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

430

298

self.remove()

435

303

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

304

self.entry_group_state_changed_match = (

437

305

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)

306

'StateChanged', self.entry_group_state_changed))

307

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

308

self.name, self.type)

441

309

self.group.AddService(

442

310

self.interface,

443

311

self.protocol,

447

315

dbus.UInt16(self.port),

448

316

avahi.string_array_to_txt_array(self.TXT))

449

317

self.group.Commit()

450

318

451

319

def entry_group_state_changed(self, state, error):

452

320

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

453

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

454

321

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

322

455

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

324

logger.debug("Zeroconf service established.")

457

325

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

326

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

459

327

self.rename()

460

328

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

329

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

330

unicode(error))

331

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

332

.format(error))

333

465

334

def cleanup(self):

466

335

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

467

336

if self.group is not None:

472

341

pass

473

342

self.group = None

474

343

self.remove()

475

344

476

345

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

477

346

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

}

347

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

485

355

if state in bad_states:

486

356

if bad_states[state] is not None:

487

357

if error is None:

488

log.error(bad_states[state])

358

logger.error(bad_states[state])

489

359

else:

490

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

360

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

491

361

self.cleanup()

492

362

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)

363

self.add()

504

364

else:

505

365

if error is None:

506

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

366

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

507

367

else:

508

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

509

368

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

369

510

370

def activate(self):

511

371

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

512

372

if self.server is None:

516

376

follow_name_owner_changes=True),

517

377

avahi.DBUS_INTERFACE_SERVER)

518

378

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

379

self.server_state_changed)

520

380

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

521

381

522

523

382

class AvahiServiceToSyslog(AvahiService):

524

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

383

def rename(self):

525

384

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

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

531

390

return ret

532

391

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

397

398

class Client(object):

875

399

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

876

400

877

401

Attributes:

878

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

402

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

879

403

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

880

404

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

405

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

406

to see if the client lives.

407

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

885

409

checker_command: string; External command which is run to check

886

410

if client lives. %() expansions are done at

887

411

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

888

412

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

889

checker_initiator_tag: a GLib event source tag, or None

413

checker_initiator_tag: a gobject event source tag, or None

890

414

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

891

415

client_structure: Object describing what attributes a client has

892

416

and is used for storing the client at exit

893

417

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

418

disable_initiator_tag: a gobject event source tag, or None

895

419

enabled: bool()

896

420

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

421

uniquely identify the client

900

422

host: string; available for use by the checker command

901

423

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

902

424

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

904

426

last_checker_status: integer between 0 and 255 reflecting exit

905

427

status of last checker. -1 reflects crashed

906

428

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

429

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

910

430

911

431

D-Bus identifiers

916

436

runtime_expansions: Allowed attributes for runtime expansion.

917

437

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

918

438

disabled, or None

919

server_settings: The server_settings dict from main()

920

439

"""

921

440

922

441

runtime_expansions = ("approval_delay", "approval_duration",

923

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

924

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

925

"last_approval_request", "last_checked_ok",

442

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

443

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

926

444

"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

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

939

471

@staticmethod

940

472

def config_parser(config):

941

473

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

948

480

for client_name in config.sections():

949

481

section = dict(config.items(client_name))

950

482

client = settings[client_name] = {}

951

483

952

484

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

953

485

# Reformat values from string types to Python types

954

486

client["approved_by_default"] = config.getboolean(

955

487

client_name, "approved_by_default")

956

488

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

957

489

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

490

964

491

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

965

492

.replace(" ", ""))

966

493

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

494

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

970

495

elif "secfile" in section:

971

496

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

972

497

(section["secfile"])),

973

498

"rb") as secfile:

974

499

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

975

500

else:

976

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

501

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

977

502

.format(section))

978

503

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

979

504

client["extended_timeout"] = string_to_delta(

987

512

client["last_approval_request"] = None

988

513

client["last_checked_ok"] = None

989

514

client["last_checker_status"] = -2

990

515

991

516

return settings

992

993

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

517

518

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

994

519

self.name = name

995

if server_settings is None:

996

server_settings = {}

997

self.server_settings = server_settings

998

520

# adding all client settings

999

for setting, value in settings.items():

521

for setting, value in settings.iteritems():

1000

522

setattr(self, setting, value)

1001

523

1002

524

if self.enabled:

1003

525

if not hasattr(self, "last_enabled"):

1004

526

self.last_enabled = datetime.datetime.utcnow()

1008

530

else:

1009

531

self.last_enabled = None

1010

532

self.expires = None

1011

1012

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

1013

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

1014

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

533

534

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

538

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

1015

539

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

1016

540

datetime.datetime.utcnow())

1017

541

1018

542

# attributes specific for this server instance

1019

543

self.checker = None

1020

544

self.checker_initiator_tag = None

1023

547

self.current_checker_command = None

1024

548

self.approved = None

1025

549

self.approvals_pending = 0

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

1030

555

if not attr.startswith("_")]

1031

556

self.client_structure.append("client_structure")

1032

1033

for name, t in inspect.getmembers(

1034

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

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

1035

562

if not name.startswith("_"):

1036

563

self.client_structure.append(name)

1037

564

1038

565

# Send notice to process children that client state has changed

1039

566

def send_changedstate(self):

1040

567

with self.changedstate:

1041

568

self.changedstate.notify_all()

1042

569

1043

570

def enable(self):

1044

571

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

1045

572

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

1046

573

# Already enabled

1047

574

return

575

self.send_changedstate()

1048

576

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

1049

577

self.enabled = True

1050

578

self.last_enabled = datetime.datetime.utcnow()

1051

579

self.init_checker()

1052

self.send_changedstate()

1053

580

1054

581

def disable(self, quiet=True):

1055

582

"""Disable this client."""

1056

583

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

1057

584

return False

1058

585

if not quiet:

1059

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

1060

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

1061

GLib.source_remove(self.disable_initiator_tag)

586

self.send_changedstate()

587

if not quiet:

588

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

589

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

590

gobject.source_remove(self.disable_initiator_tag)

1062

591

self.disable_initiator_tag = None

1063

592

self.expires = None

1064

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

1065

GLib.source_remove(self.checker_initiator_tag)

593

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

594

gobject.source_remove(self.checker_initiator_tag)

1066

595

self.checker_initiator_tag = None

1067

596

self.stop_checker()

1068

597

self.enabled = False

1069

if not quiet:

1070

self.send_changedstate()

1071

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

598

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

1072

599

return False

1073

600

1074

601

def __del__(self):

1075

602

self.disable()

1076

603

1077

604

def init_checker(self):

1078

605

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

1079

606

# and every interval from then on.

1080

if self.checker_initiator_tag is not None:

1081

GLib.source_remove(self.checker_initiator_tag)

1082

self.checker_initiator_tag = GLib.timeout_add(

1083

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

1084

+ 1)),

1085

self.start_checker)

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

1086

610

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

1087

if self.disable_initiator_tag is not None:

1088

GLib.source_remove(self.disable_initiator_tag)

1089

self.disable_initiator_tag = GLib.timeout_add(

1090

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

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

1091

614

# Also start a new checker *right now*.

1092

615

self.start_checker()

1093

1094

def checker_callback(self, source, condition, connection,

1095

command):

616

617

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

1096

618

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

1097

# Read return code from connection (see call_pipe)

1098

returncode = connection.recv()

1099

connection.close()

1100

if self.checker is not None:

1101

self.checker.join()

1102

619

self.checker_callback_tag = None

1103

620

self.checker = None

1104

1105

if returncode >= 0:

1106

self.last_checker_status = returncode

1107

self.last_checker_signal = None

621

if os.WIFEXITED(condition):

622

self.last_checker_status = os.WEXITSTATUS(condition)

1108

623

if self.last_checker_status == 0:

1109

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

624

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

625

vars(self))

1110

626

self.checked_ok()

1111

627

else:

1112

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

628

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

629

vars(self))

1113

630

else:

1114

631

self.last_checker_status = -1

1115

self.last_checker_signal = -returncode

1116

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

1117

return False

1118

632

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

633

vars(self))

634

1119

635

def checked_ok(self):

1120

636

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

1121

637

self.last_checked_ok = datetime.datetime.utcnow()

1122

638

self.last_checker_status = 0

1123

self.last_checker_signal = None

1124

639

self.bump_timeout()

1125

640

1126

641

def bump_timeout(self, timeout=None):

1127

642

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

1128

643

if timeout is None:

1129

644

timeout = self.timeout

1130

645

if self.disable_initiator_tag is not None:

1131

GLib.source_remove(self.disable_initiator_tag)

1132

self.disable_initiator_tag = None

646

gobject.source_remove(self.disable_initiator_tag)

1133

647

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

1134

self.disable_initiator_tag = GLib.timeout_add(

1135

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

1136

651

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

1137

652

1138

653

def need_approval(self):

1139

654

self.last_approval_request = datetime.datetime.utcnow()

1140

655

1141

656

def start_checker(self):

1142

657

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

1143

658

1144

659

If a checker already exists, leave it running and do

1145

660

nothing."""

1146

661

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

1151

666

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

1152

667

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

1153

668

# should be.

1154

1155

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

1156

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

1157

self.checker.join()

1158

self.checker = None

669

670

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

671

try:

672

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

673

except (AttributeError, OSError) as error:

674

if (isinstance(error, OSError)

675

and error.errno != errno.ECHILD):

676

raise error

677

else:

678

if pid:

679

logger.warning("Checker was a zombie")

680

gobject.source_remove(self.checker_callback_tag)

681

self.checker_callback(pid, status,

682

self.current_checker_command)

1159

683

# Start a new checker if needed

1160

684

if self.checker is None:

1161

# Escape attributes for the shell

1162

escaped_attrs = {

1163

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

1164

for attr in self.runtime_expansions}

1165

685

try:

1166

command = self.checker_command % escaped_attrs

1167

except TypeError as error:

1168

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

1169

self.checker_command, exc_info=error)

1170

return True # Try again later

686

# In case checker_command has exactly one % operator

687

command = self.checker_command % self.host

688

except TypeError:

689

# Escape attributes for the shell

690

escaped_attrs = dict(

691

(attr,

692

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

693

errors=

694

'replace')))

695

for attr in

696

self.runtime_expansions)

697

698

try:

699

command = self.checker_command % escaped_attrs

700

except TypeError as error:

701

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

1171

704

self.current_checker_command = command

1172

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

1173

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

1174

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

1175

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

1176

# always replaced by /dev/null.)

1177

# The exception is when not debugging but nevertheless

1178

# running in the foreground; use the previously

1179

# created wnull.

1180

popen_args = {"close_fds": True,

1181

"shell": True,

1182

"cwd": "/"}

1183

if (not self.server_settings["debug"]

1184

and self.server_settings["foreground"]):

1185

popen_args.update({"stdout": wnull,

1186

"stderr": wnull})

1187

pipe = multiprocessing.Pipe(duplex=False)

1188

self.checker = multiprocessing.Process(

1189

target=call_pipe,

1190

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

1191

kwargs=popen_args)

1192

self.checker.start()

1193

self.checker_callback_tag = GLib.io_add_watch(

1194

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

1195

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1196

self.checker_callback, pipe[0], command)

1197

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

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

self.checker_callback_tag = (gobject.child_watch_add

716

(self.checker.pid,

717

self.checker_callback,

718

data=command))

719

# The checker may have completed before the gobject

720

# watch was added. Check for this.

721

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

722

if pid:

723

gobject.source_remove(self.checker_callback_tag)

724

self.checker_callback(pid, status, command)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

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

1198

729

return True

1199

730

1200

731

def stop_checker(self):

1201

732

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

1202

733

if self.checker_callback_tag:

1203

GLib.source_remove(self.checker_callback_tag)

734

gobject.source_remove(self.checker_callback_tag)

1204

735

self.checker_callback_tag = None

1205

736

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

1206

737

return

1207

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

1208

self.checker.terminate()

738

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

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

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

743

# self.checker.kill()

744

except OSError as error:

745

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

746

raise

1209

747

self.checker = None

1210

748

1211

749

1212

def dbus_service_property(dbus_interface,

1213

signature="v",

1214

access="readwrite",

1215

byte_arrays=False):

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

1216

752

"""Decorators for marking methods of a DBusObjectWithProperties to

1217

753

become properties on the D-Bus.

1218

754

1219

755

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

1220

756

and with one argument by "Set".

1221

757

1222

758

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

1223

759

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

1224

760

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

1227

763

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

1228

764

if byte_arrays and signature != "ay":

1229

765

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

1230

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

1231

766

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

1232

767

def decorator(func):

1233

768

func._dbus_is_property = True

1234

769

func._dbus_interface = dbus_interface

1237

772

func._dbus_name = func.__name__

1238

773

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

1239

774

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

1240

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

775

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1241

776

return func

1242

1243

777

return decorator

1244

778

1245

779

1246

780

def dbus_interface_annotations(dbus_interface):

1247

781

"""Decorator for marking functions returning interface annotations

1248

782

1249

783

Usage:

1250

784

1251

785

@dbus_interface_annotations("org.example.Interface")

1252

786

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

1253

787

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

1254

788

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

1255

789

"false"}

1256

790

"""

1257

1258

791

def decorator(func):

1259

792

func._dbus_is_interface = True

1260

793

func._dbus_interface = dbus_interface

1261

794

func._dbus_name = dbus_interface

1262

795

return func

1263

1264

796

return decorator

1265

797

1266

798

1267

799

def dbus_annotations(annotations):

1268

800

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

1269

801

Usage:

1270

1271

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

1272

"org.freedesktop.DBus.Property."

1273

"EmitsChangedSignal": "false"})

802

1274

803

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

1275

804

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

1276

808

def Property_dbus_property(self):

1277

809

return dbus.Boolean(False)

1278

1279

See also the DBusObjectWithAnnotations class.

1280

810

"""

1281

1282

811

def decorator(func):

1283

812

func._dbus_annotations = annotations

1284

813

return func

1285

1286

814

return decorator

1287

815

1288

816

1289

817

class DBusPropertyException(dbus.exceptions.DBusException):

1290

818

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

1291

819

"""

1292

pass

820

def __unicode__(self):

821

return unicode(str(self))

1293

822

1294

823

1295

824

class DBusPropertyAccessException(DBusPropertyException):

1304

833

pass

1305

834

1306

835

1307

class DBusObjectWithAnnotations(dbus.service.Object):

1308

"""A D-Bus object with annotations.

1309

1310

Classes inheriting from this can use the dbus_annotations

1311

decorator to add annotations to methods or signals.

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

838

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

1312

842

"""

1313

843

1314

844

@staticmethod

1315

845

def _is_dbus_thing(thing):

1316

846

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

1317

847

1318

848

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

1319

849

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

1320

850

"""

1321

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

851

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

1322

852

False)

1323

853

1324

854

def _get_all_dbus_things(self, thing):

1325

855

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

1326

856

"""

1327

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

857

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

858

name),

1328

859

athing.__get__(self))

1329

860

for cls in self.__class__.__mro__

1330

861

for name, athing in

1331

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

1332

1333

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1334

out_signature="s",

1335

path_keyword="object_path",

1336

connection_keyword="connection")

1337

def Introspect(self, object_path, connection):

1338

"""Overloading of standard D-Bus method.

1339

1340

Inserts annotation tags on methods and signals.

1341

"""

1342

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

1343

connection)

1344

try:

1345

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

1346

1347

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

1348

# Add annotation tags

1349

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

1350

for tag in if_tag.getElementsByTagName(typ):

1351

annots = dict()

1352

for name, prop in (self.

1353

_get_all_dbus_things(typ)):

1354

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

1355

and prop._dbus_interface

1356

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

1357

annots.update(getattr(

1358

prop, "_dbus_annotations", {}))

1359

for name, value in annots.items():

1360

ann_tag = document.createElement(

1361

"annotation")

1362

ann_tag.setAttribute("name", name)

1363

ann_tag.setAttribute("value", value)

1364

tag.appendChild(ann_tag)

1365

# Add interface annotation tags

1366

for annotation, value in dict(

1367

itertools.chain.from_iterable(

1368

annotations().items()

1369

for name, annotations

1370

in self._get_all_dbus_things("interface")

1371

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

1372

)).items():

1373

ann_tag = document.createElement("annotation")

1374

ann_tag.setAttribute("name", annotation)

1375

ann_tag.setAttribute("value", value)

1376

if_tag.appendChild(ann_tag)

1377

# Fix argument name for the Introspect method itself

1378

if (if_tag.getAttribute("name")

1379

== dbus.INTROSPECTABLE_IFACE):

1380

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

1381

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

1382

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

1383

if (arg.getAttribute("direction")

1384

== "out"):

1385

arg.setAttribute("name",

1386

"xml_data")

1387

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

1388

document.unlink()

1389

except (AttributeError, xml.dom.DOMException,

1390

xml.parsers.expat.ExpatError) as error:

1391

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

1392

exc_info=error)

1393

return xmlstring

1394

1395

1396

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1397

"""A D-Bus object with properties.

1398

1399

Classes inheriting from this can use the dbus_service_property

1400

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

1401

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

1402

"""

1403

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

864

1404

865

def _get_dbus_property(self, interface_name, property_name):

1405

866

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

1406

867

property with the specified name and interface.

1407

868

"""

1408

for cls in self.__class__.__mro__:

1409

for name, value in inspect.getmembers(

1410

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

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

1411

873

if (value._dbus_name == property_name

1412

874

and value._dbus_interface == interface_name):

1413

875

return value.__get__(self)

1414

876

1415

877

# No such property

1416

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

1417

self.dbus_object_path, interface_name, property_name))

1418

1419

@classmethod

1420

def _get_all_interface_names(cls):

1421

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

1422

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

1423

"_dbus_interface", None)

1424

for x in (inspect.getmro(cls))

1425

for attr in dir(x))

1426

if name is not None)

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="ss",

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

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

1430

883

out_signature="v")

1431

884

def Get(self, interface_name, property_name):

1432

885

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

1438

891

if not hasattr(value, "variant_level"):

1439

892

return value

1440

893

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

1441

894

1442

895

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

1443

896

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

1444

897

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

1450

903

# The byte_arrays option is not supported yet on

1451

904

# signatures other than "ay".

1452

905

if prop._dbus_signature != "ay":

1453

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

1454

"'ay' signature {!r}"

1455

.format(prop._dbus_signature))

1456

value = dbus.ByteArray(bytes(value))

906

raise ValueError

907

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

908

for byte in value))

1457

909

prop(value)

1458

1459

@dbus.service.method(dbus.PROPERTIES_IFACE,

1460

in_signature="s",

910

911

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

1461

912

out_signature="a{sv}")

1462

913

def GetAll(self, interface_name):

1463

914

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

1464

915

standard.

1465

916

1466

917

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

1467

918

"""

1468

919

properties = {}

1478

929

if not hasattr(value, "variant_level"):

1479

930

properties[name] = value

1480

931

continue

1481

properties[name] = type(value)(

1482

value, variant_level=value.variant_level + 1)

932

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

933

value.variant_level+1)

1483

934

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

1484

1485

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

1486

def PropertiesChanged(self, interface_name, changed_properties,

1487

invalidated_properties):

1488

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

1489

standard.

1490

"""

1491

pass

1492

935

1493

936

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1494

937

out_signature="s",

1495

path_keyword="object_path",

1496

connection_keyword="connection")

938

path_keyword='object_path',

939

connection_keyword='connection')

1497

940

def Introspect(self, object_path, connection):

1498

941

"""Overloading of standard D-Bus method.

1499

942

1500

943

Inserts property tags and interface annotation tags.

1501

944

"""

1502

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1503

object_path,

1504

connection)

945

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

946

connection)

1505

947

try:

1506

948

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

1507

1508

949

def make_tag(document, name, prop):

1509

950

e = document.createElement("property")

1510

951

e.setAttribute("name", name)

1511

952

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

1512

953

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

1513

954

return e

1514

1515

955

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

1516

956

# Add property tags

1517

957

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

1520

960

if prop._dbus_interface

1521

961

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

1522

962

if_tag.appendChild(tag)

1523

# Add annotation tags for properties

1524

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

1525

annots = dict()

1526

for name, prop in self._get_all_dbus_things(

1527

"property"):

1528

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

1529

and prop._dbus_interface

1530

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

1531

annots.update(getattr(

1532

prop, "_dbus_annotations", {}))

1533

for name, value in annots.items():

1534

ann_tag = document.createElement(

1535

"annotation")

1536

ann_tag.setAttribute("name", name)

1537

ann_tag.setAttribute("value", value)

1538

tag.appendChild(ann_tag)

963

# Add annotation tags

964

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

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

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

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_tag)

1539

994

# Add the names to the return values for the

1540

995

# "org.freedesktop.DBus.Properties" methods

1541

996

if (if_tag.getAttribute("name")

1555

1010

document.unlink()

1556

1011

except (AttributeError, xml.dom.DOMException,

1557

1012

xml.parsers.expat.ExpatError) as error:

1558

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

1559

exc_info=error)

1560

return xmlstring

1561

1562

1563

try:

1564

dbus.OBJECT_MANAGER_IFACE

1565

except AttributeError:

1566

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

1567

1568

1569

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1570

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

1571

1572

Classes inheriting from this exposes the standard

1573

GetManagedObjects call and the InterfacesAdded and

1574

InterfacesRemoved signals on the standard

1575

"org.freedesktop.DBus.ObjectManager" interface.

1576

1577

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

1578

manually.

1579

"""

1580

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1581

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

1582

def GetManagedObjects(self):

1583

"""This function must be overridden"""

1584

raise NotImplementedError()

1585

1586

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1587

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

1588

def InterfacesAdded(self, object_path, interfaces_and_properties):

1589

pass

1590

1591

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

1592

def InterfacesRemoved(self, object_path, interfaces):

1593

pass

1594

1595

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1596

out_signature="s",

1597

path_keyword="object_path",

1598

connection_keyword="connection")

1599

def Introspect(self, object_path, connection):

1600

"""Overloading of standard D-Bus method.

1601

1602

Override return argument name of GetManagedObjects to be

1603

"objpath_interfaces_and_properties"

1604

"""

1605

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1606

object_path,

1607

connection)

1608

try:

1609

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

1610

1611

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

1612

# Fix argument name for the GetManagedObjects method

1613

if (if_tag.getAttribute("name")

1614

== dbus.OBJECT_MANAGER_IFACE):

1615

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

1616

if (cn.getAttribute("name")

1617

== "GetManagedObjects"):

1618

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

1619

if (arg.getAttribute("direction")

1620

== "out"):

1621

arg.setAttribute(

1622

"name",

1623

"objpath_interfaces"

1624

"_and_properties")

1625

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

1626

document.unlink()

1627

except (AttributeError, xml.dom.DOMException,

1628

xml.parsers.expat.ExpatError) as error:

1629

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

1630

exc_info=error)

1631

return xmlstring

1632

1633

1634

def datetime_to_dbus(dt, variant_level=0):

1013

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

1014

exc_info=error)

1015

return xmlstring

1016

1017

1018

def datetime_to_dbus (dt, variant_level=0):

1635

1019

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

1636

1020

if dt is None:

1637

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

1638

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

1021

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1639

1024

1640

1025

1641

1026

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1643

1028

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

1644

1029

interface names according to the "alt_interface_names" mapping.

1645

1030

Usage:

1646

1647

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

1648

"net.example.AlternateInterface"})

1031

1032

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

1033

"net.example.AlternateInterface"})

1649

1034

class SampleDBusObject(dbus.service.Object):

1650

1035

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

1651

1036

def SampleDBusMethod():

1652

1037

pass

1653

1038

1654

1039

The above "SampleDBusMethod" on "SampleDBusObject" will be

1655

1040

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

1656

1041

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

1657

1042

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

1658

1043

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

1659

1044

1660

1045

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

1661

1046

(from DBusObjectWithProperties) and interfaces (from the

1662

1047

dbus_interface_annotations decorator).

1663

1048

"""

1664

1665

1049

def wrapper(cls):

1666

1050

for orig_interface_name, alt_interface_name in (

1667

alt_interface_names.items()):

1051

alt_interface_names.iteritems()):

1668

1052

attr = {}

1669

1053

interface_names = set()

1670

1054

# Go though all attributes of the class

1672

1056

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

1673

1057

# with the wrong interface name

1674

1058

if (not hasattr(attribute, "_dbus_interface")

1675

or not attribute._dbus_interface.startswith(

1676

orig_interface_name)):

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1677

1061

continue

1678

1062

# Create an alternate D-Bus interface name based on

1679

1063

# the current name

1680

alt_interface = attribute._dbus_interface.replace(

1681

orig_interface_name, alt_interface_name)

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1682

1067

interface_names.add(alt_interface)

1683

1068

# Is this a D-Bus signal?

1684

1069

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

1685

# Extract the original non-method undecorated

1686

# function by black magic

1687

if sys.version_info.major == 2:

1688

nonmethod_func = (dict(

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1689

1073

zip(attribute.func_code.co_freevars,

1690

attribute.__closure__))

1691

["func"].cell_contents)

1692

else:

1693

nonmethod_func = (dict(

1694

zip(attribute.__code__.co_freevars,

1695

attribute.__closure__))

1696

["func"].cell_contents)

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1697

1076

# Create a new, but exactly alike, function

1698

1077

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

1699

1078

# with the alternate D-Bus interface name

1700

new_function = copy_function(nonmethod_func)

1701

new_function = (dbus.service.signal(

1702

alt_interface,

1703

attribute._dbus_signature)(new_function))

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

1704

1088

# Copy annotations, if any

1705

1089

try:

1706

new_function._dbus_annotations = dict(

1707

attribute._dbus_annotations)

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1708

1092

except AttributeError:

1709

1093

pass

1710

1711

1094

# Define a creator of a function to call both the

1712

1095

# original and alternate functions, so both the

1713

1096

# original and alternate signals gets sent when

1716

1099

"""This function is a scope container to pass

1717

1100

func1 and func2 to the "call_both" function

1718

1101

outside of its arguments"""

1719

1720

@functools.wraps(func2)

1721

1102

def call_both(*args, **kwargs):

1722

1103

"""This function will emit two D-Bus

1723

1104

signals by calling func1 and func2"""

1724

1105

func1(*args, **kwargs)

1725

1106

func2(*args, **kwargs)

1726

# Make wrapper function look like a D-Bus

1727

# signal

1728

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

1729

if name.startswith("_dbus_"):

1730

setattr(call_both, name, attr)

1731

1732

1107

return call_both

1733

1108

# Create the "call_both" function and add it to

1734

1109

# the class

1739

1114

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

1740

1115

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

1741

1116

# to the class.

1742

attr[attrname] = (

1743

dbus.service.method(

1744

alt_interface,

1745

attribute._dbus_in_signature,

1746

attribute._dbus_out_signature)

1747

(copy_function(attribute)))

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1748

1127

# Copy annotations, if any

1749

1128

try:

1750

attr[attrname]._dbus_annotations = dict(

1751

attribute._dbus_annotations)

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1752

1131

except AttributeError:

1753

1132

pass

1754

1133

# Is this a D-Bus property?

1757

1136

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

1758

1137

# property with the alternate D-Bus interface

1759

1138

# name. Add it to the class.

1760

attr[attrname] = (dbus_service_property(

1761

alt_interface, attribute._dbus_signature,

1762

attribute._dbus_access,

1763

attribute._dbus_get_args_options

1764

["byte_arrays"])

1765

(copy_function(attribute)))

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1766

1152

# Copy annotations, if any

1767

1153

try:

1768

attr[attrname]._dbus_annotations = dict(

1769

attribute._dbus_annotations)

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1770

1156

except AttributeError:

1771

1157

pass

1772

1158

# Is this a D-Bus interface?

1775

1161

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

1776

1162

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

1777

1163

# to the class.

1778

attr[attrname] = (

1779

dbus_interface_annotations(alt_interface)

1780

(copy_function(attribute)))

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1781

1172

if deprecate:

1782

1173

# Deprecate all alternate interfaces

1783

iname = "_AlternateDBusNames_interface_annotation{}"

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1784

1175

for interface_name in interface_names:

1785

1786

1176

@dbus_interface_annotations(interface_name)

1787

1177

def func(self):

1788

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

1789

"true"}

1178

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

1179

"true" }

1790

1180

# Find an unused name

1791

1181

for aname in (iname.format(i)

1792

1182

for i in itertools.count()):

1796

1186

if interface_names:

1797

1187

# Replace the class with a new subclass of it with

1798

1188

# methods, signals, etc. as created above.

1799

if sys.version_info.major == 2:

1800

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

1801

(cls, ), attr)

1802

else:

1803

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

1804

(cls, ), attr)

1189

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

1190

(cls,), attr)

1805

1191

return cls

1806

1807

1192

return wrapper

1808

1193

1809

1194

1810

1195

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

1811

"se.bsnet.fukt.Mandos"})

1196

"se.bsnet.fukt.Mandos"})

1812

1197

class ClientDBus(Client, DBusObjectWithProperties):

1813

1198

"""A Client class using D-Bus

1814

1199

1815

1200

Attributes:

1816

1201

dbus_object_path: dbus.ObjectPath

1817

1202

bus: dbus.SystemBus()

1818

1203

"""

1819

1204

1820

1205

runtime_expansions = (Client.runtime_expansions

1821

+ ("dbus_object_path", ))

1822

1823

_interface = "se.recompile.Mandos.Client"

1824

1206

+ ("dbus_object_path",))

1207

1825

1208

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

1826

1827

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

1209

1210

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

1828

1211

self.bus = bus

1829

1212

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

1830

1213

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

1831

1214

# the D-Bus

1832

client_object_name = str(self.name).translate(

1215

client_object_name = unicode(self.name).translate(

1833

1216

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

1834

1217

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

1835

self.dbus_object_path = dbus.ObjectPath(

1836

"/clients/" + client_object_name)

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1837

1220

DBusObjectWithProperties.__init__(self, self.bus,

1838

1221

self.dbus_object_path)

1839

1840

def notifychangeproperty(transform_func, dbus_name,

1841

type_func=lambda x: x,

1842

variant_level=1,

1843

invalidate_only=False,

1844

_interface=_interface):

1222

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1845

1226

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

1846

1227

its changes to DBus.

1847

1228

1848

1229

transform_fun: Function that takes a value and a variant_level

1849

1230

and transforms it to a D-Bus type.

1850

1231

dbus_name: D-Bus name of the variable

1852

1233

to the D-Bus. Default: no transform

1853

1234

variant_level: D-Bus variant level. Default: 1

1854

1235

"""

1855

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

1856

1236

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

1857

1237

def setter(self, value):

1858

1238

if hasattr(self, "dbus_object_path"):

1859

1239

if (not hasattr(self, attrname) or

1860

1240

type_func(getattr(self, attrname, None))

1861

1241

!= type_func(value)):

1862

if invalidate_only:

1863

self.PropertiesChanged(

1864

_interface, dbus.Dictionary(),

1865

dbus.Array((dbus_name, )))

1866

else:

1867

dbus_value = transform_func(

1868

type_func(value),

1869

variant_level=variant_level)

1870

self.PropertyChanged(dbus.String(dbus_name),

1871

dbus_value)

1872

self.PropertiesChanged(

1873

_interface,

1874

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

1875

dbus_value}),

1876

dbus.Array())

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1877

1247

setattr(self, attrname, value)

1878

1248

1879

1249

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

1880

1250

1881

1251

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1882

1252

approvals_pending = notifychangeproperty(dbus.Boolean,

1883

1253

"ApprovalPending",

1884

type_func=bool)

1254

type_func = bool)

1885

1255

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

1886

1256

last_enabled = notifychangeproperty(datetime_to_dbus,

1887

1257

"LastEnabled")

1888

checker = notifychangeproperty(

1889

dbus.Boolean, "CheckerRunning",

1890

type_func=lambda checker: checker is not None)

1258

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

1259

type_func = lambda checker:

1260

checker is not None)

1891

1261

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1892

1262

"LastCheckedOK")

1893

1263

last_checker_status = notifychangeproperty(dbus.Int16,

1896

1266

datetime_to_dbus, "LastApprovalRequest")

1897

1267

approved_by_default = notifychangeproperty(dbus.Boolean,

1898

1268

"ApprovedByDefault")

1899

approval_delay = notifychangeproperty(

1900

dbus.UInt64, "ApprovalDelay",

1901

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

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1902

1273

approval_duration = notifychangeproperty(

1903

1274

dbus.UInt64, "ApprovalDuration",

1904

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

1275

type_func = timedelta_to_milliseconds)

1905

1276

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

1906

timeout = notifychangeproperty(

1907

dbus.UInt64, "Timeout",

1908

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

1277

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

1278

type_func =

1279

timedelta_to_milliseconds)

1909

1280

extended_timeout = notifychangeproperty(

1910

1281

dbus.UInt64, "ExtendedTimeout",

1911

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

1912

interval = notifychangeproperty(

1913

dbus.UInt64, "Interval",

1914

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

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1915

1287

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

1916

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

1917

invalidate_only=True)

1918

1288

1919

1289

del notifychangeproperty

1920

1290

1921

1291

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

1922

1292

try:

1923

1293

self.remove_from_connection()

1926

1296

if hasattr(DBusObjectWithProperties, "__del__"):

1927

1297

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

1928

1298

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

1929

1930

def checker_callback(self, source, condition,

1931

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

1932

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

1933

connection, command, *args,

1934

**kwargs)

1935

exitstatus = self.last_checker_status

1936

if exitstatus >= 0:

1299

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1937

1306

# Emit D-Bus signal

1938

1307

self.CheckerCompleted(dbus.Int16(exitstatus),

1939

# This is specific to GNU libC

1940

dbus.Int64(exitstatus << 8),

1308

dbus.Int64(condition),

1941

1309

dbus.String(command))

1942

1310

else:

1943

1311

# Emit D-Bus signal

1944

1312

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

1945

dbus.Int64(

1946

# This is specific to GNU libC

1947

(exitstatus << 8)

1948

| self.last_checker_signal),

1313

dbus.Int64(condition),

1949

1314

dbus.String(command))

1950

return ret

1951

1315

1316

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

1317

*args, **kwargs)

1318

1952

1319

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

1953

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1954

1325

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

1955

1326

# Only if new checker process was started

1956

1327

if (self.checker is not None

1958

1329

# Emit D-Bus signal

1959

1330

self.CheckerStarted(self.current_checker_command)

1960

1331

return r

1961

1332

1962

1333

def _reset_approved(self):

1963

1334

self.approved = None

1964

1335

return False

1965

1336

1966

1337

def approve(self, value=True):

1338

self.send_changedstate()

1967

1339

self.approved = value

1968

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

1969

* 1000), self._reset_approved)

1970

self.send_changedstate()

1971

1972

# D-Bus methods, signals & properties

1973

1974

# Interfaces

1975

1976

# Signals

1977

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1343

1344

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

## Signals

1355

1978

1356

# CheckerCompleted - signal

1979

1357

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

1980

1358

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

1981

1359

"D-Bus signal"

1982

1360

pass

1983

1361

1984

1362

# CheckerStarted - signal

1985

1363

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

1986

1364

def CheckerStarted(self, command):

1987

1365

"D-Bus signal"

1988

1366

pass

1989

1367

1990

1368

# PropertyChanged - signal

1991

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

1992

1369

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

1993

1370

def PropertyChanged(self, property, value):

1994

1371

"D-Bus signal"

1995

1372

pass

1996

1373

1997

1374

# GotSecret - signal

1998

1375

@dbus.service.signal(_interface)

1999

1376

def GotSecret(self):

2002

1379

server to mandos-client

2003

1380

"""

2004

1381

pass

2005

1382

2006

1383

# Rejected - signal

2007

1384

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

2008

1385

def Rejected(self, reason):

2009

1386

"D-Bus signal"

2010

1387

pass

2011

1388

2012

1389

# NeedApproval - signal

2013

1390

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

2014

1391

def NeedApproval(self, timeout, default):

2015

1392

"D-Bus signal"

2016

1393

return self.need_approval()

2017

2018

# Methods

2019

1394

1395

## Methods

1396

2020

1397

# Approve - method

2021

1398

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

2022

1399

def Approve(self, value):

2023

1400

self.approve(value)

2024

1401

2025

1402

# CheckedOK - method

2026

1403

@dbus.service.method(_interface)

2027

1404

def CheckedOK(self):

2028

1405

self.checked_ok()

2029

1406

2030

1407

# Enable - method

2031

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

2032

1408

@dbus.service.method(_interface)

2033

1409

def Enable(self):

2034

1410

"D-Bus method"

2035

1411

self.enable()

2036

1412

2037

1413

# StartChecker - method

2038

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

2039

1414

@dbus.service.method(_interface)

2040

1415

def StartChecker(self):

2041

1416

"D-Bus method"

2042

1417

self.start_checker()

2043

1418

2044

1419

# Disable - method

2045

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

2046

1420

@dbus.service.method(_interface)

2047

1421

def Disable(self):

2048

1422

"D-Bus method"

2049

1423

self.disable()

2050

1424

2051

1425

# StopChecker - method

2052

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

2053

1426

@dbus.service.method(_interface)

2054

1427

def StopChecker(self):

2055

1428

self.stop_checker()

2056

2057

# Properties

2058

1429

1430

## Properties

1431

2059

1432

# ApprovalPending - property

2060

1433

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

2061

1434

def ApprovalPending_dbus_property(self):

2062

1435

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

2063

1436

2064

1437

# ApprovedByDefault - property

2065

@dbus_service_property(_interface,

2066

signature="b",

1438

@dbus_service_property(_interface, signature="b",

2067

1439

access="readwrite")

2068

1440

def ApprovedByDefault_dbus_property(self, value=None):

2069

1441

if value is None: # get

2070

1442

return dbus.Boolean(self.approved_by_default)

2071

1443

self.approved_by_default = bool(value)

2072

1444

2073

1445

# ApprovalDelay - property

2074

@dbus_service_property(_interface,

2075

signature="t",

1446

@dbus_service_property(_interface, signature="t",

2076

1447

access="readwrite")

2077

1448

def ApprovalDelay_dbus_property(self, value=None):

2078

1449

if value is None: # get

2079

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

2080

* 1000)

1450

return dbus.UInt64(self.approval_delay_milliseconds())

2081

1451

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

2082

1452

2083

1453

# ApprovalDuration - property

2084

@dbus_service_property(_interface,

2085

signature="t",

1454

@dbus_service_property(_interface, signature="t",

2086

1455

access="readwrite")

2087

1456

def ApprovalDuration_dbus_property(self, value=None):

2088

1457

if value is None: # get

2089

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

2090

* 1000)

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

2091

1460

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

2092

1461

2093

1462

# Name - property

2094

@dbus_annotations(

2095

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

2096

1463

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

2097

1464

def Name_dbus_property(self):

2098

1465

return dbus.String(self.name)

2099

2100

# KeyID - property

2101

@dbus_annotations(

2102

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

2103

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

2104

def KeyID_dbus_property(self):

2105

return dbus.String(self.key_id)

2106

1466

2107

1467

# Fingerprint - property

2108

@dbus_annotations(

2109

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

2110

1468

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

2111

1469

def Fingerprint_dbus_property(self):

2112

1470

return dbus.String(self.fingerprint)

2113

1471

2114

1472

# Host - property

2115

@dbus_service_property(_interface,

2116

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2117

1474

access="readwrite")

2118

1475

def Host_dbus_property(self, value=None):

2119

1476

if value is None: # get

2120

1477

return dbus.String(self.host)

2121

self.host = str(value)

2122

1478

self.host = unicode(value)

1479

2123

1480

# Created - property

2124

@dbus_annotations(

2125

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

2126

1481

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

2127

1482

def Created_dbus_property(self):

2128

1483

return datetime_to_dbus(self.created)

2129

1484

2130

1485

# LastEnabled - property

2131

1486

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

2132

1487

def LastEnabled_dbus_property(self):

2133

1488

return datetime_to_dbus(self.last_enabled)

2134

1489

2135

1490

# Enabled - property

2136

@dbus_service_property(_interface,

2137

signature="b",

1491

@dbus_service_property(_interface, signature="b",

2138

1492

access="readwrite")

2139

1493

def Enabled_dbus_property(self, value=None):

2140

1494

if value is None: # get

2143

1497

self.enable()

2144

1498

else:

2145

1499

self.disable()

2146

1500

2147

1501

# LastCheckedOK - property

2148

@dbus_service_property(_interface,

2149

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2150

1503

access="readwrite")

2151

1504

def LastCheckedOK_dbus_property(self, value=None):

2152

1505

if value is not None:

2153

1506

self.checked_ok()

2154

1507

return

2155

1508

return datetime_to_dbus(self.last_checked_ok)

2156

1509

2157

1510

# LastCheckerStatus - property

2158

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

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

2159

1513

def LastCheckerStatus_dbus_property(self):

2160

1514

return dbus.Int16(self.last_checker_status)

2161

1515

2162

1516

# Expires - property

2163

1517

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

2164

1518

def Expires_dbus_property(self):

2165

1519

return datetime_to_dbus(self.expires)

2166

1520

2167

1521

# LastApprovalRequest - property

2168

1522

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

2169

1523

def LastApprovalRequest_dbus_property(self):

2170

1524

return datetime_to_dbus(self.last_approval_request)

2171

1525

2172

1526

# Timeout - property

2173

@dbus_service_property(_interface,

2174

signature="t",

1527

@dbus_service_property(_interface, signature="t",

2175

1528

access="readwrite")

2176

1529

def Timeout_dbus_property(self, value=None):

2177

1530

if value is None: # get

2178

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

2179

old_timeout = self.timeout

1531

return dbus.UInt64(self.timeout_milliseconds())

2180

1532

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

2181

# Reschedule disabling

1533

# Reschedule timeout

2182

1534

if self.enabled:

2183

1535

now = datetime.datetime.utcnow()

2184

self.expires += self.timeout - old_timeout

2185

if self.expires <= now:

1536

time_to_die = timedelta_to_milliseconds(

1537

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

1538

if time_to_die <= 0:

2186

1539

# The timeout has passed

2187

1540

self.disable()

2188

1541

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

2189

1545

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

2190

1546

is None):

2191

1547

return

2192

GLib.source_remove(self.disable_initiator_tag)

2193

self.disable_initiator_tag = GLib.timeout_add(

2194

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

2195

self.disable)

2196

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1552

2197

1553

# ExtendedTimeout - property

2198

@dbus_service_property(_interface,

2199

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2200

1555

access="readwrite")

2201

1556

def ExtendedTimeout_dbus_property(self, value=None):

2202

1557

if value is None: # get

2203

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

2204

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2205

1559

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

2206

1560

2207

1561

# Interval - property

2208

@dbus_service_property(_interface,

2209

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2210

1563

access="readwrite")

2211

1564

def Interval_dbus_property(self, value=None):

2212

1565

if value is None: # get

2213

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

1566

return dbus.UInt64(self.interval_milliseconds())

2214

1567

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

2215

1568

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

2216

1569

return

2217

1570

if self.enabled:

2218

1571

# Reschedule checker run

2219

GLib.source_remove(self.checker_initiator_tag)

2220

self.checker_initiator_tag = GLib.timeout_add(

2221

value, self.start_checker)

2222

self.start_checker() # Start one now, too

2223

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2224

1577

# Checker - property

2225

@dbus_service_property(_interface,

2226

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2227

1579

access="readwrite")

2228

1580

def Checker_dbus_property(self, value=None):

2229

1581

if value is None: # get

2230

1582

return dbus.String(self.checker_command)

2231

self.checker_command = str(value)

2232

1583

self.checker_command = unicode(value)

1584

2233

1585

# CheckerRunning - property

2234

@dbus_service_property(_interface,

2235

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2236

1587

access="readwrite")

2237

1588

def CheckerRunning_dbus_property(self, value=None):

2238

1589

if value is None: # get

2241

1592

self.start_checker()

2242

1593

else:

2243

1594

self.stop_checker()

2244

1595

2245

1596

# ObjectPath - property

2246

@dbus_annotations(

2247

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

2248

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

2249

1597

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

2250

1598

def ObjectPath_dbus_property(self):

2251

return self.dbus_object_path # is already a dbus.ObjectPath

2252

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2253

1601

# Secret = property

2254

@dbus_annotations(

2255

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

2256

"invalidates"})

2257

@dbus_service_property(_interface,

2258

signature="ay",

2259

access="write",

2260

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2261

1604

def Secret_dbus_property(self, value):

2262

self.secret = bytes(value)

2263

1605

self.secret = str(value)

1606

2264

1607

del _interface

2265

1608

2266

1609

2267

class ProxyClient:

2268

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

1610

class ProxyClient(object):

1611

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

2269

1612

self._pipe = child_pipe

2270

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

1613

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

2271

1614

if not self._pipe.recv():

2272

raise KeyError(key_id or fpr)

2273

1615

raise KeyError()

1616

2274

1617

def __getattribute__(self, name):

2275

if name == "_pipe":

1618

if name == '_pipe':

2276

1619

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

2277

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

1620

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

2278

1621

data = self._pipe.recv()

2279

if data[0] == "data":

1622

if data[0] == 'data':

2280

1623

return data[1]

2281

if data[0] == "function":

2282

1624

if data[0] == 'function':

2283

1625

def func(*args, **kwargs):

2284

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

1626

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

2285

1627

return self._pipe.recv()[1]

2286

2287

1628

return func

2288

1629

2289

1630

def __setattr__(self, name, value):

2290

if name == "_pipe":

1631

if name == '_pipe':

2291

1632

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

2292

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

1633

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

2293

1634

2294

1635

2295

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2296

1637

"""A class to handle client connections.

2297

1638

2298

1639

Instantiated once for each connection to handle it.

2299

1640

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

2300

1641

2301

1642

def handle(self):

2302

1643

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

2303

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

2304

str(self.client_address))

2305

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

2306

2307

session = gnutls.ClientSession(self.request)

2308

2309

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

2310

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

2311

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

2312

# "+DHE-DSS"))

1644

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

1645

unicode(self.client_address))

1646

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

1647

self.server.child_pipe.fileno())

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2313

1663

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

2314

1664

priority = self.server.gnutls_priority

2315

1665

if priority is None:

2316

1666

priority = "NORMAL"

2317

gnutls.priority_set_direct(session,

2318

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

2319

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2320

1671

# Start communication using the Mandos protocol

2321

1672

# Get protocol number

2322

1673

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

2323

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

1674

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

2324

1675

try:

2325

1676

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

2326

raise RuntimeError(line)

1677

raise RuntimeError

2327

1678

except (ValueError, IndexError, RuntimeError) as error:

2328

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

1679

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

2329

1680

return

2330

1681

2331

1682

# Start GnuTLS connection

2332

1683

try:

2333

1684

session.handshake()

2334

except gnutls.Error as error:

2335

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

1685

except gnutls.errors.GNUTLSError as error:

1686

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

2336

1687

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

2337

1688

# established. Just abandon the request.

2338

1689

return

2339

log.debug("Handshake succeeded")

2340

1690

logger.debug("Handshake succeeded")

1691

2341

1692

approval_required = False

2342

1693

try:

2343

if gnutls.has_rawpk:

2344

fpr = b""

2345

try:

2346

key_id = self.key_id(

2347

self.peer_certificate(session))

2348

except (TypeError, gnutls.Error) as error:

2349

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

2350

return

2351

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

2352

key_id.decode("utf-8",

2353

errors="replace"))

2354

2355

else:

2356

key_id = b""

2357

try:

2358

fpr = self.fingerprint(

2359

self.peer_certificate(session))

2360

except (TypeError, gnutls.Error) as error:

2361

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

2362

return

2363

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

2364

2365

try:

2366

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2367

1705

self.client_address)

2368

1706

except KeyError:

2369

1707

return

2370

1708

2371

1709

if client.approval_delay:

2372

1710

delay = client.approval_delay

2373

1711

client.approvals_pending += 1

2374

1712

approval_required = True

2375

1713

2376

1714

while True:

2377

1715

if not client.enabled:

2378

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

1716

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

1717

client.name)

2379

1718

if self.server.use_dbus:

2380

1719

# Emit D-Bus signal

2381

1720

client.Rejected("Disabled")

2382

1721

return

2383

1722

2384

1723

if client.approved or not client.approval_delay:

2385

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2386

1725

break

2387

1726

elif client.approved is None:

2388

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

2389

client.name)

1727

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

1728

client.name)

2390

1729

if self.server.use_dbus:

2391

1730

# Emit D-Bus signal

2392

1731

client.NeedApproval(

2393

client.approval_delay.total_seconds()

2394

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2395

1734

else:

2396

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

2397

client.name)

1735

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

1736

client.name)

2398

1737

if self.server.use_dbus:

2399

1738

# Emit D-Bus signal

2400

1739

client.Rejected("Denied")

2401

1740

return

2402

2403

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2404

1743

time = datetime.datetime.now()

2405

1744

client.changedstate.acquire()

2406

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

1745

(client.changedstate.wait

1746

(float(client.timedelta_to_milliseconds(delay)

1747

/ 1000)))

2407

1748

client.changedstate.release()

2408

1749

time2 = datetime.datetime.now()

2409

1750

if (time2 - time) >= delay:

2410

1751

if not client.approved_by_default:

2411

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

2412

" waiting for approval",

2413

client.name)

1752

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

1753

" waiting for approval",

1754

client.name)

2414

1755

if self.server.use_dbus:

2415

1756

# Emit D-Bus signal

2416

1757

client.Rejected("Approval timed out")

2419

1760

break

2420

1761

else:

2421

1762

delay -= time2 - time

2422

2423

try:

2424

session.send(client.secret)

2425

except gnutls.Error as error:

2426

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

2427

return

2428

2429

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

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

1777

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

2430

1778

# bump the timeout using extended_timeout

2431

1779

client.bump_timeout(client.extended_timeout)

2432

1780

if self.server.use_dbus:

2433

1781

# Emit D-Bus signal

2434

1782

client.GotSecret()

2435

1783

2436

1784

finally:

2437

1785

if approval_required:

2438

1786

client.approvals_pending -= 1

2439

1787

try:

2440

1788

session.bye()

2441

except gnutls.Error as error:

2442

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

2443

1789

except gnutls.errors.GNUTLSError as error:

1790

logger.warning("GnuTLS bye failed",

1791

exc_info=error)

1792

2444

1793

@staticmethod

2445

1794

def peer_certificate(session):

2446

"Return the peer's certificate as a bytestring"

2447

try:

2448

cert_type = gnutls.certificate_type_get2(

2449

session, gnutls.CTYPE_PEERS)

2450

except AttributeError:

2451

cert_type = gnutls.certificate_type_get(session)

2452

if gnutls.has_rawpk:

2453

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2454

else:

2455

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2456

# If not a valid certificate type...

2457

if cert_type not in valid_cert_types:

2458

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

2459

valid_cert_types)

2460

# ...return invalid data

2461

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2462

1802

list_size = ctypes.c_uint(1)

2463

cert_list = (gnutls.certificate_get_peers

2464

(session, ctypes.byref(list_size)))

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

1805

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

2465

1806

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

2466

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

1807

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

1808

" certificate")

2467

1809

if list_size.value == 0:

2468

1810

return None

2469

1811

cert = cert_list[0]

2470

1812

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

2471

2472

@staticmethod

2473

def key_id(certificate):

2474

"Convert a certificate bytestring to a hexdigit key ID"

2475

# New GnuTLS "datum" with the public key

2476

datum = gnutls.datum_t(

2477

ctypes.cast(ctypes.c_char_p(certificate),

2478

ctypes.POINTER(ctypes.c_ubyte)),

2479

ctypes.c_uint(len(certificate)))

2480

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

2481

# New empty GnuTLS certificate

2482

pubkey = gnutls.pubkey_t()

2483

gnutls.pubkey_init(ctypes.byref(pubkey))

2484

# Import the raw public key into the certificate

2485

gnutls.pubkey_import(pubkey,

2486

ctypes.byref(datum),

2487

gnutls.X509_FMT_DER)

2488

# New buffer for the key ID

2489

buf = ctypes.create_string_buffer(32)

2490

buf_len = ctypes.c_size_t(len(buf))

2491

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

2492

gnutls.pubkey_get_key_id(

2493

pubkey,

2494

gnutls.KEYID_USE_SHA256,

2495

ctypes.cast(ctypes.byref(buf),

2496

ctypes.POINTER(ctypes.c_ubyte)),

2497

ctypes.byref(buf_len))

2498

# Deinit the certificate

2499

gnutls.pubkey_deinit(pubkey)

2500

2501

# Convert the buffer to a Python bytestring

2502

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

2503

# Convert the bytestring to hexadecimal notation

2504

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

2505

return hex_key_id

2506

1813

2507

1814

@staticmethod

2508

1815

def fingerprint(openpgp):

2509

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2510

1817

# New GnuTLS "datum" with the OpenPGP public key

2511

datum = gnutls.datum_t(

2512

ctypes.cast(ctypes.c_char_p(openpgp),

2513

ctypes.POINTER(ctypes.c_ubyte)),

2514

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2515

1823

# New empty GnuTLS certificate

2516

crt = gnutls.openpgp_crt_t()

2517

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2518

1827

# Import the OpenPGP public key into the certificate

2519

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

2520

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2521

1832

# Verify the self signature in the key

2522

1833

crtverify = ctypes.c_uint()

2523

gnutls.openpgp_crt_verify_self(crt, 0,

2524

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2525

1837

if crtverify.value != 0:

2526

gnutls.openpgp_crt_deinit(crt)

2527

raise gnutls.CertificateSecurityError(code

2528

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2529

1841

# New buffer for the fingerprint

2530

1842

buf = ctypes.create_string_buffer(20)

2531

1843

buf_len = ctypes.c_size_t()

2532

1844

# Get the fingerprint from the certificate into the buffer

2533

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

2534

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2535

1848

# Deinit the certificate

2536

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2537

1850

# Convert the buffer to a Python bytestring

2538

1851

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

2539

1852

# Convert the bytestring to hexadecimal notation

2541

1854

return hex_fpr

2542

1855

2543

1856

2544

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2545

1858

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

2546

2547

1859

def sub_process_main(self, request, address):

2548

1860

try:

2549

1861

self.finish_request(request, address)

2550

1862

except Exception:

2551

1863

self.handle_error(request, address)

2552

1864

self.close_request(request)

2553

1865

2554

1866

def process_request(self, request, address):

2555

1867

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

2556

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

2557

args=(request, address))

1868

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

1869

args = (request, address))

2558

1870

proc.start()

2559

1871

return proc

2560

1872

2561

1873

2562

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2563

1875

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

2564

2565

1876

def process_request(self, request, client_address):

2566

1877

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

2567

1878

2568

1879

This function creates a new pipe in self.pipe

2569

1880

"""

2570

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2571

1882

2572

1883

proc = MultiprocessingMixIn.process_request(self, request,

2573

1884

client_address)

2574

1885

self.child_pipe.close()

2575

1886

self.add_pipe(parent_pipe, proc)

2576

1887

2577

1888

def add_pipe(self, parent_pipe, proc):

2578

1889

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

2579

raise NotImplementedError()

1890

raise NotImplementedError

2580

1891

2581

1892

2582

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2583

socketserver.TCPServer):

2584

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

2585

1894

socketserver.TCPServer, object):

1895

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

1896

2586

1897

Attributes:

2587

1898

enabled: Boolean; whether this server is activated yet

2588

1899

interface: None or a network interface name (string)

2589

1900

use_ipv6: Boolean; to use IPv6 or not

2590

1901

"""

2591

2592

1902

def __init__(self, server_address, RequestHandlerClass,

2593

interface=None,

2594

use_ipv6=True,

2595

socketfd=None):

2596

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

2597

creating a new one with socket.socket().

2598

"""

1903

interface=None, use_ipv6=True):

2599

1904

self.interface = interface

2600

1905

if use_ipv6:

2601

1906

self.address_family = socket.AF_INET6

2602

if socketfd is not None:

2603

# Save the file descriptor

2604

self.socketfd = socketfd

2605

# Save the original socket.socket() function

2606

self.socket_socket = socket.socket

2607

2608

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

2609

#

2610

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

2611

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

2612

# patching socket.socket.)

2613

#

2614

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

2615

@functools.wraps(socket.socket)

2616

def socket_wrapper(*args, **kwargs):

2617

# Restore original function so subsequent calls are

2618

# not affected.

2619

socket.socket = self.socket_socket

2620

del self.socket_socket

2621

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

2622

# saved file descriptor.

2623

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

2624

# Replace socket.socket() function with wrapper

2625

socket.socket = socket_wrapper

2626

# The socketserver.TCPServer.__init__ will call

2627

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

2628

# socket_wrapper(), if socketfd was set.

2629

1907

socketserver.TCPServer.__init__(self, server_address,

2630

1908

RequestHandlerClass)

2631

2632

1909

def server_bind(self):

2633

1910

"""This overrides the normal server_bind() function

2634

1911

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

2635

1912

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

2636

global SO_BINDTODEVICE

2637

1913

if self.interface is not None:

2638

1914

if SO_BINDTODEVICE is None:

2639

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

2640

# common enough.

2641

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

2642

SO_BINDTODEVICE = 25

2643

try:

2644

self.socket.setsockopt(

2645

socket.SOL_SOCKET, SO_BINDTODEVICE,

2646

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

2647

except socket.error as error:

2648

if error.errno == errno.EPERM:

2649

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

2650

self.interface)

2651

elif error.errno == errno.ENOPROTOOPT:

2652

log.error("SO_BINDTODEVICE not available; cannot"

2653

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

2654

elif error.errno == errno.ENODEV:

2655

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

2656

" bind", self.interface)

2657

else:

2658

raise

1915

logger.error("SO_BINDTODEVICE does not exist;"

1916

" cannot bind to interface %s",

1917

self.interface)

1918

else:

1919

try:

1920

self.socket.setsockopt(socket.SOL_SOCKET,

1921

SO_BINDTODEVICE,

1922

str(self.interface

1923

+ '\0'))

1924

except socket.error as error:

1925

if error[0] == errno.EPERM:

1926

logger.error("No permission to"

1927

" bind to interface %s",

1928

self.interface)

1929

elif error[0] == errno.ENOPROTOOPT:

1930

logger.error("SO_BINDTODEVICE not available;"

1931

" cannot bind to interface %s",

1932

self.interface)

1933

else:

1934

raise

2659

1935

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

2660

1936

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

2661

if self.server_address[1]:

2662

self.allow_reuse_address = True

2663

1937

if not self.server_address[0]:

2664

1938

if self.address_family == socket.AF_INET6:

2665

any_address = "::" # in6addr_any

1939

any_address = "::" # in6addr_any

2666

1940

else:

2667

any_address = "0.0.0.0" # INADDR_ANY

1941

any_address = socket.INADDR_ANY

2668

1942

self.server_address = (any_address,

2669

1943

self.server_address[1])

2670

1944

elif not self.server_address[1]:

2671

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

1945

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

1946

0)

2672

1947

# if self.interface:

2673

1948

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

2674

1949

# 0, # port

2680

1955

2681

1956

class MandosServer(IPv6_TCPServer):

2682

1957

"""Mandos server.

2683

1958

2684

1959

Attributes:

2685

1960

clients: set of Client objects

2686

1961

gnutls_priority GnuTLS priority string

2687

1962

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

2688

2689

Assumes a GLib.MainLoop event loop.

1963

1964

Assumes a gobject.MainLoop event loop.

2690

1965

"""

2691

2692

1966

def __init__(self, server_address, RequestHandlerClass,

2693

interface=None,

2694

use_ipv6=True,

2695

clients=None,

2696

gnutls_priority=None,

2697

use_dbus=True,

2698

socketfd=None):

1967

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

1968

gnutls_priority=None, use_dbus=True):

2699

1969

self.enabled = False

2700

1970

self.clients = clients

2701

1971

if self.clients is None:

2704

1974

self.gnutls_priority = gnutls_priority

2705

1975

IPv6_TCPServer.__init__(self, server_address,

2706

1976

RequestHandlerClass,

2707

interface=interface,

2708

use_ipv6=use_ipv6,

2709

socketfd=socketfd)

2710

1977

interface = interface,

1978

use_ipv6 = use_ipv6)

2711

1979

def server_activate(self):

2712

1980

if self.enabled:

2713

1981

return socketserver.TCPServer.server_activate(self)

2714

1982

2715

1983

def enable(self):

2716

1984

self.enabled = True

2717

1985

2718

1986

def add_pipe(self, parent_pipe, proc):

2719

1987

# Call "handle_ipc" for both data and EOF events

2720

GLib.io_add_watch(

2721

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

2722

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

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc))

2726

2727

def handle_ipc(self, source, condition,

2728

parent_pipe=None,

2729

proc=None,

2730

client_object=None):

1988

gobject.io_add_watch(parent_pipe.fileno(),

1989

gobject.IO_IN | gobject.IO_HUP,

1990

functools.partial(self.handle_ipc,

1991

parent_pipe =

1992

parent_pipe,

1993

proc = proc))

1994

1995

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

1996

proc = None, client_object=None):

2731

1997

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

2732

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

1998

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

2733

1999

# Wait for other process to exit

2734

2000

proc.join()

2735

2001

return False

2736

2002

2737

2003

# Read a request from the child

2738

2004

request = parent_pipe.recv()

2739

2005

command = request[0]

2740

2741

if command == "init":

2742

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

2743

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

2744

address = request[3]

2745

2746

for c in self.clients.values():

2747

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2748

"27AE41E4649B934CA495991B7852B855"):

2749

continue

2750

if key_id and c.key_id == key_id:

2751

client = c

2752

break

2753

if fpr and c.fingerprint == fpr:

2006

2007

if command == 'init':

2008

fpr = request[1]

2009

address = request[2]

2010

2011

for c in self.clients.itervalues():

2012

if c.fingerprint == fpr:

2754

2013

client = c

2755

2014

break

2756

2015

else:

2757

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

2758

" %s", key_id or fpr, address)

2016

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

2017

"dress: %s", fpr, address)

2759

2018

if self.use_dbus:

2760

2019

# Emit D-Bus signal

2761

mandos_dbus_service.ClientNotFound(key_id or fpr,

2020

mandos_dbus_service.ClientNotFound(fpr,

2762

2021

address[0])

2763

2022

parent_pipe.send(False)

2764

2023

return False

2765

2766

GLib.io_add_watch(

2767

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

2768

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

2769

functools.partial(self.handle_ipc,

2770

parent_pipe=parent_pipe,

2771

proc=proc,

2772

client_object=client))

2024

2025

gobject.io_add_watch(parent_pipe.fileno(),

2026

gobject.IO_IN | gobject.IO_HUP,

2027

functools.partial(self.handle_ipc,

2028

parent_pipe =

2029

parent_pipe,

2030

proc = proc,

2031

client_object =

2032

client))

2773

2033

parent_pipe.send(True)

2774

2034

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

2775

2035

# same fileno

2776

2036

return False

2777

if command == "funcall":

2037

if command == 'funcall':

2778

2038

funcname = request[1]

2779

2039

args = request[2]

2780

2040

kwargs = request[3]

2781

2782

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

2041

2042

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

2783

2043

funcname)(*args,

2784

**kwargs)))

2785

2786

if command == "getattr":

2044

**kwargs)))

2045

2046

if command == 'getattr':

2787

2047

attrname = request[1]

2788

if isinstance(client_object.__getattribute__(attrname),

2789

collections.abc.Callable):

2790

parent_pipe.send(("function", ))

2048

if callable(client_object.__getattribute__(attrname)):

2049

parent_pipe.send(('function',))

2791

2050

else:

2792

parent_pipe.send((

2793

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

2794

2795

if command == "setattr":

2051

parent_pipe.send(('data', client_object

2052

.__getattribute__(attrname)))

2053

2054

if command == 'setattr':

2796

2055

attrname = request[1]

2797

2056

value = request[2]

2798

2057

setattr(client_object, attrname, value)

2799

2058

2800

2059

return True

2801

2060

2802

2061

2803

def rfc3339_duration_to_delta(duration):

2804

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

2805

2806

>>> timedelta = datetime.timedelta

2807

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

2808

True

2809

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

2810

True

2811

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

2812

True

2813

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

2814

True

2815

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

2816

True

2817

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

2818

True

2819

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

2820

True

2821

>>> del timedelta

2822

"""

2823

2824

# Parsing an RFC 3339 duration with regular expressions is not

2825

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

2826

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

2827

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

2828

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

2829

# avoid excessive use of external libraries.

2830

2831

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

2832

Token = collections.namedtuple("Token", (

2833

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

2834

# a "group" containing digits

2835

"value", # datetime.timedelta or None

2836

"followers")) # Tokens valid after this token

2837

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

2838

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

2839

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

2840

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

2841

datetime.timedelta(seconds=1),

2842

frozenset((token_end, )))

2843

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

2844

datetime.timedelta(minutes=1),

2845

frozenset((token_second, token_end)))

2846

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

2847

datetime.timedelta(hours=1),

2848

frozenset((token_minute, token_end)))

2849

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

2850

None,

2851

frozenset((token_hour, token_minute,

2852

token_second)))

2853

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

2854

datetime.timedelta(days=1),

2855

frozenset((token_time, token_end)))

2856

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

2857

datetime.timedelta(weeks=4),

2858

frozenset((token_day, token_end)))

2859

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

2860

datetime.timedelta(weeks=52),

2861

frozenset((token_month, token_end)))

2862

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

2863

datetime.timedelta(weeks=1),

2864

frozenset((token_end, )))

2865

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

2866

frozenset((token_year, token_month,

2867

token_day, token_time,

2868

token_week)))

2869

# Define starting values:

2870

# Value so far

2871

value = datetime.timedelta()

2872

found_token = None

2873

# Following valid tokens

2874

followers = frozenset((token_duration, ))

2875

# String left to parse

2876

s = duration

2877

# Loop until end token is found

2878

while found_token is not token_end:

2879

# Search for any currently valid tokens

2880

for token in followers:

2881

match = token.regexp.match(s)

2882

if match is not None:

2883

# Token found

2884

if token.value is not None:

2885

# Value found, parse digits

2886

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

2887

# Add to value so far

2888

value += factor * token.value

2889

# Strip token from string

2890

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

2891

# Go to found token

2892

found_token = token

2893

# Set valid next tokens

2894

followers = found_token.followers

2895

break

2896

else:

2897

# No currently valid tokens were found

2898

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

2899

.format(duration))

2900

# End token found

2901

return value

2902

2903

2904

2062

def string_to_delta(interval):

2905

2063

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

2906

2907

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

2908

True

2909

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

2910

True

2911

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

2912

True

2913

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

2914

True

2915

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

2916

True

2917

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

2918

True

2064

2065

>>> string_to_delta('7d')

2066

datetime.timedelta(7)

2067

>>> string_to_delta('60s')

2068

datetime.timedelta(0, 60)

2069

>>> string_to_delta('60m')

2070

datetime.timedelta(0, 3600)

2071

>>> string_to_delta('24h')

2072

datetime.timedelta(1)

2073

>>> string_to_delta('1w')

2074

datetime.timedelta(7)

2075

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

2076

datetime.timedelta(0, 330)

2919

2077

"""

2920

2921

try:

2922

return rfc3339_duration_to_delta(interval)

2923

except ValueError:

2924

pass

2925

2926

2078

timevalue = datetime.timedelta(0)

2927

2079

for s in interval.split():

2928

2080

try:

2929

suffix = s[-1]

2081

suffix = unicode(s[-1])

2930

2082

value = int(s[:-1])

2931

2083

if suffix == "d":

2932

2084

delta = datetime.timedelta(value)

2939

2091

elif suffix == "w":

2940

2092

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

2941

2093

else:

2942

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

2943

except IndexError as e:

2094

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

2095

.format(suffix))

2096

except (ValueError, IndexError) as e:

2944

2097

raise ValueError(*(e.args))

2945

2098

timevalue += delta

2946

2099

return timevalue

2947

2100

2948

2101

2949

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

2102

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

2950

2103

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

2951

2104

2952

2105

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

2953

2106

if os.fork():

2954

2107

sys.exit()

2962

2115

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

2963

2116

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

2964

2117

raise OSError(errno.ENODEV,

2965

"{} not a character device"

2118

"{0} not a character device"

2966

2119

.format(os.devnull))

2967

2120

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

2968

2121

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

2972

2125

2973

2126

2974

2127

def main():

2975

2128

2976

2129

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

2977

2130

# Parsing of options, both command line and config file

2978

2131

2979

2132

parser = argparse.ArgumentParser()

2980

2133

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

2981

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

2134

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

2982

2135

help="show version number and exit")

2983

2136

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

2984

2137

help="Bind to interface IF")

2990

2143

help="Run self-test")

2991

2144

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

2992

2145

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

2993

" to terminal", default=None)

2146

" to terminal")

2994

2147

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

2995

2148

help="Debug level for stdout output")

2996

2149

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

3003

2156

" files")

3004

2157

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

3005

2158

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

3006

" system bus interface", default=None)

2159

" system bus interface")

3007

2160

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

3008

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

3009

default=None)

2161

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

3010

2162

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

3011

2163

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

3012

" state", default=None)

3013

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

3014

help="Specify a file descriptor to a network"

3015

" socket to use instead of creating one")

2164

" state")

3016

2165

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

3017

2166

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

3018

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

3019

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

3020

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

3021

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

3022

default=None)

3023

2167

3024

2168

options = parser.parse_args()

3025

2169

2170

if options.check:

2171

import doctest

2172

doctest.testmod()

2173

sys.exit()

2174

3026

2175

# Default values for config file for server-global settings

3027

if gnutls.has_rawpk:

3028

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

3029

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

3030

else:

3031

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

3032

":+SIGN-DSA-SHA256")

3033

server_defaults = {"interface": "",

3034

"address": "",

3035

"port": "",

3036

"debug": "False",

3037

"priority": priority,

3038

"servicename": "Mandos",

3039

"use_dbus": "True",

3040

"use_ipv6": "True",

3041

"debuglevel": "",

3042

"restore": "True",

3043

"socket": "",

3044

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

3045

"foreground": "False",

3046

"zeroconf": "True",

3047

}

3048

del priority

3049

2176

server_defaults = { "interface": "",

2177

"address": "",

2178

"port": "",

2179

"debug": "False",

2180

"priority":

2181

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

2182

"servicename": "Mandos",

2183

"use_dbus": "True",

2184

"use_ipv6": "True",

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

2188

}

2189

3050

2190

# Parse config file for server-global settings

3051

server_config = configparser.ConfigParser(server_defaults)

2191

server_config = configparser.SafeConfigParser(server_defaults)

3052

2192

del server_defaults

3053

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

3054

# Convert the ConfigParser object to a dict

2193

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

2194

"mandos.conf"))

2195

# Convert the SafeConfigParser object to a dict

3055

2196

server_settings = server_config.defaults()

3056

2197

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

3057

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

3058

"foreground", "zeroconf"):

2198

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

3059

2199

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

3060

2200

option)

3061

2201

if server_settings["port"]:

3062

2202

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

3063

2203

"port")

3064

if server_settings["socket"]:

3065

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

3066

"socket")

3067

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

3068

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

3069

# happen with a supplied network socket.

3070

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

3071

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

3072

["socket"])

3073

2204

del server_config

3074

2205

3075

2206

# Override the settings from the config file with command line

3076

2207

# options, if set.

3077

2208

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

3078

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

3079

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

3080

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

2209

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

2210

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

2211

"statedir"):

3081

2212

value = getattr(options, option)

3082

2213

if value is not None:

3083

2214

server_settings[option] = value

3084

2215

del options

3085

2216

# Force all strings to be unicode

3086

2217

for option in server_settings.keys():

3087

if isinstance(server_settings[option], bytes):

3088

server_settings[option] = (server_settings[option]

3089

.decode("utf-8"))

3090

# Force all boolean options to be boolean

3091

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

3092

"foreground", "zeroconf"):

3093

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

3094

# Debug implies foreground

3095

if server_settings["debug"]:

3096

server_settings["foreground"] = True

2218

if type(server_settings[option]) is str:

2219

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

3097

2220

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

3098

2221

3099

2222

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

3100

3101

if (not server_settings["zeroconf"]

3102

and not (server_settings["port"]

3103

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

3104

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

3105

2223

3106

2224

# For convenience

3107

2225

debug = server_settings["debug"]

3108

2226

debuglevel = server_settings["debuglevel"]

3110

2228

use_ipv6 = server_settings["use_ipv6"]

3111

2229

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

3112

2230

stored_state_file)

3113

foreground = server_settings["foreground"]

3114

zeroconf = server_settings["zeroconf"]

3115

2231

3116

2232

if debug:

3117

2233

initlogger(debug, logging.DEBUG)

3118

2234

else:

3121

2237

else:

3122

2238

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

3123

2239

initlogger(debug, level)

3124

2240

3125

2241

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

3126

syslogger.setFormatter(

3127

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

3128

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

3129

server_settings["servicename"])))

3130

2242

syslogger.setFormatter(logging.Formatter

2243

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

2244

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

2245

.format(server_settings

2246

["servicename"])))

2247

3131

2248

# Parse config file with clients

3132

client_config = configparser.ConfigParser(Client.client_defaults)

2249

client_config = configparser.SafeConfigParser(Client

2250

.client_defaults)

3133

2251

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

3134

2252

"clients.conf"))

3135

2253

3136

2254

global mandos_dbus_service

3137

2255

mandos_dbus_service = None

3138

3139

socketfd = None

3140

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

3141

socketfd = server_settings["socket"]

3142

tcp_server = MandosServer(

3143

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

3144

ClientHandler,

3145

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

3146

use_ipv6=use_ipv6,

3147

gnutls_priority=server_settings["priority"],

3148

use_dbus=use_dbus,

3149

socketfd=socketfd)

3150

if not foreground:

3151

pidfilename = "/run/mandos.pid"

3152

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

3153

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

3154

pidfile = None

2256

2257

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

2258

server_settings["port"]),

2259

ClientHandler,

2260

interface=(server_settings["interface"]

2261

or None),

2262

use_ipv6=use_ipv6,

2263

gnutls_priority=

2264

server_settings["priority"],

2265

use_dbus=use_dbus)

2266

if not debug:

2267

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

3155

2268

try:

3156

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

2269

pidfile = open(pidfilename, "w")

3157

2270

except IOError as e:

3158

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

3159

exc_info=e)

3160

3161

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

3162

("mandos", "mandos"),

3163

("nobody", "nogroup")):

2271

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

2272

exc_info=e)

2273

2274

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

3164

2275

try:

3165

2276

uid = pwd.getpwnam(name).pw_uid

3166

gid = pwd.getpwnam(group).pw_gid

2277

gid = pwd.getpwnam(name).pw_gid

3167

2278

break

3168

2279

except KeyError:

3169

2280

continue

3173

2284

try:

3174

2285

os.setgid(gid)

3175

2286

os.setuid(uid)

3176

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

3177

2287

except OSError as error:

3178

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

3179

os.strerror(error.errno))

3180

if error.errno != errno.EPERM:

3181

raise

3182

2288

if error[0] != errno.EPERM:

2289

raise error

2290

3183

2291

if debug:

3184

2292

# Enable all possible GnuTLS debugging

3185

2293

3186

2294

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

3187

2295

# - GnuTLS manual

3188

gnutls.global_set_log_level(11)

3189

3190

@gnutls.log_func

2296

gnutls.library.functions.gnutls_global_set_log_level(11)

2297

2298

@gnutls.library.types.gnutls_log_func

3191

2299

def debug_gnutls(level, string):

3192

log.debug("GnuTLS: %s",

3193

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

3194

3195

gnutls.global_set_log_function(debug_gnutls)

3196

2300

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

2301

2302

(gnutls.library.functions

2303

.gnutls_global_set_log_function(debug_gnutls))

2304

3197

2305

# Redirect stdin so all checkers get /dev/null

3198

2306

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

3199

2307

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

3200

2308

if null > 2:

3201

2309

os.close(null)

3202

2310

3203

2311

# Need to fork before connecting to D-Bus

3204

if not foreground:

2312

if not debug:

3205

2313

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

3206

2314

daemon()

3207

3208

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

3209

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

3210

# need to inform GLib that threads will be used.

3211

GLib.threads_init()

3212

2315

2316

gobject.threads_init()

2317

3213

2318

global main_loop

3214

2319

# From the Avahi example code

3215

2320

DBusGMainLoop(set_as_default=True)

3216

main_loop = GLib.MainLoop()

2321

main_loop = gobject.MainLoop()

3217

2322

bus = dbus.SystemBus()

3218

2323

# End of Avahi example code

3219

2324

if use_dbus:

3220

2325

try:

3221

2326

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

3222

bus,

3223

do_not_queue=True)

3224

old_bus_name = dbus.service.BusName(

3225

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

3226

do_not_queue=True)

3227

except dbus.exceptions.DBusException as e:

3228

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

2327

bus, do_not_queue=True)

2328

old_bus_name = (dbus.service.BusName

2329

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

2330

do_not_queue=True))

2331

except dbus.exceptions.NameExistsException as e:

2332

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

3229

2333

use_dbus = False

3230

2334

server_settings["use_dbus"] = False

3231

2335

tcp_server.use_dbus = False

3232

if zeroconf:

3233

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3234

service = AvahiServiceToSyslog(

3235

name=server_settings["servicename"],

3236

servicetype="_mandos._tcp",

3237

protocol=protocol,

3238

bus=bus)

3239

if server_settings["interface"]:

3240

service.interface = if_nametoindex(

3241

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

3242

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2341

if server_settings["interface"]:

2342

service.interface = (if_nametoindex

2343

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

2344

3243

2345

global multiprocessing_manager

3244

2346

multiprocessing_manager = multiprocessing.Manager()

3245

2347

3246

2348

client_class = Client

3247

2349

if use_dbus:

3248

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

3249

2350

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

2351

3250

2352

client_settings = Client.config_parser(client_config)

3251

2353

old_client_settings = {}

3252

2354

clients_data = {}

3253

3254

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

3255

global wnull

3256

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

3257

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

3258

# mode

3259

if debug or not foreground:

3260

wnull.close()

3261

2355

3262

2356

# Get client data and settings from last running state.

3263

2357

if server_settings["restore"]:

3264

2358

try:

3265

2359

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

3266

if sys.version_info.major == 2:

3267

clients_data, old_client_settings = pickle.load(

3268

stored_state)

3269

else:

3270

bytes_clients_data, bytes_old_client_settings = (

3271

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

3272

# Fix bytes to strings

3273

# clients_data

3274

# .keys()

3275

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

3276

if isinstance(key, bytes)

3277

else key): value

3278

for key, value in

3279

bytes_clients_data.items()}

3280

del bytes_clients_data

3281

for key in clients_data:

3282

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

3283

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

3284

for k, v in

3285

clients_data[key].items()}

3286

clients_data[key] = value

3287

# .client_structure

3288

value["client_structure"] = [

3289

(s.decode("utf-8")

3290

if isinstance(s, bytes)

3291

else s) for s in

3292

value["client_structure"]]

3293

# .name, .host, and .checker_command

3294

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

3295

if isinstance(value[k], bytes):

3296

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

3297

if "key_id" not in value:

3298

value["key_id"] = ""

3299

elif "fingerprint" not in value:

3300

value["fingerprint"] = ""

3301

# old_client_settings

3302

# .keys()

3303

old_client_settings = {

3304

(key.decode("utf-8")

3305

if isinstance(key, bytes)

3306

else key): value

3307

for key, value in

3308

bytes_old_client_settings.items()}

3309

del bytes_old_client_settings

3310

# .host and .checker_command

3311

for value in old_client_settings.values():

3312

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

3313

if isinstance(value[attribute], bytes):

3314

value[attribute] = (value[attribute]

3315

.decode("utf-8"))

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

3316

2362

os.remove(stored_state_path)

3317

2363

except IOError as e:

3318

2364

if e.errno == errno.ENOENT:

3319

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

3320

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

2365

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

2366

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

3321

2367

else:

3322

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

3323

exc_info=e)

2368

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

2369

exc_info=e)

3324

2370

raise

3325

2371

except EOFError as e:

3326

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

3327

exc_info=e)

3328

2372

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

2373

"EOFError:", exc_info=e)

2374

3329

2375

with PGPEngine() as pgp:

3330

for client_name, client in clients_data.items():

3331

# Skip removed clients

3332

if client_name not in client_settings:

3333

continue

3334

2376

for client_name, client in clients_data.iteritems():

3335

2377

# Decide which value to use after restoring saved state.

3336

2378

# We have three different values: Old config file,

3337

2379

# new config file, and saved state.

3342

2384

# For each value in new config, check if it

3343

2385

# differs from the old config value (Except for

3344

2386

# the "secret" attribute)

3345

if (name != "secret"

3346

and (value !=

3347

old_client_settings[client_name][name])):

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

3348

2390

client[name] = value

3349

2391

except KeyError:

3350

2392

pass

3351

2393

3352

2394

# Clients who has passed its expire date can still be

3353

# enabled if its last checker was successful. A Client

2395

# enabled if its last checker was successful. Clients

3354

2396

# whose checker succeeded before we stored its state is

3355

2397

# assumed to have successfully run all checkers during

3356

2398

# downtime.

3357

2399

if client["enabled"]:

3358

2400

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

3359

2401

if not client["last_checked_ok"]:

3360

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

3361

" never performed a successful"

3362

" checker", client_name)

2402

logger.warning(

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

3363

2406

client["enabled"] = False

3364

2407

elif client["last_checker_status"] != 0:

3365

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

3366

" last checker failed with error"

3367

" code %s", client_name,

3368

client["last_checker_status"])

2408

logger.warning(

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

3369

2413

client["enabled"] = False

3370

2414

else:

3371

client["expires"] = (

3372

datetime.datetime.utcnow()

3373

+ client["timeout"])

3374

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

3375

" enabled", client_name)

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

2418

logger.debug("Last checker succeeded,"

2419

" keeping {0} enabled"

2420

.format(client_name))

3376

2421

try:

3377

client["secret"] = pgp.decrypt(

3378

client["encrypted_secret"],

3379

client_settings[client_name]["secret"])

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

3380

2426

except PGPError:

3381

2427

# If decryption fails, we use secret from new settings

3382

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

3383

client_name)

3384

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

3385

["secret"])

3386

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

3387

2433

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

3388

2434

for client_name in (set(old_client_settings)

3389

2435

- set(client_settings)):

3391

2437

for client_name in (set(client_settings)

3392

2438

- set(old_client_settings)):

3393

2439

clients_data[client_name] = client_settings[client_name]

3394

2440

3395

2441

# Create all client objects

3396

for client_name, client in clients_data.items():

2442

for client_name, client in clients_data.iteritems():

3397

2443

tcp_server.clients[client_name] = client_class(

3398

name=client_name,

3399

settings=client,

3400

server_settings=server_settings)

3401

2444

name = client_name, settings = client)

2445

3402

2446

if not tcp_server.clients:

3403

log.warning("No clients defined")

3404

3405

if not foreground:

3406

if pidfile is not None:

3407

pid = os.getpid()

3408

try:

3409

with pidfile:

3410

print(pid, file=pidfile)

3411

except IOError:

3412

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

3413

pidfilename, pid)

3414

del pidfile

2447

logger.warning("No clients defined")

2448

2449

if not debug:

2450

try:

2451

with pidfile:

2452

pid = os.getpid()

2453

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

2454

del pidfile

2455

except IOError:

2456

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

2457

pidfilename, pid)

2458

except NameError:

2459

# "pidfile" was never created

2460

pass

3415

2461

del pidfilename

3416

3417

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

3418

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3419

lambda: main_loop.quit() and False)

3420

2462

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

2463

2464

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

2465

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

2466

3421

2467

if use_dbus:

3422

3423

@alternate_dbus_interfaces(

3424

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

3425

class MandosDBusService(DBusObjectWithObjectManager):

2468

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

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

3426

2471

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

3427

3428

2472

def __init__(self):

3429

2473

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

3430

3431

2474

_interface = "se.recompile.Mandos"

3432

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

3433

2482

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

3434

2483

def ClientAdded(self, objpath):

3435

2484

"D-Bus signal"

3436

2485

pass

3437

2486

3438

2487

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

3439

def ClientNotFound(self, key_id, address):

2488

def ClientNotFound(self, fingerprint, address):

3440

2489

"D-Bus signal"

3441

2490

pass

3442

3443

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

3444

"true"})

2491

3445

2492

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

3446

2493

def ClientRemoved(self, objpath, name):

3447

2494

"D-Bus signal"

3448

2495

pass

3449

3450

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

3451

"true"})

2496

3452

2497

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

3453

2498

def GetAllClients(self):

3454

2499

"D-Bus method"

3455

return dbus.Array(c.dbus_object_path for c in

3456

tcp_server.clients.values())

3457

3458

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

3459

"true"})

2500

return dbus.Array(c.dbus_object_path

2501

for c in

2502

tcp_server.clients.itervalues())

2503

3460

2504

@dbus.service.method(_interface,

3461

2505

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

3462

2506

def GetAllClientsWithProperties(self):

3463

2507

"D-Bus method"

3464

2508

return dbus.Dictionary(

3465

{c.dbus_object_path: c.GetAll(

3466

"se.recompile.Mandos.Client")

3467

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

2509

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

2510

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

3468

2511

signature="oa{sv}")

3469

2512

3470

2513

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

3471

2514

def RemoveClient(self, object_path):

3472

2515

"D-Bus method"

3473

for c in tcp_server.clients.values():

2516

for c in tcp_server.clients.itervalues():

3474

2517

if c.dbus_object_path == object_path:

3475

2518

del tcp_server.clients[c.name]

3476

2519

c.remove_from_connection()

3477

# Don't signal the disabling

2520

# Don't signal anything except ClientRemoved

3478

2521

c.disable(quiet=True)

3479

# Emit D-Bus signal for removal

3480

self.client_removed_signal(c)

2522

# Emit D-Bus signal

2523

self.ClientRemoved(object_path, c.name)

3481

2524

return

3482

2525

raise KeyError(object_path)

3483

2526

3484

2527

del _interface

3485

3486

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3487

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

3488

def GetManagedObjects(self):

3489

"""D-Bus method"""

3490

return dbus.Dictionary(

3491

{client.dbus_object_path:

3492

dbus.Dictionary(

3493

{interface: client.GetAll(interface)

3494

for interface in

3495

client._get_all_interface_names()})

3496

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

3497

3498

def client_added_signal(self, client):

3499

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

3500

if use_dbus:

3501

# New standard signal

3502

self.InterfacesAdded(

3503

client.dbus_object_path,

3504

dbus.Dictionary(

3505

{interface: client.GetAll(interface)

3506

for interface in

3507

client._get_all_interface_names()}))

3508

# Old signal

3509

self.ClientAdded(client.dbus_object_path)

3510

3511

def client_removed_signal(self, client):

3512

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

3513

if use_dbus:

3514

# New standard signal

3515

self.InterfacesRemoved(

3516

client.dbus_object_path,

3517

client._get_all_interface_names())

3518

# Old signal

3519

self.ClientRemoved(client.dbus_object_path,

3520

client.name)

3521

2528

3522

2529

mandos_dbus_service = MandosDBusService()

3523

3524

# Save modules to variables to exempt the modules from being

3525

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

3526

mp = multiprocessing

3527

wn = wnull

3528

2530

3529

2531

def cleanup():

3530

2532

"Cleanup function; run on exit"

3531

if zeroconf:

3532

service.cleanup()

3533

3534

mp.active_children()

3535

wn.close()

2533

service.cleanup()

2534

2535

multiprocessing.active_children()

3536

2536

if not (tcp_server.clients or client_settings):

3537

2537

return

3538

2538

3539

2539

# Store client before exiting. Secrets are encrypted with key

3540

2540

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

3541

2541

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

3542

2542

clients = {}

3543

2543

with PGPEngine() as pgp:

3544

for client in tcp_server.clients.values():

2544

for client in tcp_server.clients.itervalues():

3545

2545

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

3546

2546

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

3547

2547

key)

3548

2548

client_dict = {}

3549

2549

3550

2550

# A list of attributes that can not be pickled

3551

2551

# + secret.

3552

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

3553

"checker", "server_settings"}

3554

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

3555

.Object):

2552

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

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

3556

2556

exclude.add(name)

3557

2557

3558

2558

client_dict["encrypted_secret"] = (client

3559

2559

.encrypted_secret)

3560

2560

for attr in client.client_structure:

3561

2561

if attr not in exclude:

3562

2562

client_dict[attr] = getattr(client, attr)

3563

2563

3564

2564

clients[client.name] = client_dict

3565

2565

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

3566

2566

3567

2567

try:

3568

with tempfile.NamedTemporaryFile(

3569

mode="wb",

3570

suffix=".pickle",

3571

prefix="clients-",

3572

dir=os.path.dirname(stored_state_path),

3573

delete=False) as stored_state:

3574

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

3575

protocol=2)

3576

tempname = stored_state.name

2568

with (tempfile.NamedTemporaryFile

2569

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

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

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

2573

tempname=stored_state.name

3577

2574

os.rename(tempname, stored_state_path)

3578

2575

except (IOError, OSError) as e:

3579

2576

if not debug:

3582

2579

except NameError:

3583

2580

pass

3584

2581

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

3585

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

3586

os.strerror(e.errno))

2582

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

2583

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

3587

2584

else:

3588

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

3589

exc_info=e)

3590

raise

3591

2585

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

2586

exc_info=e)

2587

raise e

2588

3592

2589

# Delete all clients, and settings from config

3593

2590

while tcp_server.clients:

3594

2591

name, client = tcp_server.clients.popitem()

3595

2592

if use_dbus:

3596

2593

client.remove_from_connection()

3597

# Don't signal the disabling

2594

# Don't signal anything except ClientRemoved

3598

2595

client.disable(quiet=True)

3599

# Emit D-Bus signal for removal

3600

2596

if use_dbus:

3601

mandos_dbus_service.client_removed_signal(client)

2597

# Emit D-Bus signal

2598

mandos_dbus_service.ClientRemoved(client

2599

.dbus_object_path,

2600

client.name)

3602

2601

client_settings.clear()

3603

2602

3604

2603

atexit.register(cleanup)

3605

3606

for client in tcp_server.clients.values():

2604

2605

for client in tcp_server.clients.itervalues():

3607

2606

if use_dbus:

3608

# Emit D-Bus signal for adding

3609

mandos_dbus_service.client_added_signal(client)

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3610

2609

# Need to initiate checking of clients

3611

2610

if client.enabled:

3612

2611

client.init_checker()

3613

2612

3614

2613

tcp_server.enable()

3615

2614

tcp_server.server_activate()

3616

2615

3617

2616

# Find out what port we got

3618

if zeroconf:

3619

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

2617

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

3620

2618

if use_ipv6:

3621

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

3622

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

2619

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

2620

" flowinfo %d, scope_id %d",

2621

*tcp_server.socket.getsockname())

3623

2622

else: # IPv4

3624

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

3625

*tcp_server.socket.getsockname())

3626

3627

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

3628

2623

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

2624

*tcp_server.socket.getsockname())

2625

2626

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

2627

3629

2628

try:

3630

if zeroconf:

3631

# From the Avahi example code

3632

try:

3633

service.activate()

3634

except dbus.exceptions.DBusException as error:

3635

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

3636

cleanup()

3637

sys.exit(1)

3638

# End of Avahi example code

3639

3640

GLib.io_add_watch(

3641

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

3642

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3643

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

3644

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

3645

3646

log.debug("Starting main loop")

2629

# From the Avahi example code

2630

try:

2631

service.activate()

2632

except dbus.exceptions.DBusException as error:

2633

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

2634

cleanup()

2635

sys.exit(1)

2636

# End of Avahi example code

2637

2638

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

2639

lambda *args, **kwargs:

2640

(tcp_server.handle_request

2641

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

2642

2643

logger.debug("Starting main loop")

3647

2644

main_loop.run()

3648

2645

except AvahiError as error:

3649

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

2646

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

3650

2647

cleanup()

3651

2648

sys.exit(1)

3652

2649

except KeyboardInterrupt:

3653

2650

if debug:

3654

2651

print("", file=sys.stderr)

3655

log.debug("Server received KeyboardInterrupt")

3656

log.debug("Server exiting")

2652

logger.debug("Server received KeyboardInterrupt")

2653

logger.debug("Server exiting")

3657

2654

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

3658

2655

cleanup()

3659

2656

3660

3661

def parse_test_args():

3662

# type: () -> argparse.Namespace

3663

parser = argparse.ArgumentParser(add_help=False)

3664

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

3665

parser.add_argument("--prefix", )

3666

args, unknown_args = parser.parse_known_args()

3667

if args.check:

3668

# Remove test options from sys.argv

3669

sys.argv[1:] = unknown_args

3670

return args

3671

3672

# Add all tests from doctest strings

3673

def load_tests(loader, tests, none):

3674

import doctest

3675

tests.addTests(doctest.DocTestSuite())

3676

return tests

3677

3678

if __name__ == "__main__":

3679

options = parse_test_args()

3680

try:

3681

if options.check:

3682

extra_test_prefix = options.prefix

3683

if extra_test_prefix is not None:

3684

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

3685

.result.wasSuccessful()):

3686

sys.exit(1)

3687

class ExtraTestLoader(unittest.TestLoader):

3688

testMethodPrefix = extra_test_prefix

3689

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

3690

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

3691

else:

3692

unittest.main(argv=[""])

3693

else:

3694

main()

3695

finally:

3696

logging.shutdown()

3697

3698

# Local Variables:

3699

# run-tests:

3700

# (lambda (&optional extra)

3701

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

3702

# extra))

3703

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

3704

# (funcall remove-test-window)

3705

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

3706

# run-tests-in-test-buffer:

3707

# (lambda (dir &optional extra)

3708

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

3709

# (setq buffer-read-only nil

3710

# default-directory dir)

3711

# (erase-buffer)

3712

# (compilation-mode))

3713

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

3714

# (= (process-file-shell-command

3715

# (funcall get-command-line extra)

3716

# nil "*Test*") 0)))

3717

# get-command-line:

3718

# (lambda (&optional extra)

3719

# (let ((quoted-script

3720

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

3721

# (format

3722

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

3723

# quoted-script)))

3724

# get-script-name:

3725

# (lambda ()

3726

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

3727

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

3728

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

3729

# (buffer-file-name))))

3730

# remove-test-window:

3731

# (lambda ()

3732

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

3733

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

3734

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

3735

# (lambda ()

3736

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

3737

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

3738

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

3739

# (display-buffer-overriding-action

3740

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

3741

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

3742

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

3743

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

3744

# eval:

3745

# (progn

3746

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

3747

# (funcall run-tests t)))

3748

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

3749

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

3750

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

3751

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

3752

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

3753

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

3754

# End:

2657

if __name__ == '__main__':

2658

main()