/mandos/release : revision 237.7.127

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

495

382

class AvahiServiceToSyslog(AvahiService):

496

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

383

def rename(self):

497

384

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

385

ret = AvahiService.rename(self)

386

syslogger.setFormatter(logging.Formatter

387

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

388

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

389

.format(self.name)))

502

390

return ret

503

391

504

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

815

392

def timedelta_to_milliseconds(td):

393

"Convert a datetime.timedelta() to milliseconds"

394

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

395

+ (td.seconds * 1000)

396

+ (td.microseconds // 1000))

816

397

817

398

class Client(object):

818

399

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

819

400

820

401

Attributes:

821

402

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

822

403

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

824

405

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

825

406

to see if the client lives.

826

407

'None' if no process is running.

827

checker_callback_tag: a GLib event source tag, or None

408

checker_callback_tag: a gobject event source tag, or None

828

409

checker_command: string; External command which is run to check

829

410

if client lives. %() expansions are done at

830

411

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

831

412

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

832

checker_initiator_tag: a GLib event source tag, or None

413

checker_initiator_tag: a gobject event source tag, or None

833

414

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

834

415

client_structure: Object describing what attributes a client has

835

416

and is used for storing the client at exit

836

417

current_checker_command: string; current running checker_command

837

disable_initiator_tag: a GLib event source tag, or None

418

disable_initiator_tag: a gobject event source tag, or None

838

419

enabled: bool()

839

420

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

421

uniquely identify the client

843

422

host: string; available for use by the checker command

844

423

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

845

424

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

847

426

last_checker_status: integer between 0 and 255 reflecting exit

848

427

status of last checker. -1 reflects crashed

849

428

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

429

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

853

430

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

854

431

D-Bus identifiers

859

436

runtime_expansions: Allowed attributes for runtime expansion.

860

437

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

861

438

disabled, or None

862

server_settings: The server_settings dict from main()

863

439

"""

864

440

865

441

runtime_expansions = ("approval_delay", "approval_duration",

866

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

867

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

868

"last_approval_request", "last_checked_ok",

442

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

443

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

869

444

"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

445

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

446

"extended_timeout": "15m",

447

"interval": "2m",

448

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

449

"host": "",

450

"approval_delay": "0s",

451

"approval_duration": "1s",

452

"approved_by_default": "True",

453

"enabled": "True",

454

}

455

456

def timeout_milliseconds(self):

457

"Return the 'timeout' attribute in milliseconds"

458

return timedelta_to_milliseconds(self.timeout)

459

460

def extended_timeout_milliseconds(self):

461

"Return the 'extended_timeout' attribute in milliseconds"

462

return timedelta_to_milliseconds(self.extended_timeout)

463

464

def interval_milliseconds(self):

465

"Return the 'interval' attribute in milliseconds"

466

return timedelta_to_milliseconds(self.interval)

467

468

def approval_delay_milliseconds(self):

469

return timedelta_to_milliseconds(self.approval_delay)

470

882

471

@staticmethod

883

472

def config_parser(config):

884

473

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

891

480

for client_name in config.sections():

892

481

section = dict(config.items(client_name))

893

482

client = settings[client_name] = {}

894

483

895

484

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

896

485

# Reformat values from string types to Python types

897

486

client["approved_by_default"] = config.getboolean(

898

487

client_name, "approved_by_default")

899

488

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

900

489

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

490

907

491

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

908

492

.replace(" ", ""))

909

493

if "secret" in section:

910

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

911

.encode("utf-8"),

912

"base64")

494

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

913

495

elif "secfile" in section:

914

496

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

915

497

(section["secfile"])),

916

498

"rb") as secfile:

917

499

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

918

500

else:

919

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

501

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

920

502

.format(section))

921

503

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

922

504

client["extended_timeout"] = string_to_delta(

930

512

client["last_approval_request"] = None

931

513

client["last_checked_ok"] = None

932

514

client["last_checker_status"] = -2

933

515

934

516

return settings

935

936

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

517

518

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

937

519

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

941

520

# adding all client settings

942

for setting, value in settings.items():

521

for setting, value in settings.iteritems():

943

522

setattr(self, setting, value)

944

523

945

524

if self.enabled:

946

525

if not hasattr(self, "last_enabled"):

947

526

self.last_enabled = datetime.datetime.utcnow()

951

530

else:

952

531

self.last_enabled = None

953

532

self.expires = None

954

533

955

534

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

956

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

535

# Uppercase and remove spaces from fingerprint for later

536

# comparison purposes with return value from the fingerprint()

537

# function

957

538

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

958

539

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

959

540

datetime.datetime.utcnow())

960

541

961

542

# attributes specific for this server instance

962

543

self.checker = None

963

544

self.checker_initiator_tag = None

966

547

self.current_checker_command = None

967

548

self.approved = None

968

549

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

550

self.changedstate = (multiprocessing_manager

551

.Condition(multiprocessing_manager

552

.Lock()))

553

self.client_structure = [attr for attr in

554

self.__dict__.iterkeys()

973

555

if not attr.startswith("_")]

974

556

self.client_structure.append("client_structure")

975

976

for name, t in inspect.getmembers(

977

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

557

558

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

559

lambda obj:

560

isinstance(obj,

561

property)):

978

562

if not name.startswith("_"):

979

563

self.client_structure.append(name)

980

564

981

565

# Send notice to process children that client state has changed

982

566

def send_changedstate(self):

983

567

with self.changedstate:

984

568

self.changedstate.notify_all()

985

569

986

570

def enable(self):

987

571

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

988

572

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

989

573

# Already enabled

990

574

return

575

self.send_changedstate()

991

576

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

992

577

self.enabled = True

993

578

self.last_enabled = datetime.datetime.utcnow()

994

579

self.init_checker()

995

self.send_changedstate()

996

580

997

581

def disable(self, quiet=True):

998

582

"""Disable this client."""

999

583

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

1000

584

return False

1001

585

if not quiet:

586

self.send_changedstate()

587

if not quiet:

1002

588

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

1003

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

1004

GLib.source_remove(self.disable_initiator_tag)

589

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

590

gobject.source_remove(self.disable_initiator_tag)

1005

591

self.disable_initiator_tag = None

1006

592

self.expires = None

1007

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

1008

GLib.source_remove(self.checker_initiator_tag)

593

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

594

gobject.source_remove(self.checker_initiator_tag)

1009

595

self.checker_initiator_tag = None

1010

596

self.stop_checker()

1011

597

self.enabled = False

1012

if not quiet:

1013

self.send_changedstate()

1014

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

598

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

1015

599

return False

1016

600

1017

601

def __del__(self):

1018

602

self.disable()

1019

603

1020

604

def init_checker(self):

1021

605

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

1022

606

# and every interval from then on.

1023

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)

607

self.checker_initiator_tag = (gobject.timeout_add

608

(self.interval_milliseconds(),

609

self.start_checker))

1028

610

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

1029

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)

611

self.disable_initiator_tag = (gobject.timeout_add

612

(self.timeout_milliseconds(),

613

self.disable))

1033

614

# Also start a new checker *right now*.

1034

615

self.start_checker()

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

616

617

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

1038

618

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

1039

619

self.checker_callback_tag = None

1040

620

self.checker = None

1041

# Read return code from connection (see call_pipe)

1042

returncode = connection.recv()

1043

connection.close()

1044

1045

if returncode >= 0:

1046

self.last_checker_status = returncode

1047

self.last_checker_signal = None

621

if os.WIFEXITED(condition):

622

self.last_checker_status = os.WEXITSTATUS(condition)

1048

623

if self.last_checker_status == 0:

1049

624

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

1050

625

vars(self))

1051

626

self.checked_ok()

1052

627

else:

1053

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

628

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

629

vars(self))

1054

630

else:

1055

631

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

1057

632

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

1058

633

vars(self))

1059

return False

1060

634

1061

635

def checked_ok(self):

1062

636

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

1063

637

self.last_checked_ok = datetime.datetime.utcnow()

1064

638

self.last_checker_status = 0

1065

self.last_checker_signal = None

1066

639

self.bump_timeout()

1067

640

1068

641

def bump_timeout(self, timeout=None):

1069

642

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

1070

643

if timeout is None:

1071

644

timeout = self.timeout

1072

645

if self.disable_initiator_tag is not None:

1073

GLib.source_remove(self.disable_initiator_tag)

1074

self.disable_initiator_tag = None

646

gobject.source_remove(self.disable_initiator_tag)

1075

647

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

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

648

self.disable_initiator_tag = (gobject.timeout_add

649

(timedelta_to_milliseconds

650

(timeout), self.disable))

1078

651

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

1079

652

1080

653

def need_approval(self):

1081

654

self.last_approval_request = datetime.datetime.utcnow()

1082

655

1083

656

def start_checker(self):

1084

657

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

1085

658

1086

659

If a checker already exists, leave it running and do

1087

660

nothing."""

1088

661

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

1093

666

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

1094

667

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

1095

668

# should be.

1096

1097

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

1098

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

1099

self.checker.join()

1100

self.checker = None

669

670

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

671

try:

672

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

673

except (AttributeError, OSError) as error:

674

if (isinstance(error, OSError)

675

and error.errno != errno.ECHILD):

676

raise error

677

else:

678

if pid:

679

logger.warning("Checker was a zombie")

680

gobject.source_remove(self.checker_callback_tag)

681

self.checker_callback(pid, status,

682

self.current_checker_command)

1101

683

# Start a new checker if needed

1102

684

if self.checker is None:

1103

# Escape attributes for the shell

1104

escaped_attrs = {

1105

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

1106

for attr in self.runtime_expansions}

1107

try:

1108

command = self.checker_command % escaped_attrs

1109

except TypeError as error:

1110

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

1111

self.checker_command,

685

try:

686

# In case checker_command has exactly one % operator

687

command = self.checker_command % self.host

688

except TypeError:

689

# Escape attributes for the shell

690

escaped_attrs = dict(

691

(attr,

692

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

693

errors=

694

'replace')))

695

for attr in

696

self.runtime_expansions)

697

698

try:

699

command = self.checker_command % escaped_attrs

700

except TypeError as error:

701

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

702

self.checker_command, exc_info=error)

703

return True # Try again later

704

self.current_checker_command = command

705

try:

706

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

707

command, self.name)

708

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

709

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

710

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

711

# always replaced by /dev/null.)

712

self.checker = subprocess.Popen(command,

713

close_fds=True,

714

shell=True, cwd="/")

715

self.checker_callback_tag = (gobject.child_watch_add

716

(self.checker.pid,

717

self.checker_callback,

718

data=command))

719

# The checker may have completed before the gobject

720

# watch was added. Check for this.

721

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

722

if pid:

723

gobject.source_remove(self.checker_callback_tag)

724

self.checker_callback(pid, status, command)

725

except OSError as error:

726

logger.error("Failed to start subprocess",

1112

727

exc_info=error)

1113

return True # Try again later

1114

self.current_checker_command = command

1115

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

1116

self.name)

1117

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

1118

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

1119

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

1120

# always replaced by /dev/null.)

1121

# The exception is when not debugging but nevertheless

1122

# running in the foreground; use the previously

1123

# created wnull.

1124

popen_args = {"close_fds": True,

1125

"shell": True,

1126

"cwd": "/"}

1127

if (not self.server_settings["debug"]

1128

and self.server_settings["foreground"]):

1129

popen_args.update({"stdout": wnull,

1130

"stderr": wnull})

1131

pipe = multiprocessing.Pipe(duplex=False)

1132

self.checker = multiprocessing.Process(

1133

target=call_pipe,

1134

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

1135

kwargs=popen_args)

1136

self.checker.start()

1137

self.checker_callback_tag = GLib.io_add_watch(

1138

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

1139

self.checker_callback, pipe[0], command)

1140

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

728

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

1141

729

return True

1142

730

1143

731

def stop_checker(self):

1144

732

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

1145

733

if self.checker_callback_tag:

1146

GLib.source_remove(self.checker_callback_tag)

734

gobject.source_remove(self.checker_callback_tag)

1147

735

self.checker_callback_tag = None

1148

736

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

1149

737

return

1150

738

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

1151

self.checker.terminate()

739

try:

740

self.checker.terminate()

741

#time.sleep(0.5)

742

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

743

# self.checker.kill()

744

except OSError as error:

745

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

746

raise

1152

747

self.checker = None

1153

748

1154

749

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

750

def dbus_service_property(dbus_interface, signature="v",

751

access="readwrite", byte_arrays=False):

