/mandos/trunk : revision 237.7.1

1

#!/usr/bin/python

2

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

3

#

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

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

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

55

51

import sys

56

52

import re

57

53

import os

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

71

81

72

import dbus

82

73

import dbus.service

83

from gi.repository import GLib

74

import gobject

75

import avahi

84

76

from dbus.mainloop.glib import DBusGMainLoop

85

77

import ctypes

86

78

import ctypes.util

87

79

import xml.dom.minidom

88

80

import inspect

81

import GnuPGInterface

89

82

90

# Try to find the value of SO_BINDTODEVICE:

91

83

try:

92

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

93

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

94

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

95

85

except AttributeError:

96

86

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

99

87

from IN import SO_BINDTODEVICE

100

88

except ImportError:

101

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

102

# Try running the C preprocessor:

103

try:

104

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

105

"/dev/stdin"],

106

stdin=subprocess.PIPE,

107

stdout=subprocess.PIPE)

108

stdout = cc.communicate(

109

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

110

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

111

except (OSError, ValueError, IndexError):

112

# No value found

113

SO_BINDTODEVICE = None

114

115

if sys.version_info.major == 2:

116

str = unicode

117

118

version = "1.8.4"

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

119

92

stored_state_file = "clients.pickle"

120

93

121

94

logger = logging.getLogger()

122

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

123

98

124

99

try:

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

127

103

except (OSError, AttributeError):

128

129

104

def if_nametoindex(interface):

130

105

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

131

106

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

132

107

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

133

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

134

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

135

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]

136

113

return interface_index

137

114

138

115

139

def copy_function(func):

140

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

141

if sys.version_info.major == 2:

142

return types.FunctionType(func.func_code,

143

func.func_globals,

144

func.func_name,

145

func.func_defaults,

146

func.func_closure)

147

else:

148

return types.FunctionType(func.__code__,

149

func.__globals__,

150

func.__name__,

151

func.__defaults__,

152

func.__closure__)

153

154

155

116

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

156

117

"""init logger and add loglevel"""

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

118

162

119

syslogger.setFormatter(logging.Formatter

163

120

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

164

121

' %(message)s'))

165

122

logger.addHandler(syslogger)

166

123

167

124

if debug:

168

125

console = logging.StreamHandler()

169

126

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

181

138

182

139

class PGPEngine(object):

183

140

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

184

185

141

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

186

143

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

187

self.gpg = "gpg"

188

try:

189

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

190

for line in output.splitlines():

191

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

192

if name == "gpg":

193

self.gpg = path

194

break

195

except OSError as e:

196

if e.errno != errno.ENOENT:

197

raise

198

self.gnupgargs = ['--batch',

199

'--homedir', self.tempdir,

200

'--force-mdc',

201

'--quiet']

202

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

203

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

204

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

205

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

206

151

def __enter__(self):

207

152

return self

208

209

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

153

154

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

210

155

self._cleanup()

211

156

return False

212

157

213

158

def __del__(self):

214

159

self._cleanup()

215

160

216

161

def _cleanup(self):

217

162

if self.tempdir is not None:

218

163

# Delete contents of tempdir

219

164

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

220

topdown=False):

165

topdown = False):

221

166

for filename in files:

222

167

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

223

168

for dirname in dirs:

225

170

# Remove tempdir

226

171

os.rmdir(self.tempdir)

227

172

self.tempdir = None

228

173

229

174

def password_encode(self, password):

230

175

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

231

176

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

232

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

233

if len(encoded) > 2048:

234

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

235

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

236

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

237

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

238

return encoded

239

177

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

178

240

179

def encrypt(self, data, password):

241

passphrase = self.password_encode(password)

242

with tempfile.NamedTemporaryFile(

243

dir=self.tempdir) as passfile:

244

passfile.write(passphrase)

245

passfile.flush()

246

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

247

'--passphrase-file',

248

passfile.name]

249

+ self.gnupgargs,

250

stdin=subprocess.PIPE,

251

stdout=subprocess.PIPE,

252

stderr=subprocess.PIPE)

253

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

254

if proc.returncode != 0:

255

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

256

194

return ciphertext

257

195

258

196

def decrypt(self, data, password):

259

passphrase = self.password_encode(password)

260

with tempfile.NamedTemporaryFile(

261

dir=self.tempdir) as passfile:

262

passfile.write(passphrase)

263

passfile.flush()

264

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

265

'--passphrase-file',

266

passfile.name]

267

+ self.gnupgargs,

268

stdin=subprocess.PIPE,

269

stdout=subprocess.PIPE,

270

stderr=subprocess.PIPE)

271

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

272

if proc.returncode != 0:

273

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

274

211

return decrypted_plaintext

275

212

276

213

277

# Pretend that we have an Avahi module

278

class avahi(object):

279

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

280

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

281

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

282

PROTO_INET = 0 # avahi-common/address.h

283

PROTO_INET6 = 1 # avahi-common/address.h

284

DBUS_NAME = "org.freedesktop.Avahi"

285

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

286

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

287

DBUS_PATH_SERVER = "/"

288

289

@staticmethod

290

def string_array_to_txt_array(t):

291

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

292

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

293

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

294

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

295

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

296

SERVER_INVALID = 0 # avahi-common/defs.h

297

SERVER_REGISTERING = 1 # avahi-common/defs.h

298

SERVER_RUNNING = 2 # avahi-common/defs.h

299

SERVER_COLLISION = 3 # avahi-common/defs.h

300

SERVER_FAILURE = 4 # avahi-common/defs.h

301

302

303

214

class AvahiError(Exception):

304

215

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

305

216

self.value = value

306

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

307

**kwargs)

308

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

309

220

310

221

class AvahiServiceError(AvahiError):

311

222

pass

312

223

313

314

224

class AvahiGroupError(AvahiError):

315

225

pass

316

226

317

227

318

228

class AvahiService(object):

319

229

"""An Avahi (Zeroconf) service.

320

230

321

231

Attributes:

322

232

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

323

233

Used to optionally bind to the specified interface.

324

234

name: string; Example: 'Mandos'

325

235

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

326

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

236

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

327

237

port: integer; what port to announce

328

238

TXT: list of strings; TXT record for the service

329

239

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

335

245

server: D-Bus Server

336

246

bus: dbus.SystemBus()

337

247

"""

338

339

def __init__(self,

340

interface=avahi.IF_UNSPEC,

341

name=None,

342

servicetype=None,

343

port=None,

344

TXT=None,

345

domain="",

346

host="",

347

max_renames=32768,

348

protocol=avahi.PROTO_UNSPEC,

349

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

350

253

self.interface = interface

351

254

self.name = name

352

255

self.type = servicetype

361

264

self.server = None

362

265

self.bus = bus

363

266

self.entry_group_state_changed_match = None

364

365

def rename(self, remove=True):

267

268

def rename(self):

366

269

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

367

270

if self.rename_count >= self.max_renames:

368

271

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

369

272

" after %i retries, exiting.",

370

273

self.rename_count)

371

274

raise AvahiServiceError("Too many renames")

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

375

277

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

376

278

self.name)

377

if remove:

378

self.remove()

279

self.remove()

379

280

try:

380

281

self.add()

381

282

except dbus.exceptions.DBusException as error:

382

if (error.get_dbus_name()

383

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

384

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

385

return self.rename(remove=False)

386

else:

387

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

388

self.cleanup()

389

os._exit(1)

390

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

391

288

def remove(self):

392

289

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

393

290

if self.entry_group_state_changed_match is not None:

395

292

self.entry_group_state_changed_match = None

396

293

if self.group is not None:

397

294

self.group.Reset()

398

295

399

296

def add(self):

400

297

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

401

298

self.remove()

418

315

dbus.UInt16(self.port),

419

316

avahi.string_array_to_txt_array(self.TXT))

420

317

self.group.Commit()

421

318

422

319

def entry_group_state_changed(self, state, error):

423

320

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

424

321

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

425

322

426

323

if state == avahi.ENTRY_GROUP_ESTABLISHED:

427

324

logger.debug("Zeroconf service established.")

428

325

elif state == avahi.ENTRY_GROUP_COLLISION:

430

327

self.rename()

431

328

elif state == avahi.ENTRY_GROUP_FAILURE:

432

329

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

433

str(error))

434

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

435

330

unicode(error))

331

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

332

.format(error))

333

436

334

def cleanup(self):

437

335

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

438

336

if self.group is not None:

443

341

pass

444

342

self.group = None

445

343

self.remove()

446

344

447

345

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

448

346

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

449

347

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

450

bad_states = {

451

avahi.SERVER_INVALID: "Zeroconf server invalid",

452

avahi.SERVER_REGISTERING: None,

453

avahi.SERVER_COLLISION: "Zeroconf server name collision",

454

avahi.SERVER_FAILURE: "Zeroconf server failure",

455

}

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

456

355

if state in bad_states:

457

356

if bad_states[state] is not None:

458

357

if error is None:

461

360

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

462

361

self.cleanup()

463

362

elif state == avahi.SERVER_RUNNING:

464

try:

465

self.add()

466

except dbus.exceptions.DBusException as error:

467

if (error.get_dbus_name()

468

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

469

logger.info("Local Zeroconf service name"

470

" collision.")

471

return self.rename(remove=False)

472

else:

473

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

474

self.cleanup()

475

os._exit(1)

363

self.add()

476

364

else:

477

365

if error is None:

478

366

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

479

367

else:

480

368

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

481

369

482

370

def activate(self):

483

371

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

484

372

if self.server is None:

488

376

follow_name_owner_changes=True),

489

377

avahi.DBUS_INTERFACE_SERVER)

490

378

self.server.connect_to_signal("StateChanged",

491

self.server_state_changed)

379

self.server_state_changed)

492

380

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

493

381

494

382

495

383

class AvahiServiceToSyslog(AvahiService):

496

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

384

def rename(self):

497

385

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

498

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

499

syslogger.setFormatter(logging.Formatter(

500

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

501

.format(self.name)))

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

502

391

return ret

503

392

504

393

505

# Pretend that we have a GnuTLS module

506

class gnutls(object):

507

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

508

509

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

510

if library is None:

511

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

512

_library = ctypes.cdll.LoadLibrary(library)

513

del library

514

515

# Unless otherwise indicated, the constants and types below are

516

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

517

518

# Constants

519

E_SUCCESS = 0

520

E_INTERRUPTED = -52

521

E_AGAIN = -28

522

CRT_OPENPGP = 2

523

CRT_RAWPK = 3

524

CLIENT = 2

525

SHUT_RDWR = 0

526

CRD_CERTIFICATE = 1

527

E_NO_CERTIFICATE_FOUND = -49

528

X509_FMT_DER = 0

529

NO_TICKETS = 1<<10

530

ENABLE_RAWPK = 1<<18

531

CTYPE_PEERS = 3

532

KEYID_USE_SHA256 = 1 # gnutls/x509.h

533

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

534

535

# Types

536

class session_int(ctypes.Structure):

537

_fields_ = []

538

session_t = ctypes.POINTER(session_int)

539

540

class certificate_credentials_st(ctypes.Structure):

541

_fields_ = []

542

certificate_credentials_t = ctypes.POINTER(

543

certificate_credentials_st)

544

certificate_type_t = ctypes.c_int

545

546

class datum_t(ctypes.Structure):

547

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

548

('size', ctypes.c_uint)]

549

550

class openpgp_crt_int(ctypes.Structure):

551

_fields_ = []

552

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

553

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

554

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

555

credentials_type_t = ctypes.c_int

556

transport_ptr_t = ctypes.c_void_p

557

close_request_t = ctypes.c_int

558

559

# Exceptions

560

class Error(Exception):

561

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

562

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

563

# code is passed, convert it to a string with

564

# gnutls.strerror()

565

self.code = code

566

if message is None and code is not None:

567

message = gnutls.strerror(code)

568

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

569

message, *args)

570

571

class CertificateSecurityError(Error):

572

pass

573

574

# Classes

575

class Credentials(object):

576

def __init__(self):

577

self._c_object = gnutls.certificate_credentials_t()

578

gnutls.certificate_allocate_credentials(

579

ctypes.byref(self._c_object))

580

self.type = gnutls.CRD_CERTIFICATE

581

582

def __del__(self):

583

gnutls.certificate_free_credentials(self._c_object)

584

585

class ClientSession(object):

586

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

587

self._c_object = gnutls.session_t()

588

gnutls_flags = gnutls.CLIENT

589

if gnutls.check_version(b"3.5.6"):

590

gnutls_flags |= gnutls.NO_TICKETS

591

if gnutls.has_rawpk:

592

gnutls_flags |= gnutls.ENABLE_RAWPK

593

gnutls.init(ctypes.byref(self._c_object), gnutls_flags)

594

del gnutls_flags

595

gnutls.set_default_priority(self._c_object)

596

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

597

gnutls.handshake_set_private_extensions(self._c_object,

598

True)

599

self.socket = socket

600

if credentials is None:

601

credentials = gnutls.Credentials()

602

gnutls.credentials_set(self._c_object, credentials.type,

603

ctypes.cast(credentials._c_object,

604

ctypes.c_void_p))

605

self.credentials = credentials

606

607

def __del__(self):

608

gnutls.deinit(self._c_object)

609

610

def handshake(self):

611

return gnutls.handshake(self._c_object)

612

613

def send(self, data):

614

data = bytes(data)

615

data_len = len(data)

616

while data_len > 0:

617

data_len -= gnutls.record_send(self._c_object,

618

data[-data_len:],

619

data_len)

620

621

def bye(self):

622

return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)

623

624

# Error handling functions

625

def _error_code(result):

626

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

627

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

628

if result >= 0:

629

return result

630

if result == gnutls.E_NO_CERTIFICATE_FOUND:

631

raise gnutls.CertificateSecurityError(code=result)

632

raise gnutls.Error(code=result)

633

634

def _retry_on_error(result, func, arguments):

635

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

636

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

637

while result < 0:

638

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

639

return _error_code(result)

640

result = func(*arguments)

641

return result

642

643

# Unless otherwise indicated, the function declarations below are

644

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

645

646

# Functions

647

priority_set_direct = _library.gnutls_priority_set_direct

648

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

649

ctypes.POINTER(ctypes.c_char_p)]

650

priority_set_direct.restype = _error_code

651

652

init = _library.gnutls_init

653

init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]

654

init.restype = _error_code

655

656

set_default_priority = _library.gnutls_set_default_priority

657

set_default_priority.argtypes = [session_t]

658

set_default_priority.restype = _error_code

659

660

record_send = _library.gnutls_record_send

661

record_send.argtypes = [session_t, ctypes.c_void_p,

662

ctypes.c_size_t]

663

record_send.restype = ctypes.c_ssize_t

664

record_send.errcheck = _retry_on_error

665

666

certificate_allocate_credentials = (

667

_library.gnutls_certificate_allocate_credentials)

668

certificate_allocate_credentials.argtypes = [

669

ctypes.POINTER(certificate_credentials_t)]

670

certificate_allocate_credentials.restype = _error_code

671

672

certificate_free_credentials = (

673

_library.gnutls_certificate_free_credentials)

674

certificate_free_credentials.argtypes = [

675

certificate_credentials_t]

676

certificate_free_credentials.restype = None

677

678

handshake_set_private_extensions = (

679

_library.gnutls_handshake_set_private_extensions)

680

handshake_set_private_extensions.argtypes = [session_t,

681

ctypes.c_int]

