/mandos/release : revision 237.7.242

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import random

81

import shlex

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Add os.set_inheritable if it does not exist

114

try:

115

os.set_inheritable

116

except AttributeError:

117

def set_inheritable(fd, inheritable):

118

flags = fcntl.fcntl(fd, fcntl.F_GETFD)

119

if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):

120

fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)

121

elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):

122

fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)

123

os.set_inheritable = set_inheritable

124

del set_inheritable

125

126

# Show warnings by default

127

if not sys.warnoptions:

128

import warnings

129

warnings.simplefilter("default")

130

131

# Try to find the value of SO_BINDTODEVICE:

132

try:

133

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

134

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

83

try:

135

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

136

85

except AttributeError:

137

86

try:

138

# This is where SO_BINDTODEVICE was up to and including Python

139

# 2.6, and also 3.2:

140

87

from IN import SO_BINDTODEVICE

141

88

except ImportError:

142

# In Python 2.7 it seems to have been removed entirely.

143

# Try running the C preprocessor:

144

try:

145

cc = subprocess.Popen(["cc", "--language=c", "-E",

146

"/dev/stdin"],

147

stdin=subprocess.PIPE,

148

stdout=subprocess.PIPE)

149

stdout = cc.communicate(

150

"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]

151

SO_BINDTODEVICE = int(stdout.splitlines()[-1])

152

except (OSError, ValueError, IndexError):

153

# No value found

154

SO_BINDTODEVICE = None

155

156

if sys.version_info < (3, 2):

157

configparser.Configparser = configparser.SafeConfigParser

158

159

version = "1.8.18"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.5"

160

92

stored_state_file = "clients.pickle"

161

93

162

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

163

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

94

logger = logging.getLogger()

164

95

syslogger = None

165

96

166

97

try:

167

if_nametoindex = ctypes.cdll.LoadLibrary(

168

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

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

169

101

except (OSError, AttributeError):

170

171

102

def if_nametoindex(interface):

172

103

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

173

104

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

174

105

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

175

106

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

176

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

177

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

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

178

111

return interface_index

179

112

180

113

181

def copy_function(func):

182

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

183

if sys.version_info.major == 2:

184

return types.FunctionType(func.func_code,

185

func.func_globals,

186

func.func_name,

187

func.func_defaults,

188

func.func_closure)

189

else:

190

return types.FunctionType(func.__code__,

191

func.__globals__,

192

func.__name__,

193

func.__defaults__,

194

func.__closure__)

195

196

197

114

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

198

115

"""init logger and add loglevel"""

199

200

global syslogger

201

syslogger = (logging.handlers.SysLogHandler(

202

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

203

address="/dev/log"))

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

204

121

syslogger.setFormatter(logging.Formatter

205

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

206

" %(message)s"))

207

log.addHandler(syslogger)

208

122

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

123

' %(message)s'))

124

logger.addHandler(syslogger)

125

209

126

if debug:

210

127

console = logging.StreamHandler()

211

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

212

" [%(process)d]:"

213

" %(levelname)s:"

214

" %(message)s"))

215

log.addHandler(console)

216

log.setLevel(level)

128

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

129

' [%(process)d]:'

130

' %(levelname)s:'

131

' %(message)s'))

132

logger.addHandler(console)

133

logger.setLevel(level)

217

134

218

135

219

136

class PGPError(Exception):

221

138

pass

222

139

223

140

224

class PGPEngine:

141

class PGPEngine(object):

225

142

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

226

227

143

def __init__(self):

228

144

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

229

self.gpg = "gpg"

230

try:

231

output = subprocess.check_output(["gpgconf"])

232

for line in output.splitlines():

233

name, text, path = line.split(b":")

234

if name == b"gpg":

235

self.gpg = path

236

break

237

except OSError as e:

238

if e.errno != errno.ENOENT:

239

raise

240

self.gnupgargs = ["--batch",

241

"--homedir", self.tempdir,

242

"--force-mdc",

243

"--quiet"]

244

# Only GPG version 1 has the --no-use-agent option.

245

if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):

246

self.gnupgargs.append("--no-use-agent")

247

145

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

147

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

248

151

def __enter__(self):

249

152

return self

250

153

251

154

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

252

155

self._cleanup()

253

156

return False

254

157

255

158

def __del__(self):

256

159

self._cleanup()

257

160

258

161

def _cleanup(self):

259

162

if self.tempdir is not None:

260

163

# Delete contents of tempdir

261

164

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

262

topdown=False):

165

topdown = False):

263

166

for filename in files:

264

167

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

265

168

for dirname in dirs:

267

170

# Remove tempdir

268

171

os.rmdir(self.tempdir)

269

172

self.tempdir = None

270

173

271

174

def password_encode(self, password):

272

175

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

273

176

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

278

181

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

279

182

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

280

183

return encoded

281

184

282

185

def encrypt(self, data, password):

283

186

passphrase = self.password_encode(password)

284

with tempfile.NamedTemporaryFile(

285

dir=self.tempdir) as passfile:

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

286

189

passfile.write(passphrase)

287

190

passfile.flush()

288

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

289

"--passphrase-file",

191

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

192

'--passphrase-file',

290

193

passfile.name]

291

194

+ self.gnupgargs,

292

stdin=subprocess.PIPE,

293

stdout=subprocess.PIPE,

294

stderr=subprocess.PIPE)

295

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

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

296

199

if proc.returncode != 0:

297

200

raise PGPError(err)

298

201

return ciphertext

299

202

300

203

def decrypt(self, data, password):

301

204

passphrase = self.password_encode(password)

302

with tempfile.NamedTemporaryFile(

303

dir=self.tempdir) as passfile:

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

304

207

passfile.write(passphrase)

305

208

passfile.flush()

306

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

307

"--passphrase-file",

209

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

210

'--passphrase-file',

308

211

passfile.name]

309

212

+ self.gnupgargs,

310

stdin=subprocess.PIPE,

311

stdout=subprocess.PIPE,

312

stderr=subprocess.PIPE)

313

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

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

314

218

if proc.returncode != 0:

315

219

raise PGPError(err)

316

220

return decrypted_plaintext

317

221

318

222

319

# Pretend that we have an Avahi module

320

class avahi:

321

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

322

IF_UNSPEC = -1 # avahi-common/address.h

323

PROTO_UNSPEC = -1 # avahi-common/address.h

324

PROTO_INET = 0 # avahi-common/address.h

325

PROTO_INET6 = 1 # avahi-common/address.h

326

DBUS_NAME = "org.freedesktop.Avahi"

327

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

328

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

329

DBUS_PATH_SERVER = "/"

330

331

@staticmethod

332

def string_array_to_txt_array(t):

333

return dbus.Array((dbus.ByteArray(s.encode("utf-8"))

334

for s in t), signature="ay")

335

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

336

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

337

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

338

SERVER_INVALID = 0 # avahi-common/defs.h

339

SERVER_REGISTERING = 1 # avahi-common/defs.h

340

SERVER_RUNNING = 2 # avahi-common/defs.h

341

SERVER_COLLISION = 3 # avahi-common/defs.h

342

SERVER_FAILURE = 4 # avahi-common/defs.h

343

344

345

223

class AvahiError(Exception):

346

224

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

347

225

self.value = value

348

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

349

**kwargs)

350

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

351

229

352

230

class AvahiServiceError(AvahiError):

353

231

pass

354

232

355

356

233

class AvahiGroupError(AvahiError):

357

234

pass

358

235

359

236

360

class AvahiService:

237

class AvahiService(object):

361

238

"""An Avahi (Zeroconf) service.

362

239

363

240

Attributes:

364

241

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

365

242

Used to optionally bind to the specified interface.

366

367

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

243

244

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

368

245

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

369

246

port: integer; what port to announce

370

247

TXT: list of strings; TXT record for the service

377

254

server: D-Bus Server

378

255

bus: dbus.SystemBus()

379

256

"""

380

381

def __init__(self,

382

interface=avahi.IF_UNSPEC,

383

name=None,

384

servicetype=None,

385

port=None,

386

TXT=None,

387

domain="",

388

host="",

389

max_renames=32768,

390

protocol=avahi.PROTO_UNSPEC,

391

bus=None):

257

258

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

259

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

260

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

261

protocol = avahi.PROTO_UNSPEC, bus = None):

392

262

self.interface = interface

393

263

self.name = name

394

264

self.type = servicetype

403

273

self.server = None

404

274

self.bus = bus

405

275

self.entry_group_state_changed_match = None

406

407

def rename(self, remove=True):

276

277

def rename(self):

408

278

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

409

279

if self.rename_count >= self.max_renames:

410

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

411

" after %i retries, exiting.",

412

self.rename_count)

280

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

281

" after %i retries, exiting.",

282

self.rename_count)

413

283

raise AvahiServiceError("Too many renames")

414

self.name = str(

415

self.server.GetAlternativeServiceName(self.name))

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

286

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

287

self.name)

288

self.remove()

289

try:

290

self.add()

291

except dbus.exceptions.DBusException as error:

292

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

293

self.cleanup()

294

os._exit(1)

416

295

self.rename_count += 1

417

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

418

self.name)

419

if remove:

420

self.remove()

421

try:

422

self.add()

423

except dbus.exceptions.DBusException as error:

424

if (error.get_dbus_name()

425

== "org.freedesktop.Avahi.CollisionError"):

426

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

427

return self.rename(remove=False)

428

else:

429

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

430

self.cleanup()

431

os._exit(1)

432

296

433

297

def remove(self):

434

298

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

435

299

if self.entry_group_state_changed_match is not None:

437

301

self.entry_group_state_changed_match = None

438

302

if self.group is not None:

439

303

self.group.Reset()

440

304

441

305

def add(self):

442

306

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

443

307

self.remove()

448

312

avahi.DBUS_INTERFACE_ENTRY_GROUP)

449

313

self.entry_group_state_changed_match = (

450

314

self.group.connect_to_signal(

451

"StateChanged", self.entry_group_state_changed))

452

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

453

self.name, self.type)

315

'StateChanged', self.entry_group_state_changed))

316

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

317

self.name, self.type)

454

318

self.group.AddService(

455

319

self.interface,

456

320

self.protocol,

460

324

dbus.UInt16(self.port),

461

325

avahi.string_array_to_txt_array(self.TXT))

462

326

self.group.Commit()

463

327

464

328

def entry_group_state_changed(self, state, error):

465

329

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

466

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

467

330

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

331

468

332

if state == avahi.ENTRY_GROUP_ESTABLISHED:

469

log.debug("Zeroconf service established.")

333

logger.debug("Zeroconf service established.")

470

334

elif state == avahi.ENTRY_GROUP_COLLISION:

471

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

335

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

472

336

self.rename()

473

337

elif state == avahi.ENTRY_GROUP_FAILURE:

474

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

475

str(error))

476

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

477

338

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

339

unicode(error))

340

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

341

.format(error))

342

478

343

def cleanup(self):

479

344

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

480

345

if self.group is not None:

485

350

pass

486

351

self.group = None

487

352

self.remove()

488

353

489

354

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

490

355

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

491

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

492

bad_states = {

493

avahi.SERVER_INVALID: "Zeroconf server invalid",

494

avahi.SERVER_REGISTERING: None,

495

avahi.SERVER_COLLISION: "Zeroconf server name collision",

496

avahi.SERVER_FAILURE: "Zeroconf server failure",

497

}

356

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

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"Zeroconf server failure" }

498

364

if state in bad_states:

499

365

if bad_states[state] is not None:

500

366

if error is None:

501

log.error(bad_states[state])

367

logger.error(bad_states[state])

502

368

else:

503

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

369

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

504

370

self.cleanup()

505

371

elif state == avahi.SERVER_RUNNING:

506

try:

507

self.add()

508

except dbus.exceptions.DBusException as error:

509

if (error.get_dbus_name()

510

== "org.freedesktop.Avahi.CollisionError"):

511

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

512

return self.rename(remove=False)

513

else:

514

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

515

self.cleanup()

516

os._exit(1)

372

self.add()

517

373

else:

518

374

if error is None:

519

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

375

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

520

376

else:

521

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

522

377

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

378

523

379

def activate(self):

524

380

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

525

381

if self.server is None:

529

385

follow_name_owner_changes=True),

530

386

avahi.DBUS_INTERFACE_SERVER)

531

387

self.server.connect_to_signal("StateChanged",

532

self.server_state_changed)

388

self.server_state_changed)

533

389

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

534

390

535

391

536

392

class AvahiServiceToSyslog(AvahiService):

537

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

393

def rename(self):

538

394

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

539

ret = super(AvahiServiceToSyslog, self).rename(*args,

540

**kwargs)

541

syslogger.setFormatter(logging.Formatter(

542

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

543

.format(self.name)))

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

544

400

return ret

545

401

546

402

547

# Pretend that we have a GnuTLS module

548

class gnutls:

549

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

550

551

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

552

if library is None:

553

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

554

_library = ctypes.cdll.LoadLibrary(library)

555

del library

556

557

# Unless otherwise indicated, the constants and types below are

558

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

559

560

# Constants

561

E_SUCCESS = 0

562

E_INTERRUPTED = -52

563

E_AGAIN = -28

564

CRT_OPENPGP = 2

565

CRT_RAWPK = 3

566

CLIENT = 2

567

SHUT_RDWR = 0

568

CRD_CERTIFICATE = 1

569

E_NO_CERTIFICATE_FOUND = -49

570

X509_FMT_DER = 0

571

NO_TICKETS = 1<<10

572

ENABLE_RAWPK = 1<<18

573

CTYPE_PEERS = 3

574

KEYID_USE_SHA256 = 1 # gnutls/x509.h

575

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

576

577

# Types

578

class _session_int(ctypes.Structure):

579

_fields_ = []

580

session_t = ctypes.POINTER(_session_int)

581

582

class certificate_credentials_st(ctypes.Structure):

583

_fields_ = []

584

certificate_credentials_t = ctypes.POINTER(

585

certificate_credentials_st)

586

certificate_type_t = ctypes.c_int

587

588

class datum_t(ctypes.Structure):

589

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

590

("size", ctypes.c_uint)]

591

592

class _openpgp_crt_int(ctypes.Structure):

593

_fields_ = []

594

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

595

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

596

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

597

credentials_type_t = ctypes.c_int

598

transport_ptr_t = ctypes.c_void_p

