/mandos/release : revision 237.7.127

1

#!/usr/bin/python3 -bI

2

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

3

#

1

#!/usr/bin/python

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

14

15

16

#

17

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

18

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

33

34

from __future__ import (division, absolute_import, print_function,

35

unicode_literals)

36

37

try:

38

from future_builtins import *

39

except ImportError:

40

pass

37

from future_builtins import *

41

38

42

import sys

43

import unittest

39

import SocketServer as socketserver

40

import socket

44

41

import argparse

45

import logging

46

import os

47

try:

48

import SocketServer as socketserver

49

except ImportError:

50

import socketserver

51

import socket

52

42

import datetime

53

43

import errno

54

try:

55

import ConfigParser as configparser

56

except ImportError:

57

import configparser

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

import sys

58

52

import re

53

import os

59

54

import signal

60

55

import subprocess

61

56

import atexit

62

57

import stat

58

import logging

63

59

import logging.handlers

64

60

import pwd

65

61

import contextlib

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

import collections

79

import codecs

80

import random

81

import shlex

82

71

83

72

import dbus

84

73

import dbus.service

85

import gi

86

from gi.repository import GLib

74

import gobject

75

import avahi

87

76

from dbus.mainloop.glib import DBusGMainLoop

88

77

import ctypes

89

78

import ctypes.util

90

79

import xml.dom.minidom

91

80

import inspect

92

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

input = raw_input

97

98

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

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

81

import GnuPGInterface

82

83

try:

122

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

123

85

except AttributeError:

124

86

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

127

87

from IN import SO_BINDTODEVICE

128

88

except ImportError:

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.15"

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

147

92

stored_state_file = "clients.pickle"

148

93

149

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

150

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

151

syslogger = None

94

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

152

98

153

99

try:

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

156

103

except (OSError, AttributeError):

157

158

104

def if_nametoindex(interface):

159

105

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

160

106

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

161

107

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

162

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

163

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

164

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

165

113

return interface_index

166

114

167

115

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

184

116

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

185

117

"""init logger and add loglevel"""

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

118

191

119

syslogger.setFormatter(logging.Formatter

192

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

193

" %(message)s"))

194

log.addHandler(syslogger)

195

120

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

121

' %(message)s'))

122

logger.addHandler(syslogger)

123

196

124

if debug:

197

125

console = logging.StreamHandler()

198

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

199

" [%(process)d]:"

200

" %(levelname)s:"

201

" %(message)s"))

202

log.addHandler(console)

203

log.setLevel(level)

126

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

127

' [%(process)d]:'

128

' %(levelname)s:'

129

' %(message)s'))

130

logger.addHandler(console)

131

logger.setLevel(level)

204

132

205

133

206

134

class PGPError(Exception):

208

136

pass

209

137

210

138

211

class PGPEngine:

139

class PGPEngine(object):

212

140

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

213

214

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

215

143

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

227

self.gnupgargs = ["--batch",

228

"--homedir", self.tempdir,

229

"--force-mdc",

230

"--quiet"]

231

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

232

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

233

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

234

144

self.gnupg = GnuPGInterface.GnuPG()

145

self.gnupg.options.meta_interactive = False

146

self.gnupg.options.homedir = self.tempdir

147

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

148

'--quiet',

149

'--no-use-agent'])

150

235

151

def __enter__(self):

236

152

return self

237

238

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

153

154

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

239

155

self._cleanup()

240

156

return False

241

157

242

158

def __del__(self):

243

159

self._cleanup()

244

160

245

161

def _cleanup(self):

246

162

if self.tempdir is not None:

247

163

# Delete contents of tempdir

248

164

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

249

topdown=False):

165

topdown = False):

250

166

for filename in files:

251

167

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

252

168

for dirname in dirs:

254

170

# Remove tempdir

255

171

os.rmdir(self.tempdir)

256

172

self.tempdir = None

257

173

258

174

def password_encode(self, password):

259

175

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

260

176

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

261

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

262

if len(encoded) > 2048:

263

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

264

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

265

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

266

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

267

return encoded

268

177

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

178

269

179

def encrypt(self, data, password):

270

passphrase = self.password_encode(password)

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

273

passfile.write(passphrase)

274

passfile.flush()

275

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

276

"--passphrase-file",

277

passfile.name]

278

+ self.gnupgargs,

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

283

if proc.returncode != 0:

284

raise PGPError(err)

180

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

181

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

182

try:

183

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

184

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

185

attach_fhs={'stderr': devnull})

186

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

187

f.write(data)

188

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

189

ciphertext = f.read()

190

proc.wait()

191

except IOError as e:

192

raise PGPError(e)

193

self.gnupg.passphrase = None

285

194

return ciphertext

286

195

287

196

def decrypt(self, data, password):

288

passphrase = self.password_encode(password)

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

291

passfile.write(passphrase)

292

passfile.flush()

293

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

294

"--passphrase-file",

295

passfile.name]

296

+ self.gnupgargs,

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

301

if proc.returncode != 0:

302

raise PGPError(err)

197

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

198

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

199

try:

200

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

201

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

202

attach_fhs={'stderr': devnull})

203

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

204

f.write(data)

205

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

206

decrypted_plaintext = f.read()

207

proc.wait()

208

except IOError as e:

209

raise PGPError(e)

210

self.gnupg.passphrase = None

303

211

return decrypted_plaintext

304

212

305

213

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

332

214

class AvahiError(Exception):

333

215

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

334

216

self.value = value

335

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

336

**kwargs)

337

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

338

220

339

221

class AvahiServiceError(AvahiError):

340

222

pass

341

223

342

343

224

class AvahiGroupError(AvahiError):

344

225

pass

345

226

346

227

347

class AvahiService:

228

class AvahiService(object):

348

229

"""An Avahi (Zeroconf) service.

349

230

350

231

Attributes:

351

232

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

352

233

Used to optionally bind to the specified interface.

353

354

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

355

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

234

235

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

236

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

356

237

port: integer; what port to announce

357

238

TXT: list of strings; TXT record for the service

358

239

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

364

245

server: D-Bus Server

365

246

bus: dbus.SystemBus()

366

247

"""

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

248

249

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

250

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

251

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

252

protocol = avahi.PROTO_UNSPEC, bus = None):

379

253

self.interface = interface

380

254

self.name = name

381

255

self.type = servicetype

390

264

self.server = None

391

265

self.bus = bus

392

266

self.entry_group_state_changed_match = None

393

394

def rename(self, remove=True):

267

268

def rename(self):

395

269

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

396

270

if self.rename_count >= self.max_renames:

397

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

398

" after %i retries, exiting.",

399

self.rename_count)

271

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

272

" after %i retries, exiting.",

273

self.rename_count)

400

274

raise AvahiServiceError("Too many renames")

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

277

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

278

self.name)

279

self.remove()

280

try:

281

self.add()

282

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

403

286

self.rename_count += 1

404

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

405

self.name)

406

if remove:

407

self.remove()

408

try:

409

self.add()

410

except dbus.exceptions.DBusException as error:

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

287

420

288

def remove(self):

421

289

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

422

290

if self.entry_group_state_changed_match is not None:

424

292

self.entry_group_state_changed_match = None

425

293

if self.group is not None:

426

294

self.group.Reset()

427

295

428

296

def add(self):

429

297

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

430

298

self.remove()

435

303

avahi.DBUS_INTERFACE_ENTRY_GROUP)

436

304

self.entry_group_state_changed_match = (

437

305

self.group.connect_to_signal(

438

"StateChanged", self.entry_group_state_changed))

439

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

440

self.name, self.type)

306

'StateChanged', self.entry_group_state_changed))

307

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

308

self.name, self.type)

441

309

self.group.AddService(

442

310

self.interface,

443

311

self.protocol,

447

315

dbus.UInt16(self.port),

448

316

avahi.string_array_to_txt_array(self.TXT))

449

317

self.group.Commit()

450

318

451

319

def entry_group_state_changed(self, state, error):

452

320

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

453

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

454

321

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

322

455

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

456

log.debug("Zeroconf service established.")

324

logger.debug("Zeroconf service established.")

457

325

elif state == avahi.ENTRY_GROUP_COLLISION:

458

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

326

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

459

327

self.rename()

460

328

elif state == avahi.ENTRY_GROUP_FAILURE:

461

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

462

str(error))

463

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

464

329

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

330

unicode(error))

331

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

332

.format(error))

333

465

334

def cleanup(self):

466

335

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

467

336

if self.group is not None:

472

341

pass

473

342

self.group = None

474

343

self.remove()

475

344

476

345

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

477

346

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

478

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

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

347

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

485

355

if state in bad_states:

486

356

if bad_states[state] is not None:

487

357

if error is None:

488

log.error(bad_states[state])

358

logger.error(bad_states[state])

489

359

else:

490

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

360

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

491

361

self.cleanup()

492

362

elif state == avahi.SERVER_RUNNING:

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

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

499

return self.rename(remove=False)

500

else:

501

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

502

self.cleanup()

503

os._exit(1)

363

self.add()

504

364

else:

505

365

if error is None:

506

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

366

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

507

367

else:

508

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

509

368

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

369

510

370

def activate(self):

511

371

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

512

372

if self.server is None:

516

376

follow_name_owner_changes=True),

517

377

avahi.DBUS_INTERFACE_SERVER)

518

378

self.server.connect_to_signal("StateChanged",

519

self.server_state_changed)

379

self.server_state_changed)

520

380

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

521

381

522

523

382

class AvahiServiceToSyslog(AvahiService):

524

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

383

def rename(self):

525

384

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

526

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

527

**kwargs)

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

531

390

return ret

532

391

533

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class _session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(_session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

("size", ctypes.c_uint)]

578

579

class _openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code).decode(

597

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

598

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

599

message, *args)

600

601

class CertificateSecurityError(Error):

602

pass

603

604

class PointerTo:

605

def __init__(self, cls):

606

self.cls = cls

607

608

def from_param(self, obj):

609

if not isinstance(obj, self.cls):

610

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

611

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

612

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

613

614

class CastToVoidPointer:

615

def __init__(self, cls):

616

self.cls = cls

617

618

def from_param(self, obj):

619

if not isinstance(obj, self.cls):

620

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

621

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

622

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

623

624

class With_from_param:

625

@classmethod

626

def from_param(cls, obj):

627

return obj._as_parameter_

628

629

# Classes

630

class Credentials(With_from_param):

631

def __init__(self):

632

self._as_parameter_ = gnutls.certificate_credentials_t()

633

gnutls.certificate_allocate_credentials(self)

634

self.type = gnutls.CRD_CERTIFICATE

635

636

def __del__(self):

637

gnutls.certificate_free_credentials(self)

638

639

class ClientSession(With_from_param):

640

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

641

self._as_parameter_ = gnutls.session_t()

642

gnutls_flags = gnutls.CLIENT

643

if gnutls.check_version(b"3.5.6"):

644

gnutls_flags |= gnutls.NO_TICKETS

645

if gnutls.has_rawpk:

646

gnutls_flags |= gnutls.ENABLE_RAWPK

647

gnutls.init(self, gnutls_flags)

648

del gnutls_flags

649

gnutls.set_default_priority(self)

650

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

651

gnutls.handshake_set_private_extensions(self, True)

652

self.socket = socket

653

if credentials is None:

654

credentials = gnutls.Credentials()

655

gnutls.credentials_set(self, credentials.type,

656

credentials)

657

self.credentials = credentials

658

659

def __del__(self):

660

gnutls.deinit(self)

661

662

def handshake(self):

663

return gnutls.handshake(self)

664

665

def send(self, data):

666

data = bytes(data)

667

data_len = len(data)

668

while data_len > 0:

669

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

670

data_len)

671

672

def bye(self):

673

return gnutls.bye(self, gnutls.SHUT_RDWR)

674

675

# Error handling functions

676

def _error_code(result):

677

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

678

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

679

if result >= gnutls.E_SUCCESS:

680

return result

681

if result == gnutls.E_NO_CERTIFICATE_FOUND:

682

raise gnutls.CertificateSecurityError(code=result)

683

raise gnutls.Error(code=result)

684

685

def _retry_on_error(result, func, arguments,

686

_error_code=_error_code):

687

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

688

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

689

while result < gnutls.E_SUCCESS:

690

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

691

return _error_code(result)

692

result = func(*arguments)

693

return result

694

695

# Unless otherwise indicated, the function declarations below are

696

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

697

698

# Functions

699

priority_set_direct = _library.gnutls_priority_set_direct

700

priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,

701

ctypes.POINTER(ctypes.c_char_p)]

702

priority_set_direct.restype = _error_code

703

704

init = _library.gnutls_init

705

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

706

init.restype = _error_code

707

708

set_default_priority = _library.gnutls_set_default_priority

709

set_default_priority.argtypes = [ClientSession]

710

set_default_priority.restype = _error_code

711

712

record_send = _library.gnutls_record_send

713

record_send.argtypes = [ClientSession, ctypes.c_void_p,

714

ctypes.c_size_t]

715

record_send.restype = ctypes.c_ssize_t

716

record_send.errcheck = _retry_on_error

717

718

certificate_allocate_credentials = (

719

_library.gnutls_certificate_allocate_credentials)

720

certificate_allocate_credentials.argtypes = [

721

PointerTo(Credentials)]

722

certificate_allocate_credentials.restype = _error_code

723

724

certificate_free_credentials = (

725

_library.gnutls_certificate_free_credentials)

726

certificate_free_credentials.argtypes = [Credentials]

727

certificate_free_credentials.restype = None

728

729

handshake_set_private_extensions = (

730

_library.gnutls_handshake_set_private_extensions)

731

handshake_set_private_extensions.argtypes = [ClientSession,

732

ctypes.c_int]

733

handshake_set_private_extensions.restype = None

734

735

credentials_set = _library.gnutls_credentials_set

736

credentials_set.argtypes = [ClientSession, credentials_type_t,

737

CastToVoidPointer(Credentials)]

738

credentials_set.restype = _error_code

739

740

strerror = _library.gnutls_strerror

741

strerror.argtypes = [ctypes.c_int]

742

strerror.restype = ctypes.c_char_p

743

744

certificate_type_get = _library.gnutls_certificate_type_get

745

certificate_type_get.argtypes = [ClientSession]

746

certificate_type_get.restype = _error_code

747

748

certificate_get_peers = _library.gnutls_certificate_get_peers

749

certificate_get_peers.argtypes = [ClientSession,

750

ctypes.POINTER(ctypes.c_uint)]

751

certificate_get_peers.restype = ctypes.POINTER(datum_t)

752

753

global_set_log_level = _library.gnutls_global_set_log_level

754

global_set_log_level.argtypes = [ctypes.c_int]

755

global_set_log_level.restype = None

756

757

global_set_log_function = _library.gnutls_global_set_log_function

758

global_set_log_function.argtypes = [log_func]

759