682

handshake_set_private_extensions.restype = None

683

684

credentials_set = _library.gnutls_credentials_set

685

credentials_set.argtypes = [session_t, credentials_type_t,

686

ctypes.c_void_p]

687

credentials_set.restype = _error_code

688

689

strerror = _library.gnutls_strerror

690

strerror.argtypes = [ctypes.c_int]

691

strerror.restype = ctypes.c_char_p

692

693

certificate_type_get = _library.gnutls_certificate_type_get

694

certificate_type_get.argtypes = [session_t]

695

certificate_type_get.restype = _error_code

696

697

certificate_get_peers = _library.gnutls_certificate_get_peers

698

certificate_get_peers.argtypes = [session_t,

699

ctypes.POINTER(ctypes.c_uint)]

700

certificate_get_peers.restype = ctypes.POINTER(datum_t)

701

702

global_set_log_level = _library.gnutls_global_set_log_level

703

global_set_log_level.argtypes = [ctypes.c_int]

704

global_set_log_level.restype = None

705

706

global_set_log_function = _library.gnutls_global_set_log_function

707

global_set_log_function.argtypes = [log_func]

708

global_set_log_function.restype = None

709

710

deinit = _library.gnutls_deinit

711

deinit.argtypes = [session_t]

712

deinit.restype = None

713

714

handshake = _library.gnutls_handshake

715

handshake.argtypes = [session_t]

716

handshake.restype = _error_code

717

handshake.errcheck = _retry_on_error

718

719

transport_set_ptr = _library.gnutls_transport_set_ptr

720

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

721

transport_set_ptr.restype = None

722

723

bye = _library.gnutls_bye

724

bye.argtypes = [session_t, close_request_t]

725

bye.restype = _error_code

726

bye.errcheck = _retry_on_error

727

728

check_version = _library.gnutls_check_version

729

check_version.argtypes = [ctypes.c_char_p]

730

check_version.restype = ctypes.c_char_p

731

732

_need_version = b"3.3.0"

733

if check_version(_need_version) is None:

734

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

735

.format(_need_version))

736

737

_tls_rawpk_version = b"3.6.6"

738

has_rawpk = bool(check_version(_tls_rawpk_version))

739

740

if has_rawpk:

741

# Types

742

class pubkey_st(ctypes.Structure):

743

_fields = []

744

pubkey_t = ctypes.POINTER(pubkey_st)

745

746

x509_crt_fmt_t = ctypes.c_int

747

748

# All the function declarations below are from gnutls/abstract.h

749

pubkey_init = _library.gnutls_pubkey_init

750

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

751

pubkey_init.restype = _error_code

752

753

pubkey_import = _library.gnutls_pubkey_import

754

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

755

x509_crt_fmt_t]

756

pubkey_import.restype = _error_code

757

758

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

759

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

760

ctypes.POINTER(ctypes.c_ubyte),

761

ctypes.POINTER(ctypes.c_size_t)]

762

pubkey_get_key_id.restype = _error_code

763

764

pubkey_deinit = _library.gnutls_pubkey_deinit

765

pubkey_deinit.argtypes = [pubkey_t]

766

pubkey_deinit.restype = None

767

else:

768

# All the function declarations below are from gnutls/openpgp.h

769

770

openpgp_crt_init = _library.gnutls_openpgp_crt_init

771

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

772

openpgp_crt_init.restype = _error_code

773

774

openpgp_crt_import = _library.gnutls_openpgp_crt_import

775

openpgp_crt_import.argtypes = [openpgp_crt_t,

776

ctypes.POINTER(datum_t),

777

openpgp_crt_fmt_t]

778

openpgp_crt_import.restype = _error_code

779

780

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

781

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

782

ctypes.POINTER(ctypes.c_uint)]

783

openpgp_crt_verify_self.restype = _error_code

784

785

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

786

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

787

openpgp_crt_deinit.restype = None

788

789

openpgp_crt_get_fingerprint = (

790

_library.gnutls_openpgp_crt_get_fingerprint)

791

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

792

ctypes.c_void_p,

793

ctypes.POINTER(

794

ctypes.c_size_t)]

795

openpgp_crt_get_fingerprint.restype = _error_code

796

797

if check_version(b"3.6.4"):

798

certificate_type_get2 = _library.gnutls_certificate_type_get2

799

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

800

certificate_type_get2.restype = _error_code

801

802

# Remove non-public functions

803

del _error_code, _retry_on_error

804

805

806

def call_pipe(connection, # : multiprocessing.Connection

807

func, *args, **kwargs):

808

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

809

810

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

811

return value on the provided multiprocessing.Connection.

812

"""

813

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

814

connection.close()

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

815

399

816

400

817

401

class Client(object):

818

402

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

819

403

820

404

Attributes:

821

405

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

822

406

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

823

407

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

824

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

825

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

826

running.

827

checker_callback_tag: a GLib event source tag, or None

408

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

409

to see if the client lives.

410

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

828

412

checker_command: string; External command which is run to check

829

413

if client lives. %() expansions are done at

830

414

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

831

415

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

832

checker_initiator_tag: a GLib event source tag, or None

416

checker_initiator_tag: a gobject event source tag, or None

833

417

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

834

418

client_structure: Object describing what attributes a client has

835

419

and is used for storing the client at exit

836

420

current_checker_command: string; current running checker_command

837

disable_initiator_tag: a GLib event source tag, or None

421

disable_initiator_tag: a gobject event source tag, or None

838

422

enabled: bool()

839

423

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

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

424

uniquely identify the client

843

425

host: string; available for use by the checker command

844

426

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

845

427

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

847

429

last_checker_status: integer between 0 and 255 reflecting exit

848

430

status of last checker. -1 reflects crashed

849

431

checker, -2 means no checker completed yet.

850

last_checker_signal: The signal which killed the last checker, if

851

last_checker_status is -1

852

432

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

853

433

name: string; from the config file, used in log messages and

854

434

D-Bus identifiers

859

439

runtime_expansions: Allowed attributes for runtime expansion.

860

440

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

861

441

disabled, or None

862

server_settings: The server_settings dict from main()

863

442

"""

864

443

865

444

runtime_expansions = ("approval_delay", "approval_duration",

866

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

445

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

867

446

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

868

447

"last_approval_request", "last_checked_ok",

869

448

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

870

client_defaults = {

871

"timeout": "PT5M",

872

"extended_timeout": "PT15M",

873

"interval": "PT2M",

874

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

875

"host": "",

876

"approval_delay": "PT0S",

877

"approval_duration": "PT1S",

878

"approved_by_default": "True",

879

"enabled": "True",

880

}

881

449

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

450

"extended_timeout": "15m",

451

"interval": "2m",

452

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

453

"host": "",

454

"approval_delay": "0s",

455

"approval_duration": "1s",

456

"approved_by_default": "True",

457

"enabled": "True",

458

}

459

460

def timeout_milliseconds(self):

461

"Return the 'timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.timeout)

463

464

def extended_timeout_milliseconds(self):

465

"Return the 'extended_timeout' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.extended_timeout)

467

468

def interval_milliseconds(self):

469

"Return the 'interval' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.interval)

471

472

def approval_delay_milliseconds(self):

473

return timedelta_to_milliseconds(self.approval_delay)

474

882

475

@staticmethod

883

476

def config_parser(config):

884

477

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

891

484

for client_name in config.sections():

892

485

section = dict(config.items(client_name))

893

486

client = settings[client_name] = {}

894

487

895

488

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

896

489

# Reformat values from string types to Python types

897

490

client["approved_by_default"] = config.getboolean(

898

491

client_name, "approved_by_default")

899

492

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

900

493

"enabled")

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

494

907

495

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

908

496

.replace(" ", ""))

909

497

if "secret" in section:

910

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

911

.encode("utf-8"),

912

"base64")

498

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

913

499

elif "secfile" in section:

914

500

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

915

501

(section["secfile"])),

916

502

"rb") as secfile:

917

503

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

918

504

else:

919

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

505

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

920

506

.format(section))

921

507

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

922

508

client["extended_timeout"] = string_to_delta(

930

516

client["last_approval_request"] = None

931

517

client["last_checked_ok"] = None

932

518

client["last_checker_status"] = -2

933

519

934

520

return settings

935

936

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

521

522

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

937

523

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

941

524

# adding all client settings

942

for setting, value in settings.items():

525

for setting, value in settings.iteritems():

943

526

setattr(self, setting, value)

944

527

945

528

if self.enabled:

946

529

if not hasattr(self, "last_enabled"):

947

530

self.last_enabled = datetime.datetime.utcnow()

951

534

else:

952

535

self.last_enabled = None

953

536

self.expires = None

954

537

955

538

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

956

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

539

# Uppercase and remove spaces from fingerprint for later

540

# comparison purposes with return value from the fingerprint()

541

# function

957

542

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

958

543

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

959

544

datetime.datetime.utcnow())

960

545

961

546

# attributes specific for this server instance

962

547

self.checker = None

963

548

self.checker_initiator_tag = None

966

551

self.current_checker_command = None

967

552

self.approved = None

968

553

self.approvals_pending = 0

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

554

self.changedstate = (multiprocessing_manager

555

.Condition(multiprocessing_manager

556

.Lock()))

557

self.client_structure = [attr for attr in

558

self.__dict__.iterkeys()

973

559

if not attr.startswith("_")]

974

560

self.client_structure.append("client_structure")

975

976

for name, t in inspect.getmembers(

977

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

561

562

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

563

lambda obj:

564

isinstance(obj,

565

property)):

978

566

if not name.startswith("_"):

979

567

self.client_structure.append(name)

980

568

981

569

# Send notice to process children that client state has changed

982

570

def send_changedstate(self):

983

571

with self.changedstate:

984

572

self.changedstate.notify_all()

985

573

986

574

def enable(self):

987

575

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

988

576

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

993

581

self.last_enabled = datetime.datetime.utcnow()

994

582

self.init_checker()

995

583

self.send_changedstate()

996

584

997

585

def disable(self, quiet=True):

998

586

"""Disable this client."""

999

587

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

1001

589

if not quiet:

1002

590

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

1003

591

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

1004

GLib.source_remove(self.disable_initiator_tag)

592

gobject.source_remove(self.disable_initiator_tag)

1005

593

self.disable_initiator_tag = None

1006

594

self.expires = None

1007

595

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

1008

GLib.source_remove(self.checker_initiator_tag)

596

gobject.source_remove(self.checker_initiator_tag)

1009

597

self.checker_initiator_tag = None

1010

598

self.stop_checker()

1011

599

self.enabled = False

1012

600

if not quiet:

1013

601

self.send_changedstate()

1014

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

602

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

1015

603

return False

1016

604

1017

605

def __del__(self):

1018

606

self.disable()

1019

607

1020

608

def init_checker(self):

1021

609

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

1022

610

# and every interval from then on.

1023

611

if self.checker_initiator_tag is not None:

1024

GLib.source_remove(self.checker_initiator_tag)

1025

self.checker_initiator_tag = GLib.timeout_add(

1026

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

1027

self.start_checker)

612

gobject.source_remove(self.checker_initiator_tag)

613

self.checker_initiator_tag = (gobject.timeout_add

614

(self.interval_milliseconds(),

615

self.start_checker))

1028

616

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

1029

617

if self.disable_initiator_tag is not None:

1030

GLib.source_remove(self.disable_initiator_tag)

1031

self.disable_initiator_tag = GLib.timeout_add(

1032

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

618

gobject.source_remove(self.disable_initiator_tag)

619

self.disable_initiator_tag = (gobject.timeout_add

620

(self.timeout_milliseconds(),

621

self.disable))

1033

622

# Also start a new checker *right now*.

1034

623

self.start_checker()

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

624

625

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

1038

626

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

1039

# Read return code from connection (see call_pipe)

1040

returncode = connection.recv()

1041

connection.close()

1042

self.checker.join()

1043

627

self.checker_callback_tag = None

1044

628

self.checker = None

1045

1046

if returncode >= 0:

1047

self.last_checker_status = returncode

1048

self.last_checker_signal = None

629

if os.WIFEXITED(condition):

630

self.last_checker_status = os.WEXITSTATUS(condition)

1049

631

if self.last_checker_status == 0:

1050

632

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

1051

633

vars(self))

1052

634

self.checked_ok()

1053

635

else:

1054

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

636

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

637

vars(self))

1055

638

else:

1056

639

self.last_checker_status = -1

1057

self.last_checker_signal = -returncode

1058

640

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

1059

641

vars(self))

1060

return False

1061

642

1062

643

def checked_ok(self):

1063

644

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

1064

645

self.last_checked_ok = datetime.datetime.utcnow()

1065

646

self.last_checker_status = 0

1066

self.last_checker_signal = None

1067

647

self.bump_timeout()

1068

648

1069

649

def bump_timeout(self, timeout=None):

1070

650

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

1071

651

if timeout is None:

1072

652

timeout = self.timeout

1073

653

if self.disable_initiator_tag is not None:

1074

GLib.source_remove(self.disable_initiator_tag)

654

gobject.source_remove(self.disable_initiator_tag)

1075

655

self.disable_initiator_tag = None

1076

656

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

1077