599

close_request_t = ctypes.c_int

600

601

# Exceptions

602

class Error(Exception):

603

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

604

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

605

# code is passed, convert it to a string with

606

# gnutls.strerror()

607

self.code = code

608

if message is None and code is not None:

609

message = gnutls.strerror(code).decode(

610

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

611

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

612

message, *args)

613

614

class CertificateSecurityError(Error):

615

pass

616

617

class PointerTo:

618

def __init__(self, cls):

619

self.cls = cls

620

621

def from_param(self, obj):

622

if not isinstance(obj, self.cls):

623

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

624

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

625

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

626

627

class CastToVoidPointer:

628

def __init__(self, cls):

629

self.cls = cls

630

631

def from_param(self, obj):

632

if not isinstance(obj, self.cls):

633

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

634

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

635

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

636

637

class With_from_param:

638

@classmethod

639

def from_param(cls, obj):

640

return obj._as_parameter_

641

642

# Classes

643

class Credentials(With_from_param):

644

def __init__(self):

645

self._as_parameter_ = gnutls.certificate_credentials_t()

646

gnutls.certificate_allocate_credentials(self)

647

self.type = gnutls.CRD_CERTIFICATE

648

649

def __del__(self):

650

gnutls.certificate_free_credentials(self)

651

652

class ClientSession(With_from_param):

653

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

654

self._as_parameter_ = gnutls.session_t()

655

gnutls_flags = gnutls.CLIENT

656

if gnutls.check_version(b"3.5.6"):

657

gnutls_flags |= gnutls.NO_TICKETS

658

if gnutls.has_rawpk:

659

gnutls_flags |= gnutls.ENABLE_RAWPK

660

gnutls.init(self, gnutls_flags)

661

del gnutls_flags

662

gnutls.set_default_priority(self)

663

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

664

gnutls.handshake_set_private_extensions(self, True)

665

self.socket = socket

666

if credentials is None:

667

credentials = gnutls.Credentials()

668

gnutls.credentials_set(self, credentials.type,

669

credentials)

670

self.credentials = credentials

671

672

def __del__(self):

673

gnutls.deinit(self)

674

675

def handshake(self):

676

return gnutls.handshake(self)

677

678

def send(self, data):

679

data = bytes(data)

680

data_len = len(data)

681

while data_len > 0:

682

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

683

data_len)

684

685

def bye(self):

686

return gnutls.bye(self, gnutls.SHUT_RDWR)

687

688

# Error handling functions

689

def _error_code(result):

690

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

691

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

692

if result >= gnutls.E_SUCCESS:

693

return result

694

if result == gnutls.E_NO_CERTIFICATE_FOUND:

695

raise gnutls.CertificateSecurityError(code=result)

696

raise gnutls.Error(code=result)

697

698

def _retry_on_error(result, func, arguments,

699

_error_code=_error_code):

700

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

701

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

702

while result < gnutls.E_SUCCESS:

703

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

704

return _error_code(result)

705

result = func(*arguments)

706

return result

707

708

# Unless otherwise indicated, the function declarations below are

709

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

710

711

# Functions

712

priority_set_direct = _library.gnutls_priority_set_direct

713

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

714

ctypes.POINTER(ctypes.c_char_p)]

715

priority_set_direct.restype = _error_code

716

717

init = _library.gnutls_init

718

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

719

init.restype = _error_code

720

721

set_default_priority = _library.gnutls_set_default_priority

722

set_default_priority.argtypes = [ClientSession]

723

set_default_priority.restype = _error_code

724

725

record_send = _library.gnutls_record_send

726

record_send.argtypes = [ClientSession, ctypes.c_void_p,

727

ctypes.c_size_t]

728

record_send.restype = ctypes.c_ssize_t

729

record_send.errcheck = _retry_on_error

730

731

certificate_allocate_credentials = (

732

_library.gnutls_certificate_allocate_credentials)

733

certificate_allocate_credentials.argtypes = [

734

PointerTo(Credentials)]

735

certificate_allocate_credentials.restype = _error_code

736

737

certificate_free_credentials = (

738

_library.gnutls_certificate_free_credentials)

739

certificate_free_credentials.argtypes = [Credentials]

740

certificate_free_credentials.restype = None

741

742

handshake_set_private_extensions = (

743

_library.gnutls_handshake_set_private_extensions)

744

handshake_set_private_extensions.argtypes = [ClientSession,

745

ctypes.c_int]

746

handshake_set_private_extensions.restype = None

747

748

credentials_set = _library.gnutls_credentials_set

749

credentials_set.argtypes = [ClientSession, credentials_type_t,

750

CastToVoidPointer(Credentials)]

751

credentials_set.restype = _error_code

752

753

strerror = _library.gnutls_strerror

754

strerror.argtypes = [ctypes.c_int]

755

strerror.restype = ctypes.c_char_p

756

757

certificate_type_get = _library.gnutls_certificate_type_get

758

certificate_type_get.argtypes = [ClientSession]

759

certificate_type_get.restype = _error_code

760

761

certificate_get_peers = _library.gnutls_certificate_get_peers

762

certificate_get_peers.argtypes = [ClientSession,

763

ctypes.POINTER(ctypes.c_uint)]

764

certificate_get_peers.restype = ctypes.POINTER(datum_t)

765

766

global_set_log_level = _library.gnutls_global_set_log_level

767

global_set_log_level.argtypes = [ctypes.c_int]

768

global_set_log_level.restype = None

769

770

global_set_log_function = _library.gnutls_global_set_log_function

771

global_set_log_function.argtypes = [log_func]

772

global_set_log_function.restype = None

773

774

deinit = _library.gnutls_deinit

775

deinit.argtypes = [ClientSession]

776

deinit.restype = None

777

778

handshake = _library.gnutls_handshake

779

handshake.argtypes = [ClientSession]

780

handshake.restype = ctypes.c_int

781

handshake.errcheck = _retry_on_error

782

783

transport_set_ptr = _library.gnutls_transport_set_ptr

784

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

785

transport_set_ptr.restype = None

786

787

bye = _library.gnutls_bye

788

bye.argtypes = [ClientSession, close_request_t]

789

bye.restype = ctypes.c_int

790

bye.errcheck = _retry_on_error

791

792

check_version = _library.gnutls_check_version

793

check_version.argtypes = [ctypes.c_char_p]

794

check_version.restype = ctypes.c_char_p

795

796

_need_version = b"3.3.0"

797

if check_version(_need_version) is None:

798

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

799

.format(_need_version))

800

801

_tls_rawpk_version = b"3.6.6"

802

has_rawpk = bool(check_version(_tls_rawpk_version))

803

804

if has_rawpk:

805

# Types

806

class pubkey_st(ctypes.Structure):

807

_fields = []

808

pubkey_t = ctypes.POINTER(pubkey_st)

809

810

x509_crt_fmt_t = ctypes.c_int

811

812

# All the function declarations below are from

813

# gnutls/abstract.h

814

pubkey_init = _library.gnutls_pubkey_init

815

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

816

pubkey_init.restype = _error_code

817

818

pubkey_import = _library.gnutls_pubkey_import

819

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

820

x509_crt_fmt_t]

821

pubkey_import.restype = _error_code

822

823

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

824

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

825

ctypes.POINTER(ctypes.c_ubyte),

826

ctypes.POINTER(ctypes.c_size_t)]

827

pubkey_get_key_id.restype = _error_code

828

829

pubkey_deinit = _library.gnutls_pubkey_deinit

830

pubkey_deinit.argtypes = [pubkey_t]

831

pubkey_deinit.restype = None

832

else:

833

# All the function declarations below are from

834

# gnutls/openpgp.h

835

836

openpgp_crt_init = _library.gnutls_openpgp_crt_init

837

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

838

openpgp_crt_init.restype = _error_code

839

840

openpgp_crt_import = _library.gnutls_openpgp_crt_import

841

openpgp_crt_import.argtypes = [openpgp_crt_t,

842

ctypes.POINTER(datum_t),

843

openpgp_crt_fmt_t]

844

openpgp_crt_import.restype = _error_code

845

846

openpgp_crt_verify_self = \

847

_library.gnutls_openpgp_crt_verify_self

848

openpgp_crt_verify_self.argtypes = [

849

openpgp_crt_t,

850

ctypes.c_uint,

851

ctypes.POINTER(ctypes.c_uint),

852

]

853

openpgp_crt_verify_self.restype = _error_code

854

855

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

856

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

857

openpgp_crt_deinit.restype = None

858

859

openpgp_crt_get_fingerprint = (

860

_library.gnutls_openpgp_crt_get_fingerprint)

861

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

862

ctypes.c_void_p,

863

ctypes.POINTER(

864

ctypes.c_size_t)]

865

openpgp_crt_get_fingerprint.restype = _error_code

866

867

if check_version(b"3.6.4"):

868

certificate_type_get2 = _library.gnutls_certificate_type_get2

869

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

870

certificate_type_get2.restype = _error_code

871

872

# Remove non-public functions

873

del _error_code, _retry_on_error

874

875

876

def call_pipe(connection, # : multiprocessing.Connection

877

func, *args, **kwargs):

878

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

879

880

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

881

return value on the provided multiprocessing.Connection.

882

"""

883

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

884

connection.close()

885

886

887

class Client:

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

408

409

410

class Client(object):

888

411

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

889

412

890

413

Attributes:

891

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

414

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

892

415

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

893

416

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

894

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

895

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

896

running.

897

checker_callback_tag: a GLib event source tag, or None

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

898

421

checker_command: string; External command which is run to check

899

422

if client lives. %() expansions are done at

900

423

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

901

424

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

902

checker_initiator_tag: a GLib event source tag, or None

425

checker_initiator_tag: a gobject event source tag, or None

903

426

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

904

427

client_structure: Object describing what attributes a client has

905

428

and is used for storing the client at exit

906

429

current_checker_command: string; current running checker_command

907

disable_initiator_tag: a GLib event source tag, or None

430

disable_initiator_tag: a gobject event source tag, or None

908

431

enabled: bool()

909

432

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

910

uniquely identify an OpenPGP client

911

key_id: string (64 hexadecimal digits); used to uniquely identify

912

a client using raw public keys

433

uniquely identify the client

913

434

host: string; available for use by the checker command

914

435

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

915

436

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

917

438

last_checker_status: integer between 0 and 255 reflecting exit

918

439

status of last checker. -1 reflects crashed

919

440

checker, -2 means no checker completed yet.

920

last_checker_signal: The signal which killed the last checker, if

921

last_checker_status is -1

922

441

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

923

442

924

443

D-Bus identifiers

931

450

disabled, or None

932

451

server_settings: The server_settings dict from main()

933

452

"""

934

453

935

454

runtime_expansions = ("approval_delay", "approval_duration",

936

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

455

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

937

456

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

938

457

"last_approval_request", "last_checked_ok",

939

458

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

940

client_defaults = {

941

"timeout": "PT5M",

942

"extended_timeout": "PT15M",

943

"interval": "PT2M",

944

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

945

"host": "",

946

"approval_delay": "PT0S",

947

"approval_duration": "PT1S",

948

"approved_by_default": "True",

949

"enabled": "True",

950

}

951

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

952

485

@staticmethod

953

486

def config_parser(config):

954

487

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

961

494

for client_name in config.sections():

962

495

section = dict(config.items(client_name))

963

496

client = settings[client_name] = {}

964

497

965

498

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

966

499

# Reformat values from string types to Python types

967

500

client["approved_by_default"] = config.getboolean(

968

501

client_name, "approved_by_default")

969

502

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

970

503

"enabled")

971

972

# Uppercase and remove spaces from key_id and fingerprint

973

# for later comparison purposes with return value from the

974

# key_id() and fingerprint() functions

975

client["key_id"] = (section.get("key_id", "").upper()

976

.replace(" ", ""))

977

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

978

"").upper()

504

505

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

979

506

.replace(" ", ""))

980

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

981

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

982

" fingerprint", client_name)

983

del settings[client_name]

984

continue

985

507

if "secret" in section:

986

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

987

.encode("utf-8"),

988

"base64")

508

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

989

509

elif "secfile" in section:

990

510

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

991

511

(section["secfile"])),

992

512

"rb") as secfile:

993

513

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

994

514

else:

995

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

515

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

996

516

.format(section))

997

517

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

998

518

client["extended_timeout"] = string_to_delta(

1006

526

client["last_approval_request"] = None

1007

527

client["last_checked_ok"] = None

1008

528

client["last_checker_status"] = -2

1009

529

1010

530

return settings

1011

1012

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

531

532

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

1013

533

self.name = name

1014

534

if server_settings is None:

1015

535

server_settings = {}

1016

536

self.server_settings = server_settings

1017

537

# adding all client settings

1018

for setting, value in settings.items():

538

for setting, value in settings.iteritems():

1019

539

setattr(self, setting, value)

1020

540

1021

541

if self.enabled:

1022

542

if not hasattr(self, "last_enabled"):

1023

543

self.last_enabled = datetime.datetime.utcnow()

1027

547

else:

1028

548

self.last_enabled = None

1029

549

self.expires = None

1030

1031

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

1032

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

1033

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

550

551

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

555

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

1034

556

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

1035

557

datetime.datetime.utcnow())

1036

558

1037

559

# attributes specific for this server instance

1038

560

self.checker = None

1039

561

self.checker_initiator_tag = None

1042

564

self.current_checker_command = None

1043

565

self.approved = None

1044

566

self.approvals_pending = 0

1045

self.changedstate = multiprocessing_manager.Condition(

1046

multiprocessing_manager.Lock())

1047

self.client_structure = [attr

1048

for attr in self.__dict__.keys()

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

1049

572

if not attr.startswith("_")]

1050

573

self.client_structure.append("client_structure")

1051

1052