global_set_log_function.restype = None

760

761

deinit = _library.gnutls_deinit

762

deinit.argtypes = [ClientSession]

763

deinit.restype = None

764

765

handshake = _library.gnutls_handshake

766

handshake.argtypes = [ClientSession]

767

handshake.restype = ctypes.c_int

768

handshake.errcheck = _retry_on_error

769

770

transport_set_ptr = _library.gnutls_transport_set_ptr

771

transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]

772

transport_set_ptr.restype = None

773

774

bye = _library.gnutls_bye

775

bye.argtypes = [ClientSession, close_request_t]

776

bye.restype = ctypes.c_int

777

bye.errcheck = _retry_on_error

778

779

check_version = _library.gnutls_check_version

780

check_version.argtypes = [ctypes.c_char_p]

781

check_version.restype = ctypes.c_char_p

782

783

_need_version = b"3.3.0"

784

if check_version(_need_version) is None:

785

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

786

.format(_need_version))

787

788

_tls_rawpk_version = b"3.6.6"

789

has_rawpk = bool(check_version(_tls_rawpk_version))

790

791

if has_rawpk:

792

# Types

793

class pubkey_st(ctypes.Structure):

794

_fields = []

795

pubkey_t = ctypes.POINTER(pubkey_st)

796

797

x509_crt_fmt_t = ctypes.c_int

798

799

# All the function declarations below are from

800

# gnutls/abstract.h

801

pubkey_init = _library.gnutls_pubkey_init

802

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

803

pubkey_init.restype = _error_code

804

805

pubkey_import = _library.gnutls_pubkey_import

806

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

807

x509_crt_fmt_t]

808

pubkey_import.restype = _error_code

809

810

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

811

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

812

ctypes.POINTER(ctypes.c_ubyte),

813

ctypes.POINTER(ctypes.c_size_t)]

814

pubkey_get_key_id.restype = _error_code

815

816

pubkey_deinit = _library.gnutls_pubkey_deinit

817

pubkey_deinit.argtypes = [pubkey_t]

818

pubkey_deinit.restype = None

819

else:

820

# All the function declarations below are from

821

# gnutls/openpgp.h

822

823

openpgp_crt_init = _library.gnutls_openpgp_crt_init

824

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

825

openpgp_crt_init.restype = _error_code

826

827

openpgp_crt_import = _library.gnutls_openpgp_crt_import

828

openpgp_crt_import.argtypes = [openpgp_crt_t,

829

ctypes.POINTER(datum_t),

830

openpgp_crt_fmt_t]

831

openpgp_crt_import.restype = _error_code

832

833

openpgp_crt_verify_self = \

834

_library.gnutls_openpgp_crt_verify_self

835

openpgp_crt_verify_self.argtypes = [

836

openpgp_crt_t,

837

ctypes.c_uint,

838

ctypes.POINTER(ctypes.c_uint),

839

]

840

openpgp_crt_verify_self.restype = _error_code

841

842

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

843

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

844

openpgp_crt_deinit.restype = None

845

846

openpgp_crt_get_fingerprint = (

847

_library.gnutls_openpgp_crt_get_fingerprint)

848

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

849

ctypes.c_void_p,

850

ctypes.POINTER(

851

ctypes.c_size_t)]

852

openpgp_crt_get_fingerprint.restype = _error_code

853

854

if check_version(b"3.6.4"):

855

certificate_type_get2 = _library.gnutls_certificate_type_get2

856

certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]

857

certificate_type_get2.restype = _error_code

858

859

# Remove non-public functions

860

del _error_code, _retry_on_error

861

862

863

def call_pipe(connection, # : multiprocessing.Connection

864

func, *args, **kwargs):

865

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

866

867

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

868

return value on the provided multiprocessing.Connection.

869

"""

870

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

871

connection.close()

872

873

874

class Client:

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

397

398

class Client(object):

875

399

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

876

400

877

401

Attributes:

878

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

402

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

879

403

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

880

404

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

881

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

882

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

883

running.

884

checker_callback_tag: a GLib event source tag, or None

405

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

406

to see if the client lives.

407

'None' if no process is running.

408

checker_callback_tag: a gobject event source tag, or None

885

409

checker_command: string; External command which is run to check

886

410

if client lives. %() expansions are done at

887

411

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

888

412

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

889

checker_initiator_tag: a GLib event source tag, or None

413

checker_initiator_tag: a gobject event source tag, or None

890

414

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

891

415

client_structure: Object describing what attributes a client has

892

416

and is used for storing the client at exit

893

417

current_checker_command: string; current running checker_command

894

disable_initiator_tag: a GLib event source tag, or None

418

disable_initiator_tag: a gobject event source tag, or None

895

419

enabled: bool()

896

420

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

897

uniquely identify an OpenPGP client

898

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

899

a client using raw public keys

421

uniquely identify the client

900

422

host: string; available for use by the checker command

901

423

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

902

424

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

904

426

last_checker_status: integer between 0 and 255 reflecting exit

905

427

status of last checker. -1 reflects crashed

906

428

checker, -2 means no checker completed yet.

907

last_checker_signal: The signal which killed the last checker, if

908

last_checker_status is -1

909

429

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

910

430

911

431

D-Bus identifiers

916

436

runtime_expansions: Allowed attributes for runtime expansion.

917

437

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

918

438

disabled, or None

919

server_settings: The server_settings dict from main()

920

439

"""

921

440

922

441

runtime_expansions = ("approval_delay", "approval_duration",

923

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

924

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

925

"last_approval_request", "last_checked_ok",

442

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

443

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

926

444

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

927

client_defaults = {

928

"timeout": "PT5M",

929

"extended_timeout": "PT15M",

930

"interval": "PT2M",

931

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

932

"host": "",

933

"approval_delay": "PT0S",

934

"approval_duration": "PT1S",

935

"approved_by_default": "True",

936

"enabled": "True",

937

}

938

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

939

471

@staticmethod

940

472

def config_parser(config):

941

473

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

948

480

for client_name in config.sections():

949

481

section = dict(config.items(client_name))

950

482

client = settings[client_name] = {}

951

483

952

484

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

953

485

# Reformat values from string types to Python types

954

486

client["approved_by_default"] = config.getboolean(

955

487

client_name, "approved_by_default")

956

488

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

957

489

"enabled")

958

959

# Uppercase and remove spaces from key_id and fingerprint

960

# for later comparison purposes with return value from the

961

# key_id() and fingerprint() functions

962

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

963

.replace(" ", ""))

490

964

491

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

965

492

.replace(" ", ""))

966

493

if "secret" in section:

967

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

968

.encode("utf-8"),

969

"base64")

494

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

970

495

elif "secfile" in section:

971

496

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

972

497

(section["secfile"])),

973

498

"rb") as secfile:

974

499

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

975

500

else:

976

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

501

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

977

502

.format(section))

978

503

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

979

504

client["extended_timeout"] = string_to_delta(

987

512

client["last_approval_request"] = None

988

513

client["last_checked_ok"] = None

989

514

client["last_checker_status"] = -2

990

515

991

516

return settings

992

993

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

517

518

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

994

519

self.name = name

995

if server_settings is None:

996

server_settings = {}

997

self.server_settings = server_settings

998

520

# adding all client settings

999

for setting, value in settings.items():

521

for setting, value in settings.iteritems():

1000

522

setattr(self, setting, value)

1001

523

1002

524

if self.enabled:

1003

525

if not hasattr(self, "last_enabled"):

1004

526

self.last_enabled = datetime.datetime.utcnow()

1008

530

else:

1009

531

self.last_enabled = None

1010

532

self.expires = None

1011

1012

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

1013

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

1014

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

533

534

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

538

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

1015

539

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

1016

540

datetime.datetime.utcnow())

1017

541

1018

542

# attributes specific for this server instance

1019

543

self.checker = None

1020

544

self.checker_initiator_tag = None

1023

547

self.current_checker_command = None

1024

548

self.approved = None

1025

549

self.approvals_pending = 0

1026

self.changedstate = multiprocessing_manager.Condition(

1027

multiprocessing_manager.Lock())

1028

self.client_structure = [attr

1029

for attr in self.__dict__.keys()

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

1030

555

if not attr.startswith("_")]

1031

556

self.client_structure.append("client_structure")

1032

1033

for name, t in inspect.getmembers(

1034

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

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

1035

562

if not name.startswith("_"):

1036

563

self.client_structure.append(name)

1037

564

1038

565

# Send notice to process children that client state has changed

1039

566

def send_changedstate(self):

1040

567

with self.changedstate:

1041

568

self.changedstate.notify_all()

1042

569

1043

570

def enable(self):

1044

571

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

1045

572

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

1046

573

# Already enabled

1047

574

return

575

self.send_changedstate()

576

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

1048

577

self.enabled = True

1049

578

self.last_enabled = datetime.datetime.utcnow()

1050

579

self.init_checker()

1051

self.send_changedstate()

1052

580

1053

581

def disable(self, quiet=True):

1054

582

"""Disable this client."""

1055

583

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

1056

584

return False

1057

585

if not quiet:

1058

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

1059

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

1060

GLib.source_remove(self.disable_initiator_tag)

586

self.send_changedstate()

587

if not quiet:

588

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

589

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

590

gobject.source_remove(self.disable_initiator_tag)

1061

591

self.disable_initiator_tag = None

1062

592

self.expires = None

1063

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

1064

GLib.source_remove(self.checker_initiator_tag)

593

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

594

gobject.source_remove(self.checker_initiator_tag)

1065

595

self.checker_initiator_tag = None

1066

596

self.stop_checker()

1067

597

self.enabled = False

1068

if not quiet:

1069

self.send_changedstate()

1070

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

598

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

1071

599

return False

1072

600

1073

601

def __del__(self):

1074

602

self.disable()

1075

1076

def init_checker(self, randomize_start=False):

1077

# Schedule a new checker to be started a randomly selected

1078

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

1079

# the startup of checkers over time when the server is

1080

# started.

1081

if self.checker_initiator_tag is not None:

1082

GLib.source_remove(self.checker_initiator_tag)

1083

interval_milliseconds = int(self.interval.total_seconds()

1084

* 1000)

1085

if randomize_start:

1086

delay_milliseconds = random.randrange(

1087

interval_milliseconds + 1)

1088

else:

1089

delay_milliseconds = interval_milliseconds

1090

self.checker_initiator_tag = GLib.timeout_add(

1091

delay_milliseconds, self.start_checker, randomize_start)

1092

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

1093

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

1094

# expire at the soonest one interval after a checker was

1095

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

1096

# time might have to be extended.

1097

now = datetime.datetime.utcnow()

1098

self.expires = now + delay + self.interval

1099

# Schedule a disable() at expire time

1100

if self.disable_initiator_tag is not None:

1101

GLib.source_remove(self.disable_initiator_tag)

1102

self.disable_initiator_tag = GLib.timeout_add(

1103

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

1104

self.disable)

1105

1106

def checker_callback(self, source, condition, connection,

1107

command):

603

604

def init_checker(self):

605

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

606

# and every interval from then on.

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

610

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

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

614

# Also start a new checker *right now*.

615

self.start_checker()

616

617

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

1108

618

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

1109

# Read return code from connection (see call_pipe)

1110

returncode = connection.recv()

1111

connection.close()

1112

if self.checker is not None:

1113

self.checker.join()

1114

619

self.checker_callback_tag = None

1115

620

self.checker = None

1116

1117

if returncode >= 0:

1118

self.last_checker_status = returncode

1119

self.last_checker_signal = None

621

if os.WIFEXITED(condition):

622

self.last_checker_status = os.WEXITSTATUS(condition)

1120

623

if self.last_checker_status == 0:

1121

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

624

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

625

vars(self))

1122

626

self.checked_ok()

1123

627

else:

1124

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

628

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

629

vars(self))

1125

630

else:

1126

631

self.last_checker_status = -1

1127

self.last_checker_signal = -returncode

1128

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

1129

return False

1130

632

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

633

vars(self))

634

1131

635

def checked_ok(self):

1132

636

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

1133

637

self.last_checked_ok = datetime.datetime.utcnow()

1134

638

self.last_checker_status = 0

1135

self.last_checker_signal = None

1136

639

self.bump_timeout()

1137

640

1138

641

def bump_timeout(self, timeout=None):

1139

642

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

1140

643

if timeout is None:

1141

644

timeout = self.timeout

1142

645

if self.disable_initiator_tag is not None:

1143

GLib.source_remove(self.disable_initiator_tag)

1144

self.disable_initiator_tag = None

646

gobject.source_remove(self.disable_initiator_tag)

1145

647

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

1146