self.disable_initiator_tag = GLib.timeout_add(

1078

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

657

self.disable_initiator_tag = (gobject.timeout_add

658

(timedelta_to_milliseconds

659

(timeout), self.disable))

1079

660

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

1080

661

1081

662

def need_approval(self):

1082

663

self.last_approval_request = datetime.datetime.utcnow()

1083

664

1084

665

def start_checker(self):

1085

666

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

1086

667

1087

668

If a checker already exists, leave it running and do

1088

669

nothing."""

1089

670

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

1094

675

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

1095

676

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

1096

677

# should be.

1097

1098

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

1099

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

1100

self.checker.join()

1101

self.checker = None

678

679

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

680

try:

681

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

682

except (AttributeError, OSError) as error:

683

if (isinstance(error, OSError)

684

and error.errno != errno.ECHILD):

685

raise error

686

else:

687

if pid:

688

logger.warning("Checker was a zombie")

689

gobject.source_remove(self.checker_callback_tag)

690

self.checker_callback(pid, status,

691

self.current_checker_command)

1102

692

# Start a new checker if needed

1103

693

if self.checker is None:

1104

694

# Escape attributes for the shell

1105

escaped_attrs = {

1106

attr: re.escape(str(getattr(self, attr)))

1107

for attr in self.runtime_expansions}

695

escaped_attrs = dict(

696

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

697

for attr in

698

self.runtime_expansions)

1108

699

try:

1109

700

command = self.checker_command % escaped_attrs

1110

701

except TypeError as error:

1111

702

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

1112

self.checker_command,

703

self.checker_command, exc_info=error)

704

return True # Try again later

705

self.current_checker_command = command

706

try:

707

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

708

command, self.name)

709

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

710

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

711

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

712

# always replaced by /dev/null.)

713

self.checker = subprocess.Popen(command,

714

close_fds=True,

715

shell=True, cwd="/")

716

except OSError as error:

717

logger.error("Failed to start subprocess",

1113

718

exc_info=error)

1114

return True # Try again later

1115

self.current_checker_command = command

1116

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

1117

self.name)

1118

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

1119

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

1120

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

1121

# always replaced by /dev/null.)

1122

# The exception is when not debugging but nevertheless

1123

# running in the foreground; use the previously

1124

# created wnull.

1125

popen_args = {"close_fds": True,

1126

"shell": True,

1127

"cwd": "/"}

1128

if (not self.server_settings["debug"]

1129

and self.server_settings["foreground"]):

1130

popen_args.update({"stdout": wnull,

1131

"stderr": wnull})

1132

pipe = multiprocessing.Pipe(duplex=False)

1133

self.checker = multiprocessing.Process(

1134

target=call_pipe,

1135

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

1136

kwargs=popen_args)

1137

self.checker.start()

1138

self.checker_callback_tag = GLib.io_add_watch(

1139

pipe[0].fileno(), GLib.IO_IN,

1140

self.checker_callback, pipe[0], command)

1141

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

719

self.checker_callback_tag = (gobject.child_watch_add

720

(self.checker.pid,

721

self.checker_callback,

722

data=command))

723

# The checker may have completed before the gobject

724

# watch was added. Check for this.

725

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

726

if pid:

727

gobject.source_remove(self.checker_callback_tag)

728

self.checker_callback(pid, status, command)

729

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

1142

730

return True

1143

731

1144

732

def stop_checker(self):

1145

733

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

1146

734

if self.checker_callback_tag:

1147

GLib.source_remove(self.checker_callback_tag)

735

gobject.source_remove(self.checker_callback_tag)

1148

736

self.checker_callback_tag = None

1149

737

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

1150

738

return

1151

739

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

1152

self.checker.terminate()

740

try:

741

self.checker.terminate()

742

#time.sleep(0.5)

743

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

744

# self.checker.kill()

745

except OSError as error:

746

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

747

raise

1153

748

self.checker = None

1154

749

1155

750

1156

def dbus_service_property(dbus_interface,

1157

signature="v",

1158

access="readwrite",

1159

byte_arrays=False):

751

def dbus_service_property(dbus_interface, signature="v",

752

access="readwrite", byte_arrays=False):

1160

753

"""Decorators for marking methods of a DBusObjectWithProperties to

1161

754

become properties on the D-Bus.

1162

755

1163

756

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

1164

757

and with one argument by "Set".

1165

758

1166

759

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

1167

760

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

1168

761

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

1171

764

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

1172

765

if byte_arrays and signature != "ay":

1173

766

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

1174

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

1175

767

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

1176

768

def decorator(func):

1177

769

func._dbus_is_property = True

1178

770

func._dbus_interface = dbus_interface

1181

773

func._dbus_name = func.__name__

1182

774

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

1183

775

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

1184

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

776

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1185

777

return func

1186

1187

778

return decorator

1188

779

1189

780

1190

781

def dbus_interface_annotations(dbus_interface):

1191

782

"""Decorator for marking functions returning interface annotations

1192

783

1193

784

Usage:

1194

785

1195

786

@dbus_interface_annotations("org.example.Interface")

1196

787

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

1197

788

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

1198

789

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

1199

790

"false"}

1200

791

"""

1201

1202

792

def decorator(func):

1203

793

func._dbus_is_interface = True

1204

794

func._dbus_interface = dbus_interface

1205

795

func._dbus_name = dbus_interface

1206

796

return func

1207

1208

797

return decorator

1209

798

1210

799

1211

800

def dbus_annotations(annotations):

1212

801

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

1213

802

Usage:

1214

1215

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

1216

"org.freedesktop.DBus.Property."

1217

"EmitsChangedSignal": "false"})

803

1218

804

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

1219

805

access="r")

806

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

807

"org.freedesktop.DBus.Property."

808

"EmitsChangedSignal": "false"})

1220

809

def Property_dbus_property(self):

1221

810

return dbus.Boolean(False)

1222

1223

See also the DBusObjectWithAnnotations class.

1224

811

"""

1225

1226

812

def decorator(func):

1227

813

func._dbus_annotations = annotations

1228

814

return func

1229

1230

815

return decorator

1231

816

1232

817

1233

818

class DBusPropertyException(dbus.exceptions.DBusException):

1234

819

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

1235

820

"""

1236

pass

821

def __unicode__(self):

822

return unicode(str(self))

1237

823

1238

824

1239

825

class DBusPropertyAccessException(DBusPropertyException):

1248

834

pass

1249

835

1250

836

1251

class DBusObjectWithAnnotations(dbus.service.Object):

1252

"""A D-Bus object with annotations.

1253

1254

Classes inheriting from this can use the dbus_annotations

1255

decorator to add annotations to methods or signals.

837

class DBusObjectWithProperties(dbus.service.Object):

838

"""A D-Bus object with properties.

839

840

Classes inheriting from this can use the dbus_service_property

841

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

842

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

1256

843

"""

1257

844

1258

845

@staticmethod

1259

846

def _is_dbus_thing(thing):

1260

847

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

1261

848

1262

849

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

1263

850

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

1264

851

"""

1265

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

852

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

1266

853

False)

1267

854

1268

855

def _get_all_dbus_things(self, thing):

1269

856

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

1270

857

"""

1271

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

858

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

859

name),

1272

860

athing.__get__(self))

1273

861

for cls in self.__class__.__mro__

1274

862

for name, athing in

1275

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

1276

1277

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1278

out_signature="s",

1279

path_keyword='object_path',

1280

connection_keyword='connection')

1281

def Introspect(self, object_path, connection):

1282

"""Overloading of standard D-Bus method.

1283

1284

Inserts annotation tags on methods and signals.

1285

"""

1286

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

1287

connection)

1288

try:

1289

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

1290

1291

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

1292

# Add annotation tags

1293

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

1294

for tag in if_tag.getElementsByTagName(typ):

1295

annots = dict()

1296

for name, prop in (self.

1297

_get_all_dbus_things(typ)):

1298

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

1299

and prop._dbus_interface

1300

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

1301

annots.update(getattr(

1302

prop, "_dbus_annotations", {}))

1303

for name, value in annots.items():

1304

ann_tag = document.createElement(

1305

"annotation")

1306

ann_tag.setAttribute("name", name)

1307

ann_tag.setAttribute("value", value)

1308

tag.appendChild(ann_tag)

1309

# Add interface annotation tags

1310

for annotation, value in dict(

1311

itertools.chain.from_iterable(

1312

annotations().items()

1313

for name, annotations

1314

in self._get_all_dbus_things("interface")

1315

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

1316

)).items():

1317

ann_tag = document.createElement("annotation")

1318

ann_tag.setAttribute("name", annotation)

1319

ann_tag.setAttribute("value", value)

1320

if_tag.appendChild(ann_tag)

1321

# Fix argument name for the Introspect method itself

1322

if (if_tag.getAttribute("name")

1323

== dbus.INTROSPECTABLE_IFACE):

1324

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

1325

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

1326

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

1327

if (arg.getAttribute("direction")

1328

== "out"):

1329

arg.setAttribute("name",

1330

"xml_data")

1331

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

1332

document.unlink()

1333

except (AttributeError, xml.dom.DOMException,

1334

xml.parsers.expat.ExpatError) as error:

1335

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

1336

exc_info=error)

1337

return xmlstring

1338

1339

1340

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1341

"""A D-Bus object with properties.

1342

1343

Classes inheriting from this can use the dbus_service_property

1344

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

1345

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

1346

"""

1347

863

inspect.getmembers(cls,

864

self._is_dbus_thing(thing)))

865

1348

866

def _get_dbus_property(self, interface_name, property_name):

1349

867

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

1350

868

property with the specified name and interface.

1351

869

"""

1352

for cls in self.__class__.__mro__:

1353

for name, value in inspect.getmembers(

1354

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

870

for cls in self.__class__.__mro__:

871

for name, value in (inspect.getmembers

872

(cls,

873

self._is_dbus_thing("property"))):

1355

874

if (value._dbus_name == property_name

1356

875

and value._dbus_interface == interface_name):

1357

876

return value.__get__(self)

1358

877

1359

878

# No such property

1360

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

1361

self.dbus_object_path, interface_name, property_name))

1362

1363

@classmethod

1364

def _get_all_interface_names(cls):

1365

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

1366

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

1367

"_dbus_interface", None)

1368

for x in (inspect.getmro(cls))

1369

for attr in dir(x))

1370

if name is not None)

1371

1372

@dbus.service.method(dbus.PROPERTIES_IFACE,

1373

in_signature="ss",

879

raise DBusPropertyNotFound(self.dbus_object_path + ":"

880

+ interface_name + "."

881

+ property_name)

882

883

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

1374

884

out_signature="v")

1375

885

def Get(self, interface_name, property_name):

1376

886

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

1382

892

if not hasattr(value, "variant_level"):

1383

893

return value

1384

894

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

1385

895

1386

896

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

1387

897

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

1388

898

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

1394

904

# The byte_arrays option is not supported yet on

1395

905

# signatures other than "ay".

1396

906

if prop._dbus_signature != "ay":

1397

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

1398

"'ay' signature {!r}"

1399

.format(prop._dbus_signature))

907

raise ValueError

1400

908

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

1401

909

for byte in value))

1402

910

prop(value)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="s",

911

912

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

1406

913

out_signature="a{sv}")

1407

914

def GetAll(self, interface_name):

1408

915

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

1409

916

standard.

1410

917

1411

918

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

1412

919

"""

1413

920

properties = {}

1423

930

if not hasattr(value, "variant_level"):

1424

931

properties[name] = value

1425

932

continue

1426

properties[name] = type(value)(

1427

value, variant_level=value.variant_level + 1)

933

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

934

value.variant_level+1)

1428

935

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

1429

1430

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

1431

def PropertiesChanged(self, interface_name, changed_properties,

1432

invalidated_properties):

1433

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

1434

standard.

1435

"""

1436

pass

1437

936

1438

937

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1439

938

out_signature="s",

1440

939

path_keyword='object_path',

1441

940

connection_keyword='connection')

1442

941

def Introspect(self, object_path, connection):

1443

942

"""Overloading of standard D-Bus method.

1444

943

1445

944

Inserts property tags and interface annotation tags.

1446

945

"""

1447

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1448

object_path,

1449

connection)

946

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

947

connection)

1450

948

try:

1451

949

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

1452

1453

950

def make_tag(document, name, prop):

1454

951

e = document.createElement("property")

1455

952

e.setAttribute("name", name)

1456

953

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

1457

954

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

1458

955

return e

1459

1460

956

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

1461

957

# Add property tags

1462

958

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

1465

961

if prop._dbus_interface

1466

962

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

1467

963

if_tag.appendChild(tag)

1468

# Add annotation tags for properties

1469

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

1470

annots = dict()

1471

for name, prop in self._get_all_dbus_things(

1472

"property"):

1473

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

1474

and prop._dbus_interface

1475

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

1476

annots.update(getattr(

1477

prop, "_dbus_annotations", {}))

1478

for name, value in annots.items():

1479

ann_tag = document.createElement(

1480

"annotation")

1481

ann_tag.setAttribute("name", name)

1482

ann_tag.setAttribute("value", value)

1483

tag.appendChild(ann_tag)

964

# Add annotation tags

965

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

966

for tag in if_tag.getElementsByTagName(typ):

967

annots = dict()

968

for name, prop in (self.

969

_get_all_dbus_things(typ)):

970

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

971

and prop._dbus_interface

972

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

973

annots.update(getattr

974

(prop,

975

"_dbus_annotations",

976

{}))

977

for name, value in annots.iteritems():

978

ann_tag = document.createElement(

979

"annotation")

980

ann_tag.setAttribute("name", name)

981

ann_tag.setAttribute("value", value)

982

tag.appendChild(ann_tag)

983

# Add interface annotation tags

984

for annotation, value in dict(

985

itertools.chain.from_iterable(

986

annotations().iteritems()

987

for name, annotations in

988

self._get_all_dbus_things("interface")

989

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

990

)).iteritems():

991

ann_tag = document.createElement("annotation")

992

ann_tag.setAttribute("name", annotation)

993

ann_tag.setAttribute("value", value)

994

if_tag.appendChild(ann_tag)

1484

995

# Add the names to the return values for the

1485

996

# "org.freedesktop.DBus.Properties" methods

1486

997

if (if_tag.getAttribute("name")

1505

1016

return xmlstring

1506

1017

1507

1018

1508

try:

1509

dbus.OBJECT_MANAGER_IFACE

1510

except AttributeError:

1511

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

1512

1513

1514

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1515

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

1516

1517

Classes inheriting from this exposes the standard

1518

GetManagedObjects call and the InterfacesAdded and

1519

InterfacesRemoved signals on the standard

1520

"org.freedesktop.DBus.ObjectManager" interface.

1521

1522

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

1523

manually.

1524

"""

1525

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1526

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

1527

def GetManagedObjects(self):

1528

"""This function must be overridden"""

1529

raise NotImplementedError()

1530

1531

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1532

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

1533

def InterfacesAdded(self, object_path, interfaces_and_properties):

1534

pass

1535

1536

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

1537

def InterfacesRemoved(self, object_path, interfaces):

1538

pass

1539

1540

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1541

out_signature="s",

1542

path_keyword='object_path',

1543

connection_keyword='connection')

1544

def Introspect(self, object_path, connection):

1545

"""Overloading of standard D-Bus method.

1546

1547

Override return argument name of GetManagedObjects to be

1548

"objpath_interfaces_and_properties"

1549

"""

1550

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1551

object_path,

1552

connection)

1553

try:

1554

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

1555

1556

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

1557

# Fix argument name for the GetManagedObjects method

1558

if (if_tag.getAttribute("name")

1559

== dbus.OBJECT_MANAGER_IFACE):

1560

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

1561

if (cn.getAttribute("name")

1562

== "GetManagedObjects"):

1563

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

1564

if (arg.getAttribute("direction")

1565

== "out"):

1566

arg.setAttribute(

1567

"name",

1568

"objpath_interfaces"

1569

"_and_properties")

1570

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

1571

document.unlink()

1572

except (AttributeError, xml.dom.DOMException,

1573

xml.parsers.expat.ExpatError) as error:

1574

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

1575

exc_info=error)

1576

return xmlstring

1577

1578

1579

def datetime_to_dbus(dt, variant_level=0):

1019

def datetime_to_dbus (dt, variant_level=0):

1580

1020

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

1581

1021

if dt is None:

1582

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

1583

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

1022

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

1023

return dbus.String(dt.isoformat(),

1024

variant_level=variant_level)

1584

1025

1585

1026

1586

1027

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1588

1029

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

1589

1030

interface names according to the "alt_interface_names" mapping.

1590

1031

Usage:

1591

1592

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

1593

"net.example.AlternateInterface"})

1032

1033

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

1034

"net.example.AlternateInterface"})

1594

1035

class SampleDBusObject(dbus.service.Object):

1595

1036

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

1596

1037

def SampleDBusMethod():

1597

1038

pass

1598

1039

1599

1040

The above "SampleDBusMethod" on "SampleDBusObject" will be

1600

1041

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

1601

1042

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

1602

1043

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

1603

1044

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

1604

1045

1605

1046

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

1606

1047

(from DBusObjectWithProperties) and interfaces (from the

1607

1048

dbus_interface_annotations decorator).

1608

1049

"""

1609

1610

1050

def wrapper(cls):

1611

1051

for orig_interface_name, alt_interface_name in (

1612

alt_interface_names.items()):

1052

alt_interface_names.iteritems()):

1613

1053

attr = {}

1614

1054

interface_names = set()

1615

1055

# Go though all attributes of the class

1617

1057

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

1618

1058

# with the wrong interface name

1619

1059