1159

752

"""Decorators for marking methods of a DBusObjectWithProperties to

1160

753

become properties on the D-Bus.

1161

754

1162

755

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

1163

756

and with one argument by "Set".

1164

757

1165

758

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

1166

759

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

1167

760

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

1170

763

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

1171

764

if byte_arrays and signature != "ay":

1172

765

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

1173

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

1174

766

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

1175

767

def decorator(func):

1176

768

func._dbus_is_property = True

1177

769

func._dbus_interface = dbus_interface

1180

772

func._dbus_name = func.__name__

1181

773

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

1182

774

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

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

775

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1184

776

return func

1185

1186

777

return decorator

1187

778

1188

779

1189

780

def dbus_interface_annotations(dbus_interface):

1190

781

"""Decorator for marking functions returning interface annotations

1191

782

1192

783

Usage:

1193

784

1194

785

@dbus_interface_annotations("org.example.Interface")

1195

786

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

1196

787

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

1197

788

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

1198

789

"false"}

1199

790

"""

1200

1201

791

def decorator(func):

1202

792

func._dbus_is_interface = True

1203

793

func._dbus_interface = dbus_interface

1204

794

func._dbus_name = dbus_interface

1205

795

return func

1206

1207

796

return decorator

1208

797

1209

798

1210

799

def dbus_annotations(annotations):

1211

800

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

1212

801

Usage:

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

802

1217

803

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

1218

804

access="r")

805

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

806

"org.freedesktop.DBus.Property."

807

"EmitsChangedSignal": "false"})

1219

808

def Property_dbus_property(self):

1220

809

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

1223

810

"""

1224

1225

811

def decorator(func):

1226

812

func._dbus_annotations = annotations

1227

813

return func

1228

1229

814

return decorator

1230

815

1231

816

1232

817

class DBusPropertyException(dbus.exceptions.DBusException):

1233

818

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

1234

819

"""

1235

pass

820

def __unicode__(self):

821

return unicode(str(self))

1236

822

1237

823

1238

824

class DBusPropertyAccessException(DBusPropertyException):

1247

833

pass

1248

834

1249

835

1250

class DBusObjectWithAnnotations(dbus.service.Object):

1251

"""A D-Bus object with annotations.

1252

1253

Classes inheriting from this can use the dbus_annotations

1254

decorator to add annotations to methods or signals.

836

class DBusObjectWithProperties(dbus.service.Object):

837

"""A D-Bus object with properties.

838

839

Classes inheriting from this can use the dbus_service_property

840

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

841

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

1255

842

"""

1256

843

1257

844

@staticmethod

1258

845

def _is_dbus_thing(thing):

1259

846

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

1260

847

1261

848

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

1262

849

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

1263

850

"""

1264

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

851

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

1265

852

False)

1266

853

1267

854

def _get_all_dbus_things(self, thing):

1268

855

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

1269

856

"""

1270

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

857

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

858

name),

1271

859

athing.__get__(self))

1272

860

for cls in self.__class__.__mro__

1273

861

for name, athing in

1274

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

1275

1276

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1277

out_signature="s",

1278

path_keyword='object_path',

1279

connection_keyword='connection')

1280

def Introspect(self, object_path, connection):

1281

"""Overloading of standard D-Bus method.

1282

1283

Inserts annotation tags on methods and signals.

1284

"""

1285

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

1286

connection)

1287

try:

1288

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

1289

1290

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

1291

# Add annotation tags

1292

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

1293

for tag in if_tag.getElementsByTagName(typ):

1294

annots = dict()

1295

for name, prop in (self.

1296

_get_all_dbus_things(typ)):

1297

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

1298

and prop._dbus_interface

1299

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

1300

annots.update(getattr(

1301

prop, "_dbus_annotations", {}))

1302

for name, value in annots.items():

1303

ann_tag = document.createElement(

1304

"annotation")

1305

ann_tag.setAttribute("name", name)

1306

ann_tag.setAttribute("value", value)

1307

tag.appendChild(ann_tag)

1308

# Add interface annotation tags

1309

for annotation, value in dict(

1310

itertools.chain.from_iterable(

1311

annotations().items()

1312

for name, annotations

1313

in self._get_all_dbus_things("interface")

1314

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

1315

)).items():

1316

ann_tag = document.createElement("annotation")

1317

ann_tag.setAttribute("name", annotation)

1318

ann_tag.setAttribute("value", value)

1319

if_tag.appendChild(ann_tag)

1320

# Fix argument name for the Introspect method itself

1321

if (if_tag.getAttribute("name")

1322

== dbus.INTROSPECTABLE_IFACE):

1323

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

1324

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

1325

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

1326

if (arg.getAttribute("direction")

1327

== "out"):

1328

arg.setAttribute("name",

1329

"xml_data")

1330

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

1331

document.unlink()

1332

except (AttributeError, xml.dom.DOMException,

1333

xml.parsers.expat.ExpatError) as error:

1334

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

1335

exc_info=error)

1336

return xmlstring

1337

1338

1339

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1340

"""A D-Bus object with properties.

1341

1342

Classes inheriting from this can use the dbus_service_property

1343

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

1344

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

1345

"""

1346

862

inspect.getmembers(cls,

863

self._is_dbus_thing(thing)))

864

1347

865

def _get_dbus_property(self, interface_name, property_name):

1348

866

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

1349

867

property with the specified name and interface.

1350

868

"""

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

869

for cls in self.__class__.__mro__:

870

for name, value in (inspect.getmembers

871

(cls,

872

self._is_dbus_thing("property"))):

1354

873

if (value._dbus_name == property_name

1355

874

and value._dbus_interface == interface_name):

1356

875

return value.__get__(self)

1357

876

1358

877

# No such property

1359

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

1360

self.dbus_object_path, interface_name, property_name))

1361

1362

@classmethod

1363

def _get_all_interface_names(cls):

1364

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

1365

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

1366

"_dbus_interface", None)

1367

for x in (inspect.getmro(cls))

1368

for attr in dir(x))

1369

if name is not None)

1370

1371

@dbus.service.method(dbus.PROPERTIES_IFACE,

1372

in_signature="ss",

878

raise DBusPropertyNotFound(self.dbus_object_path + ":"

879

+ interface_name + "."

880

+ property_name)

881

882

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

1373

883

out_signature="v")

1374

884

def Get(self, interface_name, property_name):

1375

885

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

1381

891

if not hasattr(value, "variant_level"):

1382

892

return value

1383

893

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

1384

894

1385

895

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

1386

896

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

1387

897

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

1393

903

# The byte_arrays option is not supported yet on

1394

904

# signatures other than "ay".

1395

905

if prop._dbus_signature != "ay":

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

906

raise ValueError

1399

907

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

1400

908

for byte in value))

1401

909

prop(value)

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

910

911

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

1405

912

out_signature="a{sv}")

1406

913

def GetAll(self, interface_name):

1407

914

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

1408

915

standard.

1409

916

1410

917

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

1411

918

"""

1412

919

properties = {}

1422

929

if not hasattr(value, "variant_level"):

1423

930

properties[name] = value

1424

931

continue

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

932

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

933

value.variant_level+1)

1427

934

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

1428

1429

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

1430

def PropertiesChanged(self, interface_name, changed_properties,

1431

invalidated_properties):

1432

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

1433

standard.

1434

"""

1435

pass

1436

935

1437

936

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1438

937

out_signature="s",

1439

938

path_keyword='object_path',

1440

939

connection_keyword='connection')

1441

940

def Introspect(self, object_path, connection):

1442

941

"""Overloading of standard D-Bus method.

1443

942

1444

943

Inserts property tags and interface annotation tags.

1445

944

"""

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

945

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

946

connection)

1449

947

try:

1450

948

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

1451

1452

949

def make_tag(document, name, prop):

1453

950

e = document.createElement("property")

1454

951

e.setAttribute("name", name)

1455

952

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

1456

953

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

1457

954

return e

1458

1459

955

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

1460

956

# Add property tags

1461

957

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

1464

960

if prop._dbus_interface

1465

961

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

1466

962

if_tag.appendChild(tag)

1467

# Add annotation tags for properties

1468

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

1469

annots = dict()

1470

for name, prop in self._get_all_dbus_things(

1471

"property"):

1472

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

1473

and prop._dbus_interface

1474

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

1475

annots.update(getattr(

1476

prop, "_dbus_annotations", {}))

1477

for name, value in annots.items():

1478

ann_tag = document.createElement(

1479

"annotation")

1480

ann_tag.setAttribute("name", name)

1481

ann_tag.setAttribute("value", value)

1482

tag.appendChild(ann_tag)

963

# Add annotation tags

964

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

965

for tag in if_tag.getElementsByTagName(typ):

966

annots = dict()

967

for name, prop in (self.

968

_get_all_dbus_things(typ)):

969

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

970

and prop._dbus_interface

971

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

972

annots.update(getattr

973

(prop,

974

"_dbus_annotations",

975

{}))

976

for name, value in annots.iteritems():

977

ann_tag = document.createElement(

978

"annotation")

979

ann_tag.setAttribute("name", name)

980

ann_tag.setAttribute("value", value)

981

tag.appendChild(ann_tag)

982

# Add interface annotation tags

983

for annotation, value in dict(

984

itertools.chain.from_iterable(

985

annotations().iteritems()

986

for name, annotations in

987

self._get_all_dbus_things("interface")

988

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

989

)).iteritems():

990

ann_tag = document.createElement("annotation")

991

ann_tag.setAttribute("name", annotation)

992

ann_tag.setAttribute("value", value)

993

if_tag.appendChild(ann_tag)

1483

994

# Add the names to the return values for the

1484

995

# "org.freedesktop.DBus.Properties" methods

1485

996

if (if_tag.getAttribute("name")

1504

1015

return xmlstring

1505

1016

1506

1017

1507

try:

1508

dbus.OBJECT_MANAGER_IFACE

1509

except AttributeError:

1510

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

1511

1512

1513

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1514

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

1515

1516

Classes inheriting from this exposes the standard

1517

GetManagedObjects call and the InterfacesAdded and

1518

InterfacesRemoved signals on the standard

1519

"org.freedesktop.DBus.ObjectManager" interface.

1520

1521

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

1522

manually.

1523

"""

1524

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1525

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

1526

def GetManagedObjects(self):

1527

"""This function must be overridden"""

1528

raise NotImplementedError()

1529

1530

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1531

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

1532

def InterfacesAdded(self, object_path, interfaces_and_properties):

1533

pass

1534

1535

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

1536

def InterfacesRemoved(self, object_path, interfaces):

1537

pass

1538

1539

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1540

out_signature="s",

1541

path_keyword='object_path',

1542

connection_keyword='connection')

1543

def Introspect(self, object_path, connection):

1544

"""Overloading of standard D-Bus method.

1545

1546

Override return argument name of GetManagedObjects to be

1547

"objpath_interfaces_and_properties"

1548

"""

1549

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1550

object_path,

1551

connection)

1552

try:

1553

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

1554

1555

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

1556

# Fix argument name for the GetManagedObjects method

1557

if (if_tag.getAttribute("name")

1558

== dbus.OBJECT_MANAGER_IFACE):

1559

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

1560

if (cn.getAttribute("name")

1561

== "GetManagedObjects"):

1562

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

1563

if (arg.getAttribute("direction")

1564

== "out"):

1565

arg.setAttribute(

1566

"name",

1567

"objpath_interfaces"

1568

"_and_properties")

1569

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

1570

document.unlink()

1571

except (AttributeError, xml.dom.DOMException,

1572

xml.parsers.expat.ExpatError) as error:

1573

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

1574

exc_info=error)

1575

return xmlstring

1576

1577

1578

def datetime_to_dbus(dt, variant_level=0):

1018

def datetime_to_dbus (dt, variant_level=0):

1579

1019

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

1580

1020

if dt is None:

1581

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

1582

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

1021

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

1022

return dbus.String(dt.isoformat(),

1023

variant_level=variant_level)

1583

1024

1584

1025

1585

1026

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1587

1028

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

1588

1029

interface names according to the "alt_interface_names" mapping.

1589

1030

Usage:

1590

1591

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

1592

"net.example.AlternateInterface"})

1031

1032

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

1033

"net.example.AlternateInterface"})

1593

1034

class SampleDBusObject(dbus.service.Object):

1594

1035

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

1595

1036

def SampleDBusMethod():

1596

1037

pass

1597

1038

1598

1039