self.disable_initiator_tag = GLib.timeout_add(

1147

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

1148

651

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

1149

652

1150

653

def need_approval(self):

1151

654

self.last_approval_request = datetime.datetime.utcnow()

1152

1153

def start_checker(self, start_was_randomized=False):

655

656

def start_checker(self):

1154

657

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

1155

658

1156

659

If a checker already exists, leave it running and do

1157

660

nothing."""

1158

661

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

1163

666

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

1164

667

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

1165

668

# should be.

1166

1167

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

1168

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

1169

self.checker.join()

1170

self.checker = None

669

670

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

671

try:

672

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

673

except (AttributeError, OSError) as error:

674

if (isinstance(error, OSError)

675

and error.errno != errno.ECHILD):

676

raise error

677

else:

678

if pid:

679

logger.warning("Checker was a zombie")

680

gobject.source_remove(self.checker_callback_tag)

681

self.checker_callback(pid, status,

682

self.current_checker_command)

1171

683

# Start a new checker if needed

1172

684

if self.checker is None:

1173

# Escape attributes for the shell

1174

escaped_attrs = {

1175

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

1176

for attr in self.runtime_expansions}

1177

685

try:

1178

command = self.checker_command % escaped_attrs

1179

except TypeError as error:

1180

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

1181

self.checker_command, exc_info=error)

1182

return True # Try again later

686

# In case checker_command has exactly one % operator

687

command = self.checker_command % self.host

688

except TypeError:

689

# Escape attributes for the shell

690

escaped_attrs = dict(

691

(attr,

692

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

693

errors=

694

'replace')))

695

for attr in

696

self.runtime_expansions)

697

698

try:

699

command = self.checker_command % escaped_attrs

700

except TypeError as error:

701

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

1183

704

self.current_checker_command = command

1184

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

1185

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

1186

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

1187

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

1188

# always replaced by /dev/null.)

1189

# The exception is when not debugging but nevertheless

1190

# running in the foreground; use the previously

1191

# created wnull.

1192

popen_args = {"close_fds": True,

1193

"shell": True,

1194

"cwd": "/"}

1195

if (not self.server_settings["debug"]

1196

and self.server_settings["foreground"]):

1197

popen_args.update({"stdout": wnull,

1198

"stderr": wnull})

1199

pipe = multiprocessing.Pipe(duplex=False)

1200

self.checker = multiprocessing.Process(

1201

target=call_pipe,

1202

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

1203

kwargs=popen_args)

1204

self.checker.start()

1205

self.checker_callback_tag = GLib.io_add_watch(

1206

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

1207

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1208

self.checker_callback, pipe[0], command)

1209

if start_was_randomized:

1210

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

1211

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

1212

# interval from then on.

1213

now = datetime.datetime.utcnow()

1214

self.checker_initiator_tag = GLib.timeout_add(

1215

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

1216

self.start_checker)

1217

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

1218

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

1219

return False

1220

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

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

self.checker_callback_tag = (gobject.child_watch_add

716

(self.checker.pid,

717

self.checker_callback,

718

data=command))

719

# The checker may have completed before the gobject

720

# watch was added. Check for this.

721

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

722

if pid:

723

gobject.source_remove(self.checker_callback_tag)

724

self.checker_callback(pid, status, command)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

727

exc_info=error)

728

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

1221

729

return True

1222

730

1223

731

def stop_checker(self):

1224

732

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

1225

733

if self.checker_callback_tag:

1226

GLib.source_remove(self.checker_callback_tag)

734

gobject.source_remove(self.checker_callback_tag)

1227

735

self.checker_callback_tag = None

1228

736

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

1229

737

return

1230

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

1231

self.checker.terminate()

738

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

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

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

743

# self.checker.kill()

744

except OSError as error:

745

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

746

raise

1232

747

self.checker = None

1233

748

1234

749

1235

def dbus_service_property(dbus_interface,

1236

signature="v",

1237

access="readwrite",

1238

byte_arrays=False):

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

1239

752

"""Decorators for marking methods of a DBusObjectWithProperties to

1240

753

become properties on the D-Bus.

1241

754

1242

755

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

1243

756

and with one argument by "Set".

1244

757

1245

758

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

1246

759

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

1247

760

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

1250

763

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

1251

764

if byte_arrays and signature != "ay":

1252

765

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

1253

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

1254

766

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

1255

767

def decorator(func):

1256

768

func._dbus_is_property = True

1257

769

func._dbus_interface = dbus_interface

1260

772

func._dbus_name = func.__name__

1261

773

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

1262

774

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

1263

func._dbus_get_args_options = {"byte_arrays": byte_arrays}

775

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1264

776

return func

1265

1266

777

return decorator

1267

778

1268

779

1269

780

def dbus_interface_annotations(dbus_interface):

1270

781

"""Decorator for marking functions returning interface annotations

1271

782

1272

783

Usage:

1273

784

1274

785

@dbus_interface_annotations("org.example.Interface")

1275

786

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

1276

787

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

1277

788

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

1278

789

"false"}

1279

790

"""

1280

1281

791

def decorator(func):

1282

792

func._dbus_is_interface = True

1283

793

func._dbus_interface = dbus_interface

1284

794

func._dbus_name = dbus_interface

1285

795

return func

1286

1287

796

return decorator

1288

797

1289

798

1290

799

def dbus_annotations(annotations):

1291

800

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

1292

801

Usage:

1293

1294

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

1295

"org.freedesktop.DBus.Property."

1296

"EmitsChangedSignal": "false"})

802

1297

803

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

1298

804

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

1299

808

def Property_dbus_property(self):

1300

809

return dbus.Boolean(False)

1301

1302

See also the DBusObjectWithAnnotations class.

1303

810

"""

1304

1305

811

def decorator(func):

1306

812

func._dbus_annotations = annotations

1307

813

return func

1308

1309

814

return decorator

1310

815

1311

816

1312

817

class DBusPropertyException(dbus.exceptions.DBusException):

1313

818

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

1314

819

"""

1315

pass

820

def __unicode__(self):

821

return unicode(str(self))

1316

822

1317

823

1318

824

class DBusPropertyAccessException(DBusPropertyException):

1327

833

pass

1328

834

1329

835

1330

class DBusObjectWithAnnotations(dbus.service.Object):

1331

"""A D-Bus object with annotations.

1332

1333

Classes inheriting from this can use the dbus_annotations

1334

decorator to add annotations to methods or signals.

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

838

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

1335

842

"""

1336

843

1337

844

@staticmethod

1338

845

def _is_dbus_thing(thing):

1339

846

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

1340

847

1341

848

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

1342

849

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

1343

850

"""

1344

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

851

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

1345

852

False)

1346

853

1347

854

def _get_all_dbus_things(self, thing):

1348

855

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

1349

856

"""

1350

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

857

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

858

name),

1351

859

athing.__get__(self))

1352

860

for cls in self.__class__.__mro__

1353

861

for name, athing in

1354

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

1355

1356

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1357

out_signature="s",

1358

path_keyword="object_path",

1359

connection_keyword="connection")

1360

def Introspect(self, object_path, connection):

1361

"""Overloading of standard D-Bus method.

1362

1363

Inserts annotation tags on methods and signals.

1364

"""

1365

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

1366

connection)

1367

try:

1368

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

1369

1370

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

1371

# Add annotation tags

1372

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

1373

for tag in if_tag.getElementsByTagName(typ):

1374

annots = dict()

1375

for name, prop in (self.

1376

_get_all_dbus_things(typ)):

1377

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

1378

and prop._dbus_interface

1379

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

1380

annots.update(getattr(

1381

prop, "_dbus_annotations", {}))

1382

for name, value in annots.items():

1383

ann_tag = document.createElement(

1384

"annotation")

1385

ann_tag.setAttribute("name", name)

1386

ann_tag.setAttribute("value", value)

1387

tag.appendChild(ann_tag)

1388

# Add interface annotation tags

1389

for annotation, value in dict(

1390

itertools.chain.from_iterable(

1391

annotations().items()

1392

for name, annotations

1393

in self._get_all_dbus_things("interface")

1394

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

1395

)).items():

1396

ann_tag = document.createElement("annotation")

1397

ann_tag.setAttribute("name", annotation)

1398

ann_tag.setAttribute("value", value)

1399

if_tag.appendChild(ann_tag)

1400

# Fix argument name for the Introspect method itself

1401

if (if_tag.getAttribute("name")

1402

== dbus.INTROSPECTABLE_IFACE):

1403

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

1404

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

1405

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

1406

if (arg.getAttribute("direction")

1407

== "out"):

1408

arg.setAttribute("name",

1409

"xml_data")

1410

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

1411

document.unlink()

1412

except (AttributeError, xml.dom.DOMException,

1413

xml.parsers.expat.ExpatError) as error:

1414

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

1415

exc_info=error)

1416

return xmlstring

1417

1418

1419

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1420

"""A D-Bus object with properties.

1421

1422

Classes inheriting from this can use the dbus_service_property

1423

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

1424

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

1425

"""

1426

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

864

1427

865

def _get_dbus_property(self, interface_name, property_name):

1428

866

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

1429

867

property with the specified name and interface.

1430

868

"""

1431

for cls in self.__class__.__mro__:

1432

for name, value in inspect.getmembers(

1433

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

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

1434

873

if (value._dbus_name == property_name

1435

874

and value._dbus_interface == interface_name):

1436

875

return value.__get__(self)

1437

876

1438

877

# No such property

1439

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

1440

self.dbus_object_path, interface_name, property_name))

1441

1442

@classmethod

1443

def _get_all_interface_names(cls):

1444

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

1445

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

1446

"_dbus_interface", None)

1447

for x in (inspect.getmro(cls))

1448

for attr in dir(x))

1449

if name is not None)

1450

1451

@dbus.service.method(dbus.PROPERTIES_IFACE,

1452

in_signature="ss",

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

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

1453

883

out_signature="v")

1454

884

def Get(self, interface_name, property_name):

1455

885

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

1461

891

if not hasattr(value, "variant_level"):

1462

892

return value

1463

893

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

1464

894

1465

895

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

1466

896

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

1467

897

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

1473

903

# The byte_arrays option is not supported yet on

1474

904

# signatures other than "ay".

1475

905

if prop._dbus_signature != "ay":

1476

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

1477

"'ay' signature {!r}"

1478

.format(prop._dbus_signature))

1479

value = dbus.ByteArray(bytes(value))

906

raise ValueError

907

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

908

for byte in value))

1480

909

prop(value)

1481

1482

@dbus.service.method(dbus.PROPERTIES_IFACE,

1483

in_signature="s",

910

911

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

1484

912

out_signature="a{sv}")

1485

913

def GetAll(self, interface_name):

1486

914

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

1487

915

standard.

1488

916

1489

917

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

1490

918

"""

1491

919

properties = {}

1501

929

if not hasattr(value, "variant_level"):

1502

930

properties[name] = value

1503

931

continue

1504

properties[name] = type(value)(

1505

value, variant_level=value.variant_level + 1)

932

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

933

value.variant_level+1)

1506

934

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

1507

1508

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

1509

def PropertiesChanged(self, interface_name, changed_properties,

1510

invalidated_properties):

1511

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

1512

standard.

1513

"""

1514

pass

1515

935

1516

936

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1517

937

out_signature="s",

1518

path_keyword="object_path",

1519

connection_keyword="connection")

938

path_keyword='object_path',

939

connection_keyword='connection')

1520

940

def Introspect(self, object_path, connection):

1521

941

"""Overloading of standard D-Bus method.

1522

942

1523

943

Inserts property tags and interface annotation tags.

1524

944

"""

1525

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1526

object_path,

1527

connection)

945

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

946

connection)

1528

947

try:

1529

948

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

1530

1531

949

def make_tag(document, name, prop):

1532

950

e = document.createElement("property")

1533

951

e.setAttribute("name", name)

1534

952

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

1535

953

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

1536

954

return e

1537

1538

955

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

1539

956

# Add property tags

1540

957

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

1543

960

if prop._dbus_interface

1544

961

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

1545

962

if_tag.appendChild(tag)

1546

# Add annotation tags for properties

1547

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

1548

annots = dict()

1549

for name, prop in self._get_all_dbus_things(

1550

"property"):

1551

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

1552

and prop._dbus_interface

1553

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

1554

annots.update(getattr(

1555

prop, "_dbus_annotations", {}))

1556

for name, value in annots.items():

1557

ann_tag = document.createElement(

1558

"annotation")

1559

ann_tag.setAttribute("name", name)

1560

ann_tag.setAttribute("value", value)

1561

tag.appendChild(ann_tag)

963

# Add annotation tags

964

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

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

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

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_tag)

1562

994

# Add the names to the return values for the

1563

995

# "org.freedesktop.DBus.Properties" methods

1564

996

if (if_tag.getAttribute("name")

1578

1010

document.unlink()

1579

1011

except (AttributeError, xml.dom.DOMException,

1580

1012

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1586

try:

1587

dbus.OBJECT_MANAGER_IFACE

1588

except AttributeError:

1589

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

1590

1591

1592

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1593

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

1594

1595

Classes inheriting from this exposes the standard

1596

GetManagedObjects call and the InterfacesAdded and

1597

InterfacesRemoved signals on the standard

1598

"org.freedesktop.DBus.ObjectManager" interface.

1599

1600

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

1601

manually.

1602

"""

1603

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1604

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

1605

def GetManagedObjects(self):

1606

"""This function must be overridden"""

1607

raise NotImplementedError()

1608

1609

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1610

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

1611

def InterfacesAdded(self, object_path, interfaces_and_properties):

1612

pass

1613

1614

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

1615

def InterfacesRemoved(self, object_path, interfaces):

1616

pass

1617

1618

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1619

out_signature="s",

1620

path_keyword="object_path",

1621

connection_keyword="connection")

1622

def Introspect(self, object_path, connection):

1623

"""Overloading of standard D-Bus method.

1624

1625

Override return argument name of GetManagedObjects to be

1626

"objpath_interfaces_and_properties"

1627

"""

1628

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1629

object_path,

1630

connection)

1631

try:

1632

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

1633

1634

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

1635

# Fix argument name for the GetManagedObjects method

1636

if (if_tag.getAttribute("name")

1637

== dbus.OBJECT_MANAGER_IFACE):

1638

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

1639

if (cn.getAttribute("name")

1640

== "GetManagedObjects"):

1641

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

1642

if (arg.getAttribute("direction")

1643

== "out"):

1644

arg.setAttribute(

1645

"name",

1646

"objpath_interfaces"

1647

"_and_properties")

1648

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

1649

document.unlink()

1650

except (AttributeError, xml.dom.DOMException,

1651

xml.parsers.expat.ExpatError) as error:

1652

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

1653

exc_info=error)

1654

return xmlstring

1655

1656

1657

def datetime_to_dbus(dt, variant_level=0):

1013

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

1014

exc_info=error)

1015

return xmlstring

1016

1017

1018

def datetime_to_dbus (dt, variant_level=0):

1658

1019

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

1659

1020

if dt is None:

1660

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

1661

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

1021

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1662

1024

1663

1025

1664

1026

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1666

1028

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

1667

1029

interface names according to the "alt_interface_names" mapping.

1668

1030

Usage:

1669

1670

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

1671

"net.example.AlternateInterface"})

1031

1032

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

1033

"net.example.AlternateInterface"})

1672

1034

class SampleDBusObject(dbus.service.Object):

1673

1035

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

1674

1036

def SampleDBusMethod():

1675

1037

pass

1676

1038

1677

1039

The above "SampleDBusMethod" on "SampleDBusObject" will be

1678

1040

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

1679

1041

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

1680

1042

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

1681

1043

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

1682

1044

1683

1045

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

1684

1046

(from DBusObjectWithProperties) and interfaces (from the

1685

1047

dbus_interface_annotations decorator).

1686

1048

"""

1687

1688

1049

def wrapper(cls):

1689

1050

for orig_interface_name, alt_interface_name in (

1690

alt_interface_names.items()):

1051

alt_interface_names.iteritems()):

1691

1052

attr = {}

1692

1053

interface_names = set()

1693

1054

# Go though all attributes of the class

1695

1056

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

1696

1057

# with the wrong interface name

1697

1058

if (not hasattr(attribute, "_dbus_interface")

1698

or not attribute._dbus_interface.startswith(

1699

orig_interface_name)):

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1700

1061

continue

1701

1062

# Create an alternate D-Bus interface name based on

1702

1063

# the current name

1703

alt_interface = attribute._dbus_interface.replace(

1704

orig_interface_name, alt_interface_name)

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1705

1067

interface_names.add(alt_interface)

1706

1068

# Is this a D-Bus signal?

1707

1069

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

1708

# Extract the original non-method undecorated

1709

# function by black magic

1710

if sys.version_info.major == 2:

1711

nonmethod_func = (dict(

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1712

1073

zip(attribute.func_code.co_freevars,

1713

attribute.__closure__))

1714

["func"].cell_contents)

1715

else:

1716

nonmethod_func = (dict(

1717

zip(attribute.__code__.co_freevars,

1718

attribute.__closure__))

1719

["func"].cell_contents)

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1720

1076

# Create a new, but exactly alike, function

1721

1077

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

1722

1078

# with the alternate D-Bus interface name

1723

new_function = copy_function(nonmethod_func)

1724

new_function = (dbus.service.signal(

1725

alt_interface,

1726

attribute._dbus_signature)(new_function))

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

1727

1088

# Copy annotations, if any

1728

1089

try:

1729

new_function._dbus_annotations = dict(

1730

attribute._dbus_annotations)

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1731

1092

except AttributeError:

1732

1093

pass

1733

1734

1094

# Define a creator of a function to call both the

1735

1095

# original and alternate functions, so both the

1736

1096

# original and alternate signals gets sent when

1739

1099

"""This function is a scope container to pass