if (not hasattr(attribute, "_dbus_interface")

1620

or not attribute._dbus_interface.startswith(

1621

orig_interface_name)):

1060

or not attribute._dbus_interface

1061

.startswith(orig_interface_name)):

1622

1062

continue

1623

1063

# Create an alternate D-Bus interface name based on

1624

1064

# the current name

1625

alt_interface = attribute._dbus_interface.replace(

1626

orig_interface_name, alt_interface_name)

1065

alt_interface = (attribute._dbus_interface

1066

.replace(orig_interface_name,

1067

alt_interface_name))

1627

1068

interface_names.add(alt_interface)

1628

1069

# Is this a D-Bus signal?

1629

1070

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

1630

# Extract the original non-method undecorated

1631

# function by black magic

1632

if sys.version_info.major == 2:

1633

nonmethod_func = (dict(

1071

# Extract the original non-method function by

1072

# black magic

1073

nonmethod_func = (dict(

1634

1074

zip(attribute.func_code.co_freevars,

1635

attribute.__closure__))

1636

["func"].cell_contents)

1637

else:

1638

nonmethod_func = (dict(

1639

zip(attribute.__code__.co_freevars,

1640

attribute.__closure__))

1641

["func"].cell_contents)

1075

attribute.__closure__))["func"]

1076

.cell_contents)

1642

1077

# Create a new, but exactly alike, function

1643

1078

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

1644

1079

# with the alternate D-Bus interface name

1645

new_function = copy_function(nonmethod_func)

1646

new_function = (dbus.service.signal(

1647

alt_interface,

1648

attribute._dbus_signature)(new_function))

1080

new_function = (dbus.service.signal

1081

(alt_interface,

1082

attribute._dbus_signature)

1083

(types.FunctionType(

1084

nonmethod_func.func_code,

1085

nonmethod_func.func_globals,

1086

nonmethod_func.func_name,

1087

nonmethod_func.func_defaults,

1088

nonmethod_func.func_closure)))

1649

1089

# Copy annotations, if any

1650

1090

try:

1651

new_function._dbus_annotations = dict(

1652

attribute._dbus_annotations)

1091

new_function._dbus_annotations = (

1092

dict(attribute._dbus_annotations))

1653

1093

except AttributeError:

1654

1094

pass

1655

1656

1095

# Define a creator of a function to call both the

1657

1096

# original and alternate functions, so both the

1658

1097

# original and alternate signals gets sent when

1661

1100

"""This function is a scope container to pass

1662

1101

func1 and func2 to the "call_both" function

1663

1102

outside of its arguments"""

1664

1665

@functools.wraps(func2)

1666

1103

def call_both(*args, **kwargs):

1667

1104

"""This function will emit two D-Bus

1668

1105

signals by calling func1 and func2"""

1669

1106

func1(*args, **kwargs)

1670

1107

func2(*args, **kwargs)

1671

# Make wrapper function look like a D-Bus

1672

# signal

1673

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

1674

if name.startswith("_dbus_"):

1675

setattr(call_both, name, attr)

1676

1677

1108

return call_both

1678

1109

# Create the "call_both" function and add it to

1679

1110

# the class

1684

1115

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

1685

1116

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

1686

1117

# to the class.

1687

attr[attrname] = (

1688

dbus.service.method(

1689

alt_interface,

1690

attribute._dbus_in_signature,

1691

attribute._dbus_out_signature)

1692

(copy_function(attribute)))

1118

attr[attrname] = (dbus.service.method

1119

(alt_interface,

1120

attribute._dbus_in_signature,

1121

attribute._dbus_out_signature)

1122

(types.FunctionType

1123

(attribute.func_code,

1124

attribute.func_globals,

1125

attribute.func_name,

1126

attribute.func_defaults,

1127

attribute.func_closure)))

1693

1128

# Copy annotations, if any

1694

1129

try:

1695

attr[attrname]._dbus_annotations = dict(

1696

attribute._dbus_annotations)

1130

attr[attrname]._dbus_annotations = (

1131

dict(attribute._dbus_annotations))

1697

1132

except AttributeError:

1698

1133

pass

1699

1134

# Is this a D-Bus property?

1702

1137

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

1703

1138

# property with the alternate D-Bus interface

1704

1139

# name. Add it to the class.

1705

attr[attrname] = (dbus_service_property(

1706

alt_interface, attribute._dbus_signature,

1707

attribute._dbus_access,

1708

attribute._dbus_get_args_options

1709

["byte_arrays"])

1710

(copy_function(attribute)))

1140

attr[attrname] = (dbus_service_property

1141

(alt_interface,

1142

attribute._dbus_signature,

1143

attribute._dbus_access,

1144

attribute

1145

._dbus_get_args_options

1146

["byte_arrays"])

1147

(types.FunctionType

1148

(attribute.func_code,

1149

attribute.func_globals,

1150

attribute.func_name,

1151

attribute.func_defaults,

1152

attribute.func_closure)))

1711

1153

# Copy annotations, if any

1712

1154

try:

1713

attr[attrname]._dbus_annotations = dict(

1714

attribute._dbus_annotations)

1155

attr[attrname]._dbus_annotations = (

1156

dict(attribute._dbus_annotations))

1715

1157

except AttributeError:

1716

1158

pass

1717

1159

# Is this a D-Bus interface?

1720

1162

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

1721

1163

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

1722

1164

# to the class.

1723

attr[attrname] = (

1724

dbus_interface_annotations(alt_interface)

1725

(copy_function(attribute)))

1165

attr[attrname] = (dbus_interface_annotations

1166

(alt_interface)

1167

(types.FunctionType

1168

(attribute.func_code,

1169

attribute.func_globals,

1170

attribute.func_name,

1171

attribute.func_defaults,

1172

attribute.func_closure)))

1726

1173

if deprecate:

1727

1174

# Deprecate all alternate interfaces

1728

iname = "_AlternateDBusNames_interface_annotation{}"

1175

iname="_AlternateDBusNames_interface_annotation{0}"

1729

1176

for interface_name in interface_names:

1730

1731

1177

@dbus_interface_annotations(interface_name)

1732

1178

def func(self):

1733

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

1734

"true"}

1179

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

1180

"true" }

1735

1181

# Find an unused name

1736

1182

for aname in (iname.format(i)

1737

1183

for i in itertools.count()):

1741

1187

if interface_names:

1742

1188

# Replace the class with a new subclass of it with

1743

1189

# methods, signals, etc. as created above.

1744

if sys.version_info.major == 2:

1745

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

1746

(cls, ), attr)

1747

else:

1748

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

1749

(cls, ), attr)

1190

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

1191

(cls,), attr)

1750

1192

return cls

1751

1752

1193

return wrapper

1753

1194

1754

1195

1755

1196

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

1756

"se.bsnet.fukt.Mandos"})

1197

"se.bsnet.fukt.Mandos"})

1757

1198

class ClientDBus(Client, DBusObjectWithProperties):

1758

1199

"""A Client class using D-Bus

1759

1200

1760

1201

Attributes:

1761

1202

dbus_object_path: dbus.ObjectPath

1762

1203

bus: dbus.SystemBus()

1763

1204

"""

1764

1205

1765

1206

runtime_expansions = (Client.runtime_expansions

1766

+ ("dbus_object_path", ))

1767

1768

_interface = "se.recompile.Mandos.Client"

1769

1207

+ ("dbus_object_path",))

1208

1770

1209

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

1771

1772

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

1210

1211

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

1773

1212

self.bus = bus

1774

1213

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

1775

1214

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

1776

1215

# the D-Bus

1777