for name, t in inspect.getmembers(

1053

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

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

1054

579

if not name.startswith("_"):

1055

580

self.client_structure.append(name)

1056

581

1057

582

# Send notice to process children that client state has changed

1058

583

def send_changedstate(self):

1059

584

with self.changedstate:

1060

585

self.changedstate.notify_all()

1061

586

1062

587

def enable(self):

1063

588

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

1064

589

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

1065

590

# Already enabled

1066

591

return

592

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

1067

593

self.enabled = True

1068

594

self.last_enabled = datetime.datetime.utcnow()

1069

595

self.init_checker()

1070

596

self.send_changedstate()

1071

597

1072

598

def disable(self, quiet=True):

1073

599

"""Disable this client."""

1074

600

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

1075

601

return False

1076

602

if not quiet:

1077

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

603

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

1078

604

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

1079

GLib.source_remove(self.disable_initiator_tag)

605

gobject.source_remove(self.disable_initiator_tag)

1080

606

self.disable_initiator_tag = None

1081

607

self.expires = None

1082

608

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

1083

GLib.source_remove(self.checker_initiator_tag)

609

gobject.source_remove(self.checker_initiator_tag)

1084

610

self.checker_initiator_tag = None

1085

611

self.stop_checker()

1086

612

self.enabled = False

1087

613

if not quiet:

1088

614

self.send_changedstate()

1089

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

615

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

1090

616

return False

1091

617

1092

618

def __del__(self):

1093

619

self.disable()

1094

1095

def init_checker(self, randomize_start=False):

1096

# Schedule a new checker to be started a randomly selected

1097

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

1098

# the startup of checkers over time when the server is

1099

# started.

620

621

def init_checker(self):

622

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

623

# and every interval from then on.

1100

624

if self.checker_initiator_tag is not None:

1101

GLib.source_remove(self.checker_initiator_tag)

1102

interval_milliseconds = int(self.interval.total_seconds()

1103

* 1000)

1104

if randomize_start:

1105

delay_milliseconds = random.randrange(

1106

interval_milliseconds + 1)

1107

else:

1108

delay_milliseconds = interval_milliseconds

1109

self.checker_initiator_tag = GLib.timeout_add(

1110

delay_milliseconds, self.start_checker, randomize_start)

1111

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

1112

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

1113

# expire at the soonest one interval after a checker was

1114

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

1115

# time might have to be extended.

1116

now = datetime.datetime.utcnow()

1117

self.expires = now + delay + self.interval

1118

# Schedule a disable() at expire time

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

629

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

1119

630

if self.disable_initiator_tag is not None:

1120

GLib.source_remove(self.disable_initiator_tag)

1121

self.disable_initiator_tag = GLib.timeout_add(

1122

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

1123

self.disable)

1124

1125

def checker_callback(self, source, condition, connection,

1126

command):

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

635

# Also start a new checker *right now*.

636

self.start_checker()

637

638

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

1127

639

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

1128

# Read return code from connection (see call_pipe)

1129

returncode = connection.recv()

1130

connection.close()

1131

if self.checker is not None:

1132

self.checker.join()

1133

640

self.checker_callback_tag = None

1134

641

self.checker = None

1135

1136

if returncode >= 0:

1137

self.last_checker_status = returncode

1138

self.last_checker_signal = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1139

644

if self.last_checker_status == 0:

1140

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

645

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

646

vars(self))

1141

647

self.checked_ok()

1142

648

else:

1143

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

649

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

650

vars(self))

1144

651

else:

1145

652

self.last_checker_status = -1

1146

self.last_checker_signal = -returncode

1147

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

1148

return False

1149

653

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

654

vars(self))

655

1150

656

def checked_ok(self):

1151

657

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

1152

658

self.last_checked_ok = datetime.datetime.utcnow()

1153

659

self.last_checker_status = 0

1154

self.last_checker_signal = None

1155

660

self.bump_timeout()

1156

661

1157

662

def bump_timeout(self, timeout=None):

1158

663

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

1159

664

if timeout is None:

1160

665

timeout = self.timeout

1161

666

if self.disable_initiator_tag is not None:

1162

GLib.source_remove(self.disable_initiator_tag)

667

gobject.source_remove(self.disable_initiator_tag)

1163

668

self.disable_initiator_tag = None

1164

669

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

1165

self.disable_initiator_tag = GLib.timeout_add(

1166

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1167

673

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

1168

674

1169

675

def need_approval(self):

1170

676

self.last_approval_request = datetime.datetime.utcnow()

1171

1172

def start_checker(self, start_was_randomized=False):

677

678

def start_checker(self):

1173

679

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

1174

680

1175

681

If a checker already exists, leave it running and do

1176

682

nothing."""

1177

683

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

1182

688

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

1183

689

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

1184

690

# should be.

1185

1186

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

1187

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

1188

self.checker.join()

1189

self.checker = None

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1190

706

# Start a new checker if needed

1191

707

if self.checker is None:

1192

708

# Escape attributes for the shell

1193

escaped_attrs = {

1194

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

1195

for attr in self.runtime_expansions}

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1196

713

try:

1197

714

command = self.checker_command % escaped_attrs

1198

715

except TypeError as error:

1199

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

1200

self.checker_command, exc_info=error)

1201

return True # Try again later

716

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1202

719

self.current_checker_command = command

1203

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

1204

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

1205

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

1206

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

1207

# always replaced by /dev/null.)

1208

# The exception is when not debugging but nevertheless

1209

# running in the foreground; use the previously

1210

# created wnull.

1211

popen_args = {"close_fds": True,

1212

"shell": True,

1213

"cwd": "/"}

1214

if (not self.server_settings["debug"]

1215

and self.server_settings["foreground"]):

1216

popen_args.update({"stdout": wnull,

1217

"stderr": wnull})

1218

pipe = multiprocessing.Pipe(duplex=False)

1219

self.checker = multiprocessing.Process(

1220

target=call_pipe,

1221

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

1222

kwargs=popen_args)

1223

self.checker.start()

1224

self.checker_callback_tag = GLib.io_add_watch(

1225

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

1226

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1227

self.checker_callback, pipe[0], command)

1228

if start_was_randomized:

1229

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

1230

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

1231

# interval from then on.

1232

now = datetime.datetime.utcnow()

1233

self.checker_initiator_tag = GLib.timeout_add(

1234

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

1235

self.start_checker)

1236

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

1237

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

1238

return False

1239

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

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1240

762

return True

1241

763

1242

764

def stop_checker(self):

1243

765

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

1244

766

if self.checker_callback_tag:

1245

GLib.source_remove(self.checker_callback_tag)

767

gobject.source_remove(self.checker_callback_tag)

1246

768

self.checker_callback_tag = None

1247

769

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

1248

770

return

1249

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

1250

self.checker.terminate()

771

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

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1251

780

self.checker = None

1252

781

1253

782

1254

def dbus_service_property(dbus_interface,

1255

signature="v",

1256

access="readwrite",

1257

byte_arrays=False):

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1258

785

"""Decorators for marking methods of a DBusObjectWithProperties to

1259

786

become properties on the D-Bus.

1260

787

1261

788

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

1262

789

and with one argument by "Set".

1263

790

1264

791

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

1265

792

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

1266

793

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

1269

796

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

1270

797

if byte_arrays and signature != "ay":

1271

798

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

1272

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

1273

799

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

1274

800

def decorator(func):

1275

801

func._dbus_is_property = True

1276

802

func._dbus_interface = dbus_interface

1279

805

func._dbus_name = func.__name__

1280

806

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

1281

807

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

1282

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1283

809

return func

1284

1285

810

return decorator

1286

811

1287

812

1288

813

def dbus_interface_annotations(dbus_interface):

1289

814

"""Decorator for marking functions returning interface annotations

1290

815

1291

816

Usage:

1292

817

1293

818

@dbus_interface_annotations("org.example.Interface")

1294

819

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

1295

820

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

1296

821

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

1297

822

"false"}

1298

823

"""

1299

1300

824

def decorator(func):

1301

825

func._dbus_is_interface = True

1302

826

func._dbus_interface = dbus_interface

1303

827

func._dbus_name = dbus_interface

1304

828

return func

1305

1306

829

return decorator

1307

830

1308

831

1309

832

def dbus_annotations(annotations):

1310

833

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

1311

834

Usage:

1312

1313

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

1314

"org.freedesktop.DBus.Property."

1315

"EmitsChangedSignal": "false"})

835

1316

836

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

1317

837

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

1318

841

def Property_dbus_property(self):

1319

842

return dbus.Boolean(False)

1320

1321

See also the DBusObjectWithAnnotations class.

1322

843

"""

1323

1324

844

def decorator(func):

1325

845

func._dbus_annotations = annotations

1326

846

return func

1327

1328

847

return decorator

1329

848

1330

849

1331

850

class DBusPropertyException(dbus.exceptions.DBusException):

1332

851

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

1333

852

"""

1334

pass

853

def __unicode__(self):

854

return unicode(str(self))

1335

855

1336

856

1337

857

class DBusPropertyAccessException(DBusPropertyException):

1346

866

pass

1347

867

1348

868

1349

class DBusObjectWithAnnotations(dbus.service.Object):

1350

"""A D-Bus object with annotations.

1351

1352

Classes inheriting from this can use the dbus_annotations

1353

decorator to add annotations to methods or signals.

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1354

875

"""

1355

876

1356

877

@staticmethod

1357

878

def _is_dbus_thing(thing):

1358

879

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

1359

880

1360

881

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

1361

882

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

1362

883

"""

1363

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

884

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

1364

885

False)

1365

886

1366

887

def _get_all_dbus_things(self, thing):

1367

888

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

1368

889

"""

1369

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

890

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

891

name),

1370

892

athing.__get__(self))

1371

893

for cls in self.__class__.__mro__

1372

894

for name, athing in

1373

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

1374

1375

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1376

out_signature="s",

1377

path_keyword="object_path",

1378

connection_keyword="connection")

1379

def Introspect(self, object_path, connection):

1380

"""Overloading of standard D-Bus method.

1381

1382

Inserts annotation tags on methods and signals.

1383

"""

1384

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

1385

connection)

1386

try:

1387

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

1388

1389

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

1390

# Add annotation tags

1391

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

1392

for tag in if_tag.getElementsByTagName(typ):

1393

annots = dict()

1394

for name, prop in (self.

1395

_get_all_dbus_things(typ)):

1396

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

1397

and prop._dbus_interface

1398

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

1399

annots.update(getattr(

1400

prop, "_dbus_annotations", {}))

1401

for name, value in annots.items():

1402

ann_tag = document.createElement(

1403

"annotation")

1404

ann_tag.setAttribute("name", name)

1405

ann_tag.setAttribute("value", value)

1406

tag.appendChild(ann_tag)

1407

# Add interface annotation tags

1408

for annotation, value in dict(

1409

itertools.chain.from_iterable(

1410

annotations().items()

1411

for name, annotations

1412

in self._get_all_dbus_things("interface")

1413

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

1414

)).items():

1415

ann_tag = document.createElement("annotation")

1416

ann_tag.setAttribute("name", annotation)

1417

ann_tag.setAttribute("value", value)

1418

if_tag.appendChild(ann_tag)

1419

# Fix argument name for the Introspect method itself

1420

if (if_tag.getAttribute("name")

1421

== dbus.INTROSPECTABLE_IFACE):

1422

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

1423

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

1424

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

1425

if (arg.getAttribute("direction")

1426

== "out"):

1427

arg.setAttribute("name",

1428

"xml_data")

1429

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

1430

document.unlink()

1431

except (AttributeError, xml.dom.DOMException,

1432

xml.parsers.expat.ExpatError) as error:

1433

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

1434

exc_info=error)

1435

return xmlstring

1436

1437

1438

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1439

"""A D-Bus object with properties.

1440

1441

Classes inheriting from this can use the dbus_service_property

1442

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

1443

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

1444

"""

1445

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1446

898

def _get_dbus_property(self, interface_name, property_name):

1447

899

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

1448

900

property with the specified name and interface.

1449

901

"""

1450

for cls in self.__class__.__mro__:

1451

for name, value in inspect.getmembers(

1452

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

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1453

906

if (value._dbus_name == property_name

1454

907

and value._dbus_interface == interface_name):

1455

908

return value.__get__(self)

1456

909

1457

910

# No such property

1458

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

1459

self.dbus_object_path, interface_name, property_name))

1460

1461

@classmethod

1462

def _get_all_interface_names(cls):

1463

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

1464

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

1465

"_dbus_interface", None)

1466

for x in (inspect.getmro(cls))

1467

for attr in dir(x))

1468

if name is not None)

1469

1470

@dbus.service.method(dbus.PROPERTIES_IFACE,

1471

in_signature="ss",

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1472

916

out_signature="v")

1473

917

def Get(self, interface_name, property_name):

1474

918

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

1480

924

if not hasattr(value, "variant_level"):

1481

925

return value

1482

926

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

1483

927

1484

928

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

1485

929

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

1486

930

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

1493

937

# signatures other than "ay".

1494

938

if prop._dbus_signature != "ay":

1495

939

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

1496

"'ay' signature {!r}"

940

"'ay' signature {0!r}"

1497

941

.format(prop._dbus_signature))

1498

value = dbus.ByteArray(bytes(value))

942

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

943

for byte in value))

1499

944

prop(value)

1500

1501

@dbus.service.method(dbus.PROPERTIES_IFACE,

1502

in_signature="s",

945

946

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

1503

947

out_signature="a{sv}")

1504

948

def GetAll(self, interface_name):

1505

949

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

1506

950

standard.

1507

951

1508

952

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

1509

953

"""

1510

954

properties = {}

1520

964

if not hasattr(value, "variant_level"):

1521

965

properties[name] = value

1522

966

continue

1523

properties[name] = type(value)(

1524

value, variant_level=value.variant_level + 1)

967

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

968

value.variant_level+1)

1525

969

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

1526

1527

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

1528

def PropertiesChanged(self, interface_name, changed_properties,

1529

invalidated_properties):

1530

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

1531

standard.

1532

"""

1533

pass

1534

970

1535

971

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1536

972

out_signature="s",

1537

path_keyword="object_path",

1538

connection_keyword="connection")

973

path_keyword='object_path',

974

connection_keyword='connection')

1539

975

def Introspect(self, object_path, connection):

1540

976

"""Overloading of standard D-Bus method.

1541

977

1542

978

Inserts property tags and interface annotation tags.

1543

979