1740

1100

func1 and func2 to the "call_both" function

1741

1101

outside of its arguments"""

1742

1743

@functools.wraps(func2)

1744

1102

def call_both(*args, **kwargs):

1745

1103

"""This function will emit two D-Bus

1746

1104

signals by calling func1 and func2"""

1747

1105

func1(*args, **kwargs)

1748

1106

func2(*args, **kwargs)

1749

# Make wrapper function look like a D-Bus

1750

# signal

1751

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

1752

if name.startswith("_dbus_"):

1753

setattr(call_both, name, attr)

1754

1755

1107

return call_both

1756

1108

# Create the "call_both" function and add it to

1757

1109

# the class

1762

1114

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

1763

1115

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

1764

1116

# to the class.

1765

attr[attrname] = (

1766

dbus.service.method(

1767

alt_interface,

1768

attribute._dbus_in_signature,

1769

attribute._dbus_out_signature)

1770

(copy_function(attribute)))

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1771

1127

# Copy annotations, if any

1772

1128

try:

1773

attr[attrname]._dbus_annotations = dict(

1774

attribute._dbus_annotations)

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1775

1131

except AttributeError:

1776

1132

pass

1777

1133

# Is this a D-Bus property?

1780

1136

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

1781

1137

# property with the alternate D-Bus interface

1782

1138

# name. Add it to the class.

1783

attr[attrname] = (dbus_service_property(

1784

alt_interface, attribute._dbus_signature,

1785

attribute._dbus_access,

1786

attribute._dbus_get_args_options

1787

["byte_arrays"])

1788

(copy_function(attribute)))

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1789

1152

# Copy annotations, if any

1790

1153

try:

1791

attr[attrname]._dbus_annotations = dict(

1792

attribute._dbus_annotations)

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1793

1156

except AttributeError:

1794

1157

pass

1795

1158

# Is this a D-Bus interface?

1798

1161

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

1799

1162

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

1800

1163

# to the class.

1801

attr[attrname] = (

1802

dbus_interface_annotations(alt_interface)

1803

(copy_function(attribute)))

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1804

1172

if deprecate:

1805

1173

# Deprecate all alternate interfaces

1806

iname = "_AlternateDBusNames_interface_annotation{}"

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1807

1175

for interface_name in interface_names:

1808

1809

1176

@dbus_interface_annotations(interface_name)

1810

1177

def func(self):

1811

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

1812

"true"}

1178

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

1179

"true" }

1813

1180

# Find an unused name

1814

1181

for aname in (iname.format(i)

1815

1182

for i in itertools.count()):

1819

1186

if interface_names:

1820

1187

# Replace the class with a new subclass of it with

1821

1188

# methods, signals, etc. as created above.

1822

if sys.version_info.major == 2:

1823

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

1824

(cls, ), attr)

1825

else:

1826

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

1827

(cls, ), attr)

1189

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

1190

(cls,), attr)

1828

1191

return cls

1829

1830

1192

return wrapper

1831

1193

1832

1194

1833

1195

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

1834

"se.bsnet.fukt.Mandos"})

1196

"se.bsnet.fukt.Mandos"})

1835

1197

class ClientDBus(Client, DBusObjectWithProperties):

1836

1198

"""A Client class using D-Bus

1837

1199

1838

1200

Attributes:

1839

1201

dbus_object_path: dbus.ObjectPath

1840

1202

bus: dbus.SystemBus()

1841

1203

"""

1842

1204

1843

1205

runtime_expansions = (Client.runtime_expansions

1844

+ ("dbus_object_path", ))

1845

1846

_interface = "se.recompile.Mandos.Client"

1847

1206

+ ("dbus_object_path",))

1207

1848

1208

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

1849

1850

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

1209

1210

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

1851

1211

self.bus = bus

1852

1212

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

1853

1213

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

1854

1214

# the D-Bus

1855

client_object_name = str(self.name).translate(

1215

client_object_name = unicode(self.name).translate(

1856

1216

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

1857

1217

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

1858

self.dbus_object_path = dbus.ObjectPath(

1859

"/clients/" + client_object_name)

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1860

1220

DBusObjectWithProperties.__init__(self, self.bus,

1861

1221

self.dbus_object_path)

1862

1863

def notifychangeproperty(transform_func, dbus_name,

1864

type_func=lambda x: x,

1865

variant_level=1,

1866

invalidate_only=False,

1867

_interface=_interface):

1222

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1868

1226

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

1869

1227

its changes to DBus.

1870

1228

1871

1229

transform_fun: Function that takes a value and a variant_level

1872

1230

and transforms it to a D-Bus type.

1873

1231

dbus_name: D-Bus name of the variable

1875

1233

to the D-Bus. Default: no transform

1876

1234

variant_level: D-Bus variant level. Default: 1

1877

1235

"""

1878

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

1879

1236

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

1880

1237

def setter(self, value):

1881

1238

if hasattr(self, "dbus_object_path"):

1882

1239

if (not hasattr(self, attrname) or

1883

1240

type_func(getattr(self, attrname, None))

1884

1241

!= type_func(value)):

1885

if invalidate_only:

1886

self.PropertiesChanged(

1887

_interface, dbus.Dictionary(),

1888

dbus.Array((dbus_name, )))

1889

else:

1890

dbus_value = transform_func(

1891

type_func(value),

1892

variant_level=variant_level)

1893

self.PropertyChanged(dbus.String(dbus_name),

1894

dbus_value)

1895

self.PropertiesChanged(

1896

_interface,

1897

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

1898

dbus_value}),

1899

dbus.Array())

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1900

1247

setattr(self, attrname, value)

1901

1248

1902

1249

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

1903

1250

1904

1251

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1905

1252

approvals_pending = notifychangeproperty(dbus.Boolean,

1906

1253

"ApprovalPending",

1907

type_func=bool)

1254

type_func = bool)

1908

1255

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

1909

1256

last_enabled = notifychangeproperty(datetime_to_dbus,

1910

1257

"LastEnabled")

1911

checker = notifychangeproperty(

1912

dbus.Boolean, "CheckerRunning",

1913

type_func=lambda checker: checker is not None)

1258

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

1259

type_func = lambda checker:

1260

checker is not None)

1914

1261

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1915

1262

"LastCheckedOK")

1916

1263

last_checker_status = notifychangeproperty(dbus.Int16,

1919

1266

datetime_to_dbus, "LastApprovalRequest")

1920

1267

approved_by_default = notifychangeproperty(dbus.Boolean,

1921

1268

"ApprovedByDefault")

1922

approval_delay = notifychangeproperty(

1923

dbus.UInt64, "ApprovalDelay",

1924

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

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1925

1273

approval_duration = notifychangeproperty(

1926

1274

dbus.UInt64, "ApprovalDuration",

1927

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

1275

type_func = timedelta_to_milliseconds)

1928

1276

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

1929

timeout = notifychangeproperty(

1930

dbus.UInt64, "Timeout",

1931

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

1277

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

1278

type_func =

1279

timedelta_to_milliseconds)

1932

1280

extended_timeout = notifychangeproperty(

1933

1281

dbus.UInt64, "ExtendedTimeout",

1934

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

1935

interval = notifychangeproperty(

1936

dbus.UInt64, "Interval",

1937

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

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1938

1287

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

1939

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

1940

invalidate_only=True)

1941

1288

1942

1289

del notifychangeproperty

1943

1290

1944

1291

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

1945

1292

try:

1946

1293

self.remove_from_connection()

1949

1296

if hasattr(DBusObjectWithProperties, "__del__"):

1950

1297

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

1951

1298

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

1952

1953

def checker_callback(self, source, condition,

1954

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

1955

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

1956

connection, command, *args,

1957

**kwargs)

1958

exitstatus = self.last_checker_status

1959

if exitstatus >= 0:

1299

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1960

1306

# Emit D-Bus signal

1961

1307

self.CheckerCompleted(dbus.Int16(exitstatus),

1962

# This is specific to GNU libC

1963

dbus.Int64(exitstatus << 8),

1308

dbus.Int64(condition),

1964

1309

dbus.String(command))

1965

1310

else:

1966

1311

# Emit D-Bus signal

1967

1312

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

1968

dbus.Int64(

1969

# This is specific to GNU libC

1970

(exitstatus << 8)

1971

| self.last_checker_signal),

1313

dbus.Int64(condition),

1972

1314

dbus.String(command))

1973

return ret

1974

1315

1316

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

1317

*args, **kwargs)

1318

1975

1319

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

1976

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1977

1325

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

1978

1326

# Only if new checker process was started

1979

1327

if (self.checker is not None

1981

1329

# Emit D-Bus signal

1982

1330

self.CheckerStarted(self.current_checker_command)

1983

1331

return r

1984

1332

1985

1333

def _reset_approved(self):

1986

1334

self.approved = None

1987

1335

return False

1988

1336

1989

1337

def approve(self, value=True):

1338

self.send_changedstate()

1990

1339

self.approved = value

1991

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

1992

* 1000), self._reset_approved)

1993

self.send_changedstate()

1994

1995

# D-Bus methods, signals & properties

1996

1997

# Interfaces

1998

1999

# Signals

2000

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1343

1344

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

## Signals

1355

2001

1356

# CheckerCompleted - signal

2002

1357

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

2003

1358

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

2004

1359

"D-Bus signal"

2005

1360

pass

2006

1361

2007

1362

# CheckerStarted - signal

2008

1363

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

2009

1364

def CheckerStarted(self, command):

2010

1365

"D-Bus signal"

2011

1366

pass

2012

1367

2013

1368

# PropertyChanged - signal

2014

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

2015

1369

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

2016

1370

def PropertyChanged(self, property, value):

2017

1371

"D-Bus signal"

2018

1372

pass

2019

1373

2020

1374

# GotSecret - signal

2021

1375

@dbus.service.signal(_interface)

2022

1376

def GotSecret(self):

2025

1379

server to mandos-client

2026

1380