client_object_name = str(self.name).translate(

1216

client_object_name = unicode(self.name).translate(

1778

1217

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

1779

1218

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

1780

self.dbus_object_path = dbus.ObjectPath(

1781

"/clients/" + client_object_name)

1219

self.dbus_object_path = (dbus.ObjectPath

1220

("/clients/" + client_object_name))

1782

1221

DBusObjectWithProperties.__init__(self, self.bus,

1783

1222

self.dbus_object_path)

1784

1785

def notifychangeproperty(transform_func, dbus_name,

1786

type_func=lambda x: x,

1787

variant_level=1,

1788

invalidate_only=False,

1789

_interface=_interface):

1223

1224

def notifychangeproperty(transform_func,

1225

dbus_name, type_func=lambda x: x,

1226

variant_level=1):

1790

1227

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

1791

1228

its changes to DBus.

1792

1229

1793

1230

transform_fun: Function that takes a value and a variant_level

1794

1231

and transforms it to a D-Bus type.

1795

1232

dbus_name: D-Bus name of the variable

1797

1234

to the D-Bus. Default: no transform

1798

1235

variant_level: D-Bus variant level. Default: 1

1799

1236

"""

1800

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

1801

1237

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

1802

1238

def setter(self, value):

1803

1239

if hasattr(self, "dbus_object_path"):

1804

1240

if (not hasattr(self, attrname) or

1805

1241

type_func(getattr(self, attrname, None))

1806

1242

!= type_func(value)):

1807

if invalidate_only:

1808

self.PropertiesChanged(

1809

_interface, dbus.Dictionary(),

1810

dbus.Array((dbus_name, )))

1811

else:

1812

dbus_value = transform_func(

1813

type_func(value),

1814

variant_level=variant_level)

1815

self.PropertyChanged(dbus.String(dbus_name),

1816

dbus_value)

1817

self.PropertiesChanged(

1818

_interface,

1819

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

1820

dbus_value}),

1821

dbus.Array())

1243

dbus_value = transform_func(type_func(value),

1244

variant_level

1245

=variant_level)

1246

self.PropertyChanged(dbus.String(dbus_name),

1247

dbus_value)

1822

1248

setattr(self, attrname, value)

1823

1249

1824

1250

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

1825

1251

1826

1252

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1827

1253

approvals_pending = notifychangeproperty(dbus.Boolean,

1828

1254

"ApprovalPending",

1829

type_func=bool)

1255

type_func = bool)

1830

1256

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

1831

1257

last_enabled = notifychangeproperty(datetime_to_dbus,

1832

1258

"LastEnabled")

1833

checker = notifychangeproperty(

1834

dbus.Boolean, "CheckerRunning",

1835

type_func=lambda checker: checker is not None)

1259

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

1260

type_func = lambda checker:

1261

checker is not None)

1836

1262

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1837

1263

"LastCheckedOK")

1838

1264

last_checker_status = notifychangeproperty(dbus.Int16,

1841

1267

datetime_to_dbus, "LastApprovalRequest")

1842

1268

approved_by_default = notifychangeproperty(dbus.Boolean,

1843

1269

"ApprovedByDefault")

1844

approval_delay = notifychangeproperty(

1845

dbus.UInt64, "ApprovalDelay",

1846

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

1270

approval_delay = notifychangeproperty(dbus.UInt64,

1271

"ApprovalDelay",

1272

type_func =

1273

timedelta_to_milliseconds)

1847

1274

approval_duration = notifychangeproperty(

1848

1275

dbus.UInt64, "ApprovalDuration",

1849

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

1276

type_func = timedelta_to_milliseconds)

1850

1277

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

1851

timeout = notifychangeproperty(

1852

dbus.UInt64, "Timeout",

1853

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

1278

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

1279

type_func =

1280

timedelta_to_milliseconds)

1854

1281

extended_timeout = notifychangeproperty(

1855

1282

dbus.UInt64, "ExtendedTimeout",

1856

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

1857

interval = notifychangeproperty(

1858

dbus.UInt64, "Interval",

1859

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

1283

type_func = timedelta_to_milliseconds)

1284

interval = notifychangeproperty(dbus.UInt64,

1285

"Interval",

1286

type_func =

1287

timedelta_to_milliseconds)

1860

1288

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

1861

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

1862

invalidate_only=True)

1863

1289

1864

1290

del notifychangeproperty

1865

1291

1866

1292

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

1867

1293

try:

1868

1294

self.remove_from_connection()

1871

1297

if hasattr(DBusObjectWithProperties, "__del__"):

1872

1298

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

1873

1299

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

1874

1875

def checker_callback(self, source, condition,

1876

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

1877

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

1878

connection, command, *args,

1879

**kwargs)

1880

exitstatus = self.last_checker_status

1881

if exitstatus >= 0:

1300

1301

def checker_callback(self, pid, condition, command,

1302

*args, **kwargs):

1303

self.checker_callback_tag = None

1304

self.checker = None

1305

if os.WIFEXITED(condition):

1306

exitstatus = os.WEXITSTATUS(condition)

1882

1307

# Emit D-Bus signal

1883

1308

self.CheckerCompleted(dbus.Int16(exitstatus),

1884

# This is specific to GNU libC

1885

dbus.Int64(exitstatus << 8),

1309

dbus.Int64(condition),

1886

1310

dbus.String(command))

1887

1311

else:

1888

1312

# Emit D-Bus signal

1889

1313

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

1890

dbus.Int64(

1891

# This is specific to GNU libC

1892

(exitstatus << 8)

1893

| self.last_checker_signal),

1314

dbus.Int64(condition),

1894

1315

dbus.String(command))

1895

return ret

1896

1316

1317

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

1318

*args, **kwargs)

1319

1897

1320

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

1898

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

1321

old_checker = self.checker

1322

if self.checker is not None:

1323

old_checker_pid = self.checker.pid

1324

else:

1325

old_checker_pid = None

1899

1326

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

1900

1327

# Only if new checker process was started

1901

1328

if (self.checker is not None

1903

1330

# Emit D-Bus signal

1904

1331

self.CheckerStarted(self.current_checker_command)

1905

1332

return r

1906

1333

1907

1334

def _reset_approved(self):

1908

1335

self.approved = None

1909

1336

return False

1910

1337

1911

1338

def approve(self, value=True):

1912

1339

self.approved = value

1913

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

1914

* 1000), self._reset_approved)

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1915

1343

self.send_changedstate()

1916

1917

# D-Bus methods, signals & properties

1918

1919

# Interfaces

1920

1921

# Signals

1922

1344

1345

## D-Bus methods, signals & properties

1346

_interface = "se.recompile.Mandos.Client"

1347

1348

## Interfaces

1349

1350

@dbus_interface_annotations(_interface)

1351

def _foo(self):

1352

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

1353

"false"}

1354

1355

## Signals

1356

1923

1357

# CheckerCompleted - signal

1924

1358

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

1925

1359

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

1926

1360

"D-Bus signal"

1927

1361

pass

1928

1362

1929

1363

# CheckerStarted - signal

1930

1364

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

1931

1365

def CheckerStarted(self, command):

1932

1366

"D-Bus signal"

1933

1367

pass

1934

1368

1935

1369

# PropertyChanged - signal

1936

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

1937

1370

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

1938

1371

def PropertyChanged(self, property, value):

1939

1372

"D-Bus signal"

1940

1373

pass

1941

1374

1942

1375

# GotSecret - signal

1943

1376

@dbus.service.signal(_interface)

1944

1377

def GotSecret(self):

1947

1380

server to mandos-client

1948

1381

"""

1949

1382

pass

1950

1383

1951

1384

# Rejected - signal

1952

1385

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

1953

1386

def Rejected(self, reason):

1954

1387

"D-Bus signal"

1955

1388

pass

1956

1389

1957

1390

# NeedApproval - signal

1958

1391

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

1959

1392

def NeedApproval(self, timeout, default):

1960

1393

"D-Bus signal"

1961

1394

return self.need_approval()

1962

1963

# Methods

1964

1395

1396

## Methods

1397

1965

1398

# Approve - method

1966

1399

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

1967

1400

def Approve(self, value):

1968

1401

self.approve(value)

1969

1402

1970

1403

# CheckedOK - method

1971

1404

@dbus.service.method(_interface)

1972

1405

def CheckedOK(self):

1973

1406

self.checked_ok()

1974

1407

1975

1408

# Enable - method

1976

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

1977

1409

@dbus.service.method(_interface)

1978

1410

def Enable(self):

1979

1411

"D-Bus method"

1980

1412

self.enable()

1981

1413

1982

1414

# StartChecker - method

1983

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

1984

1415

@dbus.service.method(_interface)

1985

1416

def StartChecker(self):

1986

1417

"D-Bus method"

1987

1418

self.start_checker()

1988

1419

1989

1420

# Disable - method

1990

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

1991

1421

@dbus.service.method(_interface)

1992

1422

def Disable(self):

1993

1423

"D-Bus method"

1994

1424

self.disable()

1995

1425

1996

1426

# StopChecker - method

1997

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

1998

1427

@dbus.service.method(_interface)

1999

1428

def StopChecker(self):

2000

1429

self.stop_checker()

2001

2002

# Properties

2003

1430

1431

## Properties

1432

2004

1433

# ApprovalPending - property

2005

1434

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

2006

1435

def ApprovalPending_dbus_property(self):

2007

1436

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

2008

1437

2009

1438

# ApprovedByDefault - property

2010

@dbus_service_property(_interface,

2011

signature="b",

1439

@dbus_service_property(_interface, signature="b",

2012

1440

access="readwrite")

2013

1441

def ApprovedByDefault_dbus_property(self, value=None):

2014

1442

if value is None: # get

2015

1443

return dbus.Boolean(self.approved_by_default)

2016

1444

self.approved_by_default = bool(value)

2017

1445

2018

1446

# ApprovalDelay - property

2019

@dbus_service_property(_interface,

2020

signature="t",

1447

@dbus_service_property(_interface, signature="t",

2021

1448

access="readwrite")

2022

1449

def ApprovalDelay_dbus_property(self, value=None):

2023

1450

if value is None: # get

2024

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

2025

* 1000)

1451

return dbus.UInt64(self.approval_delay_milliseconds())

2026

1452

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

2027

1453

2028

1454

# ApprovalDuration - property

2029

@dbus_service_property(_interface,

2030

signature="t",

1455

@dbus_service_property(_interface, signature="t",

2031

1456

access="readwrite")

2032

1457

def ApprovalDuration_dbus_property(self, value=None):

2033

1458

if value is None: # get

2034

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

2035

* 1000)

1459

return dbus.UInt64(timedelta_to_milliseconds(

1460

self.approval_duration))

2036

1461

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

2037

1462

2038

1463

# Name - property

2039

@dbus_annotations(

2040

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

2041

1464

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

2042

1465

def Name_dbus_property(self):

2043

1466

return dbus.String(self.name)

2044

2045

# KeyID - property

2046

@dbus_annotations(

2047

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

2048

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

2049

def KeyID_dbus_property(self):

2050

return dbus.String(self.key_id)

2051

1467

2052

1468

# Fingerprint - property

2053

@dbus_annotations(

2054

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

2055

1469

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

2056

1470

def Fingerprint_dbus_property(self):

2057

1471

return dbus.String(self.fingerprint)

2058

1472

2059

1473

# Host - property

2060

@dbus_service_property(_interface,

2061

signature="s",

1474

@dbus_service_property(_interface, signature="s",

2062

1475

access="readwrite")

2063

1476

def Host_dbus_property(self, value=None):

2064

1477

if value is None: # get

2065

1478

return dbus.String(self.host)

2066

self.host = str(value)

2067

1479

self.host = unicode(value)

1480

2068

1481

# Created - property

2069

@dbus_annotations(

2070

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

2071

1482

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

2072

1483

def Created_dbus_property(self):

2073

1484

return datetime_to_dbus(self.created)

2074

1485

2075

1486

# LastEnabled - property

2076

1487

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

2077

1488

def LastEnabled_dbus_property(self):

2078

1489

return datetime_to_dbus(self.last_enabled)

2079

1490

2080

1491

# Enabled - property

2081

@dbus_service_property(_interface,

2082

signature="b",

1492

@dbus_service_property(_interface, signature="b",

2083

1493

access="readwrite")

2084

1494

def Enabled_dbus_property(self, value=None):

2085

1495

if value is None: # get

2088

1498

self.enable()

2089

1499

else:

2090

1500

self.disable()

2091

1501

2092

1502

# LastCheckedOK - property

2093

@dbus_service_property(_interface,

2094

signature="s",

1503

@dbus_service_property(_interface, signature="s",

2095

1504

access="readwrite")

2096

1505

def LastCheckedOK_dbus_property(self, value=None):

2097

1506

if value is not None:

2098

1507

self.checked_ok()

2099

1508

return

2100

1509

return datetime_to_dbus(self.last_checked_ok)

2101

1510

2102

1511

# LastCheckerStatus - property

2103

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

1512

@dbus_service_property(_interface, signature="n",

1513

access="read")

2104

1514

def LastCheckerStatus_dbus_property(self):

2105

1515

return dbus.Int16(self.last_checker_status)

2106

1516

2107

1517

# Expires - property

2108

1518

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

2109

1519

def Expires_dbus_property(self):

2110

1520

return datetime_to_dbus(self.expires)

2111

1521

2112

1522

# LastApprovalRequest - property

2113

1523

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

2114

1524

def LastApprovalRequest_dbus_property(self):

2115

1525

return datetime_to_dbus(self.last_approval_request)

2116

1526

2117

1527

# Timeout - property

2118

@dbus_service_property(_interface,

2119

signature="t",

1528

@dbus_service_property(_interface, signature="t",

2120

1529

access="readwrite")

2121

1530

def Timeout_dbus_property(self, value=None):

2122

1531

if value is None: # get

2123

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

1532

return dbus.UInt64(self.timeout_milliseconds())

2124

1533

old_timeout = self.timeout

2125

1534

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

2126

1535

# Reschedule disabling

2134

1543

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

2135

1544

is None):

2136

1545

return

2137

GLib.source_remove(self.disable_initiator_tag)

2138

self.disable_initiator_tag = GLib.timeout_add(

2139

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

2140

self.disable)

2141

1546

gobject.source_remove(self.disable_initiator_tag)

1547

self.disable_initiator_tag = (

1548

gobject.timeout_add(

1549

timedelta_to_milliseconds(self.expires - now),

1550

self.disable))

1551

2142

1552

# ExtendedTimeout - property

2143

@dbus_service_property(_interface,

2144

signature="t",

1553

@dbus_service_property(_interface, signature="t",

2145

1554

access="readwrite")

2146

1555

def ExtendedTimeout_dbus_property(self, value=None):

2147

1556

if value is None: # get

2148

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

2149

* 1000)

1557

return dbus.UInt64(self.extended_timeout_milliseconds())

2150

1558

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

2151

1559

2152

1560

# Interval - property

2153

@dbus_service_property(_interface,

2154

signature="t",

1561

@dbus_service_property(_interface, signature="t",

2155

1562

access="readwrite")

2156

1563

def Interval_dbus_property(self, value=None):

2157

1564

if value is None: # get

2158

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

1565

return dbus.UInt64(self.interval_milliseconds())

2159

1566

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

2160

1567

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

2161

1568

return

2162

1569

if self.enabled:

2163

1570

# Reschedule checker run

2164

GLib.source_remove(self.checker_initiator_tag)

2165

self.checker_initiator_tag = GLib.timeout_add(

2166

value, self.start_checker)

2167

self.start_checker() # Start one now, too

2168

1571

gobject.source_remove(self.checker_initiator_tag)

1572

self.checker_initiator_tag = (gobject.timeout_add

1573

(value, self.start_checker))

1574

self.start_checker() # Start one now, too

1575

2169

1576

# Checker - property

2170

@dbus_service_property(_interface,

2171

signature="s",

1577

@dbus_service_property(_interface, signature="s",

2172

1578

access="readwrite")

2173

1579

def Checker_dbus_property(self, value=None):

2174

1580

if value is None: # get

2175

1581

return dbus.String(self.checker_command)

2176

self.checker_command = str(value)

2177

1582

self.checker_command = unicode(value)

1583

2178

1584

# CheckerRunning - property

2179

@dbus_service_property(_interface,

2180

signature="b",

1585

@dbus_service_property(_interface, signature="b",

2181

1586

access="readwrite")

2182

1587

def CheckerRunning_dbus_property(self, value=None):

2183

1588

if value is None: # get

2186

1591

self.start_checker()

2187

1592

else:

2188

1593

self.stop_checker()

2189

1594

2190

1595

# ObjectPath - property

2191

@dbus_annotations(

2192

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

2193

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

2194

1596

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

2195

1597

def ObjectPath_dbus_property(self):

2196

return self.dbus_object_path # is already a dbus.ObjectPath

2197

1598

return self.dbus_object_path # is already a dbus.ObjectPath

1599

2198

1600

# Secret = property

2199

@dbus_annotations(

2200

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

2201

"invalidates"})

2202

@dbus_service_property(_interface,

2203

signature="ay",

2204

access="write",

2205

byte_arrays=True)

1601

@dbus_service_property(_interface, signature="ay",

1602

access="write", byte_arrays=True)

2206

1603

def Secret_dbus_property(self, value):

2207

self.secret = bytes(value)

2208

1604

self.secret = str(value)

1605

2209

1606

del _interface

2210

1607

2211

1608

2212

1609

class ProxyClient(object):

2213

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

1610

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

2214

1611

self._pipe = child_pipe

2215

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

1612

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

2216

1613

if not self._pipe.recv():

2217

raise KeyError(key_id or fpr)

2218

1614

raise KeyError()

1615

2219

1616

def __getattribute__(self, name):

2220

1617

if name == '_pipe':

2221

1618

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

2224

1621

if data[0] == 'data':

2225

1622

return data[1]

2226

1623

if data[0] == 'function':

2227

2228

1624

def func(*args, **kwargs):

2229

1625

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

2230

1626

return self._pipe.recv()[1]

2231

2232

1627

return func

2233

1628

2234

1629

def __setattr__(self, name, value):

2235

1630

if name == '_pipe':

2236

1631

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

2239

1634

2240

1635

class ClientHandler(socketserver.BaseRequestHandler, object):

2241

1636

"""A class to handle client connections.

2242

1637

2243

1638

Instantiated once for each connection to handle it.

2244

1639

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

2245

1640

2246

1641

def handle(self):

2247

1642

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

2248

1643

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

2249

str(self.client_address))

1644

unicode(self.client_address))

2250

1645

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

2251

1646

self.server.child_pipe.fileno())

2252

2253

session = gnutls.ClientSession(self.request)

2254

2255

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

2256

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

2257

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

2258

# "+DHE-DSS"))

1647

1648

session = (gnutls.connection

1649

.ClientSession(self.request,

1650

gnutls.connection

1651

.X509Credentials()))

1652

1653

# Note: gnutls.connection.X509Credentials is really a

1654

# generic GnuTLS certificate credentials object so long as

1655

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

1656

# here despite using OpenPGP certificates.

1657

1658

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

1659

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

1660

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

1661

# "+DHE-DSS"))

2259

1662

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

2260

1663

priority = self.server.gnutls_priority

2261

1664

if priority is None:

2262

1665

priority = "NORMAL"

2263

gnutls.priority_set_direct(session._c_object,

2264

priority.encode("utf-8"),

2265

None)

2266

1666

(gnutls.library.functions

1667

.gnutls_priority_set_direct(session._c_object,

1668

priority, None))

1669

2267

1670

# Start communication using the Mandos protocol

2268

1671

# Get protocol number

2269

1672

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

2270

1673

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

2271

1674

try:

2272

1675

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

2273

raise RuntimeError(line)

1676

raise RuntimeError

2274

1677

except (ValueError, IndexError, RuntimeError) as error:

2275

1678

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

2276

1679

return

2277

1680

2278

1681

# Start GnuTLS connection

2279

1682

try:

2280

1683

session.handshake()

2281

except gnutls.Error as error:

1684

except gnutls.errors.GNUTLSError as error:

2282

1685

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

2283

1686

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

2284

1687

# established. Just abandon the request.

2285

1688

return

2286

1689

logger.debug("Handshake succeeded")

2287

1690

2288

1691

approval_required = False

2289

1692

try:

2290

if gnutls.has_rawpk:

2291

fpr = b""

2292

try:

2293

key_id = self.key_id(

2294

self.peer_certificate(session))

2295

except (TypeError, gnutls.Error) as error:

2296

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

2297

return

2298

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

2299

2300

else:

2301

key_id = b""

2302

try:

2303

fpr = self.fingerprint(

2304

self.peer_certificate(session))

2305

except (TypeError, gnutls.Error) as error:

2306

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

2307

return

2308

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

2309

2310

try:

2311

client = ProxyClient(child_pipe, key_id, fpr,

1693

try:

1694

fpr = self.fingerprint(self.peer_certificate

1695

(session))

1696

except (TypeError,

1697

gnutls.errors.GNUTLSError) as error:

1698

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

1699

return

1700

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

1701

1702

try:

1703

client = ProxyClient(child_pipe, fpr,

2312

1704

self.client_address)

2313

1705

except KeyError:

2314

1706

return

2315

1707

2316

1708

if client.approval_delay:

2317

1709

delay = client.approval_delay

2318

1710

client.approvals_pending += 1

2319

1711

approval_required = True

2320

1712

2321

1713

while True:

2322

1714

if not client.enabled:

2323

1715

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

2324

client.name)

1716

client.name)

2325

1717

if self.server.use_dbus:

2326

1718

# Emit D-Bus signal

2327

1719

client.Rejected("Disabled")

2328

1720

return

2329

1721

2330

1722

if client.approved or not client.approval_delay:

2331

# We are approved or approval is disabled

1723

#We are approved or approval is disabled

2332

1724

break

2333

1725

elif client.approved is None:

2334

1726

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

2336

1728

if self.server.use_dbus:

2337

1729

# Emit D-Bus signal

2338

1730

client.NeedApproval(

2339

client.approval_delay.total_seconds()

2340

* 1000, client.approved_by_default)

1731

client.approval_delay_milliseconds(),

1732

client.approved_by_default)

2341

1733

else:

2342

1734

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

2343

1735

client.name)

2345

1737

# Emit D-Bus signal

2346

1738

client.Rejected("Denied")

2347

1739

return

2348

2349

# wait until timeout or approved

1740

1741

#wait until timeout or approved

2350

1742

time = datetime.datetime.now()

2351

1743

client.changedstate.acquire()

2352

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

1744

client.changedstate.wait(

1745

float(timedelta_to_milliseconds(delay)

1746

/ 1000))

2353

1747

client.changedstate.release()

2354

1748

time2 = datetime.datetime.now()

2355

1749

if (time2 - time) >= delay:

2365

1759

break

2366

1760

else:

2367

1761

delay -= time2 - time

2368

2369

try:

2370

session.send(client.secret)

2371

except gnutls.Error as error:

2372

logger.warning("gnutls send failed",

2373

exc_info=error)

2374

return

2375

1762

1763

sent_size = 0

1764

while sent_size < len(client.secret):

1765

try:

1766

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

1767

except gnutls.errors.GNUTLSError as error:

1768

logger.warning("gnutls send failed",

1769

exc_info=error)

1770

return

1771

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

1772

sent, len(client.secret)

1773

- (sent_size + sent))

1774

sent_size += sent

1775

2376

1776

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

2377

1777

# bump the timeout using extended_timeout

2378

1778

client.bump_timeout(client.extended_timeout)

2379

1779

if self.server.use_dbus:

2380

1780

# Emit D-Bus signal

2381

1781

client.GotSecret()

2382

1782

2383

1783

finally:

2384

1784

if approval_required:

2385

1785

client.approvals_pending -= 1

2386

1786

try:

2387

1787

session.bye()

2388

except gnutls.Error as error:

1788

except gnutls.errors.GNUTLSError as error:

2389

1789

logger.warning("GnuTLS bye failed",

2390

1790

exc_info=error)

2391

1791

2392

1792

@staticmethod

2393

1793

def peer_certificate(session):

2394

"Return the peer's certificate as a bytestring"

2395

try:

2396

cert_type = gnutls.certificate_type_get2(session._c_object,

2397

gnutls.CTYPE_PEERS)

2398

except AttributeError:

2399

cert_type = gnutls.certificate_type_get(session._c_object)

2400

if gnutls.has_rawpk:

2401

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2402

else:

2403

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2404

# If not a valid certificate type...

2405

if cert_type not in valid_cert_types:

2406

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

2407

valid_cert_types)

2408

# ...return invalid data

2409

return b""

1794

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

1795

# If not an OpenPGP certificate...

1796

if (gnutls.library.functions

1797

.gnutls_certificate_type_get(session._c_object)

1798

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1799

# ...do the normal thing

1800

return session.peer_certificate

2410

1801

list_size = ctypes.c_uint(1)

2411

cert_list = (gnutls.certificate_get_peers

1802

cert_list = (gnutls.library.functions

1803

.gnutls_certificate_get_peers

2412

1804

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

2413

1805

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

2414

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

1806

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

1807

" certificate")

2415

1808

if list_size.value == 0:

2416

1809

return None

2417

1810

cert = cert_list[0]

2418

1811

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

2419

2420

@staticmethod

2421

def key_id(certificate):

2422

"Convert a certificate bytestring to a hexdigit key ID"

2423

# New GnuTLS "datum" with the public key

2424

datum = gnutls.datum_t(

2425

ctypes.cast(ctypes.c_char_p(certificate),

2426

ctypes.POINTER(ctypes.c_ubyte)),

2427

ctypes.c_uint(len(certificate)))

2428

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

2429

# New empty GnuTLS certificate

2430

pubkey = gnutls.pubkey_t()

2431

gnutls.pubkey_init(ctypes.byref(pubkey))

2432

# Import the raw public key into the certificate

2433

gnutls.pubkey_import(pubkey,

2434

ctypes.byref(datum),

2435

gnutls.X509_FMT_DER)

2436

# New buffer for the key ID

2437

buf = ctypes.create_string_buffer(32)

2438

buf_len = ctypes.c_size_t(len(buf))

2439

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

2440

gnutls.pubkey_get_key_id(pubkey,

2441

gnutls.KEYID_USE_SHA256,

2442

ctypes.cast(ctypes.byref(buf),

2443

ctypes.POINTER(ctypes.c_ubyte)),

2444

ctypes.byref(buf_len))

2445

# Deinit the certificate

2446

gnutls.pubkey_deinit(pubkey)

2447

2448

# Convert the buffer to a Python bytestring

2449

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

2450

# Convert the bytestring to hexadecimal notation

2451

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

2452

return hex_key_id

2453

1812

2454

1813

@staticmethod

2455

1814

def fingerprint(openpgp):

2456

1815

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2457

1816

# New GnuTLS "datum" with the OpenPGP public key

2458

datum = gnutls.datum_t(

2459

ctypes.cast(ctypes.c_char_p(openpgp),

2460

ctypes.POINTER(ctypes.c_ubyte)),

2461

ctypes.c_uint(len(openpgp)))

1817

datum = (gnutls.library.types

1818

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

1819

ctypes.POINTER

1820

(ctypes.c_ubyte)),

1821

ctypes.c_uint(len(openpgp))))

2462

1822

# New empty GnuTLS certificate

2463

crt = gnutls.openpgp_crt_t()

2464

gnutls.openpgp_crt_init(ctypes.byref(crt))

1823

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1824

(gnutls.library.functions

1825

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2465

1826

# Import the OpenPGP public key into the certificate

2466

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

2467

gnutls.OPENPGP_FMT_RAW)

1827

(gnutls.library.functions

1828

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

1829

gnutls.library.constants

1830

.GNUTLS_OPENPGP_FMT_RAW))

2468

1831

# Verify the self signature in the key

2469

1832

crtverify = ctypes.c_uint()

2470

gnutls.openpgp_crt_verify_self(crt, 0,

2471

ctypes.byref(crtverify))

1833

(gnutls.library.functions

1834

.gnutls_openpgp_crt_verify_self(crt, 0,

1835

ctypes.byref(crtverify)))

2472

1836

if crtverify.value != 0:

2473

gnutls.openpgp_crt_deinit(crt)

2474

raise gnutls.CertificateSecurityError(code

2475

=crtverify.value)

1837

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1838

raise (gnutls.errors.CertificateSecurityError

1839

("Verify failed"))

2476

1840

# New buffer for the fingerprint

2477

1841

buf = ctypes.create_string_buffer(20)

2478

1842

buf_len = ctypes.c_size_t()

2479

1843

# Get the fingerprint from the certificate into the buffer

2480

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

2481

ctypes.byref(buf_len))

1844

(gnutls.library.functions

1845

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

1846

ctypes.byref(buf_len)))

2482

1847

# Deinit the certificate

2483

gnutls.openpgp_crt_deinit(crt)

1848

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2484

1849

# Convert the buffer to a Python bytestring

2485

1850

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

2486

1851

# Convert the bytestring to hexadecimal notation

2490

1855

2491

1856

class MultiprocessingMixIn(object):

2492

1857

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

2493

2494

1858

def sub_process_main(self, request, address):

2495

1859

try:

2496

1860

self.finish_request(request, address)

2497

1861

except Exception:

2498

1862

self.handle_error(request, address)

2499

1863

self.close_request(request)

2500

1864

2501

1865

def process_request(self, request, address):

2502

1866

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

2503

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

2504

args=(request, address))

1867

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

1868

args = (request, address))

2505

1869

proc.start()

2506

1870

return proc

2507

1871

2508

1872

2509

1873

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2510

1874

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

2511

2512

1875

def process_request(self, request, client_address):

2513

1876

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

2514

1877

2515

1878

This function creates a new pipe in self.pipe

2516

1879

"""

2517

1880

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2518

1881

2519

1882

proc = MultiprocessingMixIn.process_request(self, request,

2520

1883

client_address)

2521

1884

self.child_pipe.close()

2522

1885

self.add_pipe(parent_pipe, proc)

2523

1886

2524

1887

def add_pipe(self, parent_pipe, proc):

2525

1888

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

2526

raise NotImplementedError()

1889

raise NotImplementedError

2527

1890

2528

1891

2529

1892

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2530

1893

socketserver.TCPServer, object):

2531

1894

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

2532

1895

2533

1896

Attributes:

2534

1897

enabled: Boolean; whether this server is activated yet

2535

1898

interface: None or a network interface name (string)

2536

1899

use_ipv6: Boolean; to use IPv6 or not

2537

1900

"""

2538

2539

1901

def __init__(self, server_address, RequestHandlerClass,

2540

interface=None,

2541

use_ipv6=True,

2542

socketfd=None):

2543

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

2544

creating a new one with socket.socket().

2545

"""

1902

interface=None, use_ipv6=True):

2546

1903

self.interface = interface

2547

1904

if use_ipv6:

2548

1905

self.address_family = socket.AF_INET6

2549

if socketfd is not None:

2550

# Save the file descriptor

2551

self.socketfd = socketfd

2552

# Save the original socket.socket() function

2553

self.socket_socket = socket.socket

2554

2555

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

2556

#

2557

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

2558

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

2559

# patching socket.socket.)

2560

#

2561

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

2562

@functools.wraps(socket.socket)

2563

def socket_wrapper(*args, **kwargs):

2564

# Restore original function so subsequent calls are

2565

# not affected.

2566

socket.socket = self.socket_socket

2567

del self.socket_socket

2568

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

2569

# saved file descriptor.

2570

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

2571

# Replace socket.socket() function with wrapper

2572

socket.socket = socket_wrapper

2573

# The socketserver.TCPServer.__init__ will call

2574

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

2575

# socket_wrapper(), if socketfd was set.

2576

1906

socketserver.TCPServer.__init__(self, server_address,

2577

1907

RequestHandlerClass)

2578

2579

1908

def server_bind(self):

2580

1909

"""This overrides the normal server_bind() function

2581

1910

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

2582

1911

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

2583

global SO_BINDTODEVICE

2584

1912

if self.interface is not None:

2585

1913

if SO_BINDTODEVICE is None:

2586

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

2587

# common enough.

2588

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

2589

SO_BINDTODEVICE = 25

2590

try:

2591

self.socket.setsockopt(

2592

socket.SOL_SOCKET, SO_BINDTODEVICE,

2593

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

2594

except socket.error as error:

2595

if error.errno == errno.EPERM:

2596

logger.error("No permission to bind to"

2597

" interface %s", self.interface)

2598

elif error.errno == errno.ENOPROTOOPT:

2599

logger.error("SO_BINDTODEVICE not available;"

2600

" cannot bind to interface %s",

2601

self.interface)

2602

elif error.errno == errno.ENODEV:

2603

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

2604

" cannot bind", self.interface)

2605

else:

2606

raise

1914

logger.error("SO_BINDTODEVICE does not exist;"

1915

" cannot bind to interface %s",

1916

self.interface)

1917

else:

1918

try:

1919

self.socket.setsockopt(socket.SOL_SOCKET,

1920

SO_BINDTODEVICE,

1921

str(self.interface

1922

+ '\0'))

1923

except socket.error as error:

1924

if error.errno == errno.EPERM:

1925

logger.error("No permission to"

1926

" bind to interface %s",

1927

self.interface)

1928

elif error.errno == errno.ENOPROTOOPT:

1929

logger.error("SO_BINDTODEVICE not available;"

1930

" cannot bind to interface %s",

1931

self.interface)

1932

elif error.errno == errno.ENODEV:

1933

logger.error("Interface %s does not"

1934

" exist, cannot bind",

1935

self.interface)

1936

else:

1937

raise

2607

1938

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

2608

1939

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

2609

if self.server_address[1]:

2610

self.allow_reuse_address = True

2611

1940

if not self.server_address[0]:

2612

1941

if self.address_family == socket.AF_INET6:

2613

any_address = "::" # in6addr_any

1942

any_address = "::" # in6addr_any

2614

1943

else:

2615

any_address = "0.0.0.0" # INADDR_ANY

1944

any_address = socket.INADDR_ANY

2616

1945

self.server_address = (any_address,

2617

1946

self.server_address[1])

2618

1947

elif not self.server_address[1]:

2619

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

1948

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

1949

0)

2620

1950

# if self.interface:

2621

1951

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

2622

1952

# 0, # port

2628

1958

2629

1959

class MandosServer(IPv6_TCPServer):

2630

1960

"""Mandos server.

2631

1961

2632

1962

Attributes:

2633

1963

clients: set of Client objects

2634

1964

gnutls_priority GnuTLS priority string

2635

1965

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

2636

2637

Assumes a GLib.MainLoop event loop.

1966

1967

Assumes a gobject.MainLoop event loop.

2638

1968

"""

2639

2640

1969

def __init__(self, server_address, RequestHandlerClass,

2641

interface=None,

2642

use_ipv6=True,

2643

clients=None,

2644

gnutls_priority=None,

2645

use_dbus=True,

2646

socketfd=None):

1970

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

1971

gnutls_priority=None, use_dbus=True):

2647

1972

self.enabled = False

2648

1973

self.clients = clients

2649

1974

if self.clients is None:

2652

1977

self.gnutls_priority = gnutls_priority

2653

1978

IPv6_TCPServer.__init__(self, server_address,

2654

1979

RequestHandlerClass,

2655

interface=interface,

2656

use_ipv6=use_ipv6,

2657

socketfd=socketfd)

2658

1980

interface = interface,

1981

use_ipv6 = use_ipv6)

2659

1982

def server_activate(self):

2660

1983

if self.enabled:

2661

1984

return socketserver.TCPServer.server_activate(self)

2662

1985

2663

1986

def enable(self):

2664

1987

self.enabled = True

2665

1988

2666

1989

def add_pipe(self, parent_pipe, proc):

2667

1990

# Call "handle_ipc" for both data and EOF events

2668

GLib.io_add_watch(

2669

parent_pipe.fileno(),

2670

GLib.IO_IN | GLib.IO_HUP,

2671

functools.partial(self.handle_ipc,

2672

parent_pipe=parent_pipe,

2673

proc=proc))

2674

2675

def handle_ipc(self, source, condition,

2676

parent_pipe=None,

2677

proc=None,

2678

client_object=None):

1991

gobject.io_add_watch(parent_pipe.fileno(),

1992

gobject.IO_IN | gobject.IO_HUP,

1993

functools.partial(self.handle_ipc,

1994

parent_pipe =

1995

parent_pipe,

1996

proc = proc))

1997

1998

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

1999

proc = None, client_object=None):

2679

2000

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

2680

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

2001

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

2681

2002

# Wait for other process to exit

2682

2003

proc.join()

2683

2004

return False

2684

2005

2685

2006

# Read a request from the child

2686

2007

request = parent_pipe.recv()

2687

2008

command = request[0]

2688

2009

2689

2010

if command == 'init':

2690

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

2691

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

2692

address = request[3]

2693

2694

for c in self.clients.values():

2695

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2696

continue

2697

if key_id and c.key_id == key_id:

2698

client = c

2699

break

2700

if fpr and c.fingerprint == fpr:

2011

fpr = request[1]

2012

address = request[2]

2013

2014

for c in self.clients.itervalues():

2015

if c.fingerprint == fpr:

2701

2016

client = c

2702

2017

break

2703

2018

else:

2704

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

2705

": %s", key_id or fpr, address)

2019

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

2020

"dress: %s", fpr, address)

2706

2021

if self.use_dbus:

2707

2022

# Emit D-Bus signal

2708

mandos_dbus_service.ClientNotFound(key_id or fpr,

2023

mandos_dbus_service.ClientNotFound(fpr,

2709

2024

address[0])

2710

2025

parent_pipe.send(False)

2711

2026

return False

2712

2713

GLib.io_add_watch(

2714

parent_pipe.fileno(),

2715

GLib.IO_IN | GLib.IO_HUP,

2716

functools.partial(self.handle_ipc,

2717

parent_pipe=parent_pipe,

2718

proc=proc,

2719

client_object=client))

2027

2028

gobject.io_add_watch(parent_pipe.fileno(),

2029

gobject.IO_IN | gobject.IO_HUP,

2030

functools.partial(self.handle_ipc,

2031

parent_pipe =

2032

parent_pipe,

2033

proc = proc,

2034

client_object =

2035

client))

2720

2036

parent_pipe.send(True)

2721

2037

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

2722

2038

# same fileno

2725

2041

funcname = request[1]

2726

2042

args = request[2]

2727

2043

kwargs = request[3]

2728

2044

2729

2045

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

2730

2046

funcname)(*args,

2731

**kwargs)))

2732

2047

**kwargs)))

2048

2733

2049

if command == 'getattr':

2734

2050

attrname = request[1]

2735

if isinstance(client_object.__getattribute__(attrname),

2736

collections.Callable):

2737

parent_pipe.send(('function', ))

2051

if callable(client_object.__getattribute__(attrname)):

2052

parent_pipe.send(('function',))

2738

2053

else:

2739

parent_pipe.send((

2740

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

2741

2054

parent_pipe.send(('data', client_object

2055

.__getattribute__(attrname)))

2056

2742

2057

if command == 'setattr':

2743

2058

attrname = request[1]

2744

2059

value = request[2]

2745

2060

setattr(client_object, attrname, value)

2746

2061

2747

2062

return True

2748

2063

2749

2064

2750

def rfc3339_duration_to_delta(duration):

2751

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

2752

2753

>>> rfc3339_duration_to_delta("P7D")

2754

datetime.timedelta(7)

2755

>>> rfc3339_duration_to_delta("PT60S")

2756

datetime.timedelta(0, 60)

2757

>>> rfc3339_duration_to_delta("PT60M")

2758

datetime.timedelta(0, 3600)

2759

>>> rfc3339_duration_to_delta("PT24H")

2760

datetime.timedelta(1)

2761

>>> rfc3339_duration_to_delta("P1W")

2762

datetime.timedelta(7)

2763

>>> rfc3339_duration_to_delta("PT5M30S")

2764

datetime.timedelta(0, 330)

2765

>>> rfc3339_duration_to_delta("P1DT3M20S")

2766

datetime.timedelta(1, 200)

2767

"""

2768

2769

# Parsing an RFC 3339 duration with regular expressions is not

2770

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

2771

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

2772

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

2773

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

2774

# avoid excessive use of external libraries.

2775

2776

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

2777

Token = collections.namedtuple("Token", (

2778

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

2779

# a "group" containing digits

2780

"value", # datetime.timedelta or None

2781

"followers")) # Tokens valid after this token

2782

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

2783

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

2784

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

2785

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

2786

datetime.timedelta(seconds=1),

2787

frozenset((token_end, )))

2788

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

2789

datetime.timedelta(minutes=1),

2790

frozenset((token_second, token_end)))

2791

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

2792

datetime.timedelta(hours=1),

2793

frozenset((token_minute, token_end)))

2794

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

2795

None,

2796

frozenset((token_hour, token_minute,

2797

token_second)))

2798

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

2799

datetime.timedelta(days=1),

2800

frozenset((token_time, token_end)))

2801

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

2802

datetime.timedelta(weeks=4),

2803

frozenset((token_day, token_end)))

2804

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

2805

datetime.timedelta(weeks=52),

2806

frozenset((token_month, token_end)))

2807

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

2808

datetime.timedelta(weeks=1),

2809

frozenset((token_end, )))

2810

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

2811

frozenset((token_year, token_month,

2812

token_day, token_time,

2813

token_week)))

2814

# Define starting values:

2815

# Value so far

2816

value = datetime.timedelta()

2817

found_token = None

2818

# Following valid tokens

2819

followers = frozenset((token_duration, ))

2820

# String left to parse

2821

s = duration

2822

# Loop until end token is found

2823

while found_token is not token_end:

2824

# Search for any currently valid tokens

2825

for token in followers:

2826

match = token.regexp.match(s)

2827

if match is not None:

2828

# Token found

2829

if token.value is not None:

2830

# Value found, parse digits

2831

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

2832

# Add to value so far

2833

value += factor * token.value

2834

# Strip token from string

2835

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

2836

# Go to found token

2837

found_token = token

2838

# Set valid next tokens

2839

followers = found_token.followers

2840

break

2841

else:

2842

# No currently valid tokens were found

2843

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

2844

.format(duration))

2845

# End token found

2846

return value

2847

2848

2849

2065

def string_to_delta(interval):

2850

2066

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

2851

2067

2852

2068

>>> string_to_delta('7d')

2853

2069

datetime.timedelta(7)

2854

2070

>>> string_to_delta('60s')

2862

2078

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

2863

2079

datetime.timedelta(0, 330)

2864

2080

"""

2865

2866

try:

2867

return rfc3339_duration_to_delta(interval)

2868

except ValueError:

2869

pass

2870

2871

2081

timevalue = datetime.timedelta(0)

2872

2082

for s in interval.split():

2873

2083

try:

2874

suffix = s[-1]

2084

suffix = unicode(s[-1])

2875

2085

value = int(s[:-1])

2876

2086

if suffix == "d":

2877

2087

delta = datetime.timedelta(value)

2884

2094

elif suffix == "w":

2885

2095

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

2886

2096

else:

2887

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

2888

except IndexError as e:

2097

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

2098

.format(suffix))

2099

except (ValueError, IndexError) as e:

2889

2100

raise ValueError(*(e.args))

2890

2101

timevalue += delta

2891

2102

return timevalue

2892

2103

2893

2104

2894

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

2105

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

2895

2106

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

2896

2107

2897

2108

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

2898

2109

if os.fork():

2899

2110

sys.exit()

2907

2118

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

2908

2119

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

2909

2120

raise OSError(errno.ENODEV,

2910

"{} not a character device"

2121

"{0} not a character device"

2911

2122

.format(os.devnull))

2912

2123

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

2913

2124

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

2917

2128

2918

2129

2919

2130

def main():

2920

2131

2921

2132

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

2922

2133

# Parsing of options, both command line and config file

2923

2134

2924

2135

parser = argparse.ArgumentParser()

2925

2136

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

2926

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

2137

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

2927

2138

help="show version number and exit")

2928

2139

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

2929

2140

help="Bind to interface IF")

2935

2146

help="Run self-test")

2936

2147

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

2937

2148

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

2938

" to terminal", default=None)

2149

" to terminal")

2939

2150

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

2940

2151

help="Debug level for stdout output")

2941

2152

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

2948

2159

" files")

2949

2160

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

2950

2161

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

2951

" system bus interface", default=None)

2162

" system bus interface")

2952

2163

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

2953

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

2954

default=None)

2164

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

2955

2165

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

2956

2166

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

2957

" state", default=None)

2958

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

2959

help="Specify a file descriptor to a network"

2960

" socket to use instead of creating one")

2167

" state")

2961

2168

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

2962

2169

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

2963

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

2964

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

2965

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

2966

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

2967

default=None)

2968

2170

2969

2171

options = parser.parse_args()

2970

2172

2971

2173

if options.check:

2972

2174

import doctest

2973

fail_count, test_count = doctest.testmod()

2974

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

2975

2175

doctest.testmod()

2176

sys.exit()

2177

2976

2178

# Default values for config file for server-global settings

2977

if gnutls.has_rawpk:

2978

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

2979

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

2980

else:

2981

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

2982

":+SIGN-DSA-SHA256")

2983

server_defaults = {"interface": "",

2984

"address": "",

2985

"port": "",

2986

"debug": "False",

2987

"priority": priority,

2988

"servicename": "Mandos",

2989

"use_dbus": "True",

2990

"use_ipv6": "True",

2991

"debuglevel": "",

2992

"restore": "True",

2993

"socket": "",

2994

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

2995

"foreground": "False",

2996

"zeroconf": "True",

2997

}

2998

del priority

2999

2179

server_defaults = { "interface": "",

2180

"address": "",

2181

"port": "",

2182

"debug": "False",

2183

"priority":

2184

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

2185

"servicename": "Mandos",

2186

"use_dbus": "True",

2187

"use_ipv6": "True",

2188

"debuglevel": "",

2189

"restore": "True",

2190

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

2191

}

2192

3000

2193

# Parse config file for server-global settings

3001

2194

server_config = configparser.SafeConfigParser(server_defaults)

3002

2195

del server_defaults

3003

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

2196

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

2197

"mandos.conf"))

3004

2198

# Convert the SafeConfigParser object to a dict

3005

2199

server_settings = server_config.defaults()

3006

2200

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

3007

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

3008

"foreground", "zeroconf"):

2201

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

3009

2202

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

3010

2203

option)

3011

2204

if server_settings["port"]:

3012

2205

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

3013

2206

"port")

3014

if server_settings["socket"]:

3015

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

3016

"socket")

3017

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

3018

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

3019

# happen with a supplied network socket.

3020

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

3021

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

3022

["socket"])

3023

2207

del server_config

3024

2208

3025

2209

# Override the settings from the config file with command line

3026

2210

# options, if set.

3027

2211

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

3028

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

3029

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

3030

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

2212

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

2213

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

2214

"statedir"):

3031

2215

value = getattr(options, option)

3032

2216

if value is not None:

3033

2217

server_settings[option] = value

3034

2218

del options

3035

2219

# Force all strings to be unicode

3036

2220

for option in server_settings.keys():

3037

if isinstance(server_settings[option], bytes):

3038

server_settings[option] = (server_settings[option]

3039

.decode("utf-8"))

3040

# Force all boolean options to be boolean

3041

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

3042

"foreground", "zeroconf"):

3043

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

3044

# Debug implies foreground

3045

if server_settings["debug"]:

3046

server_settings["foreground"] = True

2221

if type(server_settings[option]) is str:

2222

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

3047

2223

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

3048

2224

3049

2225

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

3050

3051

if (not server_settings["zeroconf"]

3052

and not (server_settings["port"]

3053

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

3054

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

3055

2226

3056

2227

# For convenience

3057

2228

debug = server_settings["debug"]

3058

2229

debuglevel = server_settings["debuglevel"]

3060

2231

use_ipv6 = server_settings["use_ipv6"]

3061

2232

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

3062

2233

stored_state_file)

3063

foreground = server_settings["foreground"]

3064

zeroconf = server_settings["zeroconf"]

3065

2234

3066

2235

if debug:

3067

2236

initlogger(debug, logging.DEBUG)

3068

2237

else:

3071

2240

else:

3072

2241

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

3073

2242

initlogger(debug, level)

3074

2243

3075

2244

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

3076

syslogger.setFormatter(

3077

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

3078

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

3079

server_settings["servicename"])))

3080

2245

syslogger.setFormatter(logging.Formatter

2246

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

2247

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

2248

.format(server_settings

2249

["servicename"])))

2250

3081

2251

# Parse config file with clients

3082

2252

client_config = configparser.SafeConfigParser(Client

3083

2253

.client_defaults)

3084

2254

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

3085

2255

"clients.conf"))

3086

2256

3087

2257

global mandos_dbus_service

3088

2258

mandos_dbus_service = None

3089

3090

socketfd = None

3091

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

3092

socketfd = server_settings["socket"]

3093

tcp_server = MandosServer(

3094

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

3095

ClientHandler,

3096

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

3097

use_ipv6=use_ipv6,

3098

gnutls_priority=server_settings["priority"],

3099

use_dbus=use_dbus,

3100

socketfd=socketfd)

3101

if not foreground:

3102

pidfilename = "/run/mandos.pid"

3103

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

3104

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

3105

pidfile = None

2259

2260

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

2261

server_settings["port"]),

2262

ClientHandler,

2263

interface=(server_settings["interface"]

2264

or None),

2265

use_ipv6=use_ipv6,

2266

gnutls_priority=

2267

server_settings["priority"],

2268

use_dbus=use_dbus)

2269

if not debug:

2270

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

3106

2271

try:

3107

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

2272

pidfile = open(pidfilename, "w")

3108

2273

except IOError as e:

3109

2274

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

3110

2275

exc_info=e)

3111

3112

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

3113

("mandos", "mandos"),

3114

("nobody", "nogroup")):

2276

2277

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

3115

2278

try:

3116

2279

uid = pwd.getpwnam(name).pw_uid

3117

gid = pwd.getpwnam(group).pw_gid

2280

gid = pwd.getpwnam(name).pw_gid

3118

2281

break

3119

2282

except KeyError:

3120

2283

continue

3124

2287

try:

3125

2288

os.setgid(gid)

3126

2289

os.setuid(uid)

3127

if debug:

3128

logger.debug("Did setuid/setgid to {}:{}".format(uid,

3129

gid))

3130

2290

except OSError as error:

3131

logger.warning("Failed to setuid/setgid to {}:{}: {}"

3132

.format(uid, gid, os.strerror(error.errno)))

3133

2291

if error.errno != errno.EPERM:

3134

raise

3135

2292

raise error

2293

3136

2294

if debug:

3137

2295

# Enable all possible GnuTLS debugging

3138

2296

3139

2297

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

3140

2298

# - GnuTLS manual

3141

gnutls.global_set_log_level(11)

3142

3143

@gnutls.log_func

2299

gnutls.library.functions.gnutls_global_set_log_level(11)

2300

2301

@gnutls.library.types.gnutls_log_func

3144

2302

def debug_gnutls(level, string):

3145

2303

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

3146

3147

gnutls.global_set_log_function(debug_gnutls)

3148

2304

2305

(gnutls.library.functions

2306

.gnutls_global_set_log_function(debug_gnutls))

2307

3149

2308

# Redirect stdin so all checkers get /dev/null

3150

2309

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

3151

2310

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

3152

2311

if null > 2:

3153

2312

os.close(null)

3154

2313

3155

2314

# Need to fork before connecting to D-Bus

3156

if not foreground:

2315

if not debug:

3157

2316

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

3158

2317

daemon()

3159

3160

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

3161

# to inform GLib that threads will be used.

3162

GLib.threads_init()

3163

2318

2319

gobject.threads_init()

2320

3164

2321

global main_loop

3165

2322

# From the Avahi example code

3166

2323

DBusGMainLoop(set_as_default=True)

3167

main_loop = GLib.MainLoop()

2324

main_loop = gobject.MainLoop()

3168

2325

bus = dbus.SystemBus()

3169

2326

# End of Avahi example code

3170

2327

if use_dbus:

3171

2328

try:

3172

2329

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

3173

bus,

3174

do_not_queue=True)

3175

old_bus_name = dbus.service.BusName(

3176

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

3177

do_not_queue=True)

3178

except dbus.exceptions.DBusException as e:

2330

bus, do_not_queue=True)

2331

old_bus_name = (dbus.service.BusName

2332

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

2333

do_not_queue=True))

2334

except dbus.exceptions.NameExistsException as e:

3179

2335

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

3180

2336

use_dbus = False

3181

2337

server_settings["use_dbus"] = False

3182

2338

tcp_server.use_dbus = False

3183

if zeroconf:

3184

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3185

service = AvahiServiceToSyslog(

3186

name=server_settings["servicename"],

3187

servicetype="_mandos._tcp",

3188

protocol=protocol,

3189

bus=bus)

3190

if server_settings["interface"]:

3191

service.interface = if_nametoindex(

3192

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

3193

2339

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2340

service = AvahiServiceToSyslog(name =

2341

server_settings["servicename"],

2342

servicetype = "_mandos._tcp",

2343

protocol = protocol, bus = bus)

2344

if server_settings["interface"]:

2345

service.interface = (if_nametoindex

2346

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

2347

3194

2348

global multiprocessing_manager

3195

2349

multiprocessing_manager = multiprocessing.Manager()

3196

2350

3197

2351

client_class = Client

3198

2352

if use_dbus:

3199

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

3200

2353

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

2354

3201

2355

client_settings = Client.config_parser(client_config)

3202

2356

old_client_settings = {}

3203

2357

clients_data = {}

3204

3205

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

3206

global wnull

3207

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

3208

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

3209

# mode

3210

if debug or not foreground:

3211

wnull.close()

3212

2358

3213

2359

# Get client data and settings from last running state.

3214

2360

if server_settings["restore"]:

3215

2361

try:

3216

2362

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

3217

if sys.version_info.major == 2:

3218

clients_data, old_client_settings = pickle.load(

3219

stored_state)

3220

else:

3221

bytes_clients_data, bytes_old_client_settings = (

3222

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

3223

# Fix bytes to strings

3224

# clients_data

3225

# .keys()

3226

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

3227

if isinstance(key, bytes)

3228

else key): value

3229

for key, value in

3230

bytes_clients_data.items()}

3231

del bytes_clients_data

3232

for key in clients_data:

3233

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

3234

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

3235

for k, v in

3236

clients_data[key].items()}

3237

clients_data[key] = value

3238

# .client_structure

3239

value["client_structure"] = [

3240

(s.decode("utf-8")

3241

if isinstance(s, bytes)

3242

else s) for s in

3243

value["client_structure"]]

3244

# .name & .host

3245

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

3246

if isinstance(value[k], bytes):

3247

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

3248

if "key_id" not in value:

3249

value["key_id"] = ""

3250

elif "fingerprint" not in value:

3251

value["fingerprint"] = ""

3252

# old_client_settings

3253

# .keys()

3254

old_client_settings = {

3255

(key.decode("utf-8")

3256

if isinstance(key, bytes)

3257

else key): value

3258

for key, value in

3259

bytes_old_client_settings.items()}

3260

del bytes_old_client_settings

3261

# .host

3262

for value in old_client_settings.values():

3263

if isinstance(value["host"], bytes):

3264

value["host"] = (value["host"]

3265

.decode("utf-8"))

2363

clients_data, old_client_settings = (pickle.load

2364

(stored_state))

3266

2365

os.remove(stored_state_path)

3267

2366

except IOError as e:

3268

2367

if e.errno == errno.ENOENT:

3269

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

3270

" {}".format(os.strerror(e.errno)))

2368

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

2369

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

3271

2370

else:

3272

2371

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

3273

2372

exc_info=e)

3274

2373

raise

3275

2374

except EOFError as e:

3276

2375

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

3277

"EOFError:",

3278

exc_info=e)

3279

2376

"EOFError:", exc_info=e)

2377

3280

2378

with PGPEngine() as pgp:

3281

for client_name, client in clients_data.items():

3282

# Skip removed clients

3283

if client_name not in client_settings:

3284

continue

3285

2379

for client_name, client in clients_data.iteritems():

3286

2380

# Decide which value to use after restoring saved state.

3287

2381

# We have three different values: Old config file,

3288

2382

# new config file, and saved state.

3293

2387

# For each value in new config, check if it

3294

2388

# differs from the old config value (Except for

3295

2389

# the "secret" attribute)

3296

if (name != "secret"

3297

and (value !=

3298

old_client_settings[client_name][name])):

2390

if (name != "secret" and

2391

value != old_client_settings[client_name]

2392

[name]):

3299

2393

client[name] = value

3300

2394

except KeyError:

3301

2395

pass

3302

2396

3303

2397

# Clients who has passed its expire date can still be

3304

# enabled if its last checker was successful. A Client

2398

# enabled if its last checker was successful. Clients

3305

2399

# whose checker succeeded before we stored its state is

3306

2400

# assumed to have successfully run all checkers during

3307

2401

# downtime.

3309

2403

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

3310

2404

if not client["last_checked_ok"]:

3311

2405

logger.warning(

3312

"disabling client {} - Client never "

3313

"performed a successful checker".format(

3314

client_name))

2406

"disabling client {0} - Client never "

2407

"performed a successful checker"

2408

.format(client_name))

3315

2409

client["enabled"] = False

3316

2410

elif client["last_checker_status"] != 0:

3317

2411

logger.warning(

3318

"disabling client {} - Client last"

3319

" checker failed with error code"

3320

" {}".format(

3321

client_name,

3322

client["last_checker_status"]))

2412

"disabling client {0} - Client "

2413

"last checker failed with error code {1}"

2414

.format(client_name,

2415

client["last_checker_status"]))

3323

2416

client["enabled"] = False

3324

2417

else:

3325

client["expires"] = (

3326

datetime.datetime.utcnow()

3327

+ client["timeout"])

2418

client["expires"] = (datetime.datetime

2419

.utcnow()

2420

+ client["timeout"])

3328

2421

logger.debug("Last checker succeeded,"

3329

" keeping {} enabled".format(

3330

client_name))

2422

" keeping {0} enabled"

2423

.format(client_name))

3331

2424

try:

3332

client["secret"] = pgp.decrypt(

3333

client["encrypted_secret"],

3334

client_settings[client_name]["secret"])

2425

client["secret"] = (

2426

pgp.decrypt(client["encrypted_secret"],

2427

client_settings[client_name]

2428

["secret"]))

3335

2429

except PGPError:

3336

2430

# If decryption fails, we use secret from new settings

3337

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

3338

client_name))

3339

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

3340

["secret"])

3341

2431

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

2432

.format(client_name))

2433

client["secret"] = (

2434

client_settings[client_name]["secret"])

2435

3342

2436

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

3343

2437

for client_name in (set(old_client_settings)

3344

2438

- set(client_settings)):

3346

2440

for client_name in (set(client_settings)

3347

2441

- set(old_client_settings)):

3348

2442

clients_data[client_name] = client_settings[client_name]

3349

2443

3350

2444

# Create all client objects

3351

for client_name, client in clients_data.items():

2445

for client_name, client in clients_data.iteritems():

3352

2446

tcp_server.clients[client_name] = client_class(

3353

name=client_name,

3354

settings=client,

3355

server_settings=server_settings)

3356

2447

name = client_name, settings = client)

2448

3357

2449

if not tcp_server.clients:

3358

2450

logger.warning("No clients defined")

3359

3360

if not foreground:

3361

if pidfile is not None:

3362

pid = os.getpid()

3363

try:

3364

with pidfile:

3365

print(pid, file=pidfile)

3366

except IOError:

3367

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

3368

pidfilename, pid)

3369

del pidfile

2451

2452

if not debug:

2453

try:

2454

with pidfile:

2455

pid = os.getpid()

2456

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

2457

del pidfile

2458

except IOError:

2459

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

2460

pidfilename, pid)

2461

except NameError:

2462

# "pidfile" was never created

2463

pass

3370

2464

del pidfilename

3371

3372

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

3373

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3374

lambda: main_loop.quit() and False)

3375

2465

2466

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

2467

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

2468

3376

2469

if use_dbus:

3377

3378

@alternate_dbus_interfaces(

3379

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

3380

class MandosDBusService(DBusObjectWithObjectManager):

2470

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

2471

"se.bsnet.fukt.Mandos"})

2472

class MandosDBusService(DBusObjectWithProperties):

3381

2473

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

3382

3383

2474

def __init__(self):

3384

2475

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

3385

3386

2476

_interface = "se.recompile.Mandos"

3387

2477

2478

@dbus_interface_annotations(_interface)

2479

def _foo(self):

2480

return { "org.freedesktop.DBus.Property"

2481

".EmitsChangedSignal":

2482

"false"}

2483

3388

2484

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

3389

2485

def ClientAdded(self, objpath):

3390

2486

"D-Bus signal"

3391

2487

pass

3392

2488

3393

2489

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

3394

def ClientNotFound(self, key_id, address):

2490

def ClientNotFound(self, fingerprint, address):

3395

2491

"D-Bus signal"

3396

2492

pass

3397

3398

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

3399

"true"})

2493

3400

2494

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

3401

2495

def ClientRemoved(self, objpath, name):

3402

2496

"D-Bus signal"

3403

2497

pass

3404

3405

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

3406

"true"})

2498

3407

2499

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

3408

2500

def GetAllClients(self):

3409

2501

"D-Bus method"

3410

return dbus.Array(c.dbus_object_path for c in

3411

tcp_server.clients.values())

3412

3413

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

3414

"true"})

2502

return dbus.Array(c.dbus_object_path

2503

for c in

2504

tcp_server.clients.itervalues())

2505

3415

2506

@dbus.service.method(_interface,

3416

2507

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

3417

2508

def GetAllClientsWithProperties(self):

3418

2509

"D-Bus method"

3419

2510

return dbus.Dictionary(

3420

{c.dbus_object_path: c.GetAll(

3421

"se.recompile.Mandos.Client")

3422

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

2511

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

2512

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

3423

2513

signature="oa{sv}")

3424

2514

3425

2515

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

3426

2516

def RemoveClient(self, object_path):

3427

2517

"D-Bus method"

3428

for c in tcp_server.clients.values():

2518

for c in tcp_server.clients.itervalues():

3429

2519

if c.dbus_object_path == object_path:

3430

2520

del tcp_server.clients[c.name]

3431

2521

c.remove_from_connection()

3432

# Don't signal the disabling

2522

# Don't signal anything except ClientRemoved

3433

2523

c.disable(quiet=True)

3434

# Emit D-Bus signal for removal

3435

self.client_removed_signal(c)

2524

# Emit D-Bus signal

2525

self.ClientRemoved(object_path, c.name)

3436

2526

return

3437

2527

raise KeyError(object_path)

3438

2528

3439

2529

del _interface

3440

3441

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3442

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

3443

def GetManagedObjects(self):

3444

"""D-Bus method"""

3445

return dbus.Dictionary(

3446

{client.dbus_object_path:

3447

dbus.Dictionary(

3448

{interface: client.GetAll(interface)

3449

for interface in

3450

client._get_all_interface_names()})

3451

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

3452

3453

def client_added_signal(self, client):

3454

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

3455

if use_dbus:

3456

# New standard signal

3457

self.InterfacesAdded(

3458

client.dbus_object_path,

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()}))

3463

# Old signal

3464

self.ClientAdded(client.dbus_object_path)

3465

3466

def client_removed_signal(self, client):

3467

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

3468

if use_dbus:

3469

# New standard signal

3470

self.InterfacesRemoved(

3471

client.dbus_object_path,

3472

client._get_all_interface_names())

3473

# Old signal

3474

self.ClientRemoved(client.dbus_object_path,

3475

client.name)

3476

2530

3477

2531

mandos_dbus_service = MandosDBusService()

3478

3479

# Save modules to variables to exempt the modules from being

3480

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

3481

mp = multiprocessing

3482

wn = wnull

3483

2532

3484

2533

def cleanup():

3485

2534

"Cleanup function; run on exit"

3486

if zeroconf:

3487

service.cleanup()

3488

3489

mp.active_children()

3490

wn.close()

2535

service.cleanup()

2536

2537

multiprocessing.active_children()

3491

2538

if not (tcp_server.clients or client_settings):

3492

2539

return

3493

2540

3494

2541

# Store client before exiting. Secrets are encrypted with key

3495

2542

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

3496

2543

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

3497

2544

clients = {}

3498

2545

with PGPEngine() as pgp:

3499

for client in tcp_server.clients.values():

2546

for client in tcp_server.clients.itervalues():

3500

2547

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

3501

2548

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

3502

2549

key)

3503

2550

client_dict = {}

3504

2551

3505

2552

# A list of attributes that can not be pickled

3506

2553

# + secret.

3507

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

3508

"checker", "server_settings"}

3509

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

3510

.Object):

2554

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

2555

"checker"))

2556

for name, typ in (inspect.getmembers

2557

(dbus.service.Object)):

3511

2558

exclude.add(name)

3512

2559

3513

2560

client_dict["encrypted_secret"] = (client

3514

2561

.encrypted_secret)

3515

2562

for attr in client.client_structure:

3516

2563

if attr not in exclude:

3517

2564

client_dict[attr] = getattr(client, attr)

3518

2565

3519

2566

clients[client.name] = client_dict

3520

2567

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

3521

2568

3522

2569

try:

3523

with tempfile.NamedTemporaryFile(

3524

mode='wb',

3525

suffix=".pickle",

3526

prefix='clients-',

3527

dir=os.path.dirname(stored_state_path),

3528

delete=False) as stored_state:

3529

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

3530

protocol=2)

3531

tempname = stored_state.name

2570

with (tempfile.NamedTemporaryFile

2571

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

2572

dir=os.path.dirname(stored_state_path),

2573

delete=False)) as stored_state:

2574

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

2575

tempname=stored_state.name

3532

2576

os.rename(tempname, stored_state_path)

3533

2577

except (IOError, OSError) as e:

3534

2578

if not debug:

3537

2581

except NameError:

3538

2582

pass

3539

2583

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

3540

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

2584

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

3541

2585

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

3542

2586

else:

3543

2587

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

3544

2588

exc_info=e)

3545

raise

3546

2589

raise e

2590

3547

2591

# Delete all clients, and settings from config

3548

2592

while tcp_server.clients:

3549

2593

name, client = tcp_server.clients.popitem()

3550

2594

if use_dbus:

3551

2595

client.remove_from_connection()

3552

# Don't signal the disabling

2596

# Don't signal anything except ClientRemoved

3553

2597

client.disable(quiet=True)

3554

# Emit D-Bus signal for removal

3555

2598

if use_dbus:

3556

mandos_dbus_service.client_removed_signal(client)

2599

# Emit D-Bus signal

2600

mandos_dbus_service.ClientRemoved(client

2601

.dbus_object_path,

2602

client.name)

3557

2603

client_settings.clear()

3558

2604

3559

2605

atexit.register(cleanup)

3560

3561

for client in tcp_server.clients.values():

2606

2607

for client in tcp_server.clients.itervalues():

3562

2608

if use_dbus:

3563

# Emit D-Bus signal for adding

3564

mandos_dbus_service.client_added_signal(client)

2609

# Emit D-Bus signal

2610

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3565

2611

# Need to initiate checking of clients

3566

2612

if client.enabled:

3567

2613

client.init_checker()

3568

2614

3569

2615

tcp_server.enable()

3570

2616

tcp_server.server_activate()

3571

2617

3572

2618

# Find out what port we got

3573

if zeroconf:

3574

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

2619

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

3575

2620

if use_ipv6:

3576

2621

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

3577

2622

" flowinfo %d, scope_id %d",

3579

2624

else: # IPv4

3580

2625

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

3581

2626

*tcp_server.socket.getsockname())

3582

3583

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

3584

2627

2628

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

2629

3585

2630

try:

3586

if zeroconf:

3587

# From the Avahi example code

3588

try:

3589

service.activate()

3590

except dbus.exceptions.DBusException as error:

3591

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

3592

cleanup()

3593

sys.exit(1)

3594

# End of Avahi example code

3595

3596

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

3597

lambda *args, **kwargs:

3598

(tcp_server.handle_request

3599

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

3600

2631

# From the Avahi example code

2632

try:

2633

service.activate()

2634

except dbus.exceptions.DBusException as error:

2635

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

2636

cleanup()

2637

sys.exit(1)

2638

# End of Avahi example code

2639

2640

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

2641

lambda *args, **kwargs:

2642

(tcp_server.handle_request

2643

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

2644

3601

2645

logger.debug("Starting main loop")

3602

2646

main_loop.run()

3603

2647

except AvahiError as error:

3612

2656

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

3613

2657

cleanup()

3614

2658

3615

3616

2659

if __name__ == '__main__':

3617

2660

main()