"""

1544

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1545

object_path,

1546

connection)

980

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

981

connection)

1547

982

try:

1548

983

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

1549

1550

984

def make_tag(document, name, prop):

1551

985

e = document.createElement("property")

1552

986

e.setAttribute("name", name)

1553

987

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

1554

988

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

1555

989

return e

1556

1557

990

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

1558

991

# Add property tags

1559

992

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

1562

995

if prop._dbus_interface

1563

996

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

1564

997

if_tag.appendChild(tag)

1565

# Add annotation tags for properties

1566

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

1567

annots = dict()

1568

for name, prop in self._get_all_dbus_things(

1569

"property"):

1570

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

1571

and prop._dbus_interface

1572

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

1573

annots.update(getattr(

1574

prop, "_dbus_annotations", {}))

1575

for name, value in annots.items():

1576

ann_tag = document.createElement(

1577

"annotation")

1578

ann_tag.setAttribute("name", name)

1579

ann_tag.setAttribute("value", value)

1580

tag.appendChild(ann_tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1581

1029

# Add the names to the return values for the

1582

1030

# "org.freedesktop.DBus.Properties" methods

1583

1031

if (if_tag.getAttribute("name")

1597

1045

document.unlink()

1598

1046

except (AttributeError, xml.dom.DOMException,

1599

1047

xml.parsers.expat.ExpatError) as error:

1600

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

1601

exc_info=error)

1602

return xmlstring

1603

1604

1605

try:

1606

dbus.OBJECT_MANAGER_IFACE

1607

except AttributeError:

1608

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

1609

1610

1611

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1612

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

1613

1614

Classes inheriting from this exposes the standard

1615

GetManagedObjects call and the InterfacesAdded and

1616

InterfacesRemoved signals on the standard

1617

"org.freedesktop.DBus.ObjectManager" interface.

1618

1619

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

1620

manually.

1621

"""

1622

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1623

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

1624

def GetManagedObjects(self):

1625

"""This function must be overridden"""

1626

raise NotImplementedError()

1627

1628

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1629

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

1630

def InterfacesAdded(self, object_path, interfaces_and_properties):

1631

pass

1632

1633

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

1634

def InterfacesRemoved(self, object_path, interfaces):

1635

pass

1636

1637

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1638

out_signature="s",

1639

path_keyword="object_path",

1640

connection_keyword="connection")

1641

def Introspect(self, object_path, connection):

1642

"""Overloading of standard D-Bus method.

1643

1644

Override return argument name of GetManagedObjects to be

1645

"objpath_interfaces_and_properties"

1646

"""

1647

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1648

object_path,

1649

connection)

1650

try:

1651

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

1652

1653

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

1654

# Fix argument name for the GetManagedObjects method

1655

if (if_tag.getAttribute("name")

1656

== dbus.OBJECT_MANAGER_IFACE):

1657

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

1658

if (cn.getAttribute("name")

1659

== "GetManagedObjects"):

1660

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

1661

if (arg.getAttribute("direction")

1662

== "out"):

1663

arg.setAttribute(

1664

"name",

1665

"objpath_interfaces"

1666

"_and_properties")

1667

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

1668

document.unlink()

1669

except (AttributeError, xml.dom.DOMException,

1670

xml.parsers.expat.ExpatError) as error:

1671

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

1672

exc_info=error)

1048

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

1049

exc_info=error)

1673

1050

return xmlstring

1674

1051

1675

1052

1676

1053

def datetime_to_dbus(dt, variant_level=0):

1677

1054

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

1678

1055

if dt is None:

1679

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

1680

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

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1681

1059

1682

1060

1683

1061

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1685

1063

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

1686

1064

interface names according to the "alt_interface_names" mapping.

1687

1065

Usage:

1688

1066

1689

1067

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

1690

1068

"net.example.AlternateInterface"})

1691

1069

class SampleDBusObject(dbus.service.Object):

1692

1070

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

1693

1071

def SampleDBusMethod():

1694

1072

pass

1695

1073

1696

1074

The above "SampleDBusMethod" on "SampleDBusObject" will be

1697

1075

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

1698

1076

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

1699

1077

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

1700

1078

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

1701

1079

1702

1080

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

1703

1081

(from DBusObjectWithProperties) and interfaces (from the

1704

1082

dbus_interface_annotations decorator).

1705

1083

"""

1706

1707

1084

def wrapper(cls):

1708

1085

for orig_interface_name, alt_interface_name in (

1709

alt_interface_names.items()):

1086

alt_interface_names.iteritems()):

1710

1087

attr = {}

1711

1088

interface_names = set()

1712

1089

# Go though all attributes of the class

1714

1091

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

1715

1092

# with the wrong interface name

1716

1093

if (not hasattr(attribute, "_dbus_interface")

1717

or not attribute._dbus_interface.startswith(

1718

orig_interface_name)):

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1719

1096

continue

1720

1097

# Create an alternate D-Bus interface name based on

1721

1098

# the current name

1722

alt_interface = attribute._dbus_interface.replace(

1723

orig_interface_name, alt_interface_name)

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1724

1102

interface_names.add(alt_interface)

1725

1103

# Is this a D-Bus signal?

1726

1104

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

1727

1105

# Extract the original non-method undecorated

1728

1106

# function by black magic

1729

if sys.version_info.major == 2:

1730

nonmethod_func = (dict(

1107

nonmethod_func = (dict(

1731

1108

zip(attribute.func_code.co_freevars,

1732

attribute.__closure__))

1733

["func"].cell_contents)

1734

else:

1735

nonmethod_func = (dict(

1736

zip(attribute.__code__.co_freevars,

1737

attribute.__closure__))

1738

["func"].cell_contents)

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1739

1111

# Create a new, but exactly alike, function

1740

1112

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

1741

1113

# with the alternate D-Bus interface name

1742

new_function = copy_function(nonmethod_func)

1743

new_function = (dbus.service.signal(

1744

alt_interface,

1745

attribute._dbus_signature)(new_function))

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1746

1123

# Copy annotations, if any

1747

1124

try:

1748

new_function._dbus_annotations = dict(

1749

attribute._dbus_annotations)

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1750

1127

except AttributeError:

1751

1128

pass

1752

1753

1129

# Define a creator of a function to call both the

1754

1130

# original and alternate functions, so both the

1755

1131

# original and alternate signals gets sent when

1758

1134

"""This function is a scope container to pass

1759

1135

func1 and func2 to the "call_both" function

1760

1136

outside of its arguments"""

1761

1762

@functools.wraps(func2)

1763

1137

def call_both(*args, **kwargs):

1764

1138

"""This function will emit two D-Bus

1765

1139

signals by calling func1 and func2"""

1766

1140

func1(*args, **kwargs)

1767

1141

func2(*args, **kwargs)

1768

# Make wrapper function look like a D-Bus

1769

# signal

1770

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

1771

if name.startswith("_dbus_"):

1772

setattr(call_both, name, attr)

1773

1774

1142

return call_both

1775

1143

# Create the "call_both" function and add it to

1776

1144

# the class

1781

1149

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

1782

1150

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

1783

1151

# to the class.

1784

attr[attrname] = (

1785

dbus.service.method(

1786

alt_interface,

1787

attribute._dbus_in_signature,

1788

attribute._dbus_out_signature)

1789

(copy_function(attribute)))

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1790

1162

# Copy annotations, if any

1791

1163

try:

1792

attr[attrname]._dbus_annotations = dict(

1793

attribute._dbus_annotations)

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1794

1166

except AttributeError:

1795

1167

pass

1796

1168

# Is this a D-Bus property?

1799

1171

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

1800

1172

# property with the alternate D-Bus interface

1801

1173

# name. Add it to the class.

1802

attr[attrname] = (dbus_service_property(

1803

alt_interface, attribute._dbus_signature,

1804

attribute._dbus_access,

1805

attribute._dbus_get_args_options

1806

["byte_arrays"])

1807

(copy_function(attribute)))

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1808

1187

# Copy annotations, if any

1809

1188

try:

1810

attr[attrname]._dbus_annotations = dict(

1811

attribute._dbus_annotations)

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1812

1191

except AttributeError:

1813

1192

pass

1814

1193

# Is this a D-Bus interface?

1817

1196

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

1818

1197

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

1819

1198

# to the class.

1820

attr[attrname] = (

1821

dbus_interface_annotations(alt_interface)

1822

(copy_function(attribute)))

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1823

1207

if deprecate:

1824

1208

# Deprecate all alternate interfaces

1825

iname = "_AlternateDBusNames_interface_annotation{}"

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1826

1210

for interface_name in interface_names:

1827

1828

1211

@dbus_interface_annotations(interface_name)

1829

1212

def func(self):

1830

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

1831

"true"}

1213

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

1214

"true" }

1832

1215

# Find an unused name

1833

1216

for aname in (iname.format(i)

1834

1217

for i in itertools.count()):

1838

1221

if interface_names:

1839

1222

# Replace the class with a new subclass of it with

1840

1223

# methods, signals, etc. as created above.

1841

if sys.version_info.major == 2:

1842

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

1843

(cls, ), attr)

1844

else:

1845

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

1846

(cls, ), attr)

1224

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

1225

(cls,), attr)

1847

1226

return cls

1848

1849

1227

return wrapper

1850

1228

1851

1229

1852

1230

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

1853

"se.bsnet.fukt.Mandos"})

1231

"se.bsnet.fukt.Mandos"})

1854

1232

class ClientDBus(Client, DBusObjectWithProperties):

1855

1233

"""A Client class using D-Bus

1856

1234

1857

1235

Attributes:

1858

1236

dbus_object_path: dbus.ObjectPath

1859

1237

bus: dbus.SystemBus()

1860

1238

"""

1861

1239

1862

1240

runtime_expansions = (Client.runtime_expansions

1863

+ ("dbus_object_path", ))

1864

1865

_interface = "se.recompile.Mandos.Client"

1866

1241

+ ("dbus_object_path",))

1242

1867

1243

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

1868

1869

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

1244

1245

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

1870

1246

self.bus = bus

1871

1247

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

1872

1248

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

1873

1249

# the D-Bus

1874

client_object_name = str(self.name).translate(

1250

client_object_name = unicode(self.name).translate(

1875

1251

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

1876

1252

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

1877

self.dbus_object_path = dbus.ObjectPath(

1878

"/clients/" + client_object_name)

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1879

1255

DBusObjectWithProperties.__init__(self, self.bus,

1880

1256

self.dbus_object_path)

1881

1882

def notifychangeproperty(transform_func, dbus_name,

1883

type_func=lambda x: x,

1884

variant_level=1,

1885

invalidate_only=False,

1886

_interface=_interface):

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1887

1261

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

1888

1262

its changes to DBus.

1889

1263

1890

1264

transform_fun: Function that takes a value and a variant_level

1891

1265

and transforms it to a D-Bus type.

1892

1266

dbus_name: D-Bus name of the variable

1894

1268

to the D-Bus. Default: no transform

1895

1269

variant_level: D-Bus variant level. Default: 1

1896

1270

"""

1897

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

1898

1271

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

1899

1272

def setter(self, value):

1900

1273

if hasattr(self, "dbus_object_path"):

1901

1274

if (not hasattr(self, attrname) or

1902

1275

type_func(getattr(self, attrname, None))

1903

1276

!= type_func(value)):

1904

if invalidate_only:

1905

self.PropertiesChanged(

1906

_interface, dbus.Dictionary(),

1907

dbus.Array((dbus_name, )))

1908

else:

1909

dbus_value = transform_func(

1910

type_func(value),

1911

variant_level=variant_level)

1912

self.PropertyChanged(dbus.String(dbus_name),

1913

dbus_value)

1914

self.PropertiesChanged(

1915

_interface,

1916

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

1917

dbus_value}),

1918

dbus.Array())

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1919

1282

setattr(self, attrname, value)

1920

1283

1921

1284

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

1922

1285

1923

1286

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1924

1287

approvals_pending = notifychangeproperty(dbus.Boolean,

1925

1288

"ApprovalPending",

1926

type_func=bool)

1289

type_func = bool)

1927

1290

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

1928

1291

last_enabled = notifychangeproperty(datetime_to_dbus,

1929

1292

"LastEnabled")

1930

checker = notifychangeproperty(

1931

dbus.Boolean, "CheckerRunning",

1932

type_func=lambda checker: checker is not None)

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1933

1296

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1934

1297

"LastCheckedOK")

1935

1298

last_checker_status = notifychangeproperty(dbus.Int16,

1938

1301

datetime_to_dbus, "LastApprovalRequest")

1939

1302

approved_by_default = notifychangeproperty(dbus.Boolean,

1940

1303

"ApprovedByDefault")

1941

approval_delay = notifychangeproperty(

1942

dbus.UInt64, "ApprovalDelay",

1943

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

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1944

1308

approval_duration = notifychangeproperty(

1945

1309

dbus.UInt64, "ApprovalDuration",

1946

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

1310

type_func = timedelta_to_milliseconds)

1947

1311

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

1948

timeout = notifychangeproperty(

1949

dbus.UInt64, "Timeout",

1950

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1951

1315

extended_timeout = notifychangeproperty(

1952

1316

dbus.UInt64, "ExtendedTimeout",

1953

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

1954

interval = notifychangeproperty(

1955

dbus.UInt64, "Interval",

1956

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

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1957

1322

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

1958

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

1959

invalidate_only=True)

1960

1323

1961

1324

del notifychangeproperty

1962

1325

1963

1326

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

1964

1327

try:

1965

1328

self.remove_from_connection()

1968

1331

if hasattr(DBusObjectWithProperties, "__del__"):

1969

1332

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

1970

1333

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

1971

1972

def checker_callback(self, source, condition,

1973

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

1974

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

1975

connection, command, *args,

1976

**kwargs)

1977

exitstatus = self.last_checker_status

1978

if exitstatus >= 0:

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1979

1341

# Emit D-Bus signal

1980

1342

self.CheckerCompleted(dbus.Int16(exitstatus),

1981

# This is specific to GNU libC

1982

dbus.Int64(exitstatus << 8),

1343

dbus.Int64(condition),

1983

1344

dbus.String(command))

1984

1345

else:

1985

1346

# Emit D-Bus signal

1986

1347

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

1987

dbus.Int64(

1988

# This is specific to GNU libC

1989

(exitstatus << 8)

1990

| self.last_checker_signal),

1348

dbus.Int64(condition),

1991

1349

dbus.String(command))

1992

return ret

1993

1350

1351

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

1352

*args, **kwargs)

1353

1994

1354

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

1995

1355

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

1996

1356

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

2000

1360

# Emit D-Bus signal

2001

1361

self.CheckerStarted(self.current_checker_command)

2002

1362

return r

2003

1363

2004

1364

def _reset_approved(self):

2005

1365

self.approved = None

2006

1366

return False

2007

1367

2008

1368

def approve(self, value=True):

2009

1369

self.approved = value

2010

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

2011

* 1000), self._reset_approved)

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