"""

2027

1381

pass

2028

1382

2029

1383

# Rejected - signal

2030

1384

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

2031

1385

def Rejected(self, reason):

2032

1386

"D-Bus signal"

2033

1387

pass

2034

1388

2035

1389

# NeedApproval - signal

2036

1390

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

2037

1391

def NeedApproval(self, timeout, default):

2038

1392

"D-Bus signal"

2039

1393

return self.need_approval()

2040

2041

# Methods

2042

1394

1395

## Methods

1396

2043

1397

# Approve - method

2044

1398

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

2045

1399

def Approve(self, value):

2046

1400

self.approve(value)

2047

1401

2048

1402

# CheckedOK - method

2049

1403

@dbus.service.method(_interface)

2050

1404

def CheckedOK(self):

2051

1405

self.checked_ok()

2052

1406

2053

1407

# Enable - method

2054

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

2055

1408

@dbus.service.method(_interface)

2056

1409

def Enable(self):

2057

1410

"D-Bus method"

2058

1411

self.enable()

2059

1412

2060

1413

# StartChecker - method

2061

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

2062

1414

@dbus.service.method(_interface)

2063

1415

def StartChecker(self):

2064

1416

"D-Bus method"

2065

1417

self.start_checker()

2066

1418

2067

1419

# Disable - method

2068

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

2069

1420

@dbus.service.method(_interface)

2070

1421

def Disable(self):

2071

1422

"D-Bus method"

2072

1423

self.disable()

2073

1424

2074

1425

# StopChecker - method

2075

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

2076

1426

@dbus.service.method(_interface)

2077

1427

def StopChecker(self):

2078

1428

self.stop_checker()

2079

2080

# Properties

2081

1429

1430

## Properties

1431

2082

1432

# ApprovalPending - property

2083

1433

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

2084

1434

def ApprovalPending_dbus_property(self):

2085

1435

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

2086

1436

2087

1437

# ApprovedByDefault - property

2088

@dbus_service_property(_interface,

2089

signature="b",

1438

@dbus_service_property(_interface, signature="b",

2090

1439

access="readwrite")

2091

1440

def ApprovedByDefault_dbus_property(self, value=None):

2092

1441

if value is None: # get

2093

1442

return dbus.Boolean(self.approved_by_default)

2094

1443

self.approved_by_default = bool(value)

2095

1444

2096

1445

# ApprovalDelay - property

2097

@dbus_service_property(_interface,

2098

signature="t",

1446

@dbus_service_property(_interface, signature="t",

2099

1447

access="readwrite")

2100

1448

def ApprovalDelay_dbus_property(self, value=None):

2101

1449

if value is None: # get

2102

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

2103

* 1000)

1450

return dbus.UInt64(self.approval_delay_milliseconds())

2104

1451

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

2105

1452

2106

1453

# ApprovalDuration - property

2107

@dbus_service_property(_interface,

2108

signature="t",

1454

@dbus_service_property(_interface, signature="t",

2109

1455

access="readwrite")

2110

1456

def ApprovalDuration_dbus_property(self, value=None):

2111

1457

if value is None: # get

2112

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

2113

* 1000)

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

2114

1460

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

2115

1461

2116

1462

# Name - property

2117

@dbus_annotations(

2118

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

2119

1463

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

2120

1464

def Name_dbus_property(self):

2121

1465

return dbus.String(self.name)

2122

2123

# KeyID - property

2124

@dbus_annotations(

2125

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

2126

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

2127

def KeyID_dbus_property(self):

2128

return dbus.String(self.key_id)

2129

1466

2130

1467

# Fingerprint - property

2131

@dbus_annotations(

2132

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

2133

1468

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

2134

1469

def Fingerprint_dbus_property(self):

2135

1470

return dbus.String(self.fingerprint)

2136

1471

2137

1472

# Host - property

2138

@dbus_service_property(_interface,

2139

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2140

1474

access="readwrite")

2141

1475

def Host_dbus_property(self, value=None):

2142

1476

if value is None: # get

2143

1477

return dbus.String(self.host)

2144

self.host = str(value)

2145

1478

self.host = unicode(value)

1479

2146

1480

# Created - property

2147

@dbus_annotations(

2148

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

2149

1481

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

2150

1482

def Created_dbus_property(self):

2151

1483

return datetime_to_dbus(self.created)

2152

1484

2153

1485

# LastEnabled - property

2154

1486

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

2155

1487

def LastEnabled_dbus_property(self):

2156

1488

return datetime_to_dbus(self.last_enabled)

2157

1489

2158

1490

# Enabled - property

2159

@dbus_service_property(_interface,

2160

signature="b",

1491

@dbus_service_property(_interface, signature="b",

2161

1492

access="readwrite")

2162

1493

def Enabled_dbus_property(self, value=None):

2163

1494

if value is None: # get

2166

1497

self.enable()

2167

1498

else:

2168

1499

self.disable()

2169

1500

2170

1501

# LastCheckedOK - property

2171

@dbus_service_property(_interface,

2172

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2173

1503

access="readwrite")

2174

1504

def LastCheckedOK_dbus_property(self, value=None):

2175

1505

if value is not None:

2176

1506

self.checked_ok()

2177

1507

return

2178

1508

return datetime_to_dbus(self.last_checked_ok)

2179

1509

2180

1510

# LastCheckerStatus - property

2181

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

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

2182

1513

def LastCheckerStatus_dbus_property(self):

2183

1514

return dbus.Int16(self.last_checker_status)

2184

1515

2185

1516

# Expires - property

2186

1517

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

2187

1518

def Expires_dbus_property(self):

2188

1519

return datetime_to_dbus(self.expires)

2189

1520

2190

1521

# LastApprovalRequest - property

2191

1522

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

2192

1523

def LastApprovalRequest_dbus_property(self):

2193

1524

return datetime_to_dbus(self.last_approval_request)

2194

1525

2195

1526

# Timeout - property

2196

@dbus_service_property(_interface,

2197

signature="t",

1527

@dbus_service_property(_interface, signature="t",

2198

1528

access="readwrite")

2199

1529

def Timeout_dbus_property(self, value=None):

2200

1530

if value is None: # get

2201

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

2202

old_timeout = self.timeout

1531

return dbus.UInt64(self.timeout_milliseconds())

2203

1532

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

2204

# Reschedule disabling

1533

# Reschedule timeout

2205

1534

if self.enabled:

2206

1535

now = datetime.datetime.utcnow()

2207

self.expires += self.timeout - old_timeout

2208

if self.expires <= now:

1536

time_to_die = timedelta_to_milliseconds(

1537

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

1538

if time_to_die <= 0:

2209

1539

# The timeout has passed

2210

1540

self.disable()

2211

1541

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

2212

1545

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

2213

1546

is None):

2214

1547

return

2215

GLib.source_remove(self.disable_initiator_tag)

2216

self.disable_initiator_tag = GLib.timeout_add(

2217

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

2218

self.disable)

2219

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1552

2220

1553

# ExtendedTimeout - property

2221

@dbus_service_property(_interface,

2222

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2223

1555

access="readwrite")

2224

1556

def ExtendedTimeout_dbus_property(self, value=None):

2225

1557

if value is None: # get

2226

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

2227

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2228

1559

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

2229

1560

2230

1561

# Interval - property

2231

@dbus_service_property(_interface,

2232

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2233

1563

access="readwrite")

2234

1564

def Interval_dbus_property(self, value=None):

2235

1565

if value is None: # get

2236

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

1566

return dbus.UInt64(self.interval_milliseconds())

2237

1567

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

2238

1568

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

2239

1569

return

2240

1570

if self.enabled:

2241

1571

# Reschedule checker run

2242

GLib.source_remove(self.checker_initiator_tag)

2243

self.checker_initiator_tag = GLib.timeout_add(

2244

value, self.start_checker)

2245

self.start_checker() # Start one now, too

2246

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2247

1577

# Checker - property

2248

@dbus_service_property(_interface,

2249

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2250

1579

access="readwrite")

2251

1580

def Checker_dbus_property(self, value=None):

2252

1581

if value is None: # get

2253

1582

return dbus.String(self.checker_command)

2254

self.checker_command = str(value)

2255

1583

self.checker_command = unicode(value)

1584

2256

1585

# CheckerRunning - property

2257

@dbus_service_property(_interface,

2258

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2259

1587

access="readwrite")

2260

1588

def CheckerRunning_dbus_property(self, value=None):

2261

1589

if value is None: # get

2264

1592

self.start_checker()

2265

1593

else:

2266

1594

self.stop_checker()

2267

1595

2268

1596

# ObjectPath - property

2269

@dbus_annotations(

2270

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

2271

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

2272

1597

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

2273

1598

def ObjectPath_dbus_property(self):

2274

return self.dbus_object_path # is already a dbus.ObjectPath

2275

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2276

1601

# Secret = property

2277

@dbus_annotations(

2278

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

2279

"invalidates"})

2280

@dbus_service_property(_interface,

2281

signature="ay",

2282

access="write",

2283

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2284

1604

def Secret_dbus_property(self, value):

2285

self.secret = bytes(value)

2286

1605

self.secret = str(value)

1606

2287

1607

del _interface

2288

1608

2289

1609

2290

class ProxyClient:

2291

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

1610

class ProxyClient(object):

1611

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

2292

1612

self._pipe = child_pipe

2293

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

1613

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

2294

1614

if not self._pipe.recv():

2295

raise KeyError(key_id or fpr)

2296

1615

raise KeyError()

1616

2297

1617

def __getattribute__(self, name):

2298

if name == "_pipe":

1618

if name == '_pipe':

2299

1619

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

2300

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

1620

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

2301

1621

data = self._pipe.recv()

2302

if data[0] == "data":

1622

if data[0] == 'data':

2303

1623

return data[1]

2304

if data[0] == "function":

2305

1624

if data[0] == 'function':

2306

1625

def func(*args, **kwargs):

2307

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

1626

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

2308

1627

return self._pipe.recv()[1]

2309

2310

1628

return func

2311

1629

2312

1630

def __setattr__(self, name, value):

2313

if name == "_pipe":

1631

if name == '_pipe':

2314

1632

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

2315

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

1633

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

2316

1634

2317

1635

2318

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2319

1637

"""A class to handle client connections.

2320

1638

2321

1639

Instantiated once for each connection to handle it.

2322

1640

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

2323

1641

2324

1642

def handle(self):

2325

1643

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

2326

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

2327

str(self.client_address))

2328

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

2329

2330

session = gnutls.ClientSession(self.request)

2331

2332

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

2333

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

2334

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

2335

# "+DHE-DSS"))

1644

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

1645

unicode(self.client_address))

1646

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

1647

self.server.child_pipe.fileno())

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2336

1663

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

2337

1664

priority = self.server.gnutls_priority

2338

1665

if priority is None:

2339

1666

priority = "NORMAL"

2340

gnutls.priority_set_direct(session,

2341

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

2342

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2343

1671

# Start communication using the Mandos protocol

2344

1672

# Get protocol number

2345

1673

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

2346

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

1674

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

2347

1675

try:

2348

1676

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

2349

raise RuntimeError(line)

1677

raise RuntimeError

2350

1678

except (ValueError, IndexError, RuntimeError) as error:

2351

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

1679

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

2352

1680

return

2353

1681

2354

1682

# Start GnuTLS connection

2355

1683

try:

2356

1684

session.handshake()

2357

except gnutls.Error as error:

2358

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

1685

except gnutls.errors.GNUTLSError as error:

1686

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

2359

1687

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

2360

1688

# established. Just abandon the request.

2361

1689

return

2362

log.debug("Handshake succeeded")

2363

1690

logger.debug("Handshake succeeded")

1691

2364

1692

approval_required = False

2365

1693

try:

2366

if gnutls.has_rawpk:

2367

fpr = b""

2368

try:

2369

key_id = self.key_id(

2370

self.peer_certificate(session))

2371

except (TypeError, gnutls.Error) as error:

2372

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

2373

return

2374

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

2375

key_id.decode("utf-8",

2376

errors="replace"))

2377

2378

else:

2379

key_id = b""

2380

try:

2381

fpr = self.fingerprint(

2382

self.peer_certificate(session))

2383

except (TypeError, gnutls.Error) as error:

2384

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

2385

return

2386

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

2387

2388

try:

2389

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2390

1705

self.client_address)

2391

1706

except KeyError:

2392

1707

return

2393

1708

2394

1709

if client.approval_delay:

2395

1710

delay = client.approval_delay

2396

1711

client.approvals_pending += 1

2397

1712

approval_required = True

2398

1713

2399

1714

while True:

2400

1715

if not client.enabled:

2401

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

1716

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

1717

client.name)

2402

1718

if self.server.use_dbus:

2403

1719

# Emit D-Bus signal

2404

1720

client.Rejected("Disabled")

2405

1721

return

2406

1722

2407

1723

if client.approved or not client.approval_delay:

2408

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2409

1725

break

2410

1726

elif client.approved is None:

2411

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

2412

client.name)

1727

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

1728

client.name)

2413

1729

if self.server.use_dbus:

2414

1730

# Emit D-Bus signal

2415

1731

client.NeedApproval(

2416

client.approval_delay.total_seconds()

2417

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2418

1734

else:

2419

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

2420

client.name)

1735

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

1736

client.name)

2421

1737

if self.server.use_dbus:

2422

1738

# Emit D-Bus signal

2423

1739

client.Rejected("Denied")

2424

1740

return

2425

2426

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2427

1743

time = datetime.datetime.now()

2428

1744

client.changedstate.acquire()

2429

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

1745

(client.changedstate.wait

1746

(float(client.timedelta_to_milliseconds(delay)

1747

/ 1000)))

2430

1748

client.changedstate.release()

2431

1749

time2 = datetime.datetime.now()

2432

1750

if (time2 - time) >= delay:

2433

1751

if not client.approved_by_default:

2434

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

2435

" waiting for approval",

2436

client.name)

1752

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

1753

" waiting for approval",

1754

client.name)

2437

1755

if self.server.use_dbus:

2438

1756

# Emit D-Bus signal

2439

1757

client.Rejected("Approval timed out")

2442

1760

break

2443

1761

else:

2444

1762

delay -= time2 - time

2445

2446

try:

2447

session.send(client.secret)

2448

except gnutls.Error as error:

2449

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

2450

return

2451

2452

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

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

1777

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

2453

1778

# bump the timeout using extended_timeout

2454

1779

client.bump_timeout(client.extended_timeout)

2455

1780

if self.server.use_dbus:

2456

1781

# Emit D-Bus signal

2457

1782

client.GotSecret()

2458

1783

2459

1784

finally:

2460

1785

if approval_required:

2461

1786

client.approvals_pending -= 1

2462

1787

try:

2463

1788

session.bye()

2464

except gnutls.Error as error:

2465

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

2466

1789

except gnutls.errors.GNUTLSError as error:

1790

logger.warning("GnuTLS bye failed",

1791

exc_info=error)

1792

2467

1793

@staticmethod

2468

1794

def peer_certificate(session):

2469

"Return the peer's certificate as a bytestring"

2470

try:

2471

cert_type = gnutls.certificate_type_get2(

2472

session, gnutls.CTYPE_PEERS)

2473

except AttributeError:

2474

cert_type = gnutls.certificate_type_get(session)

2475

if gnutls.has_rawpk:

2476

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2477

else:

2478

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2479

# If not a valid certificate type...

2480

if cert_type not in valid_cert_types:

2481

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

2482

valid_cert_types)

2483

# ...return invalid data

2484

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2485

1802

list_size = ctypes.c_uint(1)

2486

cert_list = (gnutls.certificate_get_peers

2487

(session, ctypes.byref(list_size)))

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

1805

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

2488

1806

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

2489

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

1807

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

1808

" certificate")

2490

1809

if list_size.value == 0:

2491

1810

return None

2492

1811

cert = cert_list[0]

2493

1812

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

2494

2495

@staticmethod

2496

def key_id(certificate):

2497

"Convert a certificate bytestring to a hexdigit key ID"

2498

# New GnuTLS "datum" with the public key

2499

datum = gnutls.datum_t(

2500

ctypes.cast(ctypes.c_char_p(certificate),

2501

ctypes.POINTER(ctypes.c_ubyte)),

2502

ctypes.c_uint(len(certificate)))

2503

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

2504

# New empty GnuTLS certificate

2505

pubkey = gnutls.pubkey_t()

2506

gnutls.pubkey_init(ctypes.byref(pubkey))

2507

# Import the raw public key into the certificate

2508

gnutls.pubkey_import(pubkey,

2509

ctypes.byref(datum),

2510

gnutls.X509_FMT_DER)

2511

# New buffer for the key ID

2512

buf = ctypes.create_string_buffer(32)

2513

buf_len = ctypes.c_size_t(len(buf))

2514

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

2515

gnutls.pubkey_get_key_id(

2516

pubkey,

2517

gnutls.KEYID_USE_SHA256,

2518

ctypes.cast(ctypes.byref(buf),

2519

ctypes.POINTER(ctypes.c_ubyte)),

2520

ctypes.byref(buf_len))

2521

# Deinit the certificate

2522

gnutls.pubkey_deinit(pubkey)

2523

2524

# Convert the buffer to a Python bytestring

2525

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

2526

# Convert the bytestring to hexadecimal notation

2527

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

2528

return hex_key_id

2529

1813

2530

1814

@staticmethod

2531

1815

def fingerprint(openpgp):

2532

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2533

1817

# New GnuTLS "datum" with the OpenPGP public key

2534