The above "SampleDBusMethod" on "SampleDBusObject" will be

1599

1040

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

1600

1041

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

1601

1042

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

1602

1043

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

1603

1044

1604

1045

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

1605

1046

(from DBusObjectWithProperties) and interfaces (from the

1606

1047

dbus_interface_annotations decorator).

1607

1048

"""

1608

1609

1049

def wrapper(cls):

1610

1050

for orig_interface_name, alt_interface_name in (

1611

alt_interface_names.items()):

1051

alt_interface_names.iteritems()):

1612

1052

attr = {}

1613

1053

interface_names = set()

1614

1054

# Go though all attributes of the class

1616

1056

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

1617

1057

# with the wrong interface name

1618

1058

if (not hasattr(attribute, "_dbus_interface")

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1059

or not attribute._dbus_interface

1060

.startswith(orig_interface_name)):

1621

1061

continue

1622

1062

# Create an alternate D-Bus interface name based on

1623

1063

# the current name

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1064

alt_interface = (attribute._dbus_interface

1065

.replace(orig_interface_name,

1066

alt_interface_name))

1626

1067

interface_names.add(alt_interface)

1627

1068

# Is this a D-Bus signal?

1628

1069

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

1629

# Extract the original non-method undecorated

1630

# function by black magic

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1070

# Extract the original non-method function by

1071

# black magic

1072

nonmethod_func = (dict(

1633

1073

zip(attribute.func_code.co_freevars,

1634

attribute.__closure__))

1635

["func"].cell_contents)

1636

else:

1637

nonmethod_func = (dict(

1638

zip(attribute.__code__.co_freevars,

1639

attribute.__closure__))

1640

["func"].cell_contents)

1074

attribute.__closure__))["func"]

1075

.cell_contents)

1641

1076

# Create a new, but exactly alike, function

1642

1077

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

1643

1078

# with the alternate D-Bus interface name

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1079

new_function = (dbus.service.signal

1080

(alt_interface,

1081

attribute._dbus_signature)

1082

(types.FunctionType(

1083

nonmethod_func.func_code,

1084

nonmethod_func.func_globals,

1085

nonmethod_func.func_name,

1086

nonmethod_func.func_defaults,

1087

nonmethod_func.func_closure)))

1648

1088

# Copy annotations, if any

1649

1089

try:

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1090

new_function._dbus_annotations = (

1091

dict(attribute._dbus_annotations))

1652

1092

except AttributeError:

1653

1093

pass

1654

1655

1094

# Define a creator of a function to call both the

1656

1095

# original and alternate functions, so both the

1657

1096

# original and alternate signals gets sent when

1660

1099

"""This function is a scope container to pass

1661

1100

func1 and func2 to the "call_both" function

1662

1101

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1665

1102

def call_both(*args, **kwargs):

1666

1103

"""This function will emit two D-Bus

1667

1104

signals by calling func1 and func2"""

1668

1105

func1(*args, **kwargs)

1669

1106

func2(*args, **kwargs)

1670

# Make wrapper function look like a D-Bus

1671

# signal

1672

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

1673

if name.startswith("_dbus_"):

1674

setattr(call_both, name, attr)

1675

1676

1107

return call_both

1677

1108

# Create the "call_both" function and add it to

1678

1109

# the class

1683

1114

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

1684

1115

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

1685

1116

# to the class.

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1117

attr[attrname] = (dbus.service.method

1118

(alt_interface,

1119

attribute._dbus_in_signature,

1120

attribute._dbus_out_signature)

1121

(types.FunctionType

1122

(attribute.func_code,

1123

attribute.func_globals,

1124

attribute.func_name,

1125

attribute.func_defaults,

1126

attribute.func_closure)))

1692

1127

# Copy annotations, if any

1693

1128

try:

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1129

attr[attrname]._dbus_annotations = (

1130

dict(attribute._dbus_annotations))

1696

1131

except AttributeError:

1697

1132

pass

1698

1133

# Is this a D-Bus property?

1701

1136

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

1702

1137

# property with the alternate D-Bus interface

1703

1138

# name. Add it to the class.

1704

attr[attrname] = (dbus_service_property(

1705

alt_interface, attribute._dbus_signature,

1706

attribute._dbus_access,

1707

attribute._dbus_get_args_options

1708

["byte_arrays"])

1709

(copy_function(attribute)))

1139

attr[attrname] = (dbus_service_property

1140

(alt_interface,

1141

attribute._dbus_signature,

1142

attribute._dbus_access,

1143

attribute

1144

._dbus_get_args_options

1145

["byte_arrays"])

1146

(types.FunctionType

1147

(attribute.func_code,

1148

attribute.func_globals,

1149

attribute.func_name,

1150

attribute.func_defaults,

1151

attribute.func_closure)))

1710

1152

# Copy annotations, if any

1711

1153

try:

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1154

attr[attrname]._dbus_annotations = (

1155

dict(attribute._dbus_annotations))

1714

1156

except AttributeError:

1715

1157

pass

1716

1158

# Is this a D-Bus interface?

1719

1161

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

1720

1162

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

1721

1163

# to the class.

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1164

attr[attrname] = (dbus_interface_annotations

1165

(alt_interface)

1166

(types.FunctionType

1167

(attribute.func_code,

1168

attribute.func_globals,

1169

attribute.func_name,

1170

attribute.func_defaults,

1171

attribute.func_closure)))

1725

1172

if deprecate:

1726

1173

# Deprecate all alternate interfaces

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1174

iname="_AlternateDBusNames_interface_annotation{0}"

1728

1175

for interface_name in interface_names:

1729

1730

1176

@dbus_interface_annotations(interface_name)

1731

1177

def func(self):

1732

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

1733

"true"}

1178

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

1179

"true" }

1734

1180

# Find an unused name

1735

1181

for aname in (iname.format(i)

1736

1182

for i in itertools.count()):

1740

1186

if interface_names:

1741

1187

# Replace the class with a new subclass of it with

1742

1188

# methods, signals, etc. as created above.

1743

if sys.version_info.major == 2:

1744

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

1745

(cls, ), attr)

1746

else:

1747

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

1748

(cls, ), attr)

1189

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

1190

(cls,), attr)

1749

1191

return cls

1750

1751

1192

return wrapper

1752

1193

1753

1194

1754

1195

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

1755

"se.bsnet.fukt.Mandos"})

1196

"se.bsnet.fukt.Mandos"})

1756

1197

class ClientDBus(Client, DBusObjectWithProperties):

1757

1198

"""A Client class using D-Bus

1758

1199

1759

1200

Attributes:

1760

1201

dbus_object_path: dbus.ObjectPath

1761

1202

bus: dbus.SystemBus()

1762

1203

"""

1763

1204

1764

1205

runtime_expansions = (Client.runtime_expansions

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1206

+ ("dbus_object_path",))

1207

1769

1208

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

1770

1771

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

1209

1210

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

1772

1211

self.bus = bus

1773

1212

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

1774

1213

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

1775

1214

# the D-Bus

1776