2012

1373

self.send_changedstate()

2013

2014

# D-Bus methods, signals & properties

2015

2016

# Interfaces

2017

2018

# Signals

2019

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

2020

1387

# CheckerCompleted - signal

2021

1388

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

2022

1389

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

2023

1390

"D-Bus signal"

2024

1391

pass

2025

1392

2026

1393

# CheckerStarted - signal

2027

1394

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

2028

1395

def CheckerStarted(self, command):

2029

1396

"D-Bus signal"

2030

1397

pass

2031

1398

2032

1399

# PropertyChanged - signal

2033

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

2034

1400

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

2035

1401

def PropertyChanged(self, property, value):

2036

1402

"D-Bus signal"

2037

1403

pass

2038

1404

2039

1405

# GotSecret - signal

2040

1406

@dbus.service.signal(_interface)

2041

1407

def GotSecret(self):

2044

1410

server to mandos-client

2045

1411

"""

2046

1412

pass

2047

1413

2048

1414

# Rejected - signal

2049

1415

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

2050

1416

def Rejected(self, reason):

2051

1417

"D-Bus signal"

2052

1418

pass

2053

1419

2054

1420

# NeedApproval - signal

2055

1421

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

2056

1422

def NeedApproval(self, timeout, default):

2057

1423

"D-Bus signal"

2058

1424

return self.need_approval()

2059

2060

# Methods

2061

1425

1426

## Methods

1427

2062

1428

# Approve - method

2063

1429

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

2064

1430

def Approve(self, value):

2065

1431

self.approve(value)

2066

1432

2067

1433

# CheckedOK - method

2068

1434

@dbus.service.method(_interface)

2069

1435

def CheckedOK(self):

2070

1436

self.checked_ok()

2071

1437

2072

1438

# Enable - method

2073

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

2074

1439

@dbus.service.method(_interface)

2075

1440

def Enable(self):

2076

1441

"D-Bus method"

2077

1442

self.enable()

2078

1443

2079

1444

# StartChecker - method

2080

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

2081

1445

@dbus.service.method(_interface)

2082

1446

def StartChecker(self):

2083

1447

"D-Bus method"

2084

1448

self.start_checker()

2085

1449

2086

1450

# Disable - method

2087

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

2088

1451

@dbus.service.method(_interface)

2089

1452

def Disable(self):

2090

1453

"D-Bus method"

2091

1454

self.disable()

2092

1455

2093

1456

# StopChecker - method

2094

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

2095

1457

@dbus.service.method(_interface)

2096

1458

def StopChecker(self):

2097

1459

self.stop_checker()

2098

2099

# Properties

2100

1460

1461

## Properties

1462

2101

1463

# ApprovalPending - property

2102

1464

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

2103

1465

def ApprovalPending_dbus_property(self):

2104

1466

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

2105

1467

2106

1468

# ApprovedByDefault - property

2107

@dbus_service_property(_interface,

2108

signature="b",

1469

@dbus_service_property(_interface, signature="b",

2109

1470

access="readwrite")

2110

1471

def ApprovedByDefault_dbus_property(self, value=None):

2111

1472

if value is None: # get

2112

1473

return dbus.Boolean(self.approved_by_default)

2113

1474

self.approved_by_default = bool(value)

2114

1475

2115

1476

# ApprovalDelay - property

2116

@dbus_service_property(_interface,

2117

signature="t",

1477

@dbus_service_property(_interface, signature="t",

2118

1478

access="readwrite")

2119

1479

def ApprovalDelay_dbus_property(self, value=None):

2120

1480

if value is None: # get

2121

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

2122

* 1000)

1481

return dbus.UInt64(self.approval_delay_milliseconds())

2123

1482

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

2124

1483

2125

1484

# ApprovalDuration - property

2126

@dbus_service_property(_interface,

2127

signature="t",

1485

@dbus_service_property(_interface, signature="t",

2128

1486

access="readwrite")

2129

1487

def ApprovalDuration_dbus_property(self, value=None):

2130

1488

if value is None: # get

2131

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

2132

* 1000)

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

2133

1491

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

2134

1492

2135

1493

# Name - property

2136

@dbus_annotations(

2137

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

2138

1494

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

2139

1495

def Name_dbus_property(self):

2140

1496

return dbus.String(self.name)

2141

2142

# KeyID - property

2143

@dbus_annotations(

2144

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

2145

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

2146

def KeyID_dbus_property(self):

2147

return dbus.String(self.key_id)

2148

1497

2149

1498

# Fingerprint - property

2150

@dbus_annotations(

2151

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

2152

1499

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

2153

1500

def Fingerprint_dbus_property(self):

2154

1501

return dbus.String(self.fingerprint)

2155

1502

2156

1503

# Host - property

2157

@dbus_service_property(_interface,

2158

signature="s",

1504

@dbus_service_property(_interface, signature="s",

2159

1505

access="readwrite")

2160

1506

def Host_dbus_property(self, value=None):

2161

1507

if value is None: # get

2162

1508

return dbus.String(self.host)

2163

self.host = str(value)

2164

1509

self.host = unicode(value)

1510

2165

1511

# Created - property

2166

@dbus_annotations(

2167

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

2168

1512

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

2169

1513

def Created_dbus_property(self):

2170

1514

return datetime_to_dbus(self.created)

2171

1515

2172

1516

# LastEnabled - property

2173

1517

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

2174

1518

def LastEnabled_dbus_property(self):

2175

1519

return datetime_to_dbus(self.last_enabled)

2176

1520

2177

1521

# Enabled - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1522

@dbus_service_property(_interface, signature="b",

2180

1523

access="readwrite")

2181

1524

def Enabled_dbus_property(self, value=None):

2182

1525

if value is None: # get

2185

1528

self.enable()

2186

1529

else:

2187

1530

self.disable()

2188

1531

2189

1532

# LastCheckedOK - property

2190

@dbus_service_property(_interface,

2191

signature="s",

1533

@dbus_service_property(_interface, signature="s",

2192

1534

access="readwrite")

2193

1535

def LastCheckedOK_dbus_property(self, value=None):

2194

1536

if value is not None:

2195

1537

self.checked_ok()

2196

1538

return

2197

1539

return datetime_to_dbus(self.last_checked_ok)

2198

1540

2199

1541

# LastCheckerStatus - property

2200

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

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2201

1544

def LastCheckerStatus_dbus_property(self):

2202

1545

return dbus.Int16(self.last_checker_status)

2203

1546

2204

1547

# Expires - property

2205

1548

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

2206

1549

def Expires_dbus_property(self):

2207

1550

return datetime_to_dbus(self.expires)

2208

1551

2209

1552

# LastApprovalRequest - property

2210

1553

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

2211

1554

def LastApprovalRequest_dbus_property(self):

2212

1555

return datetime_to_dbus(self.last_approval_request)

2213

1556

2214

1557

# Timeout - property

2215

@dbus_service_property(_interface,

2216

signature="t",

1558

@dbus_service_property(_interface, signature="t",

2217

1559

access="readwrite")

2218

1560

def Timeout_dbus_property(self, value=None):

2219

1561

if value is None: # get

2220

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

1562

return dbus.UInt64(self.timeout_milliseconds())

2221

1563

old_timeout = self.timeout

2222

1564

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

2223

1565

# Reschedule disabling

2231

1573

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

2232

1574

is None):

2233

1575

return

2234

GLib.source_remove(self.disable_initiator_tag)

2235

self.disable_initiator_tag = GLib.timeout_add(

2236

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

2237

self.disable)

2238

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2239

1582

# ExtendedTimeout - property

2240

@dbus_service_property(_interface,

2241

signature="t",

1583

@dbus_service_property(_interface, signature="t",

2242

1584

access="readwrite")

2243

1585

def ExtendedTimeout_dbus_property(self, value=None):

2244

1586

if value is None: # get

2245

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

2246

* 1000)

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2247

1588

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

2248

1589

2249

1590

# Interval - property

2250

@dbus_service_property(_interface,

2251

signature="t",

1591

@dbus_service_property(_interface, signature="t",

2252

1592

access="readwrite")

2253

1593

def Interval_dbus_property(self, value=None):

2254

1594

if value is None: # get

2255

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

1595

return dbus.UInt64(self.interval_milliseconds())

2256

1596

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

2257

1597

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

2258

1598

return

2259

1599

if self.enabled:

2260

1600

# Reschedule checker run

2261

GLib.source_remove(self.checker_initiator_tag)

2262

self.checker_initiator_tag = GLib.timeout_add(

2263

value, self.start_checker)

2264

self.start_checker() # Start one now, too

2265

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2266

1606

# Checker - property

2267

@dbus_service_property(_interface,

2268

signature="s",

1607

@dbus_service_property(_interface, signature="s",

2269

1608

access="readwrite")

2270

1609

def Checker_dbus_property(self, value=None):

2271

1610

if value is None: # get

2272

1611

return dbus.String(self.checker_command)

2273

self.checker_command = str(value)

2274

1612

self.checker_command = unicode(value)

1613

2275

1614

# CheckerRunning - property

2276

@dbus_service_property(_interface,

2277

signature="b",

1615

@dbus_service_property(_interface, signature="b",

2278

1616

access="readwrite")

2279

1617

def CheckerRunning_dbus_property(self, value=None):

2280

1618

if value is None: # get

2283

1621

self.start_checker()

2284

1622

else:

2285

1623

self.stop_checker()

2286

1624

2287

1625

# ObjectPath - property

2288

@dbus_annotations(

2289

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

2290

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

2291

1626

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

2292

1627

def ObjectPath_dbus_property(self):

2293

return self.dbus_object_path # is already a dbus.ObjectPath

2294

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2295

1630

# Secret = property

2296

@dbus_annotations(

2297

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

2298

"invalidates"})

2299

@dbus_service_property(_interface,

2300

signature="ay",

2301

access="write",

2302

byte_arrays=True)

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2303

1633

def Secret_dbus_property(self, value):

2304

self.secret = bytes(value)

2305

1634

self.secret = str(value)

1635

2306

1636

del _interface

2307

1637

2308

1638

2309

class ProxyClient:

2310

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

1639

class ProxyClient(object):

1640

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

2311

1641

self._pipe = child_pipe

2312

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

1642

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

2313

1643

if not self._pipe.recv():

2314

raise KeyError(key_id or fpr)

2315

1644

raise KeyError()

1645

2316

1646

def __getattribute__(self, name):

2317

if name == "_pipe":

1647

if name == '_pipe':

2318

1648

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

2319

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

1649

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

2320

1650

data = self._pipe.recv()

2321

if data[0] == "data":

1651

if data[0] == 'data':

2322

1652

return data[1]

2323

if data[0] == "function":

2324

1653

if data[0] == 'function':

2325

1654

def func(*args, **kwargs):

2326

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

1655

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

2327

1656

return self._pipe.recv()[1]

2328

2329

1657

return func

2330

1658

2331

1659

def __setattr__(self, name, value):

2332

if name == "_pipe":

1660

if name == '_pipe':

2333

1661

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

2334

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

1662

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

2335

1663

2336

1664

2337

1665

class ClientHandler(socketserver.BaseRequestHandler, object):

2338

1666

"""A class to handle client connections.

2339

1667

2340

1668

Instantiated once for each connection to handle it.

2341

1669

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

2342

1670

2343

1671

def handle(self):

2344

1672

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

2345

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

2346

str(self.client_address))

2347

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

2348

2349

session = gnutls.ClientSession(self.request)

2350

2351

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

2352

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

2353

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

2354

# "+DHE-DSS"))

1673

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

1674

unicode(self.client_address))

1675

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

1676

self.server.child_pipe.fileno())

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2355

1692

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

2356

1693

priority = self.server.gnutls_priority

2357

1694

if priority is None:

2358

1695

priority = "NORMAL"

2359

gnutls.priority_set_direct(session,

2360

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

2361

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2362

1700

# Start communication using the Mandos protocol

2363

1701

# Get protocol number

2364

1702

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

2365

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

1703

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

2366

1704

try:

2367

1705

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

2368

1706

raise RuntimeError(line)

2369

1707

except (ValueError, IndexError, RuntimeError) as error:

2370

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

1708

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

2371

1709

return

2372

1710

2373

1711

# Start GnuTLS connection

2374

1712

try:

2375

1713

session.handshake()

2376

except gnutls.Error as error:

2377

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

1714

except gnutls.errors.GNUTLSError as error:

1715

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

2378

1716

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

2379

1717

# established. Just abandon the request.

2380

1718

return

2381

log.debug("Handshake succeeded")

2382

1719

logger.debug("Handshake succeeded")

1720

2383

1721

approval_required = False

2384

1722

try:

2385

if gnutls.has_rawpk:

2386

fpr = b""

2387

try:

2388

key_id = self.key_id(

2389

self.peer_certificate(session))

2390

except (TypeError, gnutls.Error) as error:

2391

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

2392

return

2393

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

2394

key_id.decode("utf-8",

2395

errors="replace"))

2396

2397

else:

2398

key_id = b""

2399

try:

2400

fpr = self.fingerprint(

2401

self.peer_certificate(session))

2402

except (TypeError, gnutls.Error) as error:

2403

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

2404

return

2405

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

2406

2407

try:

2408

client = ProxyClient(child_pipe, key_id, fpr,

1723

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

1728

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

1729

return

1730

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

1731

1732

try:

1733

client = ProxyClient(child_pipe, fpr,

2409

1734

self.client_address)

2410

1735

except KeyError:

2411

1736

return

2412

1737

2413

1738

if client.approval_delay:

2414

1739

delay = client.approval_delay

2415

1740

client.approvals_pending += 1

2416

1741

approval_required = True

2417

1742

2418

1743

while True:

2419

1744

if not client.enabled:

2420

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

1745

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

1746

client.name)

2421

1747

if self.server.use_dbus:

2422

1748

# Emit D-Bus signal

2423

1749

client.Rejected("Disabled")

2424

1750

return

2425

1751

2426

1752

if client.approved or not client.approval_delay:

2427

# We are approved or approval is disabled

1753

#We are approved or approval is disabled

2428

1754

break

2429

1755

elif client.approved is None:

2430

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

2431

client.name)

1756

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

1757

client.name)

2432

1758

if self.server.use_dbus:

2433

1759

# Emit D-Bus signal

2434

1760

client.NeedApproval(

2435

client.approval_delay.total_seconds()

2436

* 1000, client.approved_by_default)

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2437

1763

else:

2438

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

2439

client.name)

1764

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

1765

client.name)

2440

1766

if self.server.use_dbus:

2441

1767

# Emit D-Bus signal

2442

1768

client.Rejected("Denied")

2443

1769

return

2444

2445

# wait until timeout or approved

1770

1771

#wait until timeout or approved

2446

1772

time = datetime.datetime.now()

2447

1773

client.changedstate.acquire()

2448

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

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2449

1777

client.changedstate.release()

2450

1778

time2 = datetime.datetime.now()

2451

1779

if (time2 - time) >= delay:

2452

1780

if not client.approved_by_default:

2453

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

2454

" waiting for approval",

2455

client.name)

1781

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

1782

" waiting for approval",

1783

client.name)

2456

1784

if self.server.use_dbus:

2457

1785

# Emit D-Bus signal

2458

1786

client.Rejected("Approval timed out")

2461

1789

break

2462

1790

else:

2463

1791

delay -= time2 - time

2464

2465

try:

2466

session.send(client.secret)

2467

except gnutls.Error as error:

2468

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

2469

return

2470

2471

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

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

1806

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

2472

1807

# bump the timeout using extended_timeout

2473

1808

client.bump_timeout(client.extended_timeout)

2474

1809

if self.server.use_dbus:

2475

1810

# Emit D-Bus signal

2476

1811

client.GotSecret()

2477

1812

2478

1813

finally:

2479

1814

if approval_required:

2480

1815

client.approvals_pending -= 1

2481

1816

try:

2482

1817

session.bye()

2483

except gnutls.Error as error:

2484

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

2485

1818

except gnutls.errors.GNUTLSError as error:

1819

logger.warning("GnuTLS bye failed",

1820

exc_info=error)

1821

2486

1822

@staticmethod

2487

1823

def peer_certificate(session):

2488

"Return the peer's certificate as a bytestring"

2489

try:

2490

cert_type = gnutls.certificate_type_get2(

2491

session, gnutls.CTYPE_PEERS)

2492

except AttributeError:

2493

cert_type = gnutls.certificate_type_get(session)

2494

if gnutls.has_rawpk:

2495

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2496

else:

2497

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2498

# If not a valid certificate type...

2499

if cert_type not in valid_cert_types:

2500

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

2501

valid_cert_types)

2502

# ...return invalid data

2503

return b""

1824

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

1825

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2504

1831

list_size = ctypes.c_uint(1)

2505

cert_list = (gnutls.certificate_get_peers

2506

(session, ctypes.byref(list_size)))

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

1834

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

2507

1835

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

2508

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

1836

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

1837

" certificate")

2509

1838

if list_size.value == 0:

2510

1839

return None

2511

1840

cert = cert_list[0]

2512

1841

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

2513

2514

@staticmethod

2515

def key_id(certificate):

2516

"Convert a certificate bytestring to a hexdigit key ID"

2517

# New GnuTLS "datum" with the public key

2518

datum = gnutls.datum_t(

2519

ctypes.cast(ctypes.c_char_p(certificate),

2520

ctypes.POINTER(ctypes.c_ubyte)),

2521

ctypes.c_uint(len(certificate)))

2522

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

2523

# New empty GnuTLS certificate

2524

pubkey = gnutls.pubkey_t()

2525

gnutls.pubkey_init(ctypes.byref(pubkey))

2526

# Import the raw public key into the certificate

2527

gnutls.pubkey_import(pubkey,

2528

ctypes.byref(datum),

2529

gnutls.X509_FMT_DER)

2530

# New buffer for the key ID

2531

buf = ctypes.create_string_buffer(32)

2532

buf_len = ctypes.c_size_t(len(buf))

2533

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

2534

gnutls.pubkey_get_key_id(

2535

pubkey,

2536

gnutls.KEYID_USE_SHA256,

2537

ctypes.cast(ctypes.byref(buf),

2538

ctypes.POINTER(ctypes.c_ubyte)),

2539

ctypes.byref(buf_len))

2540

# Deinit the certificate

2541

gnutls.pubkey_deinit(pubkey)

2542

2543

# Convert the buffer to a Python bytestring

2544

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

2545

# Convert the bytestring to hexadecimal notation

2546

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

2547

return hex_key_id

2548

1842

2549

1843

@staticmethod

2550

1844

def fingerprint(openpgp):

2551

1845

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2552

1846

# New GnuTLS "datum" with the OpenPGP public key

2553

datum = gnutls.datum_t(

2554

ctypes.cast(ctypes.c_char_p(openpgp),

2555

ctypes.POINTER(ctypes.c_ubyte)),

2556

ctypes.c_uint(len(openpgp)))

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2557

1852

# New empty GnuTLS certificate

2558

crt = gnutls.openpgp_crt_t()

2559

gnutls.openpgp_crt_init(ctypes.byref(crt))

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2560

1856

# Import the OpenPGP public key into the certificate

2561

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

2562

gnutls.OPENPGP_FMT_RAW)

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2563

1861

# Verify the self signature in the key

2564

1862

crtverify = ctypes.c_uint()

2565

gnutls.openpgp_crt_verify_self(crt, 0,

2566

ctypes.byref(crtverify))

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2567

1866

if crtverify.value != 0:

2568

gnutls.openpgp_crt_deinit(crt)

2569

raise gnutls.CertificateSecurityError(code

2570

=crtverify.value)

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2571

1870

# New buffer for the fingerprint

2572

1871

buf = ctypes.create_string_buffer(20)

2573

1872

buf_len = ctypes.c_size_t()

2574

1873

# Get the fingerprint from the certificate into the buffer

2575

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

2576

ctypes.byref(buf_len))

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2577

1877

# Deinit the certificate

2578

gnutls.openpgp_crt_deinit(crt)

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2579

1879

# Convert the buffer to a Python bytestring

2580

1880

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

2581

1881

# Convert the bytestring to hexadecimal notation

2583

1883

return hex_fpr

2584

1884

2585

1885

2586

class MultiprocessingMixIn:

1886

class MultiprocessingMixIn(object):

2587

1887

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

2588

2589

1888

def sub_process_main(self, request, address):

2590

1889

try:

2591

1890

self.finish_request(request, address)

2592

1891

except Exception:

2593

1892

self.handle_error(request, address)

2594

1893

self.close_request(request)

2595

1894

2596

1895

def process_request(self, request, address):

2597

1896

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

2598

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

2599

args=(request, address))

1897

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

1898

args = (request, address))

2600

1899

proc.start()

2601

1900

return proc

2602

1901

2603

1902

2604

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1903

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2605

1904

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

2606

2607

1905

def process_request(self, request, client_address):

2608

1906

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

2609

1907

2610

1908

This function creates a new pipe in self.pipe

2611

1909

"""

2612

1910

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2613

1911

2614

1912

proc = MultiprocessingMixIn.process_request(self, request,

2615

1913

client_address)

2616

1914

self.child_pipe.close()

2617

1915

self.add_pipe(parent_pipe, proc)

2618

1916

2619

1917

def add_pipe(self, parent_pipe, proc):

2620

1918

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

2621

1919

raise NotImplementedError()

2622

1920

2623

1921

2624

1922

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2625

socketserver.TCPServer):

2626

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

2627

1923

socketserver.TCPServer, object):

1924

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

1925

2628

1926

Attributes:

2629

1927

enabled: Boolean; whether this server is activated yet

2630

1928

interface: None or a network interface name (string)

2631

1929

use_ipv6: Boolean; to use IPv6 or not

2632

1930

"""

2633

2634

1931

def __init__(self, server_address, RequestHandlerClass,

2635

interface=None,

2636

use_ipv6=True,

2637

socketfd=None):

1932

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

2638

1933

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

2639

1934

creating a new one with socket.socket().

2640

1935

"""

2646

1941

self.socketfd = socketfd

2647

1942

# Save the original socket.socket() function

2648

1943

self.socket_socket = socket.socket

2649

2650

1944

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

2651

#

1945

#

2652

1946

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

2653

1947

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

2654

1948

# patching socket.socket.)

2655

#

1949

#

2656

1950

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

2657

1951

@functools.wraps(socket.socket)

2658

1952

def socket_wrapper(*args, **kwargs):

2670

1964

# socket_wrapper(), if socketfd was set.

2671

1965

socketserver.TCPServer.__init__(self, server_address,

2672

1966

RequestHandlerClass)

2673

1967

2674

1968

def server_bind(self):

2675

1969

"""This overrides the normal server_bind() function

2676

1970

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

2677

1971

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

2678

global SO_BINDTODEVICE

2679

1972

if self.interface is not None:

2680

1973

if SO_BINDTODEVICE is None:

2681

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

2682

# common enough.

2683

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

2684

SO_BINDTODEVICE = 25

2685

try:

2686

self.socket.setsockopt(

2687

socket.SOL_SOCKET, SO_BINDTODEVICE,

2688

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

2689

except socket.error as error:

2690

if error.errno == errno.EPERM:

2691

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

2692

self.interface)

2693

elif error.errno == errno.ENOPROTOOPT:

2694

log.error("SO_BINDTODEVICE not available; cannot"

2695

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

2696

elif error.errno == errno.ENODEV:

2697

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

2698

" bind", self.interface)

2699

else:

2700

raise

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2701

1995

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

2702

1996

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

2703

if self.server_address[1]:

2704

self.allow_reuse_address = True

2705

1997

if not self.server_address[0]:

2706

1998

if self.address_family == socket.AF_INET6:

2707

any_address = "::" # in6addr_any

1999

any_address = "::" # in6addr_any

2708

2000

else:

2709

any_address = "0.0.0.0" # INADDR_ANY

2001

any_address = "0.0.0.0" # INADDR_ANY

2710

2002

self.server_address = (any_address,

2711

2003

self.server_address[1])

2712

2004

elif not self.server_address[1]:

2713

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

2005

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

2006

0)

2714

2007

# if self.interface:

2715

2008

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

2716

2009

# 0, # port

2722

2015

2723

2016

class MandosServer(IPv6_TCPServer):

2724

2017

"""Mandos server.

2725

2018

2726

2019

Attributes:

2727

2020

clients: set of Client objects

2728

2021

gnutls_priority GnuTLS priority string

2729

2022

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

2730

2731

Assumes a GLib.MainLoop event loop.

2023

2024

Assumes a gobject.MainLoop event loop.

2732

2025

"""

2733

2734

2026

def __init__(self, server_address, RequestHandlerClass,

2735

interface=None,

2736

use_ipv6=True,

2737

clients=None,

2738

gnutls_priority=None,

2739

use_dbus=True,

2740

socketfd=None):

2027

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

2028

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

2741

2029

self.enabled = False

2742

2030

self.clients = clients

2743

2031

if self.clients is None:

2746

2034

self.gnutls_priority = gnutls_priority

2747

2035

IPv6_TCPServer.__init__(self, server_address,

2748

2036

RequestHandlerClass,

2749

interface=interface,

2750

use_ipv6=use_ipv6,

2751

socketfd=socketfd)

2752

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2753

2040

def server_activate(self):

2754

2041

if self.enabled:

2755

2042

return socketserver.TCPServer.server_activate(self)

2756

2043

2757

2044

def enable(self):

2758

2045

self.enabled = True

2759

2046

2760

2047

def add_pipe(self, parent_pipe, proc):

2761

2048

# Call "handle_ipc" for both data and EOF events

2762

GLib.io_add_watch(

2763

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

2764

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

2765

functools.partial(self.handle_ipc,

2766

parent_pipe=parent_pipe,

2767

proc=proc))

2768

2769

def handle_ipc(self, source, condition,

2770

parent_pipe=None,

2771

proc=None,

2772

client_object=None):

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2773

2058

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

2774

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

2059

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

2775

2060

# Wait for other process to exit

2776

2061

proc.join()

2777

2062

return False

2778

2063

2779

2064

# Read a request from the child

2780

2065

request = parent_pipe.recv()

2781

2066

command = request[0]

2782

2783

if command == "init":

2784

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

2785

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

2786

address = request[3]

2787

2788

for c in self.clients.values():

2789

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2790

"27AE41E4649B934CA495991B7852B855"):

2791

continue

2792

if key_id and c.key_id == key_id:

2793

client = c

2794

break

2795

if fpr and c.fingerprint == fpr:

2067

2068

if command == 'init':

2069

fpr = request[1]

2070

address = request[2]

2071

2072

for c in self.clients.itervalues():

2073

if c.fingerprint == fpr:

2796

2074

client = c

2797

2075

break

2798

2076

else:

2799

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

2800

" %s", key_id or fpr, address)

2077

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

2078

"dress: %s", fpr, address)

2801

2079

if self.use_dbus:

2802

2080

# Emit D-Bus signal

2803

mandos_dbus_service.ClientNotFound(key_id or fpr,

2081

mandos_dbus_service.ClientNotFound(fpr,

2804

2082

address[0])

2805

2083

parent_pipe.send(False)

2806

2084

return False

2807

2808

GLib.io_add_watch(

2809

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

2810

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

2811

functools.partial(self.handle_ipc,

2812

parent_pipe=parent_pipe,

2813

proc=proc,

2814

client_object=client))

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2815

2094

parent_pipe.send(True)

2816

2095

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

2817

2096

# same fileno

2818

2097

return False

2819

if command == "funcall":

2098

if command == 'funcall':

2820

2099

funcname = request[1]

2821

2100

args = request[2]

2822

2101

kwargs = request[3]

2823

2824

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

2102

2103

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

2825

2104

funcname)(*args,

2826

**kwargs)))

2827

2828

if command == "getattr":

2105

**kwargs)))

2106

2107

if command == 'getattr':

2829

2108

attrname = request[1]

2830

if isinstance(client_object.__getattribute__(attrname),

2831

collections.abc.Callable):

2832

parent_pipe.send(("function", ))

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2833

2111

else:

2834