datum = gnutls.datum_t(

2535

ctypes.cast(ctypes.c_char_p(openpgp),

2536

ctypes.POINTER(ctypes.c_ubyte)),

2537

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2538

1823

# New empty GnuTLS certificate

2539

crt = gnutls.openpgp_crt_t()

2540

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2541

1827

# Import the OpenPGP public key into the certificate

2542

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

2543

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2544

1832

# Verify the self signature in the key

2545

1833

crtverify = ctypes.c_uint()

2546

gnutls.openpgp_crt_verify_self(crt, 0,

2547

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2548

1837

if crtverify.value != 0:

2549

gnutls.openpgp_crt_deinit(crt)

2550

raise gnutls.CertificateSecurityError(code

2551

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2552

1841

# New buffer for the fingerprint

2553

1842

buf = ctypes.create_string_buffer(20)

2554

1843

buf_len = ctypes.c_size_t()

2555

1844

# Get the fingerprint from the certificate into the buffer

2556

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

2557

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2558

1848

# Deinit the certificate

2559

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2560

1850

# Convert the buffer to a Python bytestring

2561

1851

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

2562

1852

# Convert the bytestring to hexadecimal notation

2564

1854

return hex_fpr

2565

1855

2566

1856

2567

class MultiprocessingMixIn:

1857

class MultiprocessingMixIn(object):

2568

1858

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

2569

2570

1859

def sub_process_main(self, request, address):

2571

1860

try:

2572

1861

self.finish_request(request, address)

2573

1862

except Exception:

2574

1863

self.handle_error(request, address)

2575

1864

self.close_request(request)

2576

1865

2577

1866

def process_request(self, request, address):

2578

1867

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

2579

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

2580

args=(request, address))

1868

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

1869

args = (request, address))

2581

1870

proc.start()

2582

1871

return proc

2583

1872

2584

1873

2585

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2586

1875

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

2587

2588

1876

def process_request(self, request, client_address):

2589

1877

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

2590

1878

2591

1879

This function creates a new pipe in self.pipe

2592

1880

"""

2593

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2594

1882

2595

1883

proc = MultiprocessingMixIn.process_request(self, request,

2596

1884

client_address)

2597

1885

self.child_pipe.close()

2598

1886

self.add_pipe(parent_pipe, proc)

2599

1887

2600

1888

def add_pipe(self, parent_pipe, proc):

2601

1889

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

2602

raise NotImplementedError()

1890

raise NotImplementedError

2603

1891

2604

1892

2605

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2606

socketserver.TCPServer):

2607

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

2608

1894

socketserver.TCPServer, object):

1895

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

1896

2609

1897

Attributes:

2610

1898

enabled: Boolean; whether this server is activated yet

2611

1899

interface: None or a network interface name (string)

2612

1900

use_ipv6: Boolean; to use IPv6 or not

2613

1901

"""

2614

2615

1902

def __init__(self, server_address, RequestHandlerClass,

2616

interface=None,

2617

use_ipv6=True,

2618

socketfd=None):

2619

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

2620

creating a new one with socket.socket().

2621

"""

1903

interface=None, use_ipv6=True):

2622

1904

self.interface = interface

2623

1905

if use_ipv6:

2624

1906

self.address_family = socket.AF_INET6

2625

if socketfd is not None:

2626

# Save the file descriptor

2627

self.socketfd = socketfd

2628

# Save the original socket.socket() function

2629

self.socket_socket = socket.socket

2630

2631

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

2632

#

2633

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

2634

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

2635

# patching socket.socket.)

2636

#

2637

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

2638

@functools.wraps(socket.socket)

2639

def socket_wrapper(*args, **kwargs):

2640

# Restore original function so subsequent calls are

2641

# not affected.

2642

socket.socket = self.socket_socket

2643

del self.socket_socket

2644

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

2645

# saved file descriptor.

2646

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

2647

# Replace socket.socket() function with wrapper

2648

socket.socket = socket_wrapper

2649

# The socketserver.TCPServer.__init__ will call

2650

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

2651

# socket_wrapper(), if socketfd was set.

2652

1907

socketserver.TCPServer.__init__(self, server_address,

2653

1908

RequestHandlerClass)

2654

2655

1909

def server_bind(self):

2656

1910

"""This overrides the normal server_bind() function

2657

1911

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

2658

1912

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

2659

global SO_BINDTODEVICE

2660

1913

if self.interface is not None:

2661

1914

if SO_BINDTODEVICE is None:

2662

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

2663

# common enough.

2664

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

2665

SO_BINDTODEVICE = 25

2666

try:

2667

self.socket.setsockopt(

2668

socket.SOL_SOCKET, SO_BINDTODEVICE,

2669

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

2670

except socket.error as error:

2671

if error.errno == errno.EPERM:

2672

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

2673

self.interface)

2674

elif error.errno == errno.ENOPROTOOPT:

2675

log.error("SO_BINDTODEVICE not available; cannot"

2676

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

2677

elif error.errno == errno.ENODEV:

2678

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

2679

" bind", self.interface)

2680

else:

2681

raise

1915

logger.error("SO_BINDTODEVICE does not exist;"

1916

" cannot bind to interface %s",

1917

self.interface)

1918

else:

1919

try:

1920

self.socket.setsockopt(socket.SOL_SOCKET,

1921

SO_BINDTODEVICE,

1922

str(self.interface

1923

+ '\0'))

1924

except socket.error as error:

1925

if error[0] == errno.EPERM:

1926

logger.error("No permission to"

1927

" bind to interface %s",

1928

self.interface)

1929

elif error[0] == errno.ENOPROTOOPT:

1930

logger.error("SO_BINDTODEVICE not available;"

1931

" cannot bind to interface %s",

1932

self.interface)

1933

else:

1934

raise

2682

1935

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

2683

1936

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

2684

if self.server_address[1]:

2685

self.allow_reuse_address = True

2686

1937

if not self.server_address[0]:

2687

1938

if self.address_family == socket.AF_INET6:

2688

any_address = "::" # in6addr_any

1939

any_address = "::" # in6addr_any

2689

1940

else:

2690

any_address = "0.0.0.0" # INADDR_ANY

1941

any_address = socket.INADDR_ANY

2691

1942

self.server_address = (any_address,

2692

1943

self.server_address[1])

2693

1944

elif not self.server_address[1]:

2694

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

1945

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

1946

0)

2695

1947

# if self.interface:

2696

1948

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

2697

1949

# 0, # port

2703

1955

2704

1956

class MandosServer(IPv6_TCPServer):

2705

1957

"""Mandos server.

2706

1958

2707

1959

Attributes:

2708

1960

clients: set of Client objects

2709

1961

gnutls_priority GnuTLS priority string

2710

1962

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

2711

2712

Assumes a GLib.MainLoop event loop.

1963

1964

Assumes a gobject.MainLoop event loop.

2713

1965

"""

2714

2715

1966

def __init__(self, server_address, RequestHandlerClass,

2716

interface=None,

2717

use_ipv6=True,

2718

clients=None,

2719

gnutls_priority=None,

2720

use_dbus=True,

2721

socketfd=None):

1967

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

1968

gnutls_priority=None, use_dbus=True):

2722

1969

self.enabled = False

2723

1970

self.clients = clients

2724

1971

if self.clients is None:

2727

1974

self.gnutls_priority = gnutls_priority

2728

1975

IPv6_TCPServer.__init__(self, server_address,

2729

1976

RequestHandlerClass,

2730

interface=interface,

2731

use_ipv6=use_ipv6,

2732

socketfd=socketfd)

2733

1977

interface = interface,

1978

use_ipv6 = use_ipv6)

2734

1979

def server_activate(self):

2735

1980

if self.enabled:

2736

1981

return socketserver.TCPServer.server_activate(self)

2737

1982

2738

1983

def enable(self):

2739

1984

self.enabled = True

2740

1985

2741

1986

def add_pipe(self, parent_pipe, proc):

2742

1987

# Call "handle_ipc" for both data and EOF events

2743

GLib.io_add_watch(

2744

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

2745

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

2746

functools.partial(self.handle_ipc,

2747

parent_pipe=parent_pipe,

2748

proc=proc))

2749

2750

def handle_ipc(self, source, condition,

2751

parent_pipe=None,

2752

proc=None,

2753

client_object=None):

1988

gobject.io_add_watch(parent_pipe.fileno(),

1989

gobject.IO_IN | gobject.IO_HUP,

1990

functools.partial(self.handle_ipc,

1991

parent_pipe =

1992

parent_pipe,

1993

proc = proc))

1994

1995

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

1996

proc = None, client_object=None):

2754

1997

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

2755

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

1998

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

2756

1999

# Wait for other process to exit

2757

2000

proc.join()

2758

2001

return False

2759

2002

2760

2003

# Read a request from the child

2761

2004

request = parent_pipe.recv()

2762

2005

command = request[0]

2763

2764

if command == "init":

2765

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

2766

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

2767

address = request[3]

2768

2769

for c in self.clients.values():

2770

if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"

2771

"27AE41E4649B934CA495991B7852B855"):

2772

continue

2773

if key_id and c.key_id == key_id:

2774

client = c

2775

break

2776

if fpr and c.fingerprint == fpr:

2006

2007

if command == 'init':

2008

fpr = request[1]

2009

address = request[2]

2010

2011

for c in self.clients.itervalues():

2012

if c.fingerprint == fpr:

2777

2013

client = c

2778

2014

break

2779

2015

else:

2780

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

2781

" %s", key_id or fpr, address)

2016

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

2017

"dress: %s", fpr, address)

2782

2018

if self.use_dbus:

2783

2019

# Emit D-Bus signal

2784

mandos_dbus_service.ClientNotFound(key_id or fpr,

2020

mandos_dbus_service.ClientNotFound(fpr,

2785

2021

address[0])

2786

2022

parent_pipe.send(False)

2787

2023

return False

2788

2789

GLib.io_add_watch(

2790

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

2791

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

2792

functools.partial(self.handle_ipc,

2793

parent_pipe=parent_pipe,

2794

proc=proc,

2795

client_object=client))

2024

2025

gobject.io_add_watch(parent_pipe.fileno(),

2026

gobject.IO_IN | gobject.IO_HUP,

2027

functools.partial(self.handle_ipc,

2028

parent_pipe =

2029

parent_pipe,

2030

proc = proc,

2031

client_object =

2032

client))

2796

2033

parent_pipe.send(True)

2797

2034

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

2798

2035

# same fileno

2799

2036

return False

2800

if command == "funcall":

2037

if command == 'funcall':

2801

2038

funcname = request[1]

2802

2039

args = request[2]

2803

2040

kwargs = request[3]

2804

2805

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

2041

2042

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

2806

2043

funcname)(*args,

2807

**kwargs)))

2808

2809

if command == "getattr":

2044

**kwargs)))

2045

2046

if command == 'getattr':

2810

2047

attrname = request[1]

2811

if isinstance(client_object.__getattribute__(attrname),

2812

collections.abc.Callable):

2813

parent_pipe.send(("function", ))

2048

if callable(client_object.__getattribute__(attrname)):

2049

parent_pipe.send(('function',))

2814

2050

else:

2815

parent_pipe.send((

2816

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

2817

2818

if command == "setattr":

2051

parent_pipe.send(('data', client_object

2052

.__getattribute__(attrname)))

2053

2054

if command == 'setattr':

2819

2055

attrname = request[1]

2820

2056

value = request[2]

2821

2057

setattr(client_object, attrname, value)

2822

2058

2823

2059

return True

2824

2060

2825

2061

2826

def rfc3339_duration_to_delta(duration):

2827

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

2828

2829

>>> timedelta = datetime.timedelta

2830

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

2831

True

2832

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

2833

True

2834

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

2835

True

2836

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

2837

True

2838

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

2839

True

2840

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

2841

True

2842

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

2843

True

2844

>>> del timedelta

2845

"""

2846

2847

# Parsing an RFC 3339 duration with regular expressions is not

2848

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

2849

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

2850

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

2851

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

2852

# avoid excessive use of external libraries.

2853

2854

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

2855

Token = collections.namedtuple("Token", (

2856

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

2857

# a "group" containing digits

2858

"value", # datetime.timedelta or None

2859

"followers")) # Tokens valid after this token

2860

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

2861

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

2862

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

2863

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

2864

datetime.timedelta(seconds=1),

2865

frozenset((token_end, )))

2866

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

2867

datetime.timedelta(minutes=1),

2868

frozenset((token_second, token_end)))

2869

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

2870

datetime.timedelta(hours=1),

2871

frozenset((token_minute, token_end)))

2872

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

2873

None,

2874

frozenset((token_hour, token_minute,

2875

token_second)))

2876

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

2877

datetime.timedelta(days=1),

2878

frozenset((token_time, token_end)))

2879

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

2880

datetime.timedelta(weeks=4),

2881

frozenset((token_day, token_end)))

2882

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

2883

datetime.timedelta(weeks=52),

2884

frozenset((token_month, token_end)))

2885

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

2886

datetime.timedelta(weeks=1),

2887

frozenset((token_end, )))

2888

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

2889

frozenset((token_year, token_month,

2890

token_day, token_time,

2891

token_week)))

2892

# Define starting values:

2893

# Value so far

2894

value = datetime.timedelta()

2895

found_token = None

2896

# Following valid tokens

2897

followers = frozenset((token_duration, ))

2898

# String left to parse

2899

s = duration

2900

# Loop until end token is found

2901

while found_token is not token_end:

2902

# Search for any currently valid tokens

2903

for token in followers:

2904

match = token.regexp.match(s)

2905

if match is not None:

2906

# Token found

2907

if token.value is not None:

2908

# Value found, parse digits

2909

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

2910

# Add to value so far

2911

value += factor * token.value

2912

# Strip token from string

2913

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

2914

# Go to found token

2915

found_token = token

2916

# Set valid next tokens

2917

followers = found_token.followers

2918

break

2919

else:

2920

# No currently valid tokens were found

2921

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

2922

.format(duration))

2923

# End token found

2924

return value

2925

2926

2927

2062

def string_to_delta(interval):

2928

2063

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

2929

2930

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

2931

True

2932

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

2933

True

2934

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

2935

True

2936

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

2937

True

2938

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

2939

True

2940

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

2941

True

2064

2065

>>> string_to_delta('7d')

2066

datetime.timedelta(7)

2067

>>> string_to_delta('60s')

2068

datetime.timedelta(0, 60)

2069

>>> string_to_delta('60m')

2070

datetime.timedelta(0, 3600)

2071

>>> string_to_delta('24h')

2072

datetime.timedelta(1)

2073

>>> string_to_delta('1w')

2074

datetime.timedelta(7)

2075

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

2076

datetime.timedelta(0, 330)

2942

2077

"""

2943

2944

try:

2945

return rfc3339_duration_to_delta(interval)

2946

except ValueError:

2947

pass

2948

2949

2078

timevalue = datetime.timedelta(0)

2950

2079

for s in interval.split():

2951

2080

try:

2952

suffix = s[-1]

2081

suffix = unicode(s[-1])

2953

2082

value = int(s[:-1])

2954

2083

if suffix == "d":

2955

2084

delta = datetime.timedelta(value)

2962

2091

elif suffix == "w":

2963

2092

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

2964

2093

else:

2965

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

2966

except IndexError as e:

2094

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

2095

.format(suffix))

2096

except (ValueError, IndexError) as e:

2967

2097

raise ValueError(*(e.args))

2968

2098

timevalue += delta

2969

2099

return timevalue

2970

2100

2971

2101

2972

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

2102

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

2973

2103

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

2974

2104

2975

2105

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

2976

2106

if os.fork():

2977

2107

sys.exit()

2985

2115

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

2986

2116

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

2987

2117

raise OSError(errno.ENODEV,

2988

"{} not a character device"

2118

"{0} not a character device"

2989

2119

.format(os.devnull))

2990

2120

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

2991

2121

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

2995

2125

2996

2126

2997

2127

def main():

2998

2128

2999

2129

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

3000

2130

# Parsing of options, both command line and config file

3001

2131

3002

2132

parser = argparse.ArgumentParser()

3003

2133

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

3004

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

2134

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

3005

2135

help="show version number and exit")

3006

2136

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

3007

2137

help="Bind to interface IF")

3013

2143

help="Run self-test")

3014

2144

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

3015

2145

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

3016

" to terminal", default=None)

2146

" to terminal")

3017

2147

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

3018

2148

help="Debug level for stdout output")

3019

2149

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

3026

2156