client_object_name = str(self.name).translate(

1215

client_object_name = unicode(self.name).translate(

1777

1216

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

1778

1217

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

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1218

self.dbus_object_path = (dbus.ObjectPath

1219

("/clients/" + client_object_name))

1781

1220

DBusObjectWithProperties.__init__(self, self.bus,

1782

1221

self.dbus_object_path)

1783

1784

def notifychangeproperty(transform_func, dbus_name,

1785

type_func=lambda x: x,

1786

variant_level=1,

1787

invalidate_only=False,

1788

_interface=_interface):

1222

1223

def notifychangeproperty(transform_func,

1224

dbus_name, type_func=lambda x: x,

1225

variant_level=1):

1789

1226

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

1790

1227

its changes to DBus.

1791

1228

1792

1229

transform_fun: Function that takes a value and a variant_level

1793

1230

and transforms it to a D-Bus type.

1794

1231

dbus_name: D-Bus name of the variable

1796

1233

to the D-Bus. Default: no transform

1797

1234

variant_level: D-Bus variant level. Default: 1

1798

1235

"""

1799

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

1800

1236

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

1801

1237

def setter(self, value):

1802

1238

if hasattr(self, "dbus_object_path"):

1803

1239

if (not hasattr(self, attrname) or

1804

1240

type_func(getattr(self, attrname, None))

1805

1241

!= type_func(value)):

1806

if invalidate_only:

1807

self.PropertiesChanged(

1808

_interface, dbus.Dictionary(),

1809

dbus.Array((dbus_name, )))

1810

else:

1811

dbus_value = transform_func(

1812

type_func(value),

1813

variant_level=variant_level)

1814

self.PropertyChanged(dbus.String(dbus_name),

1815

dbus_value)

1816

self.PropertiesChanged(

1817

_interface,

1818

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

1819

dbus_value}),

1820

dbus.Array())

1242

dbus_value = transform_func(type_func(value),

1243

variant_level

1244

=variant_level)

1245

self.PropertyChanged(dbus.String(dbus_name),

1246

dbus_value)

1821

1247

setattr(self, attrname, value)

1822

1248

1823

1249

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

1824

1250

1825

1251

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1826

1252

approvals_pending = notifychangeproperty(dbus.Boolean,

1827

1253

"ApprovalPending",

1828

type_func=bool)

1254

type_func = bool)

1829

1255

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

1830

1256

last_enabled = notifychangeproperty(datetime_to_dbus,

1831

1257

"LastEnabled")

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1258

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

1259

type_func = lambda checker:

1260

checker is not None)

1835

1261

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1836

1262

"LastCheckedOK")

1837

1263

last_checker_status = notifychangeproperty(dbus.Int16,

1840

1266

datetime_to_dbus, "LastApprovalRequest")

1841

1267

approved_by_default = notifychangeproperty(dbus.Boolean,

1842

1268

"ApprovedByDefault")

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1269

approval_delay = notifychangeproperty(dbus.UInt64,

1270

"ApprovalDelay",

1271

type_func =

1272

timedelta_to_milliseconds)

1846

1273

approval_duration = notifychangeproperty(

1847

1274

dbus.UInt64, "ApprovalDuration",

1848

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

1275

type_func = timedelta_to_milliseconds)

1849

1276

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

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1277

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

1278

type_func =

1279

timedelta_to_milliseconds)

1853

1280

extended_timeout = notifychangeproperty(

1854

1281

dbus.UInt64, "ExtendedTimeout",

1855

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

1856

interval = notifychangeproperty(

1857

dbus.UInt64, "Interval",

1858

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

1282

type_func = timedelta_to_milliseconds)

1283

interval = notifychangeproperty(dbus.UInt64,

1284

"Interval",

1285

type_func =

1286

timedelta_to_milliseconds)

1859

1287

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

1860

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

1861

invalidate_only=True)

1862

1288

1863

1289

del notifychangeproperty

1864

1290

1865

1291

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

1866

1292

try:

1867

1293

self.remove_from_connection()

1870

1296

if hasattr(DBusObjectWithProperties, "__del__"):

1871

1297

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

1872

1298

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

1873

1874

def checker_callback(self, source, condition,

1875

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

1876

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

1877

connection, command, *args,

1878

**kwargs)

1879

exitstatus = self.last_checker_status

1880

if exitstatus >= 0:

1299

1300

def checker_callback(self, pid, condition, command,

1301

*args, **kwargs):

1302

self.checker_callback_tag = None

1303

self.checker = None

1304

if os.WIFEXITED(condition):

1305

exitstatus = os.WEXITSTATUS(condition)

1881

1306

# Emit D-Bus signal

1882

1307

self.CheckerCompleted(dbus.Int16(exitstatus),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1308

dbus.Int64(condition),

1885

1309

dbus.String(command))

1886

1310

else:

1887

1311

# Emit D-Bus signal

1888

1312

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

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1313

dbus.Int64(condition),

1893

1314

dbus.String(command))

1894

return ret

1895

1315

1316

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

1317

*args, **kwargs)

1318

1896

1319

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

1897

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

1320

old_checker = self.checker

1321

if self.checker is not None:

1322

old_checker_pid = self.checker.pid

1323

else:

1324

old_checker_pid = None

1898

1325

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

1899

1326

# Only if new checker process was started

1900

1327

if (self.checker is not None

1902

1329

# Emit D-Bus signal

1903

1330

self.CheckerStarted(self.current_checker_command)

1904

1331

return r

1905

1332

1906

1333

def _reset_approved(self):

1907

1334

self.approved = None

1908

1335

return False

1909

1336

1910

1337

def approve(self, value=True):

1338

self.send_changedstate()

1911

1339

self.approved = value

1912

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

1913

* 1000), self._reset_approved)

1914

self.send_changedstate()

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1340

gobject.timeout_add(timedelta_to_milliseconds

1341

(self.approval_duration),

1342

self._reset_approved)

1343

1344

## D-Bus methods, signals & properties

1345

_interface = "se.recompile.Mandos.Client"

1346

1347

## Interfaces

1348

1349

@dbus_interface_annotations(_interface)

1350

def _foo(self):

1351

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

1352

"false"}

1353

1354

## Signals

1355

1922

1356

# CheckerCompleted - signal

1923

1357

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

1924

1358

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

1925

1359

"D-Bus signal"

1926

1360

pass

1927

1361

1928

1362

# CheckerStarted - signal

1929

1363

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

1930

1364

def CheckerStarted(self, command):

1931

1365

"D-Bus signal"

1932

1366

pass

1933

1367

1934

1368

# PropertyChanged - signal

1935

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

1936

1369

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

1937

1370

def PropertyChanged(self, property, value):

1938

1371

"D-Bus signal"

1939

1372

pass

1940

1373

1941

1374

# GotSecret - signal

1942

1375

@dbus.service.signal(_interface)

1943

1376

def GotSecret(self):

1946

1379

server to mandos-client

1947

1380

"""

1948

1381

pass

1949

1382

1950

1383

# Rejected - signal

1951

1384

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

1952

1385

def Rejected(self, reason):

1953

1386

"D-Bus signal"

1954

1387

pass

1955

1388

1956

1389

# NeedApproval - signal

1957

1390

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

1958

1391

def NeedApproval(self, timeout, default):

1959

1392

"D-Bus signal"

1960

1393

return self.need_approval()

1961

1962

# Methods

1963

1394

1395

## Methods

1396

1964

1397

# Approve - method

1965

1398

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

1966

1399

def Approve(self, value):

1967

1400

self.approve(value)

1968

1401

1969

1402

# CheckedOK - method

1970

1403

@dbus.service.method(_interface)

1971

1404

def CheckedOK(self):

1972

1405

self.checked_ok()

1973

1406

1974

1407

# Enable - method

1975

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

1976

1408

@dbus.service.method(_interface)

1977

1409

def Enable(self):

1978

1410

"D-Bus method"

1979

1411

self.enable()

1980

1412

1981

1413

# StartChecker - method

1982

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

1983

1414

@dbus.service.method(_interface)

1984

1415

def StartChecker(self):

1985

1416

"D-Bus method"

1986

1417

self.start_checker()

1987

1418

1988

1419

# Disable - method

1989

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

1990

1420

@dbus.service.method(_interface)

1991

1421

def Disable(self):

1992

1422

"D-Bus method"

1993

1423

self.disable()

1994

1424

1995

1425

# StopChecker - method

1996

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

1997

1426

@dbus.service.method(_interface)

1998

1427

def StopChecker(self):

1999

1428

self.stop_checker()

2000

2001

# Properties

2002

1429

1430

## Properties

1431

2003

1432

# ApprovalPending - property

2004

1433

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

2005

1434

def ApprovalPending_dbus_property(self):

2006

1435

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

2007

1436

2008

1437

# ApprovedByDefault - property

2009

@dbus_service_property(_interface,

2010

signature="b",

1438

@dbus_service_property(_interface, signature="b",

2011

1439

access="readwrite")

2012

1440

def ApprovedByDefault_dbus_property(self, value=None):

2013

1441

if value is None: # get

2014

1442

return dbus.Boolean(self.approved_by_default)

2015

1443

self.approved_by_default = bool(value)

2016

1444

2017

1445

# ApprovalDelay - property

2018

@dbus_service_property(_interface,

2019

signature="t",

1446

@dbus_service_property(_interface, signature="t",

2020

1447

access="readwrite")

2021

1448

def ApprovalDelay_dbus_property(self, value=None):

2022

1449

if value is None: # get

2023

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

2024

* 1000)

1450

return dbus.UInt64(self.approval_delay_milliseconds())

2025

1451

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

2026

1452

2027

1453

# ApprovalDuration - property

2028

@dbus_service_property(_interface,

2029

signature="t",

1454

@dbus_service_property(_interface, signature="t",

2030

1455

access="readwrite")

2031

1456

def ApprovalDuration_dbus_property(self, value=None):

2032

1457

if value is None: # get

2033

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

2034

* 1000)

1458

return dbus.UInt64(timedelta_to_milliseconds(

1459

self.approval_duration))

2035

1460

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

2036

1461

2037

1462

# Name - property

2038

@dbus_annotations(

2039

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

2040

1463

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

2041

1464

def Name_dbus_property(self):

2042

1465

return dbus.String(self.name)

2043

2044

# KeyID - property

2045

@dbus_annotations(

2046

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

2047

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

2048

def KeyID_dbus_property(self):

2049

return dbus.String(self.key_id)

2050

1466

2051

1467

# Fingerprint - property

2052

@dbus_annotations(

2053

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

2054

1468

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

2055

1469

def Fingerprint_dbus_property(self):

2056

1470

return dbus.String(self.fingerprint)

2057

1471

2058

1472

# Host - property

2059

@dbus_service_property(_interface,

2060

signature="s",

1473

@dbus_service_property(_interface, signature="s",

2061

1474

access="readwrite")

2062

1475

def Host_dbus_property(self, value=None):

2063

1476

if value is None: # get

2064

1477

return dbus.String(self.host)

2065

self.host = str(value)

2066

1478

self.host = unicode(value)

1479

2067

1480

# Created - property

2068

@dbus_annotations(

2069

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

2070

1481

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

2071

1482

def Created_dbus_property(self):

2072

1483

return datetime_to_dbus(self.created)

2073

1484

2074

1485

# LastEnabled - property

2075

1486

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

2076

1487

def LastEnabled_dbus_property(self):

2077

1488

return datetime_to_dbus(self.last_enabled)

2078

1489

2079

1490

# Enabled - property

2080

@dbus_service_property(_interface,

2081

signature="b",

1491

@dbus_service_property(_interface, signature="b",

2082

1492

access="readwrite")

2083

1493

def Enabled_dbus_property(self, value=None):

2084

1494

if value is None: # get

2087

1497

self.enable()

2088

1498

else:

2089

1499

self.disable()

2090

1500

2091

1501

# LastCheckedOK - property

2092

@dbus_service_property(_interface,

2093

signature="s",

1502

@dbus_service_property(_interface, signature="s",

2094

1503

access="readwrite")

2095

1504

def LastCheckedOK_dbus_property(self, value=None):

2096

1505

if value is not None:

2097

1506

self.checked_ok()

2098

1507

return

2099

1508

return datetime_to_dbus(self.last_checked_ok)

2100

1509

2101

1510

# LastCheckerStatus - property

2102

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

1511

@dbus_service_property(_interface, signature="n",

1512

access="read")

2103

1513

def LastCheckerStatus_dbus_property(self):

2104

1514

return dbus.Int16(self.last_checker_status)

2105

1515

2106

1516

# Expires - property

2107

1517

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

2108

1518

def Expires_dbus_property(self):

2109

1519

return datetime_to_dbus(self.expires)

2110

1520

2111

1521

# LastApprovalRequest - property

2112

1522

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

2113

1523

def LastApprovalRequest_dbus_property(self):

2114

1524

return datetime_to_dbus(self.last_approval_request)

2115

1525

2116

1526

# Timeout - property

2117

@dbus_service_property(_interface,

2118

signature="t",

1527

@dbus_service_property(_interface, signature="t",

2119

1528

access="readwrite")

2120

1529

def Timeout_dbus_property(self, value=None):

2121

1530

if value is None: # get

2122

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

2123

old_timeout = self.timeout

1531

return dbus.UInt64(self.timeout_milliseconds())

2124

1532

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

2125

# Reschedule disabling

1533

# Reschedule timeout

2126

1534

if self.enabled:

2127

1535

now = datetime.datetime.utcnow()

2128

self.expires += self.timeout - old_timeout

2129

if self.expires <= now:

1536

time_to_die = timedelta_to_milliseconds(

1537

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

1538

if time_to_die <= 0:

2130

1539

# The timeout has passed

2131

1540

self.disable()

2132

1541

else:

1542

self.expires = (now +

1543

datetime.timedelta(milliseconds =

1544

time_to_die))

2133

1545

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

2134

1546

is None):

2135

1547

return

2136

GLib.source_remove(self.disable_initiator_tag)

2137

self.disable_initiator_tag = GLib.timeout_add(

2138

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

2139

self.disable)

2140

1548

gobject.source_remove(self.disable_initiator_tag)

1549

self.disable_initiator_tag = (gobject.timeout_add

1550

(time_to_die,

1551

self.disable))

1552

2141

1553

# ExtendedTimeout - property

2142

@dbus_service_property(_interface,

2143

signature="t",

1554

@dbus_service_property(_interface, signature="t",

2144

1555

access="readwrite")

2145

1556

def ExtendedTimeout_dbus_property(self, value=None):

2146

1557

if value is None: # get

2147

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

2148

* 1000)

1558

return dbus.UInt64(self.extended_timeout_milliseconds())

2149

1559

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

2150

1560

2151

1561

# Interval - property

2152

@dbus_service_property(_interface,

2153

signature="t",

1562

@dbus_service_property(_interface, signature="t",

2154

1563

access="readwrite")

2155

1564

def Interval_dbus_property(self, value=None):

2156

1565

if value is None: # get

2157

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

1566

return dbus.UInt64(self.interval_milliseconds())

2158

1567

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

2159

1568

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

2160

1569

return

2161

1570

if self.enabled:

2162

1571

# Reschedule checker run

2163

GLib.source_remove(self.checker_initiator_tag)

2164

self.checker_initiator_tag = GLib.timeout_add(

2165

value, self.start_checker)

2166

self.start_checker() # Start one now, too

2167

1572

gobject.source_remove(self.checker_initiator_tag)

1573

self.checker_initiator_tag = (gobject.timeout_add

1574

(value, self.start_checker))

1575

self.start_checker() # Start one now, too

1576

2168

1577

# Checker - property

2169

@dbus_service_property(_interface,

2170

signature="s",

1578

@dbus_service_property(_interface, signature="s",

2171

1579

access="readwrite")

2172

1580

def Checker_dbus_property(self, value=None):

2173

1581

if value is None: # get

2174

1582

return dbus.String(self.checker_command)

2175

self.checker_command = str(value)

2176

1583

self.checker_command = unicode(value)

1584

2177

1585

# CheckerRunning - property

2178

@dbus_service_property(_interface,

2179

signature="b",

1586

@dbus_service_property(_interface, signature="b",

2180

1587

access="readwrite")

2181

1588

def CheckerRunning_dbus_property(self, value=None):

2182

1589

if value is None: # get

2185

1592

self.start_checker()

2186

1593

else:

2187

1594

self.stop_checker()

2188

1595

2189

1596

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

2193

1597

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

2194

1598

def ObjectPath_dbus_property(self):

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1599

return self.dbus_object_path # is already a dbus.ObjectPath

1600

2197

1601

# Secret = property

2198

@dbus_annotations(

2199

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

2200

"invalidates"})

2201

@dbus_service_property(_interface,

2202

signature="ay",

2203

access="write",

2204

byte_arrays=True)

1602

@dbus_service_property(_interface, signature="ay",

1603

access="write", byte_arrays=True)

2205

1604

def Secret_dbus_property(self, value):

2206

self.secret = bytes(value)

2207

1605

self.secret = str(value)

1606

2208

1607

del _interface

2209

1608

2210

1609

2211

1610

class ProxyClient(object):

2212

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

1611

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

2213

1612

self._pipe = child_pipe

2214

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

1613

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

2215

1614

if not self._pipe.recv():

2216

raise KeyError(key_id or fpr)

2217

1615

raise KeyError()

1616

2218

1617

def __getattribute__(self, name):

2219

1618

if name == '_pipe':

2220

1619

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

2223

1622

if data[0] == 'data':

2224

1623

return data[1]

2225

1624

if data[0] == 'function':

2226

2227

1625

def func(*args, **kwargs):

2228

1626

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

2229

1627

return self._pipe.recv()[1]

2230

2231

1628

return func

2232

1629

2233

1630

def __setattr__(self, name, value):

2234

1631

if name == '_pipe':

2235

1632

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

2238

1635

2239

1636

class ClientHandler(socketserver.BaseRequestHandler, object):

2240

1637

"""A class to handle client connections.

2241

1638

2242

1639

Instantiated once for each connection to handle it.

2243

1640

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

2244

1641

2245

1642

def handle(self):

2246

1643

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

2247

1644

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

2248

str(self.client_address))

1645

unicode(self.client_address))

2249

1646

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

2250

1647

self.server.child_pipe.fileno())

2251

2252

session = gnutls.ClientSession(self.request)

2253

2254

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

2255

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

2256

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

2257

# "+DHE-DSS"))

1648

1649

session = (gnutls.connection

1650

.ClientSession(self.request,

1651

gnutls.connection

1652

.X509Credentials()))

1653

1654

# Note: gnutls.connection.X509Credentials is really a

1655

# generic GnuTLS certificate credentials object so long as

1656

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

1657

# here despite using OpenPGP certificates.

1658

1659

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

1660

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

1661

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

1662

# "+DHE-DSS"))

2258

1663

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

2259

1664

priority = self.server.gnutls_priority

2260

1665

if priority is None:

2261

1666

priority = "NORMAL"

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1667

(gnutls.library.functions

1668

.gnutls_priority_set_direct(session._c_object,

1669

priority, None))

1670

2266

1671

# Start communication using the Mandos protocol

2267

1672

# Get protocol number

2268

1673

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

2269

1674

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

2270

1675

try:

2271

1676

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

2272

raise RuntimeError(line)

1677

raise RuntimeError

2273

1678

except (ValueError, IndexError, RuntimeError) as error:

2274

1679

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

2275

1680

return

2276

1681

2277

1682

# Start GnuTLS connection

2278

1683

try:

2279

1684

session.handshake()

2280

except gnutls.Error as error:

1685

except gnutls.errors.GNUTLSError as error:

2281

1686

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

2282

1687

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

2283

1688

# established. Just abandon the request.

2284

1689

return

2285

1690

logger.debug("Handshake succeeded")

2286

1691

2287

1692

approval_required = False

2288

1693

try:

2289

if gnutls.has_rawpk:

2290

fpr = ""

2291

try:

2292

key_id = self.key_id(

2293

self.peer_certificate(session))

2294

except (TypeError, gnutls.Error) as error:

2295

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

2296

return

2297

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

2298

2299

else:

2300

key_id = ""

2301

try:

2302

fpr = self.fingerprint(

2303

self.peer_certificate(session))

2304

except (TypeError, gnutls.Error) as error:

2305

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

2306

return

2307

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

2308

2309

try:

2310

client = ProxyClient(child_pipe, key_id, fpr,

1694

try:

1695

fpr = self.fingerprint(self.peer_certificate

1696

(session))

1697

except (TypeError,

1698

gnutls.errors.GNUTLSError) as error:

1699

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

1700

return

1701

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

1702

1703

try:

1704

client = ProxyClient(child_pipe, fpr,

2311

1705

self.client_address)

2312

1706

except KeyError:

2313

1707

return

2314

1708

2315

1709

if client.approval_delay:

2316

1710

delay = client.approval_delay

2317

1711

client.approvals_pending += 1

2318

1712

approval_required = True

2319

1713

2320

1714

while True:

2321

1715

if not client.enabled:

2322

1716

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

2323

client.name)

1717

client.name)

2324

1718

if self.server.use_dbus:

2325

1719

# Emit D-Bus signal

2326

1720

client.Rejected("Disabled")

2327

1721

return

2328

1722

2329

1723

if client.approved or not client.approval_delay:

2330

# We are approved or approval is disabled

1724

#We are approved or approval is disabled

2331

1725

break

2332

1726

elif client.approved is None:

2333

1727

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

2335

1729

if self.server.use_dbus:

2336

1730

# Emit D-Bus signal

2337

1731

client.NeedApproval(

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1732

client.approval_delay_milliseconds(),

1733

client.approved_by_default)

2340

1734

else:

2341

1735

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

2342

1736

client.name)

2344

1738

# Emit D-Bus signal

2345

1739

client.Rejected("Denied")

2346

1740

return

2347

2348

# wait until timeout or approved

1741

1742

#wait until timeout or approved

2349

1743

time = datetime.datetime.now()

2350

1744

client.changedstate.acquire()

2351

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

1745

(client.changedstate.wait

1746

(float(client.timedelta_to_milliseconds(delay)

1747

/ 1000)))

2352

1748

client.changedstate.release()

2353

1749

time2 = datetime.datetime.now()

2354

1750

if (time2 - time) >= delay:

2364

1760

break

2365

1761

else:

2366

1762

delay -= time2 - time

2367

2368

try:

2369

session.send(client.secret)

2370

except gnutls.Error as error:

2371

logger.warning("gnutls send failed",

2372

exc_info=error)

2373

return

2374

1763

1764

sent_size = 0

1765

while sent_size < len(client.secret):

1766

try:

1767

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

1768

except gnutls.errors.GNUTLSError as error:

1769

logger.warning("gnutls send failed",

1770

exc_info=error)

1771

return

1772

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

1773

sent, len(client.secret)

1774

- (sent_size + sent))

1775

sent_size += sent

1776

2375

1777

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

2376

1778

# bump the timeout using extended_timeout

2377

1779

client.bump_timeout(client.extended_timeout)

2378

1780

if self.server.use_dbus:

2379

1781

# Emit D-Bus signal

2380

1782

client.GotSecret()

2381

1783

2382

1784

finally:

2383

1785

if approval_required:

2384

1786

client.approvals_pending -= 1

2385

1787

try:

2386

1788

session.bye()

2387

except gnutls.Error as error:

1789

except gnutls.errors.GNUTLSError as error:

2388

1790

logger.warning("GnuTLS bye failed",

2389

1791

exc_info=error)

2390

1792

2391

1793

@staticmethod

2392

1794

def peer_certificate(session):

2393

"Return the peer's certificate as a bytestring"

2394

try:

2395

cert_type = gnutls.certificate_type_get2(session._c_object,

2396

gnutls.CTYPE_PEERS)

2397

except AttributeError:

2398

cert_type = gnutls.certificate_type_get(session._c_object)

2399

if gnutls.has_rawpk:

2400

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2401

else:

2402

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2403

# If not a valid certificate type...

2404

if cert_type not in valid_cert_types:

2405

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

2406

valid_cert_types)

2407

# ...return invalid data

2408

return b""

1795

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

1796

# If not an OpenPGP certificate...

1797

if (gnutls.library.functions

1798

.gnutls_certificate_type_get(session._c_object)

1799

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1800

# ...do the normal thing

1801

return session.peer_certificate

2409

1802

list_size = ctypes.c_uint(1)

2410

cert_list = (gnutls.certificate_get_peers

1803

cert_list = (gnutls.library.functions

1804

.gnutls_certificate_get_peers

2411

1805

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

2412

1806

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

2413

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

1807

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

1808

" certificate")

2414

1809

if list_size.value == 0:

2415

1810

return None

2416

1811

cert = cert_list[0]

2417

1812

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

2418

2419

@staticmethod

2420

def key_id(certificate):

2421

"Convert a certificate bytestring to a hexdigit key ID"

2422

# New GnuTLS "datum" with the public key

2423

datum = gnutls.datum_t(

2424

ctypes.cast(ctypes.c_char_p(certificate),

2425

ctypes.POINTER(ctypes.c_ubyte)),

2426

ctypes.c_uint(len(certificate)))

2427

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

2428

# New empty GnuTLS certificate

2429

pubkey = gnutls.pubkey_t()

2430

gnutls.pubkey_init(ctypes.byref(pubkey))

2431

# Import the raw public key into the certificate

2432

gnutls.pubkey_import(pubkey,

2433

ctypes.byref(datum),

2434

gnutls.X509_FMT_DER)

2435

# New buffer for the key ID

2436

buf = ctypes.create_string_buffer(32)

2437

buf_len = ctypes.c_size_t(len(buf))

2438

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

2439

gnutls.pubkey_get_key_id(pubkey,

2440

gnutls.KEYID_USE_SHA256,

2441

ctypes.cast(ctypes.byref(buf),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.byref(buf_len))

2444

# Deinit the certificate

2445

gnutls.pubkey_deinit(pubkey)

2446

2447

# Convert the buffer to a Python bytestring

2448

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

2449

# Convert the bytestring to hexadecimal notation

2450

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

2451

return hex_key_id

2452

1813

2453

1814

@staticmethod

2454

1815

def fingerprint(openpgp):

2455

1816

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2456

1817

# New GnuTLS "datum" with the OpenPGP public key

2457

datum = gnutls.datum_t(

2458

ctypes.cast(ctypes.c_char_p(openpgp),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.c_uint(len(openpgp)))

1818

datum = (gnutls.library.types

1819

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

1820

ctypes.POINTER

1821

(ctypes.c_ubyte)),

1822

ctypes.c_uint(len(openpgp))))

2461

1823

# New empty GnuTLS certificate

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1824

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1825

(gnutls.library.functions

1826

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2464

1827

# Import the OpenPGP public key into the certificate

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1828

(gnutls.library.functions

1829

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

1830

gnutls.library.constants

1831

.GNUTLS_OPENPGP_FMT_RAW))

2467

1832

# Verify the self signature in the key

2468

1833

crtverify = ctypes.c_uint()

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1834

(gnutls.library.functions

1835

.gnutls_openpgp_crt_verify_self(crt, 0,

1836

ctypes.byref(crtverify)))

2471

1837

if crtverify.value != 0:

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1838

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1839

raise (gnutls.errors.CertificateSecurityError

1840

("Verify failed"))

2475

1841

# New buffer for the fingerprint

2476

1842

buf = ctypes.create_string_buffer(20)

2477

1843

buf_len = ctypes.c_size_t()

2478

1844

# Get the fingerprint from the certificate into the buffer

2479

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

2480

ctypes.byref(buf_len))

1845

(gnutls.library.functions

1846

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

1847

ctypes.byref(buf_len)))

2481

1848

# Deinit the certificate

2482

gnutls.openpgp_crt_deinit(crt)

1849

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2483

1850

# Convert the buffer to a Python bytestring

2484

1851

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

2485

1852

# Convert the bytestring to hexadecimal notation

2489

1856

2490

1857

class MultiprocessingMixIn(object):

2491

1858

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

2492

2493

1859

def sub_process_main(self, request, address):

2494

1860

try:

2495

1861

self.finish_request(request, address)

2496

1862

except Exception:

2497

1863

self.handle_error(request, address)

2498

1864

self.close_request(request)

2499

1865

2500

1866

def process_request(self, request, address):

2501

1867

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

2502

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

2503

args=(request, address))

1868

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

1869

args = (request, address))

2504

1870

proc.start()

2505

1871

return proc

2506

1872

2507

1873

2508

1874

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2509

1875

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

2510

2511

1876

def process_request(self, request, client_address):

2512

1877

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

2513

1878

2514

1879

This function creates a new pipe in self.pipe

2515

1880

"""

2516

1881

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2517

1882

2518

1883

proc = MultiprocessingMixIn.process_request(self, request,

2519

1884

client_address)

2520

1885

self.child_pipe.close()

2521

1886

self.add_pipe(parent_pipe, proc)

2522

1887

2523

1888

def add_pipe(self, parent_pipe, proc):

2524

1889

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

2525

raise NotImplementedError()

1890

raise NotImplementedError

2526

1891

2527

1892

2528

1893

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2529

1894

socketserver.TCPServer, object):

2530

1895

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

2531

1896

2532

1897

Attributes:

2533

1898

enabled: Boolean; whether this server is activated yet

2534

1899

interface: None or a network interface name (string)

2535

1900

use_ipv6: Boolean; to use IPv6 or not

2536

1901

"""

2537

2538

1902

def __init__(self, server_address, RequestHandlerClass,

2539

interface=None,

2540

use_ipv6=True,

2541

socketfd=None):

2542

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

2543

creating a new one with socket.socket().

2544

"""

1903

interface=None, use_ipv6=True):

2545

1904

self.interface = interface

2546

1905

if use_ipv6:

2547

1906

self.address_family = socket.AF_INET6

2548

if socketfd is not None:

2549

# Save the file descriptor

2550

self.socketfd = socketfd

2551

# Save the original socket.socket() function

2552

self.socket_socket = socket.socket

2553

2554

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

2555

#

2556

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

2557

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

2558

# patching socket.socket.)

2559

#

2560

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

2561

@functools.wraps(socket.socket)

2562

def socket_wrapper(*args, **kwargs):

2563

# Restore original function so subsequent calls are

2564

# not affected.

2565

socket.socket = self.socket_socket

2566

del self.socket_socket

2567

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

2568

# saved file descriptor.

2569

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

2570

# Replace socket.socket() function with wrapper

2571

socket.socket = socket_wrapper

2572

# The socketserver.TCPServer.__init__ will call

2573

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

2574

# socket_wrapper(), if socketfd was set.

2575

1907

socketserver.TCPServer.__init__(self, server_address,

2576

1908

RequestHandlerClass)

2577

2578

1909

def server_bind(self):

2579

1910

"""This overrides the normal server_bind() function

2580

1911

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

2581

1912

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

2582

global SO_BINDTODEVICE

2583

1913

if self.interface is not None:

2584

1914

if SO_BINDTODEVICE is None:

2585

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

2586

# common enough.

2587

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

2588

SO_BINDTODEVICE = 25

2589

try:

2590

self.socket.setsockopt(

2591

socket.SOL_SOCKET, SO_BINDTODEVICE,

2592

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

2593

except socket.error as error:

2594

if error.errno == errno.EPERM:

2595

logger.error("No permission to bind to"

2596

" interface %s", self.interface)

2597

elif error.errno == errno.ENOPROTOOPT:

2598

logger.error("SO_BINDTODEVICE not available;"

2599

" cannot bind to interface %s",

2600

self.interface)

2601

elif error.errno == errno.ENODEV:

2602

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

2603

" cannot bind", self.interface)

2604

else:

2605

raise

1915

logger.error("SO_BINDTODEVICE does not exist;"

1916

" cannot bind to interface %s",

1917

self.interface)

1918

else:

1919

try:

1920

self.socket.setsockopt(socket.SOL_SOCKET,

1921

SO_BINDTODEVICE,

1922

str(self.interface

1923

+ '\0'))

1924

except socket.error as error:

1925

if error[0] == errno.EPERM:

1926

logger.error("No permission to"

1927

" bind to interface %s",

1928

self.interface)

1929

elif error[0] == errno.ENOPROTOOPT:

1930

logger.error("SO_BINDTODEVICE not available;"

1931

" cannot bind to interface %s",

1932

self.interface)

1933

else:

1934

raise

2606

1935

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

2607

1936

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

2608

if self.server_address[1]:

2609

self.allow_reuse_address = True

2610

1937

if not self.server_address[0]:

2611

1938

if self.address_family == socket.AF_INET6:

2612

any_address = "::" # in6addr_any

1939

any_address = "::" # in6addr_any

2613

1940

else:

2614

any_address = "0.0.0.0" # INADDR_ANY

1941

any_address = socket.INADDR_ANY

2615

1942

self.server_address = (any_address,

2616

1943

self.server_address[1])

2617

1944

elif not self.server_address[1]:

2618

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

1945

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

1946

0)

2619

1947

# if self.interface:

2620

1948

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

2621

1949

# 0, # port

2627

1955

2628

1956

class MandosServer(IPv6_TCPServer):

2629

1957

"""Mandos server.

2630

1958

2631

1959

Attributes:

2632

1960

clients: set of Client objects

2633

1961

gnutls_priority GnuTLS priority string

2634

1962

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

2635

2636

Assumes a GLib.MainLoop event loop.

1963

1964

Assumes a gobject.MainLoop event loop.

2637

1965

"""

2638

2639

1966

def __init__(self, server_address, RequestHandlerClass,

2640

interface=None,

2641

use_ipv6=True,

2642

clients=None,

2643

gnutls_priority=None,

2644

use_dbus=True,

2645

socketfd=None):

1967

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

1968

gnutls_priority=None, use_dbus=True):

2646

1969

self.enabled = False

2647

1970

self.clients = clients

2648

1971

if self.clients is None:

2651

1974

self.gnutls_priority = gnutls_priority

2652

1975

IPv6_TCPServer.__init__(self, server_address,

2653

1976

RequestHandlerClass,

2654

interface=interface,

2655

use_ipv6=use_ipv6,

2656

socketfd=socketfd)

2657

1977

interface = interface,

1978

use_ipv6 = use_ipv6)

2658

1979

def server_activate(self):

2659

1980

if self.enabled:

2660

1981

return socketserver.TCPServer.server_activate(self)

2661

1982

2662

1983

def enable(self):

2663

1984

self.enabled = True

2664

1985

2665

1986

def add_pipe(self, parent_pipe, proc):

2666

1987

# Call "handle_ipc" for both data and EOF events

2667

GLib.io_add_watch(

2668

parent_pipe.fileno(),

2669

GLib.IO_IN | GLib.IO_HUP,

2670

functools.partial(self.handle_ipc,

2671

parent_pipe=parent_pipe,

2672

proc=proc))

2673

2674

def handle_ipc(self, source, condition,

2675

parent_pipe=None,

2676

proc=None,

2677

client_object=None):

1988

gobject.io_add_watch(parent_pipe.fileno(),

1989

gobject.IO_IN | gobject.IO_HUP,

1990

functools.partial(self.handle_ipc,

1991

parent_pipe =

1992

parent_pipe,

1993

proc = proc))

1994

1995

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

1996

proc = None, client_object=None):

2678

1997

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

2679

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

1998

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

2680

1999

# Wait for other process to exit

2681

2000

proc.join()

2682

2001

return False

2683

2002

2684

2003

# Read a request from the child

2685

2004

request = parent_pipe.recv()

2686

2005

command = request[0]

2687

2006

2688

2007

if command == 'init':

2689

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

2690

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

2691

address = request[3]

2692

2693

for c in self.clients.values():

2694

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2695

continue

2696

if key_id and c.key_id == key_id:

2697

client = c

2698

break

2699

if fpr and c.fingerprint == fpr:

2008

fpr = request[1]

2009

address = request[2]

2010

2011

for c in self.clients.itervalues():

2012

if c.fingerprint == fpr:

2700

2013

client = c

2701

2014

break

2702

2015

else:

2703

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

2704

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

2016

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

2017

"dress: %s", fpr, address)

2705

2018

if self.use_dbus:

2706

2019

# Emit D-Bus signal

2707

mandos_dbus_service.ClientNotFound(key_id or fpr,

2020

mandos_dbus_service.ClientNotFound(fpr,

2708

2021

address[0])

2709

2022

parent_pipe.send(False)

2710

2023

return False

2711

2712

GLib.io_add_watch(

2713

parent_pipe.fileno(),

2714

GLib.IO_IN | GLib.IO_HUP,

2715

functools.partial(self.handle_ipc,

2716

parent_pipe=parent_pipe,

2717

proc=proc,

2718

client_object=client))

2024

2025

gobject.io_add_watch(parent_pipe.fileno(),

2026

gobject.IO_IN | gobject.IO_HUP,

2027

functools.partial(self.handle_ipc,

2028

parent_pipe =

2029

parent_pipe,

2030

proc = proc,

2031

client_object =

2032

client))

2719

2033

parent_pipe.send(True)

2720

2034

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

2721

2035

# same fileno

2724

2038

funcname = request[1]

2725

2039

args = request[2]

2726

2040

kwargs = request[3]

2727

2041

2728

2042

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

2729

2043

funcname)(*args,

2730

**kwargs)))

2731

2044

**kwargs)))

2045

2732

2046

if command == 'getattr':

2733

2047

attrname = request[1]

2734

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

2048

if callable(client_object.__getattribute__(attrname)):

2049

parent_pipe.send(('function',))

2737

2050

else:

2738

parent_pipe.send((

2739

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

2740

2051

parent_pipe.send(('data', client_object

2052

.__getattribute__(attrname)))

2053

2741

2054

if command == 'setattr':

2742

2055

attrname = request[1]

2743

2056

value = request[2]

2744

2057

setattr(client_object, attrname, value)

2745

2058

2746

2059

return True

2747

2060

2748

2061

2749

def rfc3339_duration_to_delta(duration):

2750

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

2751

2752

>>> rfc3339_duration_to_delta("P7D")

2753

datetime.timedelta(7)

2754

>>> rfc3339_duration_to_delta("PT60S")

2755

datetime.timedelta(0, 60)

2756

>>> rfc3339_duration_to_delta("PT60M")

2757

datetime.timedelta(0, 3600)

2758

>>> rfc3339_duration_to_delta("PT24H")

2759

datetime.timedelta(1)

2760

>>> rfc3339_duration_to_delta("P1W")

2761

datetime.timedelta(7)

2762

>>> rfc3339_duration_to_delta("PT5M30S")

2763

datetime.timedelta(0, 330)

2764

>>> rfc3339_duration_to_delta("P1DT3M20S")

2765

datetime.timedelta(1, 200)

2766

"""

2767

2768

# Parsing an RFC 3339 duration with regular expressions is not

2769

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

2770

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

2771

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

2772

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

2773

# avoid excessive use of external libraries.

2774

2775

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

2776

Token = collections.namedtuple("Token", (

2777

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

2778

# a "group" containing digits

2779

"value", # datetime.timedelta or None

2780

"followers")) # Tokens valid after this token

2781

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

2782

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

2783

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

2784

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

2785

datetime.timedelta(seconds=1),

2786

frozenset((token_end, )))

2787

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

2788

datetime.timedelta(minutes=1),

2789

frozenset((token_second, token_end)))

2790

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

2791

datetime.timedelta(hours=1),

2792

frozenset((token_minute, token_end)))

2793

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

2794

None,

2795

frozenset((token_hour, token_minute,

2796

token_second)))

2797

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

2798

datetime.timedelta(days=1),

2799

frozenset((token_time, token_end)))

2800

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

2801

datetime.timedelta(weeks=4),

2802

frozenset((token_day, token_end)))

2803

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

2804

datetime.timedelta(weeks=52),

2805

frozenset((token_month, token_end)))

2806

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

2807

datetime.timedelta(weeks=1),

2808

frozenset((token_end, )))

2809

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

2810

frozenset((token_year, token_month,

2811

token_day, token_time,

2812

token_week)))

2813

# Define starting values:

2814

# Value so far

2815

value = datetime.timedelta()

2816

found_token = None

2817

# Following valid tokens

2818

followers = frozenset((token_duration, ))

2819

# String left to parse

2820

s = duration

2821

# Loop until end token is found

2822

while found_token is not token_end:

2823

# Search for any currently valid tokens

2824

for token in followers:

2825

match = token.regexp.match(s)

2826

if match is not None:

2827

# Token found

2828

if token.value is not None:

2829

# Value found, parse digits

2830

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

2831

# Add to value so far

2832

value += factor * token.value

2833

# Strip token from string

2834

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

2835

# Go to found token

2836

found_token = token

2837

# Set valid next tokens

2838

followers = found_token.followers

2839

break

2840

else:

2841

# No currently valid tokens were found

2842

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

2843

.format(duration))

2844

# End token found

2845

return value

2846

2847

2848

2062

def string_to_delta(interval):

2849

2063

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

2850

2064

2851

2065

>>> string_to_delta('7d')

2852

2066

datetime.timedelta(7)

2853

2067

>>> string_to_delta('60s')

2861

2075

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

2862

2076

datetime.timedelta(0, 330)

2863

2077

"""

2864

2865

try:

2866

return rfc3339_duration_to_delta(interval)

2867

except ValueError:

2868

pass

2869

2870

2078

timevalue = datetime.timedelta(0)

2871

2079

for s in interval.split():

2872

2080

try:

2873

suffix = s[-1]

2081

suffix = unicode(s[-1])

2874

2082

value = int(s[:-1])

2875

2083

if suffix == "d":

2876

2084

delta = datetime.timedelta(value)

2883

2091

elif suffix == "w":

2884

2092

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

2885

2093

else:

2886

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

2887

except IndexError as e:

2094

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

2095

.format(suffix))

2096

except (ValueError, IndexError) as e:

2888

2097

raise ValueError(*(e.args))

2889

2098

timevalue += delta

2890

2099

return timevalue

2891

2100

2892

2101

2893

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

2102

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

2894

2103

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

2895

2104

2896

2105

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

2897

2106

if os.fork():

2898

2107

sys.exit()

2906

2115

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

2907

2116

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

2908

2117

raise OSError(errno.ENODEV,

2909

"{} not a character device"

2118

"{0} not a character device"

2910

2119

.format(os.devnull))

2911

2120

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

2912

2121

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

2916

2125

2917

2126

2918

2127

def main():

2919

2128

2920

2129

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

2921

2130

# Parsing of options, both command line and config file

2922

2131

2923

2132

parser = argparse.ArgumentParser()

2924

2133

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

2925

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

2134

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

2926

2135

help="show version number and exit")

2927

2136

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

2928

2137

help="Bind to interface IF")

2934

2143

help="Run self-test")

2935

2144

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

2936

2145

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

2937

" to terminal", default=None)

2146

" to terminal")

2938

2147

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

2939

2148

help="Debug level for stdout output")

2940

2149

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

2947

2156

" files")

2948

2157

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

2949

2158

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

2950

" system bus interface", default=None)

2159

" system bus interface")

2951

2160

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

2952

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

2953

default=None)

2161

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

2954

2162

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

2955

2163

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

2956

" state", default=None)

2957

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

2958

help="Specify a file descriptor to a network"

2959

" socket to use instead of creating one")

2164

" state")

2960

2165

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

2961

2166

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

2962

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

2963

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

2964

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

2965

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

2966

default=None)

2967

2167

2968

2168

options = parser.parse_args()

2969

2169

2970

2170

if options.check:

2971

2171

import doctest

2972

fail_count, test_count = doctest.testmod()

2973

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

2974

2172

doctest.testmod()

2173

sys.exit()

2174

2975

2175

# Default values for config file for server-global settings

2976

if gnutls.has_rawpk:

2977

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

2978

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

2979

else:

2980

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

2981

":+SIGN-DSA-SHA256")

2982

server_defaults = {"interface": "",

2983

"address": "",

2984

"port": "",

2985

"debug": "False",

2986

"priority": priority,

2987

"servicename": "Mandos",

2988

"use_dbus": "True",

2989

"use_ipv6": "True",

2990

"debuglevel": "",

2991

"restore": "True",

2992

"socket": "",

2993

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

2994

"foreground": "False",

2995

"zeroconf": "True",

2996

}

2997

del priority

2998

2176

server_defaults = { "interface": "",

2177

"address": "",

2178

"port": "",

2179

"debug": "False",

2180

"priority":

2181

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

2182

"servicename": "Mandos",

2183

"use_dbus": "True",

2184

"use_ipv6": "True",

2185

"debuglevel": "",

2186

"restore": "True",

2187

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

2188

}

2189

2999

2190

# Parse config file for server-global settings

3000

2191

server_config = configparser.SafeConfigParser(server_defaults)

3001

2192

del server_defaults

3002

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

2193

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

2194

"mandos.conf"))

3003

2195

# Convert the SafeConfigParser object to a dict

3004

2196

server_settings = server_config.defaults()

3005

2197

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

3006

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

3007

"foreground", "zeroconf"):

2198

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

3008

2199

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

3009

2200

option)

3010

2201

if server_settings["port"]:

3011

2202

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

3012

2203

"port")

3013

if server_settings["socket"]:

3014

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

3015

"socket")

3016

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

3017

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

3018

# happen with a supplied network socket.

3019

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

3020

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

3021

["socket"])

3022

2204

del server_config

3023

2205

3024

2206

# Override the settings from the config file with command line

3025

2207

# options, if set.

3026

2208

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

3027

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

3028

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

3029

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

2209

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

2210

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

2211

"statedir"):

3030

2212

value = getattr(options, option)

3031

2213

if value is not None:

3032

2214

server_settings[option] = value

3033

2215

del options

3034

2216

# Force all strings to be unicode

3035

2217

for option in server_settings.keys():

3036

if isinstance(server_settings[option], bytes):

3037

server_settings[option] = (server_settings[option]

3038

.decode("utf-8"))

3039

# Force all boolean options to be boolean

3040

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

3041

"foreground", "zeroconf"):

3042

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

3043

# Debug implies foreground

3044

if server_settings["debug"]:

3045

server_settings["foreground"] = True

2218

if type(server_settings[option]) is str:

2219

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

3046

2220

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

3047

2221

3048

2222

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

3049

3050

if (not server_settings["zeroconf"]

3051

and not (server_settings["port"]

3052

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

3053

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

3054

2223

3055

2224

# For convenience

3056

2225

debug = server_settings["debug"]

3057

2226

debuglevel = server_settings["debuglevel"]

3059

2228

use_ipv6 = server_settings["use_ipv6"]

3060

2229

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

3061

2230

stored_state_file)

3062

foreground = server_settings["foreground"]

3063

zeroconf = server_settings["zeroconf"]

3064

2231

3065

2232

if debug:

3066

2233

initlogger(debug, logging.DEBUG)

3067

2234

else:

3070

2237

else:

3071

2238

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

3072

2239

initlogger(debug, level)

3073

2240

3074

2241

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

3075

syslogger.setFormatter(

3076

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

3077

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

3078

server_settings["servicename"])))

3079

2242

syslogger.setFormatter(logging.Formatter

2243

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

2244

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

2245

.format(server_settings

2246

["servicename"])))

2247

3080

2248

# Parse config file with clients

3081

2249

client_config = configparser.SafeConfigParser(Client

3082

2250

.client_defaults)

3083

2251

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

3084

2252

"clients.conf"))

3085

2253

3086

2254

global mandos_dbus_service

3087

2255

mandos_dbus_service = None

3088

3089

socketfd = None

3090

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

3091

socketfd = server_settings["socket"]

3092

tcp_server = MandosServer(

3093

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

3094

ClientHandler,

3095

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

3096

use_ipv6=use_ipv6,

3097

gnutls_priority=server_settings["priority"],

3098

use_dbus=use_dbus,

3099

socketfd=socketfd)

3100

if not foreground:

3101

pidfilename = "/run/mandos.pid"

3102

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

3103

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

3104

pidfile = None

2256

2257

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

2258

server_settings["port"]),

2259

ClientHandler,

2260

interface=(server_settings["interface"]

2261

or None),

2262

use_ipv6=use_ipv6,

2263

gnutls_priority=

2264

server_settings["priority"],

2265

use_dbus=use_dbus)

2266

if not debug:

2267

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

3105

2268

try:

3106

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

2269

pidfile = open(pidfilename, "w")

3107

2270

except IOError as e:

3108

2271

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

3109

2272

exc_info=e)

3110

3111

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

3112

("mandos", "mandos"),

3113

("nobody", "nogroup")):

2273

2274

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

3114

2275

try:

3115

2276

uid = pwd.getpwnam(name).pw_uid

3116

gid = pwd.getpwnam(group).pw_gid

2277

gid = pwd.getpwnam(name).pw_gid

3117

2278

break

3118

2279

except KeyError:

3119

2280

continue

3123

2284

try:

3124

2285

os.setgid(gid)

3125

2286

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

3129

2287

except OSError as error:

3130

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

3131

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

3132

if error.errno != errno.EPERM:

3133

raise

3134

2288

if error[0] != errno.EPERM:

2289

raise error

2290

3135

2291

if debug:

3136

2292

# Enable all possible GnuTLS debugging

3137

2293

3138

2294

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

3139

2295

# - GnuTLS manual

3140

gnutls.global_set_log_level(11)

3141

3142

@gnutls.log_func

2296

gnutls.library.functions.gnutls_global_set_log_level(11)

2297

2298

@gnutls.library.types.gnutls_log_func

3143

2299

def debug_gnutls(level, string):

3144

2300

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

3145

3146

gnutls.global_set_log_function(debug_gnutls)

3147

2301

2302

(gnutls.library.functions

2303

.gnutls_global_set_log_function(debug_gnutls))

2304

3148

2305

# Redirect stdin so all checkers get /dev/null

3149

2306

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

3150

2307

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

3151

2308

if null > 2:

3152

2309

os.close(null)

3153

2310

3154

2311

# Need to fork before connecting to D-Bus

3155

if not foreground:

2312

if not debug:

3156

2313

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

3157

2314

daemon()

3158

3159

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

3160

# to inform GLib that threads will be used.

3161

GLib.threads_init()

3162

2315

2316

gobject.threads_init()

2317

3163

2318

global main_loop

3164

2319

# From the Avahi example code

3165

2320

DBusGMainLoop(set_as_default=True)

3166

main_loop = GLib.MainLoop()

2321

main_loop = gobject.MainLoop()

3167

2322

bus = dbus.SystemBus()

3168

2323

# End of Avahi example code

3169

2324

if use_dbus:

3170

2325

try:

3171

2326

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

3172

bus,

3173

do_not_queue=True)

3174

old_bus_name = dbus.service.BusName(

3175

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

3176

do_not_queue=True)

3177

except dbus.exceptions.DBusException as e:

2327

bus, do_not_queue=True)

2328

old_bus_name = (dbus.service.BusName

2329

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

2330

do_not_queue=True))

2331

except dbus.exceptions.NameExistsException as e:

3178

2332

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

3179

2333

use_dbus = False

3180

2334

server_settings["use_dbus"] = False

3181

2335

tcp_server.use_dbus = False

3182

if zeroconf:

3183

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3184

service = AvahiServiceToSyslog(

3185

name=server_settings["servicename"],

3186

servicetype="_mandos._tcp",

3187

protocol=protocol,

3188

bus=bus)

3189

if server_settings["interface"]:

3190

service.interface = if_nametoindex(

3191

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

3192

2336

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2337

service = AvahiServiceToSyslog(name =

2338

server_settings["servicename"],

2339

servicetype = "_mandos._tcp",

2340

protocol = protocol, bus = bus)

2341

if server_settings["interface"]:

2342

service.interface = (if_nametoindex

2343

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

2344

3193

2345

global multiprocessing_manager

3194

2346

multiprocessing_manager = multiprocessing.Manager()

3195

2347

3196

2348

client_class = Client

3197

2349

if use_dbus:

3198

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

3199

2350

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

2351

3200

2352

client_settings = Client.config_parser(client_config)

3201

2353

old_client_settings = {}

3202

2354

clients_data = {}

3203

3204

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

3205

global wnull

3206

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

3207

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

3208

# mode

3209

if debug or not foreground:

3210

wnull.close()

3211

2355

3212

2356

# Get client data and settings from last running state.

3213

2357

if server_settings["restore"]:

3214

2358

try:

3215

2359

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

3216

if sys.version_info.major == 2:

3217

clients_data, old_client_settings = pickle.load(

3218

stored_state)

3219

else:

3220

bytes_clients_data, bytes_old_client_settings = (

3221

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

3222

# Fix bytes to strings

3223

# clients_data

3224

# .keys()

3225

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

3226

if isinstance(key, bytes)

3227

else key): value

3228

for key, value in

3229

bytes_clients_data.items()}

3230

del bytes_clients_data

3231

for key in clients_data:

3232

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

3233

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

3234

for k, v in

3235

clients_data[key].items()}

3236

clients_data[key] = value

3237

# .client_structure

3238

value["client_structure"] = [

3239

(s.decode("utf-8")

3240

if isinstance(s, bytes)

3241

else s) for s in

3242

value["client_structure"]]

3243

# .name & .host

3244

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

3245

if isinstance(value[k], bytes):

3246

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

3247

if not value.has_key("key_id"):

3248

value["key_id"] = ""

3249

elif not value.has_key("fingerprint"):

3250

value["fingerprint"] = ""

3251

# old_client_settings

3252

# .keys()

3253

old_client_settings = {

3254

(key.decode("utf-8")

3255

if isinstance(key, bytes)

3256

else key): value

3257

for key, value in

3258

bytes_old_client_settings.items()}

3259

del bytes_old_client_settings

3260

# .host

3261

for value in old_client_settings.values():

3262

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

3263

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

3264

.decode("utf-8"))

2360

clients_data, old_client_settings = (pickle.load

2361

(stored_state))

3265

2362

os.remove(stored_state_path)

3266

2363

except IOError as e:

3267

2364

if e.errno == errno.ENOENT:

3268

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

3269

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

2365

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

2366

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

3270

2367

else:

3271

2368

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

3272

2369

exc_info=e)

3273

2370

raise

3274

2371

except EOFError as e:

3275

2372

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

3276

"EOFError:",

3277

exc_info=e)

3278

2373

"EOFError:", exc_info=e)

2374

3279

2375

with PGPEngine() as pgp:

3280

for client_name, client in clients_data.items():

3281

# Skip removed clients

3282

if client_name not in client_settings:

3283

continue

3284

2376

for client_name, client in clients_data.iteritems():

3285

2377

# Decide which value to use after restoring saved state.

3286

2378

# We have three different values: Old config file,

3287

2379

# new config file, and saved state.

3292

2384

# For each value in new config, check if it

3293

2385

# differs from the old config value (Except for

3294

2386

# the "secret" attribute)

3295

if (name != "secret"

3296

and (value !=

3297

old_client_settings[client_name][name])):

2387

if (name != "secret" and

2388

value != old_client_settings[client_name]

2389

[name]):

3298

2390

client[name] = value

3299

2391

except KeyError:

3300

2392

pass

3301

2393

3302

2394

# Clients who has passed its expire date can still be

3303

# enabled if its last checker was successful. A Client

2395

# enabled if its last checker was successful. Clients

3304

2396

# whose checker succeeded before we stored its state is

3305

2397

# assumed to have successfully run all checkers during

3306

2398

# downtime.

3308

2400

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

3309

2401

if not client["last_checked_ok"]:

3310

2402

logger.warning(

3311

"disabling client {} - Client never "

3312

"performed a successful checker".format(

3313

client_name))

2403

"disabling client {0} - Client never "

2404

"performed a successful checker"

2405

.format(client_name))

3314

2406

client["enabled"] = False

3315

2407

elif client["last_checker_status"] != 0:

3316

2408

logger.warning(

3317

"disabling client {} - Client last"

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

2409

"disabling client {0} - Client "

2410

"last checker failed with error code {1}"

2411

.format(client_name,

2412

client["last_checker_status"]))

3322

2413

client["enabled"] = False

3323

2414

else:

3324

client["expires"] = (

3325

datetime.datetime.utcnow()

3326

+ client["timeout"])

2415

client["expires"] = (datetime.datetime

2416

.utcnow()

2417

+ client["timeout"])

3327

2418

logger.debug("Last checker succeeded,"

3328

" keeping {} enabled".format(

3329

client_name))

2419

" keeping {0} enabled"

2420

.format(client_name))

3330

2421

try:

3331

client["secret"] = pgp.decrypt(

3332

client["encrypted_secret"],

3333

client_settings[client_name]["secret"])

2422

client["secret"] = (

2423

pgp.decrypt(client["encrypted_secret"],

2424

client_settings[client_name]

2425

["secret"]))

3334

2426

except PGPError:

3335

2427

# If decryption fails, we use secret from new settings

3336

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

3337

client_name))

3338

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

3339

["secret"])

3340

2428

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

2429

.format(client_name))

2430

client["secret"] = (

2431

client_settings[client_name]["secret"])

2432

3341

2433

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

3342

2434

for client_name in (set(old_client_settings)

3343

2435

- set(client_settings)):

3345

2437

for client_name in (set(client_settings)

3346

2438

- set(old_client_settings)):

3347

2439

clients_data[client_name] = client_settings[client_name]

3348

2440

3349

2441

# Create all client objects

3350

for client_name, client in clients_data.items():

2442

for client_name, client in clients_data.iteritems():

3351

2443

tcp_server.clients[client_name] = client_class(

3352

name=client_name,

3353

settings=client,

3354

server_settings=server_settings)

3355

2444

name = client_name, settings = client)

2445

3356

2446

if not tcp_server.clients:

3357

2447

logger.warning("No clients defined")

3358

3359

if not foreground:

3360

if pidfile is not None:

3361

pid = os.getpid()

3362

try:

3363

with pidfile:

3364

print(pid, file=pidfile)

3365

except IOError:

3366

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

3367

pidfilename, pid)

3368

del pidfile

2448

2449

if not debug:

2450

try:

2451

with pidfile:

2452

pid = os.getpid()

2453

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

2454

del pidfile

2455

except IOError:

2456

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

2457

pidfilename, pid)

2458

except NameError:

2459

# "pidfile" was never created

2460

pass

3369

2461

del pidfilename

3370

3371

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

3372

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3373

lambda: main_loop.quit() and False)

3374

2462

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

2463

2464

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

2465

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

2466

3375

2467

if use_dbus:

3376

3377

@alternate_dbus_interfaces(

3378

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

3379

class MandosDBusService(DBusObjectWithObjectManager):

2468

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

2469

"se.bsnet.fukt.Mandos"})

2470

class MandosDBusService(DBusObjectWithProperties):

3380

2471

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

3381

3382

2472

def __init__(self):

3383

2473

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

3384

3385

2474

_interface = "se.recompile.Mandos"

3386

2475

2476

@dbus_interface_annotations(_interface)

2477

def _foo(self):

2478

return { "org.freedesktop.DBus.Property"

2479

".EmitsChangedSignal":

2480

"false"}

2481

3387

2482

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

3388

2483

def ClientAdded(self, objpath):

3389

2484

"D-Bus signal"

3390

2485

pass

3391

2486

3392

2487

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

3393

def ClientNotFound(self, key_id, address):

2488

def ClientNotFound(self, fingerprint, address):

3394

2489

"D-Bus signal"

3395

2490

pass

3396

3397

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

3398

"true"})

2491

3399

2492

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

3400

2493

def ClientRemoved(self, objpath, name):

3401

2494

"D-Bus signal"

3402

2495

pass

3403

3404

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

3405

"true"})

2496

3406

2497

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

3407

2498

def GetAllClients(self):

3408

2499

"D-Bus method"

3409

return dbus.Array(c.dbus_object_path for c in

3410

tcp_server.clients.values())

3411

3412

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

3413

"true"})

2500

return dbus.Array(c.dbus_object_path

2501

for c in

2502

tcp_server.clients.itervalues())

2503

3414

2504

@dbus.service.method(_interface,

3415

2505

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

3416

2506

def GetAllClientsWithProperties(self):

3417

2507

"D-Bus method"

3418

2508

return dbus.Dictionary(

3419

{c.dbus_object_path: c.GetAll(

3420

"se.recompile.Mandos.Client")

3421

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

2509

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

2510

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

3422

2511

signature="oa{sv}")

3423

2512

3424

2513

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

3425

2514

def RemoveClient(self, object_path):

3426

2515

"D-Bus method"

3427

for c in tcp_server.clients.values():

2516

for c in tcp_server.clients.itervalues():

3428

2517

if c.dbus_object_path == object_path:

3429

2518

del tcp_server.clients[c.name]

3430

2519

c.remove_from_connection()

3431

# Don't signal the disabling

2520

# Don't signal anything except ClientRemoved

3432

2521

c.disable(quiet=True)

3433

# Emit D-Bus signal for removal

3434

self.client_removed_signal(c)

2522

# Emit D-Bus signal

2523

self.ClientRemoved(object_path, c.name)

3435

2524

return

3436

2525

raise KeyError(object_path)

3437

2526

3438

2527

del _interface

3439

3440

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3441

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

3442

def GetManagedObjects(self):

3443

"""D-Bus method"""

3444

return dbus.Dictionary(

3445

{client.dbus_object_path:

3446

dbus.Dictionary(

3447

{interface: client.GetAll(interface)

3448

for interface in

3449

client._get_all_interface_names()})

3450

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

3451

3452

def client_added_signal(self, client):

3453

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

3454

if use_dbus:

3455

# New standard signal

3456

self.InterfacesAdded(

3457

client.dbus_object_path,

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()}))

3462

# Old signal

3463

self.ClientAdded(client.dbus_object_path)

3464

3465

def client_removed_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesRemoved(

3470

client.dbus_object_path,

3471

client._get_all_interface_names())

3472

# Old signal

3473

self.ClientRemoved(client.dbus_object_path,

3474

client.name)

3475

2528

3476

2529

mandos_dbus_service = MandosDBusService()

3477

3478

# Save modules to variables to exempt the modules from being

3479

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

3480

mp = multiprocessing

3481

wn = wnull

3482

2530

3483

2531

def cleanup():

3484

2532

"Cleanup function; run on exit"

3485

if zeroconf:

3486

service.cleanup()

3487

3488

mp.active_children()

3489

wn.close()

2533

service.cleanup()

2534

2535

multiprocessing.active_children()

3490

2536

if not (tcp_server.clients or client_settings):

3491

2537

return

3492

2538

3493

2539

# Store client before exiting. Secrets are encrypted with key

3494

2540

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

3495

2541

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

3496

2542

clients = {}

3497

2543

with PGPEngine() as pgp:

3498

for client in tcp_server.clients.values():

2544

for client in tcp_server.clients.itervalues():

3499

2545

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

3500

2546

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

3501

2547

key)

3502

2548

client_dict = {}

3503

2549

3504

2550

# A list of attributes that can not be pickled

3505

2551

# + secret.

3506

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

3507

"checker", "server_settings"}

3508

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

3509

.Object):

2552

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

2553

"checker"))

2554

for name, typ in (inspect.getmembers

2555

(dbus.service.Object)):

3510

2556

exclude.add(name)

3511

2557

3512

2558

client_dict["encrypted_secret"] = (client

3513

2559

.encrypted_secret)

3514

2560

for attr in client.client_structure:

3515

2561

if attr not in exclude:

3516

2562

client_dict[attr] = getattr(client, attr)

3517

2563

3518

2564

clients[client.name] = client_dict

3519

2565

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

3520

2566

3521

2567

try:

3522

with tempfile.NamedTemporaryFile(

3523

mode='wb',

3524

suffix=".pickle",

3525

prefix='clients-',

3526

dir=os.path.dirname(stored_state_path),

3527

delete=False) as stored_state:

3528

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

3529

protocol=2)

3530

tempname = stored_state.name

2568

with (tempfile.NamedTemporaryFile

2569

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

2570

dir=os.path.dirname(stored_state_path),

2571

delete=False)) as stored_state:

2572

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

2573

tempname=stored_state.name

3531

2574

os.rename(tempname, stored_state_path)

3532

2575

except (IOError, OSError) as e:

3533

2576

if not debug:

3536

2579

except NameError:

3537

2580

pass

3538

2581

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

3539

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

2582

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

3540

2583

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

3541

2584

else:

3542

2585

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

3543

2586

exc_info=e)

3544

raise

3545

2587

raise e

2588

3546

2589

# Delete all clients, and settings from config

3547

2590

while tcp_server.clients:

3548

2591

name, client = tcp_server.clients.popitem()

3549

2592

if use_dbus:

3550

2593

client.remove_from_connection()

3551

# Don't signal the disabling

2594

# Don't signal anything except ClientRemoved

3552

2595

client.disable(quiet=True)

3553

# Emit D-Bus signal for removal

3554

2596

if use_dbus:

3555

mandos_dbus_service.client_removed_signal(client)

2597

# Emit D-Bus signal

2598

mandos_dbus_service.ClientRemoved(client

2599

.dbus_object_path,

2600

client.name)

3556

2601

client_settings.clear()

3557

2602

3558

2603

atexit.register(cleanup)

3559

3560

for client in tcp_server.clients.values():

2604

2605

for client in tcp_server.clients.itervalues():

3561

2606

if use_dbus:

3562

# Emit D-Bus signal for adding

3563

mandos_dbus_service.client_added_signal(client)

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3564

2609

# Need to initiate checking of clients

3565

2610

if client.enabled:

3566

2611

client.init_checker()

3567

2612

3568

2613

tcp_server.enable()

3569

2614

tcp_server.server_activate()

3570

2615

3571

2616

# Find out what port we got

3572

if zeroconf:

3573

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

2617

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

3574

2618

if use_ipv6:

3575

2619

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

3576

2620

" flowinfo %d, scope_id %d",

3578

2622

else: # IPv4

3579

2623

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

3580

2624

*tcp_server.socket.getsockname())

3581

3582

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

3583

2625

2626

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

2627

3584

2628

try:

3585

if zeroconf:

3586

# From the Avahi example code

3587

try:

3588

service.activate()

3589

except dbus.exceptions.DBusException as error:

3590

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

3591

cleanup()

3592

sys.exit(1)

3593

# End of Avahi example code

3594

3595

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

3596

lambda *args, **kwargs:

3597

(tcp_server.handle_request

3598

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

3599

2629

# From the Avahi example code

2630

try:

2631

service.activate()

2632

except dbus.exceptions.DBusException as error:

2633

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

2634

cleanup()

2635

sys.exit(1)

2636

# End of Avahi example code

2637

2638

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

2639

lambda *args, **kwargs:

2640

(tcp_server.handle_request

2641

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

2642

3600

2643

logger.debug("Starting main loop")

3601

2644

main_loop.run()

3602

2645

except AvahiError as error:

3611

2654

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

3612

2655

cleanup()

3613

2656

3614

3615

2657

if __name__ == '__main__':

3616

2658

main()