parent_pipe.send((

2835

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

2836

2837

if command == "setattr":

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2115

if command == 'setattr':

2838

2116

attrname = request[1]

2839

2117

value = request[2]

2840

2118

setattr(client_object, attrname, value)

2841

2119

2842

2120

return True

2843

2121

2844

2122

2845

2123

def rfc3339_duration_to_delta(duration):

2846

2124

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

2847

2848

>>> timedelta = datetime.timedelta

2849

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

2850

True

2851

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

2852

True

2853

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

2854

True

2855

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

2856

True

2857

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

2858

True

2859

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

2860

True

2861

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

2862

True

2863

>>> del timedelta

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2864

2140

"""

2865

2141

2866

2142

# Parsing an RFC 3339 duration with regular expressions is not

2867

2143

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

2868

2144

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

2869

2145

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

2870

2146

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

2871

2147

# avoid excessive use of external libraries.

2872

2148

2873

2149

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

2874

Token = collections.namedtuple("Token", (

2875

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

2876

# a "group" containing digits

2877

"value", # datetime.timedelta or None

2878

"followers")) # Tokens valid after this token

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2879

2159

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

2880

2160

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

2881

2161

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

2882

2162

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

2883

2163

datetime.timedelta(seconds=1),

2884

frozenset((token_end, )))

2164

frozenset((token_end,)))

2885

2165

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

2886

2166

datetime.timedelta(minutes=1),

2887

2167

frozenset((token_second, token_end)))

2903

2183

frozenset((token_month, token_end)))

2904

2184

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

2905

2185

datetime.timedelta(weeks=1),

2906

frozenset((token_end, )))

2186

frozenset((token_end,)))

2907

2187

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

2908

2188

frozenset((token_year, token_month,

2909

2189

token_day, token_time,

2910

token_week)))

2911

# Define starting values:

2912

# Value so far

2913

value = datetime.timedelta()

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2914

2193

found_token = None

2915

# Following valid tokens

2916

followers = frozenset((token_duration, ))

2917

# String left to parse

2918

s = duration

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2919

2196

# Loop until end token is found

2920

2197

while found_token is not token_end:

2921

2198

# Search for any currently valid tokens

2937

2214

break

2938

2215

else:

2939

2216

# No currently valid tokens were found

2940

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

2941

.format(duration))

2217

raise ValueError("Invalid RFC 3339 duration")

2942

2218

# End token found

2943

2219

return value

2944

2220

2945

2221

2946

2222

def string_to_delta(interval):

2947

2223

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

2948

2949

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

2950

True

2951

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

2952

True

2953

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

2954

True

2955

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

2956

True

2957

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

2958

True

2959

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

2960

True

2224

2225

>>> string_to_delta('7d')

2226

datetime.timedelta(7)

2227

>>> string_to_delta('60s')

2228

datetime.timedelta(0, 60)

2229

>>> string_to_delta('60m')

2230

datetime.timedelta(0, 3600)

2231

>>> string_to_delta('24h')

2232

datetime.timedelta(1)

2233

>>> string_to_delta('1w')

2234

datetime.timedelta(7)

2235

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

2236

datetime.timedelta(0, 330)

2961

2237

"""

2962

2238

2963

2239

try:

2964

2240

return rfc3339_duration_to_delta(interval)

2965

2241

except ValueError:

2966

2242

pass

2967

2243

2968

2244

timevalue = datetime.timedelta(0)

2969

2245

for s in interval.split():

2970

2246

try:

2971

suffix = s[-1]

2247

suffix = unicode(s[-1])

2972

2248

value = int(s[:-1])

2973

2249

if suffix == "d":

2974

2250

delta = datetime.timedelta(value)

2981

2257

elif suffix == "w":

2982

2258

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

2983

2259

else:

2984

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

2260

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

2261

.format(suffix))

2985

2262

except IndexError as e:

2986

2263

raise ValueError(*(e.args))

2987

2264

timevalue += delta

2988

2265

return timevalue

2989

2266

2990

2267

2991

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

2268

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

2992

2269

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

2993

2270

2994

2271

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

2995

2272

if os.fork():

2996

2273

sys.exit()

3004

2281

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

3005

2282

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

3006

2283

raise OSError(errno.ENODEV,

3007

"{} not a character device"

2284

"{0} not a character device"

3008

2285

.format(os.devnull))

3009

2286

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

3010

2287

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

3014

2291

3015

2292

3016

2293

def main():

3017

2294

3018

2295

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

3019

2296

# Parsing of options, both command line and config file

3020

2297

3021

2298

parser = argparse.ArgumentParser()

3022

2299

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

3023

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

2300

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

3024

2301

help="show version number and exit")

3025

2302

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

3026

2303

help="Bind to interface IF")

3059

2336

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

3060

2337

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

3061

2338

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

3062

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

3063

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

3064

default=None)

3065

2339

3066

2340

options = parser.parse_args()

3067

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

sys.exit(os.EX_OK if fail_count == 0 else 1)

2346

3068

2347

# Default values for config file for server-global settings

3069

if gnutls.has_rawpk:

3070

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

3071

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

3072

else:

3073

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

3074

":+SIGN-DSA-SHA256")

3075

server_defaults = {"interface": "",

3076

"address": "",

3077

"port": "",

3078

"debug": "False",

3079

"priority": priority,

3080

"servicename": "Mandos",

3081

"use_dbus": "True",

3082

"use_ipv6": "True",

3083

"debuglevel": "",

3084

"restore": "True",

3085

"socket": "",

3086

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

3087

"foreground": "False",

3088

"zeroconf": "True",

3089

}

3090

del priority

3091

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

3092

2364

# Parse config file for server-global settings

3093

server_config = configparser.ConfigParser(server_defaults)

2365

server_config = configparser.SafeConfigParser(server_defaults)

3094

2366

del server_defaults

3095

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

3096

# Convert the ConfigParser object to a dict

2367

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

2368

"mandos.conf"))

2369

# Convert the SafeConfigParser object to a dict

3097

2370

server_settings = server_config.defaults()

3098

2371

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

3099

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

3100

"foreground", "zeroconf"):

2372

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

3101

2373

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

3102

2374

option)

3103

2375

if server_settings["port"]:

3109

2381

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

3110

2382

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

3111

2383

# happen with a supplied network socket.

3112

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

2384

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

3113

2385

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

3114

2386

["socket"])

3115

os.set_inheritable(server_settings["socket"], False)

3116

2387

del server_config

3117

2388

3118

2389

# Override the settings from the config file with command line

3119

2390

# options, if set.

3120

2391

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

3121

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

3122

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

3123

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

2392

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

2393

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

2394

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

3124

2395

value = getattr(options, option)

3125

2396

if value is not None:

3126

2397

server_settings[option] = value

3127

2398

del options

3128

2399

# Force all strings to be unicode

3129

2400

for option in server_settings.keys():

3130

if isinstance(server_settings[option], bytes):

3131

server_settings[option] = (server_settings[option]

3132

.decode("utf-8"))

2401

if type(server_settings[option]) is str:

2402

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

3133

2403

# Force all boolean options to be boolean

3134

2404

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

3135

"foreground", "zeroconf"):

2405

"foreground"):

3136

2406

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

3137

2407

# Debug implies foreground

3138

2408

if server_settings["debug"]:

3139

2409

server_settings["foreground"] = True

3140

2410

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

3141

2411

3142

2412

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

3143

3144

if (not server_settings["zeroconf"]

3145

and not (server_settings["port"]

3146

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

3147

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

3148

2413

3149

2414

# For convenience

3150

2415

debug = server_settings["debug"]

3151

2416

debuglevel = server_settings["debuglevel"]

3154

2419

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

3155

2420

stored_state_file)

3156

2421

foreground = server_settings["foreground"]

3157

zeroconf = server_settings["zeroconf"]

3158

2422

3159

2423

if debug:

3160

2424

initlogger(debug, logging.DEBUG)

3161

2425

else:

3164

2428

else:

3165

2429

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

3166

2430

initlogger(debug, level)

3167

2431

3168

2432

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

3169

syslogger.setFormatter(

3170

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

3171

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

3172

server_settings["servicename"])))

3173

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

3174

2439

# Parse config file with clients

3175

client_config = configparser.ConfigParser(Client.client_defaults)

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

3176

2442

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

3177

2443

"clients.conf"))

3178

2444

3179

2445

global mandos_dbus_service

3180

2446

mandos_dbus_service = None

3181

3182

socketfd = None

3183

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

3184

socketfd = server_settings["socket"]

3185

tcp_server = MandosServer(

3186

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

3187

ClientHandler,

3188

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

3189

use_ipv6=use_ipv6,

3190

gnutls_priority=server_settings["priority"],

3191

use_dbus=use_dbus,

3192

socketfd=socketfd)

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

3193

2459

if not foreground:

3194

2460

pidfilename = "/run/mandos.pid"

3195

2461

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

3196

2462

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

3197

2463

pidfile = None

3198

2464

try:

3199

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

2465

pidfile = open(pidfilename, "w")

3200

2466

except IOError as e:

3201

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

3202

exc_info=e)

3203

3204

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

3205

("mandos", "mandos"),

3206

("nobody", "nogroup")):

2467

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

2468

exc_info=e)

2469

2470

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

3207

2471

try:

3208

2472

uid = pwd.getpwnam(name).pw_uid

3209

gid = pwd.getpwnam(group).pw_gid

2473

gid = pwd.getpwnam(name).pw_gid

3210

2474

break

3211

2475

except KeyError:

3212

2476

continue

3216

2480

try:

3217

2481

os.setgid(gid)

3218

2482

os.setuid(uid)

3219

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

3220

2483

except OSError as error:

3221

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

3222

os.strerror(error.errno))

3223

2484

if error.errno != errno.EPERM:

3224

2485

raise

3225

2486

3226

2487

if debug:

3227

2488

# Enable all possible GnuTLS debugging

3228

2489

3229

2490

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

3230

2491

# - GnuTLS manual

3231

gnutls.global_set_log_level(11)

3232

3233

@gnutls.log_func

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3234

2495

def debug_gnutls(level, string):

3235

log.debug("GnuTLS: %s",

3236

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

3237

3238

gnutls.global_set_log_function(debug_gnutls)

3239

2496

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

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3240

2501

# Redirect stdin so all checkers get /dev/null

3241

2502

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

3242

2503

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

3243

2504

if null > 2:

3244

2505

os.close(null)

3245

2506

3246

2507

# Need to fork before connecting to D-Bus

3247

2508

if not foreground:

3248

2509

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

3249

2510

daemon()

3250

3251

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

3252

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

3253

# need to inform GLib that threads will be used.

3254

GLib.threads_init()

3255

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3256

2516

global main_loop

3257

2517

# From the Avahi example code

3258

2518

DBusGMainLoop(set_as_default=True)

3259

main_loop = GLib.MainLoop()

3260

if use_dbus or zeroconf:

3261

bus = dbus.SystemBus()

2519

main_loop = gobject.MainLoop()

2520

bus = dbus.SystemBus()

3262

2521

# End of Avahi example code

3263

2522

if use_dbus:

3264

2523

try:

3265

2524

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

3266

bus,

3267

do_not_queue=True)

3268

old_bus_name = dbus.service.BusName(

3269

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

3270

do_not_queue=True)

3271

except dbus.exceptions.DBusException as e:

3272

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

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

2530

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

3273

2531

use_dbus = False

3274

2532

server_settings["use_dbus"] = False

3275

2533

tcp_server.use_dbus = False

3276

if zeroconf:

3277

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3278

service = AvahiServiceToSyslog(

3279

name=server_settings["servicename"],

3280

servicetype="_mandos._tcp",

3281

protocol=protocol,

3282

bus=bus)

3283

if server_settings["interface"]:

3284

service.interface = if_nametoindex(

3285

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

3286

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3287

2543

global multiprocessing_manager

3288

2544

multiprocessing_manager = multiprocessing.Manager()

3289

2545

3290

2546

client_class = Client

3291

2547

if use_dbus:

3292

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

3293

2548

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

2549

3294

2550

client_settings = Client.config_parser(client_config)

3295

2551

old_client_settings = {}

3296

2552

clients_data = {}

3297

2553

3298

2554

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

3299

2555

global wnull

3300

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

2556

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

3301

2557

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

3302

2558

# mode

3303

2559

if debug or not foreground:

3304

2560

wnull.close()

3305

2561

3306

2562

# Get client data and settings from last running state.

3307

2563

if server_settings["restore"]:

3308

2564

try:

3309

2565

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

3310

if sys.version_info.major == 2:

3311

clients_data, old_client_settings = pickle.load(

3312

stored_state)

3313

else:

3314

bytes_clients_data, bytes_old_client_settings = (

3315

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

3316

# Fix bytes to strings

3317

# clients_data

3318

# .keys()

3319

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

3320

if isinstance(key, bytes)

3321

else key): value

3322

for key, value in

3323

bytes_clients_data.items()}

3324

del bytes_clients_data

3325

for key in clients_data:

3326

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

3327

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

3328

for k, v in

3329

clients_data[key].items()}

3330

clients_data[key] = value

3331

# .client_structure

3332

value["client_structure"] = [

3333

(s.decode("utf-8")

3334

if isinstance(s, bytes)

3335

else s) for s in

3336

value["client_structure"]]

3337

# .name, .host, and .checker_command

3338

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

3339

if isinstance(value[k], bytes):

3340

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

3341

if "key_id" not in value:

3342

value["key_id"] = ""

3343

elif "fingerprint" not in value:

3344

value["fingerprint"] = ""

3345

# old_client_settings

3346

# .keys()

3347

old_client_settings = {

3348

(key.decode("utf-8")

3349

if isinstance(key, bytes)

3350

else key): value

3351

for key, value in

3352

bytes_old_client_settings.items()}

3353

del bytes_old_client_settings

3354

# .host and .checker_command

3355

for value in old_client_settings.values():

3356

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

3357

if isinstance(value[attribute], bytes):

3358

value[attribute] = (value[attribute]

3359

.decode("utf-8"))

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3360

2568

os.remove(stored_state_path)

3361

2569

except IOError as e:

3362

2570

if e.errno == errno.ENOENT:

3363

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

3364

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

2571

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

2572

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

3365

2573

else:

3366

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

3367

exc_info=e)

2574

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

2575

exc_info=e)

3368

2576

raise

3369

2577

except EOFError as e:

3370

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

3371

exc_info=e)

3372

2578

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

2579

"EOFError:", exc_info=e)

2580

3373

2581

with PGPEngine() as pgp:

3374

for client_name, client in clients_data.items():

2582

for client_name, client in clients_data.iteritems():

3375

2583

# Skip removed clients

3376

2584

if client_name not in client_settings:

3377

2585

continue

3378

2586

3379

2587

# Decide which value to use after restoring saved state.

3380

2588

# We have three different values: Old config file,

3381

2589

# new config file, and saved state.

3386

2594

# For each value in new config, check if it

3387

2595

# differs from the old config value (Except for

3388

2596

# the "secret" attribute)

3389

if (name != "secret"

3390

and (value !=

3391

old_client_settings[client_name][name])):

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3392

2600

client[name] = value

3393

2601

except KeyError:

3394

2602

pass

3395

2603

3396

2604

# Clients who has passed its expire date can still be

3397

# enabled if its last checker was successful. A Client

2605

# enabled if its last checker was successful. Clients

3398

2606

# whose checker succeeded before we stored its state is

3399

2607

# assumed to have successfully run all checkers during

3400

2608

# downtime.

3401

2609

if client["enabled"]:

3402

2610

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

3403

2611

if not client["last_checked_ok"]:

3404

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

3405

" never performed a successful"

3406

" checker", client_name)

2612

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3407

2616

client["enabled"] = False

3408

2617

elif client["last_checker_status"] != 0:

3409

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

3410

" last checker failed with error"

3411

" code %s", client_name,

3412

client["last_checker_status"])

2618

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3413

2623

client["enabled"] = False

3414

2624

else:

3415

client["expires"] = (

3416

datetime.datetime.utcnow()

3417

+ client["timeout"])

3418

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

3419

" enabled", client_name)

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

2628

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3420

2631

try:

3421

client["secret"] = pgp.decrypt(

3422

client["encrypted_secret"],

3423

client_settings[client_name]["secret"])

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3424

2636

except PGPError:

3425

2637

# If decryption fails, we use secret from new settings

3426

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

3427

client_name)

3428

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

3429

["secret"])

3430

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3431

2643

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

3432

2644

for client_name in (set(old_client_settings)

3433

2645

- set(client_settings)):

3435

2647

for client_name in (set(client_settings)

3436

2648

- set(old_client_settings)):

3437

2649

clients_data[client_name] = client_settings[client_name]

3438

2650

3439

2651

# Create all client objects

3440

for client_name, client in clients_data.items():

2652

for client_name, client in clients_data.iteritems():

3441

2653

tcp_server.clients[client_name] = client_class(

3442

name=client_name,

3443

settings=client,

3444

server_settings=server_settings)

3445

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3446

2657

if not tcp_server.clients:

3447

log.warning("No clients defined")

3448

2658

logger.warning("No clients defined")

2659

3449

2660

if not foreground:

3450

2661

if pidfile is not None:

3451

pid = os.getpid()

3452

2662

try:

3453

2663

with pidfile:

3454

print(pid, file=pidfile)

2664

pid = os.getpid()

2665

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

3455

2666

except IOError:

3456

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

3457

pidfilename, pid)

2667

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

2668

pidfilename, pid)

3458

2669

del pidfile

3459

2670

del pidfilename

3460

3461

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

3462

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3463

lambda: main_loop.quit() and False)

3464

2671

2672

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

2673

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

2674

3465

2675

if use_dbus:

3466

3467

@alternate_dbus_interfaces(

3468

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

3469

class MandosDBusService(DBusObjectWithObjectManager):

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3470

2679

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

3471

3472

2680

def __init__(self):

3473

2681

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

3474

3475

2682

_interface = "se.recompile.Mandos"

3476

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3477

2690

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

3478

2691

def ClientAdded(self, objpath):

3479

2692

"D-Bus signal"

3480

2693

pass

3481

2694

3482

2695

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

3483

def ClientNotFound(self, key_id, address):

2696

def ClientNotFound(self, fingerprint, address):

3484

2697

"D-Bus signal"

3485

2698

pass

3486

3487

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

3488

"true"})

2699

3489

2700

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

3490

2701

def ClientRemoved(self, objpath, name):

3491

2702

"D-Bus signal"

3492

2703

pass

3493

3494

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

3495

"true"})

2704

3496

2705

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

3497

2706

def GetAllClients(self):

3498

2707

"D-Bus method"

3499

return dbus.Array(c.dbus_object_path for c in

3500

tcp_server.clients.values())

3501

3502

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

3503

"true"})

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3504

2712

@dbus.service.method(_interface,

3505

2713

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

3506

2714

def GetAllClientsWithProperties(self):

3507

2715

"D-Bus method"

3508

2716

return dbus.Dictionary(

3509

{c.dbus_object_path: c.GetAll(

3510

"se.recompile.Mandos.Client")

3511

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

2717

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

2718

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

3512

2719

signature="oa{sv}")

3513

2720

3514

2721

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

3515

2722

def RemoveClient(self, object_path):

3516

2723

"D-Bus method"

3517

for c in tcp_server.clients.values():

2724

for c in tcp_server.clients.itervalues():

3518

2725

if c.dbus_object_path == object_path:

3519

2726

del tcp_server.clients[c.name]

3520

2727

c.remove_from_connection()

3521

# Don't signal the disabling

2728

# Don't signal anything except ClientRemoved

3522

2729

c.disable(quiet=True)

3523

# Emit D-Bus signal for removal

3524

self.client_removed_signal(c)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3525

2732

return

3526

2733

raise KeyError(object_path)

3527

2734

3528

2735

del _interface

3529

3530

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3531

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

3532

def GetManagedObjects(self):

3533

"""D-Bus method"""

3534

return dbus.Dictionary(

3535

{client.dbus_object_path:

3536

dbus.Dictionary(

3537

{interface: client.GetAll(interface)

3538

for interface in

3539

client._get_all_interface_names()})

3540

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

3541

3542

def client_added_signal(self, client):

3543

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

3544

if use_dbus:

3545

# New standard signal

3546

self.InterfacesAdded(

3547

client.dbus_object_path,

3548

dbus.Dictionary(

3549

{interface: client.GetAll(interface)

3550

for interface in

3551

client._get_all_interface_names()}))

3552

# Old signal

3553

self.ClientAdded(client.dbus_object_path)

3554

3555

def client_removed_signal(self, client):

3556

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

3557

if use_dbus:

3558

# New standard signal

3559

self.InterfacesRemoved(

3560

client.dbus_object_path,

3561

client._get_all_interface_names())

3562

# Old signal

3563

self.ClientRemoved(client.dbus_object_path,

3564

client.name)

3565

2736

3566

2737

mandos_dbus_service = MandosDBusService()

3567

3568

# Save modules to variables to exempt the modules from being

3569

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

3570

mp = multiprocessing

3571

wn = wnull

3572

2738

3573

2739

def cleanup():

3574

2740

"Cleanup function; run on exit"

3575

if zeroconf:

3576

service.cleanup()

3577

3578

mp.active_children()

3579

wn.close()

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3580

2745

if not (tcp_server.clients or client_settings):

3581

2746

return

3582

2747

3583

2748

# Store client before exiting. Secrets are encrypted with key

3584

2749

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

3585

2750

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

3586

2751

clients = {}

3587

2752

with PGPEngine() as pgp:

3588

for client in tcp_server.clients.values():

2753

for client in tcp_server.clients.itervalues():

3589

2754

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

3590

2755

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

3591

2756

key)

3592

2757

client_dict = {}

3593

2758

3594

2759

# A list of attributes that can not be pickled

3595

2760

# + secret.

3596

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

3597

"checker", "server_settings"}

3598

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

3599

.Object):

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3600

2765

exclude.add(name)

3601

2766

3602

2767

client_dict["encrypted_secret"] = (client

3603

2768

.encrypted_secret)

3604

2769

for attr in client.client_structure:

3605

2770

if attr not in exclude:

3606

2771

client_dict[attr] = getattr(client, attr)

3607

2772

3608

2773

clients[client.name] = client_dict

3609

2774

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

3610

2775

3611

2776

try:

3612

with tempfile.NamedTemporaryFile(

3613

mode="wb",

3614

suffix=".pickle",

3615

prefix="clients-",

3616

dir=os.path.dirname(stored_state_path),

3617

delete=False) as stored_state:

3618

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

3619

protocol=2)

3620

tempname = stored_state.name

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3621

2783

os.rename(tempname, stored_state_path)

3622

2784

except (IOError, OSError) as e:

3623

2785

if not debug:

3626

2788

except NameError:

3627

2789

pass

3628

2790

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

3629

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

3630

os.strerror(e.errno))

2791

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

2792

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

3631

2793

else:

3632

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

3633

exc_info=e)

2794

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

2795

exc_info=e)

3634

2796

raise

3635

2797

3636

2798

# Delete all clients, and settings from config

3637

2799

while tcp_server.clients:

3638

2800

name, client = tcp_server.clients.popitem()

3639

2801

if use_dbus:

3640

2802

client.remove_from_connection()

3641

# Don't signal the disabling

2803

# Don't signal anything except ClientRemoved

3642

2804

client.disable(quiet=True)

3643

# Emit D-Bus signal for removal

3644

2805

if use_dbus:

3645

mandos_dbus_service.client_removed_signal(client)

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3646

2810

client_settings.clear()

3647

2811

3648

2812

atexit.register(cleanup)

3649

3650

for client in tcp_server.clients.values():

2813

2814

for client in tcp_server.clients.itervalues():

3651

2815

if use_dbus:

3652

# Emit D-Bus signal for adding

3653

mandos_dbus_service.client_added_signal(client)

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3654

2818

# Need to initiate checking of clients

3655

2819

if client.enabled:

3656

client.init_checker(randomize_start=True)

3657

2820

client.init_checker()

2821

3658

2822

tcp_server.enable()

3659

2823

tcp_server.server_activate()

3660

2824

3661

2825

# Find out what port we got

3662

if zeroconf:

3663

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

2826

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

3664

2827

if use_ipv6:

3665

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

3666

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

2828

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

2829

" flowinfo %d, scope_id %d",

2830

*tcp_server.socket.getsockname())

3667

2831

else: # IPv4

3668

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

3669

*tcp_server.socket.getsockname())

3670

3671

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

3672

2832

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

2833

*tcp_server.socket.getsockname())

2834

2835

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

2836

3673

2837

try:

3674

if zeroconf:

3675

# From the Avahi example code

3676

try:

3677

service.activate()

3678

except dbus.exceptions.DBusException as error:

3679

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

3680

cleanup()

3681

sys.exit(1)

3682

# End of Avahi example code

3683

3684

GLib.io_add_watch(

3685

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

3686

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3687

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

3688

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

3689

3690

log.debug("Starting main loop")

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

2852

logger.debug("Starting main loop")

3691

2853

main_loop.run()

3692

2854

except AvahiError as error:

3693

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

2855

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

3694

2856

cleanup()

3695

2857

sys.exit(1)

3696

2858

except KeyboardInterrupt:

3697

2859

if debug:

3698

2860

print("", file=sys.stderr)

3699

log.debug("Server received KeyboardInterrupt")

3700

log.debug("Server exiting")

2861

logger.debug("Server received KeyboardInterrupt")

2862

logger.debug("Server exiting")

3701

2863

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

3702

2864

cleanup()

3703

2865

3704

3705

def parse_test_args():

3706

# type: () -> argparse.Namespace

3707

parser = argparse.ArgumentParser(add_help=False)

3708

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

3709

parser.add_argument("--prefix", )

3710

args, unknown_args = parser.parse_known_args()

3711

if args.check:

3712

# Remove test options from sys.argv

3713

sys.argv[1:] = unknown_args

3714

return args

3715

3716

# Add all tests from doctest strings

3717

def load_tests(loader, tests, none):

3718

import doctest

3719

tests.addTests(doctest.DocTestSuite())

3720

return tests

3721

3722

if __name__ == "__main__":

3723

options = parse_test_args()

3724

try:

3725

if options.check:

3726

extra_test_prefix = options.prefix

3727

if extra_test_prefix is not None:

3728

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

3729

.result.wasSuccessful()):

3730

sys.exit(1)

3731

class ExtraTestLoader(unittest.TestLoader):

3732

testMethodPrefix = extra_test_prefix

3733

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

3734

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

3735

else:

3736

unittest.main(argv=[""])

3737

else:

3738

main()

3739

finally:

3740

logging.shutdown()

3741

3742

# Local Variables:

3743

# run-tests:

3744

# (lambda (&optional extra)

3745

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

3746

# extra))

3747

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

3748

# (funcall remove-test-window)

3749

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

3750

# run-tests-in-test-buffer:

3751

# (lambda (dir &optional extra)

3752

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

3753

# (setq buffer-read-only nil

3754

# default-directory dir)

3755

# (erase-buffer)

3756

# (compilation-mode))

3757

# (let ((process-result

3758

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

3759

# (process-file-shell-command

3760

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

3761

# (and (numberp process-result)

3762

# (= process-result 0))))

3763

# get-command-line:

3764

# (lambda (&optional extra)

3765

# (let ((quoted-script

3766

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

3767

# (format

3768

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

3769

# quoted-script)))

3770

# get-script-name:

3771

# (lambda ()

3772

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

3773

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

3774

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

3775

# (buffer-file-name))))

3776

# remove-test-window:

3777

# (lambda ()

3778

# (let ((test-window (get-buffer-window "*Test*")))

3779

# (if test-window (delete-window test-window))))

3780

# show-test-buffer-in-test-window:

3781

# (lambda ()

3782

# (when (not (get-buffer-window-list "*Test*"))

3783

# (setq next-error-last-buffer (get-buffer "*Test*"))

3784

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3785

# (display-buffer-overriding-action

3786

# `((display-buffer-in-side-window) (side . ,side)

3787

# (window-height . fit-window-to-buffer)

3788

# (window-width . fit-window-to-buffer))))

3789

# (display-buffer "*Test*"))))

3790

# eval:

3791

# (progn

3792

# (let* ((run-extra-tests (lambda () (interactive)

3793

# (funcall run-tests t)))

3794

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3795

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3796

# (setq minor-mode-overriding-map-alist

3797

# (cons `(run-tests . ,outer-keymap)

3798

# minor-mode-overriding-map-alist)))

3799

# (add-hook 'after-save-hook run-tests 90 t))

3800

# End:

2866

if __name__ == '__main__':

2867

main()