" files")

3027

2157

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

3028

2158

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

3029

" system bus interface", default=None)

2159

" system bus interface")

3030

2160

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

3031

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

3032

default=None)

2161

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

3033

2162

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

3034

2163

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

3035

" state", default=None)

3036

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

3037

help="Specify a file descriptor to a network"

3038

" socket to use instead of creating one")

2164

" state")

3039

2165

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

3040

2166

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

3041

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

3042

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

3043

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

3044

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

3045

default=None)

3046

2167

3047

2168

options = parser.parse_args()

3048

2169

2170

if options.check:

2171

import doctest

2172

doctest.testmod()

2173

sys.exit()

2174

3049

2175

# Default values for config file for server-global settings

3050

if gnutls.has_rawpk:

3051

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

3052

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

3053

else:

3054

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

3055

":+SIGN-DSA-SHA256")

3056

server_defaults = {"interface": "",

3057

"address": "",

3058

"port": "",

3059

"debug": "False",

3060

"priority": priority,

3061

"servicename": "Mandos",

3062

"use_dbus": "True",

3063

"use_ipv6": "True",

3064

"debuglevel": "",

3065

"restore": "True",

3066

"socket": "",

3067

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

3068

"foreground": "False",

3069

"zeroconf": "True",

3070

}

3071

del priority

3072

2176

server_defaults = { "interface": "",

2177

"address": "",

2178

"port": "",

2179

"debug": "False",

2180

"priority":

2181

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

2182

"servicename": "Mandos",

2183

"use_dbus": "True",

2184

"use_ipv6": "True",

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

2188

}

2189

3073

2190

# Parse config file for server-global settings

3074

server_config = configparser.ConfigParser(server_defaults)

2191

server_config = configparser.SafeConfigParser(server_defaults)

3075

2192

del server_defaults

3076

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

3077

# Convert the ConfigParser object to a dict

2193

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

2194

"mandos.conf"))

2195

# Convert the SafeConfigParser object to a dict

3078

2196

server_settings = server_config.defaults()

3079

2197

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

3080

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

3081

"foreground", "zeroconf"):

2198

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

3082

2199

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

3083

2200

option)

3084

2201

if server_settings["port"]:

3085

2202

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

3086

2203

"port")

3087

if server_settings["socket"]:

3088

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

3089

"socket")

3090

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

3091

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

3092

# happen with a supplied network socket.

3093

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

3094

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

3095

["socket"])

3096

2204

del server_config

3097

2205

3098

2206

# Override the settings from the config file with command line

3099

2207

# options, if set.

3100

2208

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

3101

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

3102

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

3103

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

2209

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

2210

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

2211

"statedir"):

3104

2212

value = getattr(options, option)

3105

2213

if value is not None:

3106

2214

server_settings[option] = value

3107

2215

del options

3108

2216

# Force all strings to be unicode

3109

2217

for option in server_settings.keys():

3110

if isinstance(server_settings[option], bytes):

3111

server_settings[option] = (server_settings[option]

3112

.decode("utf-8"))

3113

# Force all boolean options to be boolean

3114

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

3115

"foreground", "zeroconf"):

3116

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

3117

# Debug implies foreground

3118

if server_settings["debug"]:

3119

server_settings["foreground"] = True

2218

if type(server_settings[option]) is str:

2219

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

3120

2220

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

3121

2221

3122

2222

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

3123

3124

if (not server_settings["zeroconf"]

3125

and not (server_settings["port"]

3126

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

3127

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

3128

2223

3129

2224

# For convenience

3130

2225

debug = server_settings["debug"]

3131

2226

debuglevel = server_settings["debuglevel"]

3133

2228

use_ipv6 = server_settings["use_ipv6"]

3134

2229

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

3135

2230

stored_state_file)

3136

foreground = server_settings["foreground"]

3137

zeroconf = server_settings["zeroconf"]

3138

2231

3139

2232

if debug:

3140

2233

initlogger(debug, logging.DEBUG)

3141

2234

else:

3144

2237

else:

3145

2238

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

3146

2239

initlogger(debug, level)

3147

2240

3148

2241

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

3149

syslogger.setFormatter(

3150

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

3151

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

3152

server_settings["servicename"])))

3153

2242

syslogger.setFormatter(logging.Formatter

2243

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

2244

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

2245

.format(server_settings

2246

["servicename"])))

2247

3154

2248

# Parse config file with clients

3155

client_config = configparser.ConfigParser(Client.client_defaults)

2249

client_config = configparser.SafeConfigParser(Client

2250

.client_defaults)

3156

2251

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

3157

2252

"clients.conf"))

3158

2253

3159

2254

global mandos_dbus_service

3160

2255

mandos_dbus_service = None

3161

3162

socketfd = None

3163

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

3164

socketfd = server_settings["socket"]

3165

tcp_server = MandosServer(

3166

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

3167

ClientHandler,

3168

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

3169

use_ipv6=use_ipv6,

3170

gnutls_priority=server_settings["priority"],

3171

use_dbus=use_dbus,

3172

socketfd=socketfd)

3173

if not foreground:

3174

pidfilename = "/run/mandos.pid"

3175

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

3176

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

3177

pidfile = None

2256

2257

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

2258

server_settings["port"]),

2259

ClientHandler,

2260

interface=(server_settings["interface"]

2261

or None),

2262

use_ipv6=use_ipv6,

2263

gnutls_priority=

2264

server_settings["priority"],

2265

use_dbus=use_dbus)

2266

if not debug:

2267

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

3178

2268

try:

3179

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

2269

pidfile = open(pidfilename, "w")

3180

2270

except IOError as e:

3181

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

3182

exc_info=e)

3183

3184

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

3185

("mandos", "mandos"),

3186

("nobody", "nogroup")):

2271

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

2272

exc_info=e)

2273

2274

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

3187

2275

try:

3188

2276

uid = pwd.getpwnam(name).pw_uid

3189

gid = pwd.getpwnam(group).pw_gid

2277

gid = pwd.getpwnam(name).pw_gid

3190

2278

break

3191

2279

except KeyError:

3192

2280

continue

3196

2284

try:

3197

2285

os.setgid(gid)

3198

2286

os.setuid(uid)

3199

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

3200

2287

except OSError as error:

3201

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

3202

os.strerror(error.errno))

3203

if error.errno != errno.EPERM:

3204

raise

3205

2288

if error[0] != errno.EPERM:

2289

raise error

2290

3206

2291

if debug:

3207

2292

# Enable all possible GnuTLS debugging

3208

2293

3209

2294

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

3210

2295

# - GnuTLS manual

3211

gnutls.global_set_log_level(11)

3212

3213

@gnutls.log_func

2296

gnutls.library.functions.gnutls_global_set_log_level(11)

2297

2298

@gnutls.library.types.gnutls_log_func

3214

2299

def debug_gnutls(level, string):

3215

log.debug("GnuTLS: %s",

3216

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

3217

3218

gnutls.global_set_log_function(debug_gnutls)

3219

2300

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

2301

2302

(gnutls.library.functions

2303

.gnutls_global_set_log_function(debug_gnutls))

2304

3220

2305

# Redirect stdin so all checkers get /dev/null

3221

2306

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

3222

2307

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

3223

2308

if null > 2:

3224

2309

os.close(null)

3225

2310

3226

2311

# Need to fork before connecting to D-Bus

3227

if not foreground:

2312

if not debug:

3228

2313

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

3229

2314

daemon()

3230

3231

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

3232

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

3233

# need to inform GLib that threads will be used.

3234

GLib.threads_init()

3235

2315

2316

gobject.threads_init()

2317

3236

2318

global main_loop

3237

2319

# From the Avahi example code

3238

2320

DBusGMainLoop(set_as_default=True)

3239

main_loop = GLib.MainLoop()

2321

main_loop = gobject.MainLoop()

3240

2322

bus = dbus.SystemBus()

3241

2323

# End of Avahi example code

3242

2324

if use_dbus:

3243

2325

try:

3244

2326

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

3245

bus,

3246

do_not_queue=True)

3247

old_bus_name = dbus.service.BusName(

3248

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

3249

do_not_queue=True)

3250

except dbus.exceptions.DBusException as e:

3251

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

2327

bus, do_not_queue=True)

2328

old_bus_name = (dbus.service.BusName

2329

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

2330

do_not_queue=True))

2331

except dbus.exceptions.NameExistsException as e:

2332

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

3252

2333

use_dbus = False

3253

2334

server_settings["use_dbus"] = False

3254

2335

tcp_server.use_dbus = False

3255

if zeroconf:

3256

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3257

service = AvahiServiceToSyslog(

3258

name=server_settings["servicename"],

3259

servicetype="_mandos._tcp",

3260

protocol=protocol,

3261

bus=bus)

3262

if server_settings["interface"]:

3263

service.interface = if_nametoindex(

3264

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

3265

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2341

if server_settings["interface"]:

2342

service.interface = (if_nametoindex

2343

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

2344

3266

2345

global multiprocessing_manager

3267

2346

multiprocessing_manager = multiprocessing.Manager()

3268

2347

3269

2348

client_class = Client

3270

2349

if use_dbus:

3271

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

3272

2350

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

2351

3273

2352

client_settings = Client.config_parser(client_config)

3274

2353

old_client_settings = {}

3275

2354

clients_data = {}

3276

3277

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

3278

global wnull

3279

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

3280

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

3281

# mode

3282

if debug or not foreground:

3283

wnull.close()

3284

2355

3285

2356

# Get client data and settings from last running state.

3286

2357

if server_settings["restore"]:

3287

2358

try:

3288

2359

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

3289

if sys.version_info.major == 2:

3290

clients_data, old_client_settings = pickle.load(

3291

stored_state)

3292

else:

3293

bytes_clients_data, bytes_old_client_settings = (

3294

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

3295

# Fix bytes to strings

3296

# clients_data

3297

# .keys()

3298

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

3299

if isinstance(key, bytes)

3300

else key): value

3301

for key, value in

3302

bytes_clients_data.items()}

3303

del bytes_clients_data

3304

for key in clients_data:

3305

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

3306

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

3307

for k, v in

3308

clients_data[key].items()}

3309

clients_data[key] = value

3310

# .client_structure

3311

value["client_structure"] = [

3312

(s.decode("utf-8")

3313

if isinstance(s, bytes)

3314

else s) for s in

3315

value["client_structure"]]

3316

# .name, .host, and .checker_command

3317

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

3318

if isinstance(value[k], bytes):

3319

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

3320

if "key_id" not in value:

3321

value["key_id"] = ""

3322

elif "fingerprint" not in value:

3323

value["fingerprint"] = ""

3324

# old_client_settings

3325

# .keys()

3326

old_client_settings = {

3327

(key.decode("utf-8")

3328

if isinstance(key, bytes)

3329

else key): value

3330

for key, value in

3331

bytes_old_client_settings.items()}

3332

del bytes_old_client_settings

3333

# .host and .checker_command

3334

for value in old_client_settings.values():

3335

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

3336

if isinstance(value[attribute], bytes):

3337

value[attribute] = (value[attribute]

3338

.decode("utf-8"))

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

3339

2362

os.remove(stored_state_path)

3340

2363

except IOError as e:

3341

2364

if e.errno == errno.ENOENT:

3342

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

3343

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

2365

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

2366

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

3344

2367

else:

3345

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

3346

exc_info=e)

2368

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

2369

exc_info=e)

3347

2370

raise

3348

2371

except EOFError as e:

3349

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

3350

exc_info=e)

3351

2372

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

2373

"EOFError:", exc_info=e)

2374

3352

2375

with PGPEngine() as pgp:

3353

for client_name, client in clients_data.items():

3354

# Skip removed clients

3355

if client_name not in client_settings:

3356

continue

3357

2376

for client_name, client in clients_data.iteritems():

3358

2377

# Decide which value to use after restoring saved state.

3359

2378

# We have three different values: Old config file,

3360

2379

# new config file, and saved state.

3365

2384

# For each value in new config, check if it

3366

2385

# differs from the old config value (Except for

3367

2386

# the "secret" attribute)

3368

if (name != "secret"

3369

and (value !=

3370

old_client_settings[client_name][name])):

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

3371

2390

client[name] = value

3372

2391

except KeyError:

3373

2392

pass

3374

2393

3375

2394

# Clients who has passed its expire date can still be

3376

# enabled if its last checker was successful. A Client

2395

# enabled if its last checker was successful. Clients

3377

2396

# whose checker succeeded before we stored its state is

3378

2397

# assumed to have successfully run all checkers during

3379

2398

# downtime.

3380

2399

if client["enabled"]:

3381

2400

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

3382

2401

if not client["last_checked_ok"]:

3383

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

3384

" never performed a successful"

3385

" checker", client_name)

2402

logger.warning(

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

3386

2406

client["enabled"] = False

3387

2407

elif client["last_checker_status"] != 0:

3388

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

3389

" last checker failed with error"

3390

" code %s", client_name,

3391

client["last_checker_status"])

2408

logger.warning(

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

3392

2413

client["enabled"] = False

3393

2414

else:

3394

client["expires"] = (

3395

datetime.datetime.utcnow()

3396

+ client["timeout"])

3397

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

3398

" enabled", client_name)

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

2418

logger.debug("Last checker succeeded,"

2419

" keeping {0} enabled"

2420

.format(client_name))

3399

2421

try:

3400

client["secret"] = pgp.decrypt(

3401

client["encrypted_secret"],

3402

client_settings[client_name]["secret"])

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

3403

2426

except PGPError:

3404

2427

# If decryption fails, we use secret from new settings

3405

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

3406

client_name)

3407

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

3408

["secret"])

3409

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

3410

2433

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

3411

2434

for client_name in (set(old_client_settings)

3412

2435

- set(client_settings)):

3414

2437

for client_name in (set(client_settings)

3415

2438

- set(old_client_settings)):

3416

2439

clients_data[client_name] = client_settings[client_name]

3417

2440

3418

2441

# Create all client objects

3419

for client_name, client in clients_data.items():

2442

for client_name, client in clients_data.iteritems():

3420

2443

tcp_server.clients[client_name] = client_class(

3421

name=client_name,

3422

settings=client,

3423

server_settings=server_settings)

3424

2444

name = client_name, settings = client)

2445

3425

2446

if not tcp_server.clients:

3426

log.warning("No clients defined")

3427

3428

if not foreground:

3429

if pidfile is not None:

3430

pid = os.getpid()

3431

try:

3432

with pidfile:

3433

print(pid, file=pidfile)

3434

except IOError:

3435

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

3436

pidfilename, pid)

3437

del pidfile

2447

logger.warning("No clients defined")

2448

2449

if not debug:

2450

try:

2451

with pidfile:

2452

pid = os.getpid()

2453

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

2454

del pidfile

2455

except IOError:

2456

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

2457

pidfilename, pid)

2458

except NameError:

2459

# "pidfile" was never created

2460

pass

3438

2461

del pidfilename

3439

3440

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

3441

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3442

lambda: main_loop.quit() and False)

3443

2462

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

2463

2464

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

2465

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

2466

3444

2467

if use_dbus:

3445

3446

@alternate_dbus_interfaces(

3447

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

3448

class MandosDBusService(DBusObjectWithObjectManager):

2468

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

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

3449

2471

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

3450

3451

2472

def __init__(self):

3452

2473

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

3453

3454

2474

_interface = "se.recompile.Mandos"

3455

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

3456

2482

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

3457

2483

def ClientAdded(self, objpath):

3458

2484

"D-Bus signal"

3459

2485

pass

3460

2486

3461

2487

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

3462

def ClientNotFound(self, key_id, address):

2488

def ClientNotFound(self, fingerprint, address):

3463

2489

"D-Bus signal"

3464

2490

pass

3465

3466

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

3467

"true"})

2491

3468

2492

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

3469

2493

def ClientRemoved(self, objpath, name):

3470

2494

"D-Bus signal"

3471

2495

pass

3472

3473

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

3474

"true"})

2496

3475

2497

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

3476

2498

def GetAllClients(self):

3477

2499

"D-Bus method"

3478

return dbus.Array(c.dbus_object_path for c in

3479

tcp_server.clients.values())

3480

3481

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

3482

"true"})

2500

return dbus.Array(c.dbus_object_path

2501

for c in

2502

tcp_server.clients.itervalues())

2503

3483

2504

@dbus.service.method(_interface,

3484

2505

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

3485

2506

def GetAllClientsWithProperties(self):

3486

2507

"D-Bus method"

3487

2508

return dbus.Dictionary(

3488

{c.dbus_object_path: c.GetAll(

3489

"se.recompile.Mandos.Client")

3490

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

2509

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

2510

for c in tcp_server.clients.itervalues()),

3491

2511

signature="oa{sv}")

3492

2512

3493

2513

@dbus.service.method(_interface, in_signature="o")

3494

2514

def RemoveClient(self, object_path):

3495

2515

"D-Bus method"

3496

for c in tcp_server.clients.values():

2516

for c in tcp_server.clients.itervalues():

3497

2517

if c.dbus_object_path == object_path:

3498

2518

del tcp_server.clients[c.name]

3499

2519

c.remove_from_connection()

3500

# Don't signal the disabling

2520

# Don't signal anything except ClientRemoved

3501

2521

c.disable(quiet=True)

3502

# Emit D-Bus signal for removal

3503

self.client_removed_signal(c)

2522

# Emit D-Bus signal

2523

self.ClientRemoved(object_path, c.name)

3504

2524

return

3505

2525

raise KeyError(object_path)

3506

2526

3507

2527

del _interface

3508

3509

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3510

out_signature="a{oa{sa{sv}}}")

3511

def GetManagedObjects(self):

3512

"""D-Bus method"""

3513

return dbus.Dictionary(

3514

{client.dbus_object_path:

3515

dbus.Dictionary(

3516

{interface: client.GetAll(interface)

3517

for interface in

3518

client._get_all_interface_names()})

3519

for client in tcp_server.clients.values()})

3520

3521

def client_added_signal(self, client):

3522

"""Send the new standard signal and the old signal"""

3523

if use_dbus:

3524

# New standard signal

3525

self.InterfacesAdded(

3526

client.dbus_object_path,

3527

dbus.Dictionary(

3528

{interface: client.GetAll(interface)

3529

for interface in

3530

client._get_all_interface_names()}))

3531

# Old signal

3532

self.ClientAdded(client.dbus_object_path)

3533

3534

def client_removed_signal(self, client):

3535

"""Send the new standard signal and the old signal"""

3536

if use_dbus:

3537

# New standard signal

3538

self.InterfacesRemoved(

3539

client.dbus_object_path,

3540

client._get_all_interface_names())

3541

# Old signal

3542

self.ClientRemoved(client.dbus_object_path,

3543

client.name)

3544

2528

3545

2529

mandos_dbus_service = MandosDBusService()

3546

3547

# Save modules to variables to exempt the modules from being

3548

# unloaded before the function registered with atexit() is run.

3549

mp = multiprocessing

3550

wn = wnull

3551

2530

3552

2531

def cleanup():

3553

2532

"Cleanup function; run on exit"

3554

if zeroconf:

3555

service.cleanup()

3556

3557

mp.active_children()

3558

wn.close()

2533

service.cleanup()

2534

2535

multiprocessing.active_children()

3559

2536

if not (tcp_server.clients or client_settings):

3560

2537

return

3561

2538

3562

2539

# Store client before exiting. Secrets are encrypted with key

3563

2540

# based on what config file has. If config file is

3564

2541

# removed/edited, old secret will thus be unrecovable.

3565

2542

clients = {}

3566

2543

with PGPEngine() as pgp:

3567

for client in tcp_server.clients.values():

2544

for client in tcp_server.clients.itervalues():

3568

2545

key = client_settings[client.name]["secret"]

3569

2546

client.encrypted_secret = pgp.encrypt(client.secret,

3570

2547

key)

3571

2548

client_dict = {}

3572

2549

3573

2550

# A list of attributes that can not be pickled

3574

2551

# + secret.

3575

exclude = {"bus", "changedstate", "secret",

3576

"checker", "server_settings"}

3577

for name, typ in inspect.getmembers(dbus.service

3578

.Object):

2552

exclude = set(("bus", "changedstate", "secret",

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

3579

2556

exclude.add(name)

3580

2557

3581

2558

client_dict["encrypted_secret"] = (client

3582

2559

.encrypted_secret)

3583

2560

for attr in client.client_structure:

3584

2561

if attr not in exclude:

3585

2562

client_dict[attr] = getattr(client, attr)

3586

2563

3587

2564

clients[client.name] = client_dict

3588

2565

del client_settings[client.name]["secret"]

3589

2566

3590

2567

try:

3591

with tempfile.NamedTemporaryFile(

3592

mode="wb",

3593

suffix=".pickle",

3594

prefix="clients-",

3595

dir=os.path.dirname(stored_state_path),

3596

delete=False) as stored_state:

3597

pickle.dump((clients, client_settings), stored_state,

3598

protocol=2)

3599

tempname = stored_state.name

2568

with (tempfile.NamedTemporaryFile

2569

(mode='wb', suffix=".pickle", prefix='clients-',

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

pickle.dump((clients, client_settings), stored_state)

2573

tempname=stored_state.name

3600

2574

os.rename(tempname, stored_state_path)

3601

2575

except (IOError, OSError) as e:

3602

2576

if not debug:

3605

2579

except NameError:

3606

2580

pass

3607

2581

if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):

3608

log.warning("Could not save persistent state: %s",

3609

os.strerror(e.errno))

2582

logger.warning("Could not save persistent state: {0}"

2583

.format(os.strerror(e.errno)))

3610

2584

else:

3611

log.warning("Could not save persistent state:",

3612

exc_info=e)

3613

raise

3614

2585

logger.warning("Could not save persistent state:",

2586

exc_info=e)

2587

raise e

2588

3615

2589

# Delete all clients, and settings from config

3616

2590

while tcp_server.clients:

3617

2591

name, client = tcp_server.clients.popitem()

3618

2592

if use_dbus:

3619

2593

client.remove_from_connection()

3620

# Don't signal the disabling

2594

# Don't signal anything except ClientRemoved

3621

2595

client.disable(quiet=True)

3622

# Emit D-Bus signal for removal

3623

2596

if use_dbus:

3624

mandos_dbus_service.client_removed_signal(client)

2597

# Emit D-Bus signal

2598

mandos_dbus_service.ClientRemoved(client

2599

.dbus_object_path,

2600

client.name)

3625

2601

client_settings.clear()

3626

2602

3627

2603

atexit.register(cleanup)

3628

3629

for client in tcp_server.clients.values():

2604

2605

for client in tcp_server.clients.itervalues():

3630

2606

if use_dbus:

3631

# Emit D-Bus signal for adding

3632

mandos_dbus_service.client_added_signal(client)

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3633

2609

# Need to initiate checking of clients

3634

2610

if client.enabled:

3635

client.init_checker(randomize_start=True)

3636

2611

client.init_checker()

2612

3637

2613

tcp_server.enable()

3638

2614

tcp_server.server_activate()

3639

2615

3640

2616

# Find out what port we got

3641

if zeroconf:

3642

service.port = tcp_server.socket.getsockname()[1]

2617

service.port = tcp_server.socket.getsockname()[1]

3643

2618

if use_ipv6:

3644

log.info("Now listening on address %r, port %d, flowinfo %d,"

3645

" scope_id %d", *tcp_server.socket.getsockname())

2619

logger.info("Now listening on address %r, port %d,"

2620

" flowinfo %d, scope_id %d",

2621

*tcp_server.socket.getsockname())

3646

2622

else: # IPv4

3647

log.info("Now listening on address %r, port %d",

3648

*tcp_server.socket.getsockname())

3649

3650

# service.interface = tcp_server.socket.getsockname()[3]

3651

2623

logger.info("Now listening on address %r, port %d",

2624

*tcp_server.socket.getsockname())

2625

2626

#service.interface = tcp_server.socket.getsockname()[3]

2627

3652

2628

try:

3653

if zeroconf:

3654

# From the Avahi example code

3655

try:

3656

service.activate()

3657

except dbus.exceptions.DBusException as error:

3658

log.critical("D-Bus Exception", exc_info=error)

3659

cleanup()

3660

sys.exit(1)

3661

# End of Avahi example code

3662

3663

GLib.io_add_watch(

3664

GLib.IOChannel.unix_new(tcp_server.fileno()),

3665

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3666

lambda *args, **kwargs: (tcp_server.handle_request

3667

(*args[2:], **kwargs) or True))

3668

3669

log.debug("Starting main loop")

2629

# From the Avahi example code

2630

try:

2631

service.activate()

2632

except dbus.exceptions.DBusException as error:

2633

logger.critical("D-Bus Exception", exc_info=error)

2634

cleanup()

2635

sys.exit(1)

2636

# End of Avahi example code

2637

2638

gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,

2639

lambda *args, **kwargs:

2640

(tcp_server.handle_request

2641

(*args[2:], **kwargs) or True))

2642

2643

logger.debug("Starting main loop")

3670

2644

main_loop.run()

3671

2645

except AvahiError as error:

3672

log.critical("Avahi Error", exc_info=error)

2646

logger.critical("Avahi Error", exc_info=error)

3673

2647

cleanup()

3674

2648

sys.exit(1)

3675

2649

except KeyboardInterrupt:

3676

2650

if debug:

3677

2651

print("", file=sys.stderr)

3678

log.debug("Server received KeyboardInterrupt")

3679

log.debug("Server exiting")

2652

logger.debug("Server received KeyboardInterrupt")

2653

logger.debug("Server exiting")

3680

2654

# Must run before the D-Bus bus name gets deregistered

3681

2655

cleanup()

3682

2656

3683

3684

def parse_test_args():

3685

# type: () -> argparse.Namespace

3686

parser = argparse.ArgumentParser(add_help=False)

3687

parser.add_argument("--check", action="store_true")

3688

parser.add_argument("--prefix", )

3689

args, unknown_args = parser.parse_known_args()

3690

if args.check:

3691

# Remove test options from sys.argv

3692

sys.argv[1:] = unknown_args

3693

return args

3694

3695

# Add all tests from doctest strings

3696

def load_tests(loader, tests, none):

3697

import doctest

3698

tests.addTests(doctest.DocTestSuite())

3699

return tests

3700

3701

if __name__ == "__main__":

3702

options = parse_test_args()

3703

try:

3704

if options.check:

3705

extra_test_prefix = options.prefix

3706

if extra_test_prefix is not None:

3707

if not (unittest.main(argv=[""], exit=False)

3708

.result.wasSuccessful()):

3709

sys.exit(1)

3710

class ExtraTestLoader(unittest.TestLoader):

3711

testMethodPrefix = extra_test_prefix

3712

# Call using ./scriptname --test [--verbose]

3713

unittest.main(argv=[""], testLoader=ExtraTestLoader())

3714

else:

3715

unittest.main(argv=[""])

3716

else:

3717

main()

3718

finally:

3719

logging.shutdown()

3720

3721

# Local Variables:

3722

# run-tests:

3723

# (lambda (&optional extra)

3724

# (if (not (funcall run-tests-in-test-buffer default-directory

3725

# extra))

3726

# (funcall show-test-buffer-in-test-window)

3727

# (funcall remove-test-window)

3728

# (if extra (message "Extra tests run successfully!"))))

3729

# run-tests-in-test-buffer:

3730

# (lambda (dir &optional extra)

3731

# (with-current-buffer (get-buffer-create "*Test*")

3732

# (setq buffer-read-only nil

3733

# default-directory dir)

3734

# (erase-buffer)

3735

# (compilation-mode))

3736

# (let ((process-result

3737

# (let ((inhibit-read-only t))

3738

# (process-file-shell-command

3739

# (funcall get-command-line extra) nil "*Test*"))))

3740

# (and (numberp process-result)

3741

# (= process-result 0))))

3742

# get-command-line:

3743

# (lambda (&optional extra)

3744

# (let ((quoted-script

3745

# (shell-quote-argument (funcall get-script-name))))

3746

# (format

3747

# (concat "%s --check" (if extra " --prefix=atest" ""))

3748

# quoted-script)))

3749

# get-script-name:

3750

# (lambda ()

3751

# (if (fboundp 'file-local-name)

3752

# (file-local-name (buffer-file-name))

3753

# (or (file-remote-p (buffer-file-name) 'localname)

3754

# (buffer-file-name))))

3755

# remove-test-window:

3756

# (lambda ()

3757

# (let ((test-window (get-buffer-window "*Test*")))

3758

# (if test-window (delete-window test-window))))

3759

# show-test-buffer-in-test-window:

3760

# (lambda ()

3761

# (when (not (get-buffer-window-list "*Test*"))

3762

# (setq next-error-last-buffer (get-buffer "*Test*"))

3763

# (let* ((side (if (>= (window-width) 146) 'right 'bottom))

3764

# (display-buffer-overriding-action

3765

# `((display-buffer-in-side-window) (side . ,side)

3766

# (window-height . fit-window-to-buffer)

3767

# (window-width . fit-window-to-buffer))))

3768

# (display-buffer "*Test*"))))

3769

# eval:

3770

# (progn

3771

# (let* ((run-extra-tests (lambda () (interactive)

3772

# (funcall run-tests t)))

3773

# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t

3774

# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c

3775

# (setq minor-mode-overriding-map-alist

3776

# (cons `(run-tests . ,outer-keymap)

3777

# minor-mode-overriding-map-alist)))

3778

# (add-hook 'after-save-hook run-tests 90 t))

3779

# End:

2657

if __name__ == '__main__':

2658

main()