/mandos/release : revision 237.7.671

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

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

78

import collections

79

import codecs

71

80

72

81

import dbus

73

82

import dbus.service

74

import gobject

75

import avahi

83

from gi.repository import GLib

76

84

from dbus.mainloop.glib import DBusGMainLoop

77

85

import ctypes

78

86

import ctypes.util

79

87

import xml.dom.minidom

80

88

import inspect

81

import GnuPGInterface

82

89

90

# Try to find the value of SO_BINDTODEVICE:

83

91

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:

84

94

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

95

except AttributeError:

86

96

try:

97

# This is where SO_BINDTODEVICE was up to and including Python

98

# 2.6, and also 3.2:

87

99

from IN import SO_BINDTODEVICE

88

100

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.5.3"

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"

92

119

stored_state_file = "clients.pickle"

93

120

94

121

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

122

syslogger = None

98

123

99

124

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

125

if_nametoindex = ctypes.cdll.LoadLibrary(

126

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

103

127

except (OSError, AttributeError):

128

104

129

def if_nametoindex(interface):

105

130

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

106

131

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

107

132

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

108

133

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

134

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

135

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

113

136

return interface_index

114

137

115

138

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

116

155

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

117

156

"""init logger and add loglevel"""

118

157

158

global syslogger

159

syslogger = (logging.handlers.SysLogHandler(

160

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

161

address="/dev/log"))

119

162

syslogger.setFormatter(logging.Formatter

120

163

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

121

164

' %(message)s'))

122

165

logger.addHandler(syslogger)

123

166

124

167

if debug:

125

168

console = logging.StreamHandler()

126

169

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

138

181

139

182

class PGPEngine(object):

140

183

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

184

141

185

def __init__(self):

142

self.gnupg = GnuPGInterface.GnuPG()

143

186

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

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

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

151

206

def __enter__(self):

152

207

return self

153

154

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

208

209

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

155

210

self._cleanup()

156

211

return False

157

212

158

213

def __del__(self):

159

214

self._cleanup()

160

215

161

216

def _cleanup(self):

162

217

if self.tempdir is not None:

163

218

# Delete contents of tempdir

164

219

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

165

topdown = False):

220

topdown=False):

166

221

for filename in files:

167

222

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

168

223

for dirname in dirs:

170

225

# Remove tempdir

171

226

os.rmdir(self.tempdir)

172

227

self.tempdir = None

173

228

174

229

def password_encode(self, password):

175

230

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

176

231

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

177

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

178

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

179

240

def encrypt(self, data, password):

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

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)

194

256

return ciphertext

195

257

196

258

def decrypt(self, data, password):

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

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)

211

274

return decrypted_plaintext

212

275

213

276

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

214

303

class AvahiError(Exception):

215

304

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

216

305

self.value = value

217

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

218

def __unicode__(self):

219

return unicode(repr(self.value))

306

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

307

**kwargs)

308

220

309

221

310

class AvahiServiceError(AvahiError):

222

311

pass

223

312

313

224

314

class AvahiGroupError(AvahiError):

225

315

pass

226

316

227

317

228

318

class AvahiService(object):

229

319

"""An Avahi (Zeroconf) service.

230

320

231

321

Attributes:

232

322

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

233

323

Used to optionally bind to the specified interface.

234

324

name: string; Example: 'Mandos'

235

325

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

236

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

326

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

237

327

port: integer; what port to announce

238

328

TXT: list of strings; TXT record for the service

239

329

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

245

335

server: D-Bus Server

246

336

bus: dbus.SystemBus()

247

337

"""

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

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

253

350

self.interface = interface

254

351

self.name = name

255

352

self.type = servicetype

264

361

self.server = None

265

362

self.bus = bus

266

363

self.entry_group_state_changed_match = None

267

268

def rename(self):

364

365

def rename(self, remove=True):

269

366

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

270

367

if self.rename_count >= self.max_renames:

271

368

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

272

369

" after %i retries, exiting.",

273

370

self.rename_count)

274

371

raise AvahiServiceError("Too many renames")

275

self.name = unicode(self.server

276

.GetAlternativeServiceName(self.name))

372

self.name = str(

373

self.server.GetAlternativeServiceName(self.name))

374

self.rename_count += 1

277

375

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

278

376

self.name)

279

self.remove()

377

if remove:

378

self.remove()

280

379

try:

281

380

self.add()

282

381

except dbus.exceptions.DBusException as error:

283

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

284

self.cleanup()

285

os._exit(1)

286

self.rename_count += 1

287

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

288

391

def remove(self):

289

392

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

290

393

if self.entry_group_state_changed_match is not None:

292

395

self.entry_group_state_changed_match = None

293

396

if self.group is not None:

294

397

self.group.Reset()

295

398

296

399

def add(self):

297

400

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

298

401

self.remove()

315

418

dbus.UInt16(self.port),

316

419

avahi.string_array_to_txt_array(self.TXT))

317

420

self.group.Commit()

318

421

319

422

def entry_group_state_changed(self, state, error):

320

423

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

321

424

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

322

425

323

426

if state == avahi.ENTRY_GROUP_ESTABLISHED:

324

427

logger.debug("Zeroconf service established.")

325

428

elif state == avahi.ENTRY_GROUP_COLLISION:

327

430

self.rename()

328

431

elif state == avahi.ENTRY_GROUP_FAILURE:

329

432

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

330

unicode(error))

331

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

332

.format(error))

333

433

str(error))

434

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

435

334

436

def cleanup(self):

335

437

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

336

438

if self.group is not None:

341

443

pass

342

444

self.group = None

343

445

self.remove()

344

446

345

447

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

346

448

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

347

449

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

348

bad_states = { avahi.SERVER_INVALID:

349

"Zeroconf server invalid",

350

avahi.SERVER_REGISTERING: None,

351

avahi.SERVER_COLLISION:

352

"Zeroconf server name collision",

353

avahi.SERVER_FAILURE:

354

"Zeroconf server failure" }

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

}

355

456

if state in bad_states:

356

457

if bad_states[state] is not None:

357

458

if error is None:

360

461

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

361

462

self.cleanup()

362

463

elif state == avahi.SERVER_RUNNING:

363

self.add()

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)

364

476

else:

365

477

if error is None:

366

478

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

367

479

else:

368

480

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

369

481

370

482

def activate(self):

371

483

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

372

484

if self.server is None:

376

488

follow_name_owner_changes=True),

377

489

avahi.DBUS_INTERFACE_SERVER)

378

490

self.server.connect_to_signal("StateChanged",

379

self.server_state_changed)

491

self.server_state_changed)

380

492

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

381

493

382

494

383

495

class AvahiServiceToSyslog(AvahiService):

384

def rename(self):

496

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

385

497

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

386

ret = AvahiService.rename(self)

387

syslogger.setFormatter(logging.Formatter

388

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

389

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

390

.format(self.name)))

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

391

502

return ret

392

503

393

504

394

def timedelta_to_milliseconds(td):

395

"Convert a datetime.timedelta() to milliseconds"

396

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

397

+ (td.seconds * 1000)

398

+ (td.microseconds // 1000))

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

399

815

400

816

401

817

class Client(object):

402

818

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

403

819

404

820

Attributes:

405

821

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

406

822

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

408

824

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

409

825

to see if the client lives.

410

826

'None' if no process is running.

411

checker_callback_tag: a gobject event source tag, or None

827

checker_callback_tag: a GLib event source tag, or None

412

828

checker_command: string; External command which is run to check

413

829

if client lives. %() expansions are done at

414

830

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

415

831

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

416

checker_initiator_tag: a gobject event source tag, or None

832

checker_initiator_tag: a GLib event source tag, or None

417

833

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

418

834

client_structure: Object describing what attributes a client has

419

835

and is used for storing the client at exit

420

836

current_checker_command: string; current running checker_command

421

disable_initiator_tag: a gobject event source tag, or None

837

disable_initiator_tag: a GLib event source tag, or None

422

838

enabled: bool()

423

839

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

424

uniquely identify the client

840

uniquely identify an OpenPGP client

841

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

842

a client using raw public keys

425

843

host: string; available for use by the checker command

426

844

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

427

845

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

429

847

last_checker_status: integer between 0 and 255 reflecting exit

430

848

status of last checker. -1 reflects crashed

431

849

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

432

852

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

433

853

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

434

854

D-Bus identifiers

439

859

runtime_expansions: Allowed attributes for runtime expansion.

440

860

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

441

861

disabled, or None

862

server_settings: The server_settings dict from main()

442

863

"""

443

864

444

865

runtime_expansions = ("approval_delay", "approval_duration",

445

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

446

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

866

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

867

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

868

"last_approval_request", "last_checked_ok",

447

869

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

448

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

449

"extended_timeout": "15m",

450

"interval": "2m",

451

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

452

"host": "",

453

"approval_delay": "0s",

454

"approval_duration": "1s",

455

"approved_by_default": "True",

456

"enabled": "True",

457

}

458

459

def timeout_milliseconds(self):

460

"Return the 'timeout' attribute in milliseconds"

461

return timedelta_to_milliseconds(self.timeout)

462

463

def extended_timeout_milliseconds(self):

464

"Return the 'extended_timeout' attribute in milliseconds"

465

return timedelta_to_milliseconds(self.extended_timeout)

466

467

def interval_milliseconds(self):

468

"Return the 'interval' attribute in milliseconds"

469

return timedelta_to_milliseconds(self.interval)

470

471

def approval_delay_milliseconds(self):

472

return timedelta_to_milliseconds(self.approval_delay)

473

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

474

882

@staticmethod

475

883

def config_parser(config):

476

884

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

483

891

for client_name in config.sections():

484

892

section = dict(config.items(client_name))

485

893

client = settings[client_name] = {}

486

894

487

895

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

488

896

# Reformat values from string types to Python types

489

897

client["approved_by_default"] = config.getboolean(

490

898

client_name, "approved_by_default")

491

899

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

492

900

"enabled")

493

901

902

# Uppercase and remove spaces from key_id and fingerprint

903

# for later comparison purposes with return value from the

904

# key_id() and fingerprint() functions

905

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

906

.replace(" ", ""))

494

907

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

495

908

.replace(" ", ""))

496

909

if "secret" in section:

497

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

910

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

911

.encode("utf-8"),

912

"base64")

498

913

elif "secfile" in section:

499

914

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

500

915

(section["secfile"])),

501

916

"rb") as secfile:

502

917

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

503

918

else:

504

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

919

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

505

920

.format(section))

506

921

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

507

922

client["extended_timeout"] = string_to_delta(

515

930

client["last_approval_request"] = None

516

931

client["last_checked_ok"] = None

517

932

client["last_checker_status"] = -2

518

933

519

934

return settings

520

521

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

935

936

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

522

937

self.name = name

938

if server_settings is None:

939

server_settings = {}

940

self.server_settings = server_settings

523

941

# adding all client settings

524

for setting, value in settings.iteritems():

942

for setting, value in settings.items():

525

943

setattr(self, setting, value)

526

944

527

945

if self.enabled:

528

946

if not hasattr(self, "last_enabled"):

529

947

self.last_enabled = datetime.datetime.utcnow()

533

951

else:

534

952

self.last_enabled = None

535

953

self.expires = None

536

954

537

955

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

538

# Uppercase and remove spaces from fingerprint for later

539

# comparison purposes with return value from the fingerprint()

540

# function

956

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

541

957

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

542

958

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

543

959

datetime.datetime.utcnow())

544

960

545

961

# attributes specific for this server instance

546

962

self.checker = None

547

963

self.checker_initiator_tag = None

550

966

self.current_checker_command = None

551

967

self.approved = None

552

968

self.approvals_pending = 0

553

self.changedstate = (multiprocessing_manager

554

.Condition(multiprocessing_manager

555

.Lock()))

556

self.client_structure = [attr for attr in

557

self.__dict__.iterkeys()

969

self.changedstate = multiprocessing_manager.Condition(

970

multiprocessing_manager.Lock())

971

self.client_structure = [attr

972

for attr in self.__dict__.keys()

558

973

if not attr.startswith("_")]

559

974

self.client_structure.append("client_structure")

560

561

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

562

lambda obj:

563

isinstance(obj,

564

property)):

975

976

for name, t in inspect.getmembers(

977

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

565

978

if not name.startswith("_"):

566

979

self.client_structure.append(name)

567

980

568

981

# Send notice to process children that client state has changed

569

982

def send_changedstate(self):

570

983

with self.changedstate:

571

984

self.changedstate.notify_all()

572

985

573

986

def enable(self):

574

987

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

575

988

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

580

993

self.last_enabled = datetime.datetime.utcnow()

581

994

self.init_checker()

582

995

self.send_changedstate()

583

996

584

997

def disable(self, quiet=True):

585

998

"""Disable this client."""

586

999

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

588

1001

if not quiet:

589

1002

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

590

1003

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

591

gobject.source_remove(self.disable_initiator_tag)

1004

GLib.source_remove(self.disable_initiator_tag)

592

1005

self.disable_initiator_tag = None

593

1006

self.expires = None

594

1007

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

595

gobject.source_remove(self.checker_initiator_tag)

1008

GLib.source_remove(self.checker_initiator_tag)

596

1009

self.checker_initiator_tag = None

597

1010

self.stop_checker()

598

1011

self.enabled = False

599

1012

if not quiet:

600

1013

self.send_changedstate()

601

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

1014

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

602

1015

return False

603

1016

604

1017

def __del__(self):

605

1018

self.disable()

606

1019

607

1020

def init_checker(self):

608

1021

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

609

1022

# and every interval from then on.

610

1023

if self.checker_initiator_tag is not None:

611

gobject.source_remove(self.checker_initiator_tag)

612

self.checker_initiator_tag = (gobject.timeout_add

613

(self.interval_milliseconds(),

614

self.start_checker))

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)

615

1028

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

616

1029

if self.disable_initiator_tag is not None:

617

gobject.source_remove(self.disable_initiator_tag)

618

self.disable_initiator_tag = (gobject.timeout_add

619

(self.timeout_milliseconds(),

620

self.disable))

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)

621

1033

# Also start a new checker *right now*.

622

1034

self.start_checker()

623

624

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

1035

1036

def checker_callback(self, source, condition, connection,

1037

command):

625

1038

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

626

1039

self.checker_callback_tag = None

627

1040

self.checker = None

628

if os.WIFEXITED(condition):

629

self.last_checker_status = os.WEXITSTATUS(condition)

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

630

1048

if self.last_checker_status == 0:

631

1049

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

632

1050

vars(self))

633

1051

self.checked_ok()

634

1052

else:

635

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

636

vars(self))

1053

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

637

1054

else:

638

1055

self.last_checker_status = -1

1056

self.last_checker_signal = -returncode

639

1057

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

640

1058

vars(self))

641

1059

return False

1060

642

1061

def checked_ok(self):

643

1062

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

644

1063

self.last_checked_ok = datetime.datetime.utcnow()

645

1064

self.last_checker_status = 0

1065

self.last_checker_signal = None

646

1066

self.bump_timeout()

647

1067

648

1068

def bump_timeout(self, timeout=None):

649

1069

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

650

1070

if timeout is None:

651

1071

timeout = self.timeout

652

1072

if self.disable_initiator_tag is not None:

653

gobject.source_remove(self.disable_initiator_tag)

1073

GLib.source_remove(self.disable_initiator_tag)

654

1074

self.disable_initiator_tag = None

655

1075

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

656

self.disable_initiator_tag = (gobject.timeout_add

657

(timedelta_to_milliseconds

658

(timeout), self.disable))

1076

self.disable_initiator_tag = GLib.timeout_add(

1077

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

659

1078

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

660

1079

661

1080

def need_approval(self):

662

1081

self.last_approval_request = datetime.datetime.utcnow()

663

1082

664

1083

def start_checker(self):

665

1084

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

666

1085

667

1086

If a checker already exists, leave it running and do

668

1087

nothing."""

669

1088

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

674

1093

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

675

1094

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

676

1095

# should be.

677

678

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

679

try:

680

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

681

except (AttributeError, OSError) as error:

682

if (isinstance(error, OSError)

683

and error.errno != errno.ECHILD):

684

raise error

685

else:

686

if pid:

687

logger.warning("Checker was a zombie")

688

gobject.source_remove(self.checker_callback_tag)

689

self.checker_callback(pid, status,

690

self.current_checker_command)

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

691

1101

# Start a new checker if needed

692

1102

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}

693

1107

try:

694

# In case checker_command has exactly one % operator

695

command = self.checker_command % self.host

696

except TypeError:

697

# Escape attributes for the shell

698

escaped_attrs = dict(

699

(attr,

700

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

701

errors=

702

'replace')))

703

for attr in

704

self.runtime_expansions)

705

706

try:

707

command = self.checker_command % escaped_attrs

708

except TypeError as error:

709

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

710

self.checker_command, exc_info=error)

711

return True # Try again later

1108

command = self.checker_command % escaped_attrs

1109

except TypeError as error:

1110

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

1111

self.checker_command,

1112

exc_info=error)

1113

return True # Try again later

712

1114

self.current_checker_command = command

713

try:

714

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

715

command, self.name)

716

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

717

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

718

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

719

# always replaced by /dev/null.)

720

self.checker = subprocess.Popen(command,

721

close_fds=True,

722

shell=True, cwd="/")

723

self.checker_callback_tag = (gobject.child_watch_add

724

(self.checker.pid,

725

self.checker_callback,

726

data=command))

727

# The checker may have completed before the gobject

728

# watch was added. Check for this.

729

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

730

if pid:

731

gobject.source_remove(self.checker_callback_tag)

732

self.checker_callback(pid, status, command)

733

except OSError as error:

734

logger.error("Failed to start subprocess",

735

exc_info=error)

736

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

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

737

1141

return True

738

1142

739

1143

def stop_checker(self):

740

1144

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

741

1145

if self.checker_callback_tag:

742

gobject.source_remove(self.checker_callback_tag)

1146

GLib.source_remove(self.checker_callback_tag)

743

1147

self.checker_callback_tag = None

744

1148

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

745

1149

return

746

1150

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

747

try:

748

self.checker.terminate()

749

#time.sleep(0.5)

750

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

751

# self.checker.kill()

752

except OSError as error:

753

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

754

raise

1151

self.checker.terminate()

755

1152

self.checker = None

756

1153

757

1154

758

def dbus_service_property(dbus_interface, signature="v",

759

access="readwrite", byte_arrays=False):

1155

def dbus_service_property(dbus_interface,

1156

signature="v",

1157

access="readwrite",

1158

byte_arrays=False):

760

1159

"""Decorators for marking methods of a DBusObjectWithProperties to

761

1160

become properties on the D-Bus.

762

1161

763

1162

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

764

1163

and with one argument by "Set".

765

1164

766

1165

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

767

1166

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

768

1167

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

771

1170

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

772

1171

if byte_arrays and signature != "ay":

773

1172

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

774

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

1173

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

1174

775

1175

def decorator(func):

776

1176

func._dbus_is_property = True

777

1177

func._dbus_interface = dbus_interface

780

1180

func._dbus_name = func.__name__

781

1181

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

782

1182

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

783

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1183

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

784

1184

return func

1185

785

1186

return decorator

786

1187

787

1188

788

1189

def dbus_interface_annotations(dbus_interface):

789

1190

"""Decorator for marking functions returning interface annotations

790

1191

791

1192

Usage:

792

1193

793

1194

@dbus_interface_annotations("org.example.Interface")

794

1195

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

795

1196

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

796

1197

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

797

1198

"false"}

798

1199

"""

1200

799

1201

def decorator(func):

800

1202

func._dbus_is_interface = True

801

1203

func._dbus_interface = dbus_interface

802

1204

func._dbus_name = dbus_interface

803

1205

return func

1206

804

1207

return decorator

805

1208

806

1209

807

1210

def dbus_annotations(annotations):

808

1211

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

809

1212

Usage:

810

1213

1214

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

1215

"org.freedesktop.DBus.Property."

1216

"EmitsChangedSignal": "false"})

811

1217

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

812

1218

access="r")

813

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

814

"org.freedesktop.DBus.Property."

815

"EmitsChangedSignal": "false"})

816

1219

def Property_dbus_property(self):

817

1220

return dbus.Boolean(False)

1221

1222

See also the DBusObjectWithAnnotations class.

818

1223

"""

1224

819

1225

def decorator(func):

820

1226

func._dbus_annotations = annotations

821

1227

return func

1228

822

1229

return decorator

823

1230

824

1231

825

1232

class DBusPropertyException(dbus.exceptions.DBusException):

826

1233

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

827

1234

"""

828

def __unicode__(self):

829

return unicode(str(self))

1235

pass

830

1236

831

1237

832

1238

class DBusPropertyAccessException(DBusPropertyException):

841

1247

pass

842

1248

843

1249

844

class DBusObjectWithProperties(dbus.service.Object):

845

"""A D-Bus object with properties.

846

847

Classes inheriting from this can use the dbus_service_property

848

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

849

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

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.

850

1255

"""

851

1256

852

1257

@staticmethod

853

1258

def _is_dbus_thing(thing):

854

1259

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

855

1260

856

1261

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

857

1262

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

858

1263

"""

859

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

1264

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

860

1265

False)

861

1266

862

1267

def _get_all_dbus_things(self, thing):

863

1268

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

864

1269

"""

865

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

866

name),

1270

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

867

1271

athing.__get__(self))

868

1272

for cls in self.__class__.__mro__

869

1273

for name, athing in

870

inspect.getmembers(cls,

871

self._is_dbus_thing(thing)))

872

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

873

1347

def _get_dbus_property(self, interface_name, property_name):

874

1348

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

875

1349

property with the specified name and interface.

876

1350

"""

877

for cls in self.__class__.__mro__:

878

for name, value in (inspect.getmembers

879

(cls,

880

self._is_dbus_thing("property"))):

1351

for cls in self.__class__.__mro__:

1352

for name, value in inspect.getmembers(

1353

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

881

1354

if (value._dbus_name == property_name

882

1355

and value._dbus_interface == interface_name):

883

1356

return value.__get__(self)

884

1357

885

1358

# No such property

886

raise DBusPropertyNotFound(self.dbus_object_path + ":"

887

+ interface_name + "."

888

+ property_name)

889

890

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

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

891

1373

out_signature="v")

892

1374

def Get(self, interface_name, property_name):

893

1375

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

899

1381

if not hasattr(value, "variant_level"):

900

1382

return value

901

1383

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

902

1384

903

1385

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

904

1386

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

905

1387

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

911

1393

# The byte_arrays option is not supported yet on

912

1394

# signatures other than "ay".

913

1395

if prop._dbus_signature != "ay":

914

raise ValueError

1396

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

1397

"'ay' signature {!r}"

1398

.format(prop._dbus_signature))

915

1399

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

916

1400

for byte in value))

917

1401

prop(value)

918

919

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

1402

1403

@dbus.service.method(dbus.PROPERTIES_IFACE,

1404

in_signature="s",

920

1405

out_signature="a{sv}")

921

1406

def GetAll(self, interface_name):

922

1407

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

923

1408

standard.

924

1409

925

1410

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

926

1411

"""

927

1412

properties = {}

937

1422

if not hasattr(value, "variant_level"):

938

1423

properties[name] = value

939

1424

continue

940

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

941

value.variant_level+1)

1425

properties[name] = type(value)(

1426

value, variant_level=value.variant_level + 1)

942

1427

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

943

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

944

1437

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

945

1438

out_signature="s",

946

1439

path_keyword='object_path',

947

1440

connection_keyword='connection')

948

1441

def Introspect(self, object_path, connection):

949

1442

"""Overloading of standard D-Bus method.

950

1443

951

1444

Inserts property tags and interface annotation tags.

952

1445

"""

953

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

954

connection)

1446

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1447

object_path,

1448

connection)

955

1449

try:

956

1450

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

1451

957

1452

def make_tag(document, name, prop):

958

1453

e = document.createElement("property")

959

1454

e.setAttribute("name", name)

960

1455

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

961

1456

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

962

1457

return e

1458

963

1459

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

964

1460

# Add property tags

965

1461

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

968

1464

if prop._dbus_interface

969

1465

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

970

1466

if_tag.appendChild(tag)

971

# Add annotation tags

972

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

973

for tag in if_tag.getElementsByTagName(typ):

974

annots = dict()

975

for name, prop in (self.

976

_get_all_dbus_things(typ)):

977

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

978

and prop._dbus_interface

979

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

980

annots.update(getattr

981

(prop,

982

"_dbus_annotations",

983

{}))

984

for name, value in annots.iteritems():

985

ann_tag = document.createElement(

986

"annotation")

987

ann_tag.setAttribute("name", name)

988

ann_tag.setAttribute("value", value)

989

tag.appendChild(ann_tag)

990

# Add interface annotation tags

991

for annotation, value in dict(

992

itertools.chain.from_iterable(

993

annotations().iteritems()

994

for name, annotations in

995

self._get_all_dbus_things("interface")

996

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

997

)).iteritems():

998

ann_tag = document.createElement("annotation")

999

ann_tag.setAttribute("name", annotation)

1000

ann_tag.setAttribute("value", value)

1001

if_tag.appendChild(ann_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)

1002

1483

# Add the names to the return values for the

1003

1484

# "org.freedesktop.DBus.Properties" methods

1004

1485

if (if_tag.getAttribute("name")

1023

1504

return xmlstring

1024

1505

1025

1506

1026

def datetime_to_dbus (dt, variant_level=0):

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

1027

1579

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

1028

1580

if dt is None:

1029

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

1030

return dbus.String(dt.isoformat(),

1031

variant_level=variant_level)

1581

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

1582

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

1032

1583

1033

1584

1034

1585

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1036

1587

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

1037

1588

interface names according to the "alt_interface_names" mapping.

1038

1589

Usage:

1039

1040

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

1041

"net.example.AlternateInterface"})

1590

1591

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

1592

"net.example.AlternateInterface"})

1042

1593

class SampleDBusObject(dbus.service.Object):

1043

1594

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

1044

1595

def SampleDBusMethod():

1045

1596

pass

1046

1597

1047

1598

The above "SampleDBusMethod" on "SampleDBusObject" will be

1048

1599

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

1049

1600

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

1050

1601

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

1051

1602

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

1052

1603

1053

1604

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

1054

1605

(from DBusObjectWithProperties) and interfaces (from the

1055

1606

dbus_interface_annotations decorator).

1056

1607

"""

1608

1057

1609

def wrapper(cls):

1058

1610

for orig_interface_name, alt_interface_name in (

1059

alt_interface_names.iteritems()):

1611

alt_interface_names.items()):

1060

1612

attr = {}

1061

1613

interface_names = set()

1062

1614

# Go though all attributes of the class

1064

1616

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

1065

1617

# with the wrong interface name

1066

1618

if (not hasattr(attribute, "_dbus_interface")

1067

or not attribute._dbus_interface

1068

.startswith(orig_interface_name)):

1619

or not attribute._dbus_interface.startswith(

1620

orig_interface_name)):

1069

1621

continue

1070

1622

# Create an alternate D-Bus interface name based on

1071

1623

# the current name

1072

alt_interface = (attribute._dbus_interface

1073

.replace(orig_interface_name,

1074

alt_interface_name))

1624

alt_interface = attribute._dbus_interface.replace(

1625

orig_interface_name, alt_interface_name)

1075

1626

interface_names.add(alt_interface)

1076

1627

# Is this a D-Bus signal?

1077

1628

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

1078

# Extract the original non-method function by

1079

# black magic

1080

nonmethod_func = (dict(

1629

# Extract the original non-method undecorated

1630

# function by black magic

1631

if sys.version_info.major == 2:

1632

nonmethod_func = (dict(

1081

1633

zip(attribute.func_code.co_freevars,

1082

attribute.__closure__))["func"]

1083

.cell_contents)

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)

1084

1641

# Create a new, but exactly alike, function

1085

1642

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

1086

1643

# with the alternate D-Bus interface name

1087

new_function = (dbus.service.signal

1088

(alt_interface,

1089

attribute._dbus_signature)

1090

(types.FunctionType(

1091

nonmethod_func.func_code,

1092

nonmethod_func.func_globals,

1093

nonmethod_func.func_name,

1094

nonmethod_func.func_defaults,

1095

nonmethod_func.func_closure)))

1644

new_function = copy_function(nonmethod_func)

1645

new_function = (dbus.service.signal(

1646

alt_interface,

1647

attribute._dbus_signature)(new_function))

1096

1648

# Copy annotations, if any

1097

1649

try:

1098

new_function._dbus_annotations = (

1099

dict(attribute._dbus_annotations))

1650

new_function._dbus_annotations = dict(

1651

attribute._dbus_annotations)

1100

1652

except AttributeError:

1101

1653

pass

1654

1102

1655

# Define a creator of a function to call both the

1103

1656

# original and alternate functions, so both the

1104

1657

# original and alternate signals gets sent when

1107

1660

"""This function is a scope container to pass

1108

1661

func1 and func2 to the "call_both" function

1109

1662

outside of its arguments"""

1663

1664

@functools.wraps(func2)

1110

1665

def call_both(*args, **kwargs):

1111

1666

"""This function will emit two D-Bus

1112

1667

signals by calling func1 and func2"""

1113

1668

func1(*args, **kwargs)

1114

1669

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

1115

1676

return call_both

1116

1677

# Create the "call_both" function and add it to

1117

1678

# the class

1122

1683

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

1123

1684

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

1124

1685

# to the class.

1125

attr[attrname] = (dbus.service.method

1126

(alt_interface,

1127

attribute._dbus_in_signature,

1128

attribute._dbus_out_signature)

1129

(types.FunctionType

1130

(attribute.func_code,

1131

attribute.func_globals,

1132

attribute.func_name,

1133

attribute.func_defaults,

1134

attribute.func_closure)))

1686

attr[attrname] = (

1687

dbus.service.method(

1688

alt_interface,

1689

attribute._dbus_in_signature,

1690

attribute._dbus_out_signature)

1691

(copy_function(attribute)))

1135

1692

# Copy annotations, if any

1136

1693

try:

1137

attr[attrname]._dbus_annotations = (

1138

dict(attribute._dbus_annotations))

1694

attr[attrname]._dbus_annotations = dict(

1695

attribute._dbus_annotations)

1139

1696

except AttributeError:

1140

1697

pass

1141

1698

# Is this a D-Bus property?

1144

1701

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

1145

1702

# property with the alternate D-Bus interface

1146

1703

# name. Add it to the class.

1147

attr[attrname] = (dbus_service_property

1148

(alt_interface,

1149

attribute._dbus_signature,

1150

attribute._dbus_access,

1151

attribute

1152

._dbus_get_args_options

1153

["byte_arrays"])

1154

(types.FunctionType

1155

(attribute.func_code,

1156

attribute.func_globals,

1157

attribute.func_name,

1158

attribute.func_defaults,

1159

attribute.func_closure)))

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

1160

1710

# Copy annotations, if any

1161

1711

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1712

attr[attrname]._dbus_annotations = dict(

1713

attribute._dbus_annotations)

1164

1714

except AttributeError:

1165

1715

pass

1166

1716

# Is this a D-Bus interface?

1169

1719

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

1170

1720

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

1171

1721

# to the class.

1172

attr[attrname] = (dbus_interface_annotations

1173

(alt_interface)

1174

(types.FunctionType

1175

(attribute.func_code,

1176

attribute.func_globals,

1177

attribute.func_name,

1178

attribute.func_defaults,

1179

attribute.func_closure)))

1722

attr[attrname] = (

1723

dbus_interface_annotations(alt_interface)

1724

(copy_function(attribute)))

1180

1725

if deprecate:

1181

1726

# Deprecate all alternate interfaces

1182

iname="_AlternateDBusNames_interface_annotation{0}"

1727

iname = "_AlternateDBusNames_interface_annotation{}"

1183

1728

for interface_name in interface_names:

1729

1184

1730

@dbus_interface_annotations(interface_name)

1185

1731

def func(self):

1186

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

1187

"true" }

1732

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

1733

"true"}

1188

1734

# Find an unused name

1189

1735

for aname in (iname.format(i)

1190

1736

for i in itertools.count()):

1194

1740

if interface_names:

1195

1741

# Replace the class with a new subclass of it with

1196

1742

# methods, signals, etc. as created above.

1197

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

1198

(cls,), attr)

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)

1199

1749

return cls

1750

1200

1751

return wrapper

1201

1752

1202

1753

1203

1754

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

1204

"se.bsnet.fukt.Mandos"})

1755

"se.bsnet.fukt.Mandos"})

1205

1756

class ClientDBus(Client, DBusObjectWithProperties):

1206

1757

"""A Client class using D-Bus

1207

1758

1208

1759

Attributes:

1209

1760

dbus_object_path: dbus.ObjectPath

1210

1761

bus: dbus.SystemBus()

1211

1762

"""

1212

1763

1213

1764

runtime_expansions = (Client.runtime_expansions

1214

+ ("dbus_object_path",))

1215

1765

+ ("dbus_object_path", ))

1766

1767

_interface = "se.recompile.Mandos.Client"

1768

1216

1769

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

1217

1218

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

1770

1771

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

1219

1772

self.bus = bus

1220

1773

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

1221

1774

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

1222

1775

# the D-Bus

1223

client_object_name = unicode(self.name).translate(

1776

client_object_name = str(self.name).translate(

1224

1777

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

1225

1778

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

1226

self.dbus_object_path = (dbus.ObjectPath

1227

("/clients/" + client_object_name))

1779

self.dbus_object_path = dbus.ObjectPath(

1780

"/clients/" + client_object_name)

1228

1781

DBusObjectWithProperties.__init__(self, self.bus,

1229

1782

self.dbus_object_path)

1230

1231

def notifychangeproperty(transform_func,

1232

dbus_name, type_func=lambda x: x,

1233

variant_level=1):

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

1234

1789

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

1235

1790

its changes to DBus.

1236

1791

1237

1792

transform_fun: Function that takes a value and a variant_level

1238

1793

and transforms it to a D-Bus type.

1239

1794

dbus_name: D-Bus name of the variable

1241

1796

to the D-Bus. Default: no transform

1242

1797

variant_level: D-Bus variant level. Default: 1

1243

1798

"""

1244

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

1799

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

1800

1245

1801

def setter(self, value):

1246

1802

if hasattr(self, "dbus_object_path"):

1247

1803

if (not hasattr(self, attrname) or

1248

1804

type_func(getattr(self, attrname, None))

1249

1805

!= type_func(value)):

1250

dbus_value = transform_func(type_func(value),

1251

variant_level

1252

=variant_level)

1253

self.PropertyChanged(dbus.String(dbus_name),

1254

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

1255

1821

setattr(self, attrname, value)

1256

1822

1257

1823

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

1258

1824

1259

1825

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1260

1826

approvals_pending = notifychangeproperty(dbus.Boolean,

1261

1827

"ApprovalPending",

1262

type_func = bool)

1828

type_func=bool)

1263

1829

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

1264

1830

last_enabled = notifychangeproperty(datetime_to_dbus,

1265

1831

"LastEnabled")

1266

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

1267

type_func = lambda checker:

1268

checker is not None)

1832

checker = notifychangeproperty(

1833

dbus.Boolean, "CheckerRunning",

1834

type_func=lambda checker: checker is not None)

1269

1835

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1270

1836

"LastCheckedOK")

1271

1837

last_checker_status = notifychangeproperty(dbus.Int16,

1274

1840

datetime_to_dbus, "LastApprovalRequest")

1275

1841

approved_by_default = notifychangeproperty(dbus.Boolean,

1276

1842

"ApprovedByDefault")

1277

approval_delay = notifychangeproperty(dbus.UInt64,

1278

"ApprovalDelay",

1279

type_func =

1280

timedelta_to_milliseconds)

1843

approval_delay = notifychangeproperty(

1844

dbus.UInt64, "ApprovalDelay",

1845

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

1281

1846

approval_duration = notifychangeproperty(

1282

1847

dbus.UInt64, "ApprovalDuration",

1283

type_func = timedelta_to_milliseconds)

1848

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

1284

1849

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

1285

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

1286

type_func =

1287

timedelta_to_milliseconds)

1850

timeout = notifychangeproperty(

1851

dbus.UInt64, "Timeout",

1852

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

1288

1853

extended_timeout = notifychangeproperty(

1289

1854

dbus.UInt64, "ExtendedTimeout",

1290

type_func = timedelta_to_milliseconds)

1291

interval = notifychangeproperty(dbus.UInt64,

1292

"Interval",

1293

type_func =

1294

timedelta_to_milliseconds)

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)

1295

1859

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

1296

1860

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

1861

invalidate_only=True)

1862

1297

1863

del notifychangeproperty

1298

1864

1299

1865

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

1300

1866

try:

1301

1867

self.remove_from_connection()

1304

1870

if hasattr(DBusObjectWithProperties, "__del__"):

1305

1871

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

1306

1872

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

1307

1308

def checker_callback(self, pid, condition, command,

1309

*args, **kwargs):

1310

self.checker_callback_tag = None

1311

self.checker = None

1312

if os.WIFEXITED(condition):

1313

exitstatus = os.WEXITSTATUS(condition)

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:

1314

1881

# Emit D-Bus signal

1315

1882

self.CheckerCompleted(dbus.Int16(exitstatus),

1316

dbus.Int64(condition),

1883

# This is specific to GNU libC

1884

dbus.Int64(exitstatus << 8),

1317

1885

dbus.String(command))

1318

1886

else:

1319

1887

# Emit D-Bus signal

1320

1888

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

1321

dbus.Int64(condition),

1889

dbus.Int64(

1890

# This is specific to GNU libC

1891

(exitstatus << 8)

1892

| self.last_checker_signal),

1322

1893

dbus.String(command))

1323

1324

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

1325

*args, **kwargs)

1326

1894

return ret

1895

1327

1896

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

1328

old_checker = self.checker

1329

if self.checker is not None:

1330

old_checker_pid = self.checker.pid

1331

else:

1332

old_checker_pid = None

1897

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

1333

1898

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

1334

1899

# Only if new checker process was started

1335

1900

if (self.checker is not None

1337

1902

# Emit D-Bus signal

1338

1903

self.CheckerStarted(self.current_checker_command)

1339

1904

return r

1340

1905

1341

1906

def _reset_approved(self):

1342

1907

self.approved = None

1343

1908

return False

1344

1909

1345

1910

def approve(self, value=True):

1346

1911

self.approved = value

1347

gobject.timeout_add(timedelta_to_milliseconds

1348

(self.approval_duration),

1349

self._reset_approved)

1912

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

1913

* 1000), self._reset_approved)

1350

1914

self.send_changedstate()

1351

1352

## D-Bus methods, signals & properties

1353

_interface = "se.recompile.Mandos.Client"

1354

1355

## Interfaces

1356

1357

@dbus_interface_annotations(_interface)

1358

def _foo(self):

1359

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

1360

"false"}

1361

1362

## Signals

1363

1915

1916

# D-Bus methods, signals & properties

1917

1918

# Interfaces

1919

1920

# Signals

1921

1364

1922

# CheckerCompleted - signal

1365

1923

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

1366

1924

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

1367

1925

"D-Bus signal"

1368

1926

pass

1369

1927

1370

1928

# CheckerStarted - signal

1371

1929

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

1372

1930

def CheckerStarted(self, command):

1373

1931

"D-Bus signal"

1374

1932

pass

1375

1933

1376

1934

# PropertyChanged - signal

1935

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

1377

1936

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

1378

1937

def PropertyChanged(self, property, value):

1379

1938

"D-Bus signal"

1380

1939

pass

1381

1940

1382

1941

# GotSecret - signal

1383

1942

@dbus.service.signal(_interface)

1384

1943

def GotSecret(self):

1387

1946

server to mandos-client

1388

1947

"""

1389

1948

pass

1390

1949

1391

1950

# Rejected - signal

1392

1951

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

1393

1952

def Rejected(self, reason):

1394

1953

"D-Bus signal"

1395

1954

pass

1396

1955

1397

1956

# NeedApproval - signal

1398

1957

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

1399

1958

def NeedApproval(self, timeout, default):

1400

1959

"D-Bus signal"

1401

1960

return self.need_approval()

1402

1403

## Methods

1404

1961

1962

# Methods

1963

1405

1964

# Approve - method

1406

1965

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

1407

1966

def Approve(self, value):

1408

1967

self.approve(value)

1409

1968

1410

1969

# CheckedOK - method

1411

1970

@dbus.service.method(_interface)

1412

1971

def CheckedOK(self):

1413

1972

self.checked_ok()

1414

1973

1415

1974

# Enable - method

1975

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

1416

1976

@dbus.service.method(_interface)

1417

1977

def Enable(self):

1418

1978

"D-Bus method"

1419

1979

self.enable()

1420

1980

1421

1981

# StartChecker - method

1982

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

1422

1983

@dbus.service.method(_interface)

1423

1984

def StartChecker(self):

1424

1985

"D-Bus method"

1425

1986

self.start_checker()

1426

1987

1427

1988

# Disable - method

1989

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

1428

1990

@dbus.service.method(_interface)

1429

1991

def Disable(self):

1430

1992

"D-Bus method"

1431

1993

self.disable()

1432

1994

1433

1995

# StopChecker - method

1996

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

1434

1997

@dbus.service.method(_interface)

1435

1998

def StopChecker(self):

1436

1999

self.stop_checker()

1437

1438

## Properties

1439

2000

2001

# Properties

2002

1440

2003

# ApprovalPending - property

1441

2004

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

1442

2005

def ApprovalPending_dbus_property(self):

1443

2006

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

1444

2007

1445

2008

# ApprovedByDefault - property

1446

@dbus_service_property(_interface, signature="b",

2009

@dbus_service_property(_interface,

2010

signature="b",

1447

2011

access="readwrite")

1448

2012

def ApprovedByDefault_dbus_property(self, value=None):

1449

2013

if value is None: # get

1450

2014

return dbus.Boolean(self.approved_by_default)

1451

2015

self.approved_by_default = bool(value)

1452

2016

1453

2017

# ApprovalDelay - property

1454

@dbus_service_property(_interface, signature="t",

2018

@dbus_service_property(_interface,

2019

signature="t",

1455

2020

access="readwrite")

1456

2021

def ApprovalDelay_dbus_property(self, value=None):

1457

2022

if value is None: # get

1458

return dbus.UInt64(self.approval_delay_milliseconds())

2023

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

2024

* 1000)

1459

2025

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

1460

2026

1461

2027

# ApprovalDuration - property

1462

@dbus_service_property(_interface, signature="t",

2028

@dbus_service_property(_interface,

2029

signature="t",

1463

2030

access="readwrite")

1464

2031

def ApprovalDuration_dbus_property(self, value=None):

1465

2032

if value is None: # get

1466

return dbus.UInt64(timedelta_to_milliseconds(

1467

self.approval_duration))

2033

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

2034

* 1000)

1468

2035

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

1469

2036

1470

2037

# Name - property

2038

@dbus_annotations(

2039

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

1471

2040

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

1472

2041

def Name_dbus_property(self):

1473

2042

return dbus.String(self.name)

1474

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

1475

2051

# Fingerprint - property

2052

@dbus_annotations(

2053

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

1476

2054

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

1477

2055

def Fingerprint_dbus_property(self):

1478

2056

return dbus.String(self.fingerprint)

1479

2057

1480

2058

# Host - property

1481

@dbus_service_property(_interface, signature="s",

2059

@dbus_service_property(_interface,

2060

signature="s",

1482

2061

access="readwrite")

1483

2062

def Host_dbus_property(self, value=None):

1484

2063

if value is None: # get

1485

2064

return dbus.String(self.host)

1486

self.host = unicode(value)

1487

2065

self.host = str(value)

2066

1488

2067

# Created - property

2068

@dbus_annotations(

2069

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

1489

2070

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

1490

2071

def Created_dbus_property(self):

1491

2072

return datetime_to_dbus(self.created)

1492

2073

1493

2074

# LastEnabled - property

1494

2075

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

1495

2076

def LastEnabled_dbus_property(self):

1496

2077

return datetime_to_dbus(self.last_enabled)

1497

2078

1498

2079

# Enabled - property

1499

@dbus_service_property(_interface, signature="b",

2080

@dbus_service_property(_interface,

2081

signature="b",

1500

2082

access="readwrite")

1501

2083

def Enabled_dbus_property(self, value=None):

1502

2084

if value is None: # get

1505

2087

self.enable()

1506

2088

else:

1507

2089

self.disable()

1508

2090

1509

2091

# LastCheckedOK - property

1510

@dbus_service_property(_interface, signature="s",

2092

@dbus_service_property(_interface,

2093

signature="s",

1511

2094

access="readwrite")

1512

2095

def LastCheckedOK_dbus_property(self, value=None):

1513

2096

if value is not None:

1514

2097

self.checked_ok()

1515

2098

return

1516

2099

return datetime_to_dbus(self.last_checked_ok)

1517

2100

1518

2101

# LastCheckerStatus - property

1519

@dbus_service_property(_interface, signature="n",

1520

access="read")

2102

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

1521

2103

def LastCheckerStatus_dbus_property(self):

1522

2104

return dbus.Int16(self.last_checker_status)

1523

2105

1524

2106

# Expires - property

1525

2107

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

1526

2108

def Expires_dbus_property(self):

1527

2109

return datetime_to_dbus(self.expires)

1528

2110

1529

2111

# LastApprovalRequest - property

1530

2112

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

1531

2113

def LastApprovalRequest_dbus_property(self):

1532

2114

return datetime_to_dbus(self.last_approval_request)

1533

2115

1534

2116

# Timeout - property

1535

@dbus_service_property(_interface, signature="t",

2117

@dbus_service_property(_interface,

2118

signature="t",

1536

2119

access="readwrite")

1537

2120

def Timeout_dbus_property(self, value=None):

1538

2121

if value is None: # get

1539

return dbus.UInt64(self.timeout_milliseconds())

2122

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

1540

2123

old_timeout = self.timeout

1541

2124

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

1542

2125

# Reschedule disabling

1550

2133

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

1551

2134

is None):

1552

2135

return

1553

gobject.source_remove(self.disable_initiator_tag)

1554

self.disable_initiator_tag = (

1555

gobject.timeout_add(

1556

timedelta_to_milliseconds(self.expires - now),

1557

self.disable))

1558

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

1559

2141

# ExtendedTimeout - property

1560

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1561

2144

access="readwrite")

1562

2145

def ExtendedTimeout_dbus_property(self, value=None):

1563

2146

if value is None: # get

1564

return dbus.UInt64(self.extended_timeout_milliseconds())

2147

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

2148

* 1000)

1565

2149

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

1566

2150

1567

2151

# Interval - property

1568

@dbus_service_property(_interface, signature="t",

2152

@dbus_service_property(_interface,

2153

signature="t",

1569

2154

access="readwrite")

1570

2155

def Interval_dbus_property(self, value=None):

1571

2156

if value is None: # get

1572

return dbus.UInt64(self.interval_milliseconds())

2157

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

1573

2158

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

1574

2159

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

1575

2160

return

1576

2161

if self.enabled:

1577

2162

# Reschedule checker run

1578

gobject.source_remove(self.checker_initiator_tag)

1579

self.checker_initiator_tag = (gobject.timeout_add

1580

(value, self.start_checker))

1581

self.start_checker() # Start one now, too

1582

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

1583

2168

# Checker - property

1584

@dbus_service_property(_interface, signature="s",

2169

@dbus_service_property(_interface,

2170

signature="s",

1585

2171

access="readwrite")

1586

2172

def Checker_dbus_property(self, value=None):

1587

2173

if value is None: # get

1588

2174

return dbus.String(self.checker_command)

1589

self.checker_command = unicode(value)

1590

2175

self.checker_command = str(value)

2176

1591

2177

# CheckerRunning - property

1592

@dbus_service_property(_interface, signature="b",

2178

@dbus_service_property(_interface,

2179

signature="b",

1593

2180

access="readwrite")

1594

2181

def CheckerRunning_dbus_property(self, value=None):

1595

2182

if value is None: # get

1598

2185

self.start_checker()

1599

2186

else:

1600

2187

self.stop_checker()

1601

2188

1602

2189

# ObjectPath - property

2190

@dbus_annotations(

2191

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

2192

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

1603

2193

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

1604

2194

def ObjectPath_dbus_property(self):

1605

return self.dbus_object_path # is already a dbus.ObjectPath

1606

2195

return self.dbus_object_path # is already a dbus.ObjectPath

2196

1607

2197

# Secret = property

1608

@dbus_service_property(_interface, signature="ay",

1609

access="write", byte_arrays=True)

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)

1610

2205

def Secret_dbus_property(self, value):

1611

self.secret = str(value)

1612

2206

self.secret = bytes(value)

2207

1613

2208

del _interface

1614

2209

1615

2210

1616

2211

class ProxyClient(object):

1617

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

2212

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

1618

2213

self._pipe = child_pipe

1619

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

2214

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

1620

2215

if not self._pipe.recv():

1621

raise KeyError()

1622

2216

raise KeyError(key_id or fpr)

2217

1623

2218

def __getattribute__(self, name):

1624

2219

if name == '_pipe':

1625

2220

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

1628

2223

if data[0] == 'data':

1629

2224

return data[1]

1630

2225

if data[0] == 'function':

2226

1631

2227

def func(*args, **kwargs):

1632

2228

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

1633

2229

return self._pipe.recv()[1]

2230

1634

2231

return func

1635

2232

1636

2233

def __setattr__(self, name, value):

1637

2234

if name == '_pipe':

1638

2235

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

1641

2238

1642

2239

class ClientHandler(socketserver.BaseRequestHandler, object):

1643

2240

"""A class to handle client connections.

1644

2241

1645

2242

Instantiated once for each connection to handle it.

1646

2243

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

1647

2244

1648

2245

def handle(self):

1649

2246

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

1650

2247

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

1651

unicode(self.client_address))

2248

str(self.client_address))

1652

2249

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

1653

2250

self.server.child_pipe.fileno())

1654

1655

session = (gnutls.connection

1656

.ClientSession(self.request,

1657

gnutls.connection

1658

.X509Credentials()))

1659

1660

# Note: gnutls.connection.X509Credentials is really a

1661

# generic GnuTLS certificate credentials object so long as

1662

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

1663

# here despite using OpenPGP certificates.

1664

1665

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

1666

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

1667

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

1668

# "+DHE-DSS"))

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

1669

2258

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

1670

2259

priority = self.server.gnutls_priority

1671

2260

if priority is None:

1672

2261

priority = "NORMAL"

1673

(gnutls.library.functions

1674

.gnutls_priority_set_direct(session._c_object,

1675

priority, None))

1676

2262

gnutls.priority_set_direct(session._c_object,

2263

priority.encode("utf-8"),

2264

None)

2265

1677

2266

# Start communication using the Mandos protocol

1678

2267

# Get protocol number

1679

2268

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

1680

2269

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

1681

2270

try:

1682

2271

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

1683

raise RuntimeError

2272

raise RuntimeError(line)

1684

2273

except (ValueError, IndexError, RuntimeError) as error:

1685

2274

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

1686

2275

return

1687

2276

1688

2277

# Start GnuTLS connection

1689

2278

try:

1690

2279

session.handshake()

1691

except gnutls.errors.GNUTLSError as error:

2280

except gnutls.Error as error:

1692

2281

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

1693

2282

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

1694

2283

# established. Just abandon the request.

1695

2284

return

1696

2285

logger.debug("Handshake succeeded")

1697

2286

1698

2287

approval_required = False

1699

2288

try:

1700

try:

1701

fpr = self.fingerprint(self.peer_certificate

1702

(session))

1703

except (TypeError,

1704

gnutls.errors.GNUTLSError) as error:

1705

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

1706

return

1707

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

1708

1709

try:

1710

client = ProxyClient(child_pipe, fpr,

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,

1711

2311

self.client_address)

1712

2312

except KeyError:

1713

2313

return

1714

2314

1715

2315

if client.approval_delay:

1716

2316

delay = client.approval_delay

1717

2317

client.approvals_pending += 1

1718

2318

approval_required = True

1719

2319

1720

2320

while True:

1721

2321

if not client.enabled:

1722

2322

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

1723

client.name)

2323

client.name)

1724

2324

if self.server.use_dbus:

1725

2325

# Emit D-Bus signal

1726

2326

client.Rejected("Disabled")

1727

2327

return

1728

2328

1729

2329

if client.approved or not client.approval_delay:

1730

#We are approved or approval is disabled

2330

# We are approved or approval is disabled

1731

2331

break

1732

2332

elif client.approved is None:

1733

2333

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

1735

2335

if self.server.use_dbus:

1736

2336

# Emit D-Bus signal

1737

2337

client.NeedApproval(

1738

client.approval_delay_milliseconds(),

1739

client.approved_by_default)

2338

client.approval_delay.total_seconds()

2339

* 1000, client.approved_by_default)

1740

2340

else:

1741

2341

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

1742

2342

client.name)

1744

2344

# Emit D-Bus signal

1745

2345

client.Rejected("Denied")

1746

2346

return

1747

1748

#wait until timeout or approved

2347

2348

# wait until timeout or approved

1749

2349

time = datetime.datetime.now()

1750

2350

client.changedstate.acquire()

1751

client.changedstate.wait(

1752

float(timedelta_to_milliseconds(delay)

1753

/ 1000))

2351

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

1754

2352

client.changedstate.release()

1755

2353

time2 = datetime.datetime.now()

1756

2354

if (time2 - time) >= delay:

1766

2364

break

1767

2365

else:

1768

2366

delay -= time2 - time

1769

1770

sent_size = 0

1771

while sent_size < len(client.secret):

1772

try:

1773

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

1774

except gnutls.errors.GNUTLSError as error:

1775

logger.warning("gnutls send failed",

1776

exc_info=error)

1777

return

1778

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

1779

sent, len(client.secret)

1780

- (sent_size + sent))

1781

sent_size += sent

1782

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

1783

2375

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

1784

2376

# bump the timeout using extended_timeout

1785

2377

client.bump_timeout(client.extended_timeout)

1786

2378

if self.server.use_dbus:

1787

2379

# Emit D-Bus signal

1788

2380

client.GotSecret()

1789

2381

1790

2382

finally:

1791

2383

if approval_required:

1792

2384

client.approvals_pending -= 1

1793

2385

try:

1794

2386

session.bye()

1795

except gnutls.errors.GNUTLSError as error:

2387

except gnutls.Error as error:

1796

2388

logger.warning("GnuTLS bye failed",

1797

2389

exc_info=error)

1798

2390

1799

2391

@staticmethod

1800

2392

def peer_certificate(session):

1801

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

1802

# If not an OpenPGP certificate...

1803

if (gnutls.library.functions

1804

.gnutls_certificate_type_get(session._c_object)

1805

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1806

# ...do the normal thing

1807

return session.peer_certificate

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

1808

2409

list_size = ctypes.c_uint(1)

1809

cert_list = (gnutls.library.functions

1810

.gnutls_certificate_get_peers

2410

cert_list = (gnutls.certificate_get_peers

1811

2411

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

1812

2412

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

1813

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

1814

" certificate")

2413

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

1815

2414

if list_size.value == 0:

1816

2415

return None

1817

2416

cert = cert_list[0]

1818

2417

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

1819

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

1820

2453

@staticmethod

1821

2454

def fingerprint(openpgp):

1822

2455

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1823

2456

# New GnuTLS "datum" with the OpenPGP public key

1824

datum = (gnutls.library.types

1825

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

1826

ctypes.POINTER

1827

(ctypes.c_ubyte)),

1828

ctypes.c_uint(len(openpgp))))

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

1829

2461

# New empty GnuTLS certificate

1830

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1831

(gnutls.library.functions

1832

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2462

crt = gnutls.openpgp_crt_t()

2463

gnutls.openpgp_crt_init(ctypes.byref(crt))

1833

2464

# Import the OpenPGP public key into the certificate

1834

(gnutls.library.functions

1835

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

1836

gnutls.library.constants

1837

.GNUTLS_OPENPGP_FMT_RAW))

2465

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

2466

gnutls.OPENPGP_FMT_RAW)

1838

2467

# Verify the self signature in the key

1839

2468

crtverify = ctypes.c_uint()

1840

(gnutls.library.functions

1841

.gnutls_openpgp_crt_verify_self(crt, 0,

1842

ctypes.byref(crtverify)))

2469

gnutls.openpgp_crt_verify_self(crt, 0,

2470

ctypes.byref(crtverify))

1843

2471

if crtverify.value != 0:

1844

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1845

raise (gnutls.errors.CertificateSecurityError

1846

("Verify failed"))

2472

gnutls.openpgp_crt_deinit(crt)

2473

raise gnutls.CertificateSecurityError(code

2474

=crtverify.value)

1847

2475

# New buffer for the fingerprint

1848

2476

buf = ctypes.create_string_buffer(20)

1849

2477

buf_len = ctypes.c_size_t()

1850

2478

# Get the fingerprint from the certificate into the buffer

1851

(gnutls.library.functions

1852

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

1853

ctypes.byref(buf_len)))

2479

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

2480

ctypes.byref(buf_len))

1854

2481

# Deinit the certificate

1855

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2482

gnutls.openpgp_crt_deinit(crt)

1856

2483

# Convert the buffer to a Python bytestring

1857

2484

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

1858

2485

# Convert the bytestring to hexadecimal notation

1862

2489

1863

2490

class MultiprocessingMixIn(object):

1864

2491

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

2492

1865

2493

def sub_process_main(self, request, address):

1866

2494

try:

1867

2495

self.finish_request(request, address)

1868

2496

except Exception:

1869

2497

self.handle_error(request, address)

1870

2498

self.close_request(request)

1871

2499

1872

2500

def process_request(self, request, address):

1873

2501

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

1874

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

1875

args = (request, address))

2502

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

2503

args=(request, address))

1876

2504

proc.start()

1877

2505

return proc

1878

2506

1879

2507

1880

2508

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

1881

2509

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

2510

1882

2511

def process_request(self, request, client_address):

1883

2512

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

1884

2513

1885

2514

This function creates a new pipe in self.pipe

1886

2515

"""

1887

2516

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1888

2517

1889

2518

proc = MultiprocessingMixIn.process_request(self, request,

1890

2519

client_address)

1891

2520

self.child_pipe.close()

1892

2521

self.add_pipe(parent_pipe, proc)

1893

2522

1894

2523

def add_pipe(self, parent_pipe, proc):

1895

2524

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

1896

raise NotImplementedError

2525

raise NotImplementedError()

1897

2526

1898

2527

1899

2528

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1900

2529

socketserver.TCPServer, object):

1901

2530

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

1902

2531

1903

2532

Attributes:

1904

2533

enabled: Boolean; whether this server is activated yet

1905

2534

interface: None or a network interface name (string)

1906

2535

use_ipv6: Boolean; to use IPv6 or not

1907

2536

"""

2537

1908

2538

def __init__(self, server_address, RequestHandlerClass,

1909

interface=None, use_ipv6=True):

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

"""

1910

2545

self.interface = interface

1911

2546

if use_ipv6:

1912

2547

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.

1913

2575

socketserver.TCPServer.__init__(self, server_address,

1914

2576

RequestHandlerClass)

2577

1915

2578

def server_bind(self):

1916

2579

"""This overrides the normal server_bind() function

1917

2580

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

1918

2581

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

2582

global SO_BINDTODEVICE

1919

2583

if self.interface is not None:

1920

2584

if SO_BINDTODEVICE is None:

1921

logger.error("SO_BINDTODEVICE does not exist;"

1922

" cannot bind to interface %s",

1923

self.interface)

1924

else:

1925

try:

1926

self.socket.setsockopt(socket.SOL_SOCKET,

1927

SO_BINDTODEVICE,

1928

str(self.interface

1929

+ '\0'))

1930

except socket.error as error:

1931

if error.errno == errno.EPERM:

1932

logger.error("No permission to"

1933

" bind to interface %s",

1934

self.interface)

1935

elif error.errno == errno.ENOPROTOOPT:

1936

logger.error("SO_BINDTODEVICE not available;"

1937

" cannot bind to interface %s",

1938

self.interface)

1939

elif error.errno == errno.ENODEV:

1940

logger.error("Interface %s does not"

1941

" exist, cannot bind",

1942

self.interface)

1943

else:

1944

raise

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

1945

2606

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

1946

2607

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

2608

if self.server_address[1]:

2609

self.allow_reuse_address = True

1947

2610

if not self.server_address[0]:

1948

2611

if self.address_family == socket.AF_INET6:

1949

any_address = "::" # in6addr_any

2612

any_address = "::" # in6addr_any

1950

2613

else:

1951

any_address = socket.INADDR_ANY

2614

any_address = "0.0.0.0" # INADDR_ANY

1952

2615

self.server_address = (any_address,

1953

2616

self.server_address[1])

1954

2617

elif not self.server_address[1]:

1955

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

1956

0)

2618

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

1957

2619

# if self.interface:

1958

2620

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

1959

2621

# 0, # port

1965

2627

1966

2628

class MandosServer(IPv6_TCPServer):

1967

2629

"""Mandos server.

1968

2630

1969

2631

Attributes:

1970

2632

clients: set of Client objects

1971

2633

gnutls_priority GnuTLS priority string

1972

2634

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

1973

1974

Assumes a gobject.MainLoop event loop.

2635

2636

Assumes a GLib.MainLoop event loop.

1975

2637

"""

2638

1976

2639

def __init__(self, server_address, RequestHandlerClass,

1977

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

1978

gnutls_priority=None, use_dbus=True):

2640

interface=None,

2641

use_ipv6=True,

2642

clients=None,

2643

gnutls_priority=None,

2644

use_dbus=True,

2645

socketfd=None):

1979

2646

self.enabled = False

1980

2647

self.clients = clients

1981

2648

if self.clients is None:

1984

2651

self.gnutls_priority = gnutls_priority

1985

2652

IPv6_TCPServer.__init__(self, server_address,

1986

2653

RequestHandlerClass,

1987

interface = interface,

1988

use_ipv6 = use_ipv6)

2654

interface=interface,

2655

use_ipv6=use_ipv6,

2656

socketfd=socketfd)

2657

1989

2658

def server_activate(self):

1990

2659

if self.enabled:

1991

2660

return socketserver.TCPServer.server_activate(self)

1992

2661

1993

2662

def enable(self):

1994

2663

self.enabled = True

1995

2664

1996

2665

def add_pipe(self, parent_pipe, proc):

1997

2666

# Call "handle_ipc" for both data and EOF events

1998

gobject.io_add_watch(parent_pipe.fileno(),

1999

gobject.IO_IN | gobject.IO_HUP,

2000

functools.partial(self.handle_ipc,

2001

parent_pipe =

2002

parent_pipe,

2003

proc = proc))

2004

2005

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

2006

proc = None, client_object=None):

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

2007

2678

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

2008

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

2679

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

2009

2680

# Wait for other process to exit

2010

2681

proc.join()

2011

2682

return False

2012

2683

2013

2684

# Read a request from the child

2014

2685

request = parent_pipe.recv()

2015

2686

command = request[0]

2016

2687

2017

2688

if command == 'init':

2018

fpr = request[1]

2019

address = request[2]

2020

2021

for c in self.clients.itervalues():

2022

if c.fingerprint == fpr:

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:

2023

2700

client = c

2024

2701

break

2025

2702

else:

2026

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

2027

"dress: %s", fpr, address)

2703

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

2704

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

2028

2705

if self.use_dbus:

2029

2706

# Emit D-Bus signal

2030

mandos_dbus_service.ClientNotFound(fpr,

2707

mandos_dbus_service.ClientNotFound(key_id or fpr,

2031

2708

address[0])

2032

2709

parent_pipe.send(False)

2033

2710

return False

2034

2035

gobject.io_add_watch(parent_pipe.fileno(),

2036

gobject.IO_IN | gobject.IO_HUP,

2037

functools.partial(self.handle_ipc,

2038

parent_pipe =

2039

parent_pipe,

2040

proc = proc,

2041

client_object =

2042

client))

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

2043

2719

parent_pipe.send(True)

2044

2720

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

2045

2721

# same fileno

2048

2724

funcname = request[1]

2049

2725

args = request[2]

2050

2726

kwargs = request[3]

2051

2727

2052

2728

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

2053

2729

funcname)(*args,

2054

**kwargs)))

2055

2730

**kwargs)))

2731

2056

2732

if command == 'getattr':

2057

2733

attrname = request[1]

2058

if callable(client_object.__getattribute__(attrname)):

2059

parent_pipe.send(('function',))

2734

if isinstance(client_object.__getattribute__(attrname),

2735

collections.Callable):

2736

parent_pipe.send(('function', ))

2060

2737

else:

2061

parent_pipe.send(('data', client_object

2062

.__getattribute__(attrname)))

2063

2738

parent_pipe.send((

2739

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

2740

2064

2741

if command == 'setattr':

2065

2742

attrname = request[1]

2066

2743

value = request[2]

2067

2744

setattr(client_object, attrname, value)

2068

2745

2069

2746

return True

2070

2747

2071

2748

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

2072

2848

def string_to_delta(interval):

2073

2849

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

2074

2850

2075

2851

>>> string_to_delta('7d')

2076

2852

datetime.timedelta(7)

2077

2853

>>> string_to_delta('60s')

2085

2861

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

2086

2862

datetime.timedelta(0, 330)

2087

2863

"""

2864

2865

try:

2866

return rfc3339_duration_to_delta(interval)

2867

except ValueError:

2868

pass

2869

2088

2870

timevalue = datetime.timedelta(0)

2089

2871

for s in interval.split():

2090

2872

try:

2091

suffix = unicode(s[-1])

2873

suffix = s[-1]

2092

2874

value = int(s[:-1])

2093

2875

if suffix == "d":

2094

2876

delta = datetime.timedelta(value)

2101

2883

elif suffix == "w":

2102

2884

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

2103

2885

else:

2104

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

2105

.format(suffix))

2106

except (ValueError, IndexError) as e:

2886

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

2887

except IndexError as e:

2107

2888

raise ValueError(*(e.args))

2108

2889

timevalue += delta

2109

2890

return timevalue

2110

2891

2111

2892

2112

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

2893

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

2113

2894

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

2114

2895

2115

2896

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

2116

2897

if os.fork():

2117

2898

sys.exit()

2125

2906

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

2126

2907

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

2127

2908

raise OSError(errno.ENODEV,

2128

"{0} not a character device"

2909

"{} not a character device"

2129

2910

.format(os.devnull))

2130

2911

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

2131

2912

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

2135

2916

2136

2917

2137

2918

def main():

2138

2919

2139

2920

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

2140

2921

# Parsing of options, both command line and config file

2141

2922

2142

2923

parser = argparse.ArgumentParser()

2143

2924

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

2144

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

2925

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

2145

2926

help="show version number and exit")

2146

2927

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

2147

2928

help="Bind to interface IF")

2153

2934

help="Run self-test")

2154

2935

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

2155

2936

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

2156

" to terminal")

2937

" to terminal", default=None)

2157

2938

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

2158

2939

help="Debug level for stdout output")

2159

2940

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

2166

2947

" files")

2167

2948

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

2168

2949

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

2169

" system bus interface")

2950

" system bus interface", default=None)

2170

2951

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

2171

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

2952

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

2953

default=None)

2172

2954

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

2173

2955

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

2174

" state")

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

2175

2960

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

2176

2961

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

2177

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

2178

2968

options = parser.parse_args()

2179

2969

2180

2970

if options.check:

2181

2971

import doctest

2182

doctest.testmod()

2183

sys.exit()

2184

2972

fail_count, test_count = doctest.testmod()

2973

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

2974

2185

2975

# Default values for config file for server-global settings

2186

server_defaults = { "interface": "",

2187

"address": "",

2188

"port": "",

2189

"debug": "False",

2190

"priority":

2191

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

2192

"servicename": "Mandos",

2193

"use_dbus": "True",

2194

"use_ipv6": "True",

2195

"debuglevel": "",

2196

"restore": "True",

2197

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

2198

}

2199

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

2200

2999

# Parse config file for server-global settings

2201

3000

server_config = configparser.SafeConfigParser(server_defaults)

2202

3001

del server_defaults

2203

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

2204

"mandos.conf"))

3002

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

2205

3003

# Convert the SafeConfigParser object to a dict

2206

3004

server_settings = server_config.defaults()

2207

3005

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

2208

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

3006

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

3007

"foreground", "zeroconf"):

2209

3008

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

2210

3009

option)

2211

3010

if server_settings["port"]:

2212

3011

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

2213

3012

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

2214

3022

del server_config

2215

3023

2216

3024

# Override the settings from the config file with command line

2217

3025

# options, if set.

2218

3026

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

2219

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

2220

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

2221

"statedir"):

3027

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

3028

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

3029

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

2222

3030

value = getattr(options, option)

2223

3031

if value is not None:

2224

3032

server_settings[option] = value

2225

3033

del options

2226

3034

# Force all strings to be unicode

2227

3035

for option in server_settings.keys():

2228

if type(server_settings[option]) is str:

2229

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

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

2230

3046

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

2231

3047

2232

3048

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

2233

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

2234

3055

# For convenience

2235

3056

debug = server_settings["debug"]

2236

3057

debuglevel = server_settings["debuglevel"]

2238

3059

use_ipv6 = server_settings["use_ipv6"]

2239

3060

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

2240

3061

stored_state_file)

2241

3062

foreground = server_settings["foreground"]

3063

zeroconf = server_settings["zeroconf"]

3064

2242

3065

if debug:

2243

3066

initlogger(debug, logging.DEBUG)

2244

3067

else:

2247

3070

else:

2248

3071

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

2249

3072

initlogger(debug, level)

2250

3073

2251

3074

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

2252

syslogger.setFormatter(logging.Formatter

2253

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

2254

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

2255

.format(server_settings

2256

["servicename"])))

2257

3075

syslogger.setFormatter(

3076

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

3077

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

3078

server_settings["servicename"])))

3079

2258

3080

# Parse config file with clients

2259

3081

client_config = configparser.SafeConfigParser(Client

2260

3082

.client_defaults)

2261

3083

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

2262

3084

"clients.conf"))

2263

3085

2264

3086

global mandos_dbus_service

2265

3087

mandos_dbus_service = None

2266

2267

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

2268

server_settings["port"]),

2269

ClientHandler,

2270

interface=(server_settings["interface"]

2271

or None),

2272

use_ipv6=use_ipv6,

2273

gnutls_priority=

2274

server_settings["priority"],

2275

use_dbus=use_dbus)

2276

if not debug:

2277

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

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

2278

3105

try:

2279

pidfile = open(pidfilename, "w")

3106

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

2280

3107

except IOError as e:

2281

3108

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

2282

3109

exc_info=e)

2283

2284

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

3110

3111

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

3112

("mandos", "mandos"),

3113

("nobody", "nogroup")):

2285

3114

try:

2286

3115

uid = pwd.getpwnam(name).pw_uid

2287

gid = pwd.getpwnam(name).pw_gid

3116

gid = pwd.getpwnam(group).pw_gid

2288

3117

break

2289

3118

except KeyError:

2290

3119

continue

2294

3123

try:

2295

3124

os.setgid(gid)

2296

3125

os.setuid(uid)

3126

if debug:

3127

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

3128

gid))

2297

3129

except OSError as error:

2298

if error[0] != errno.EPERM:

2299

raise error

2300

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

2301

3135

if debug:

2302

3136

# Enable all possible GnuTLS debugging

2303

3137

2304

3138

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

2305

3139

# - GnuTLS manual

2306

gnutls.library.functions.gnutls_global_set_log_level(11)

2307

2308

@gnutls.library.types.gnutls_log_func

3140

gnutls.global_set_log_level(11)

3141

3142

@gnutls.log_func

2309

3143

def debug_gnutls(level, string):

2310

3144

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

2311

2312

(gnutls.library.functions

2313

.gnutls_global_set_log_function(debug_gnutls))

2314

3145

3146

gnutls.global_set_log_function(debug_gnutls)

3147

2315

3148

# Redirect stdin so all checkers get /dev/null

2316

3149

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

2317

3150

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

2318

3151

if null > 2:

2319

3152

os.close(null)

2320

3153

2321

3154

# Need to fork before connecting to D-Bus

2322

if not debug:

3155

if not foreground:

2323

3156

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

2324

3157

daemon()

2325

2326

gobject.threads_init()

2327

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

2328

3163

global main_loop

2329

3164

# From the Avahi example code

2330

3165

DBusGMainLoop(set_as_default=True)

2331

main_loop = gobject.MainLoop()

3166

main_loop = GLib.MainLoop()

2332

3167

bus = dbus.SystemBus()

2333

3168

# End of Avahi example code

2334

3169

if use_dbus:

2335

3170

try:

2336

3171

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

2337

bus, do_not_queue=True)

2338

old_bus_name = (dbus.service.BusName

2339

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

2340

do_not_queue=True))

2341

except dbus.exceptions.NameExistsException as e:

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:

2342

3178

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

2343

3179

use_dbus = False

2344

3180

server_settings["use_dbus"] = False

2345

3181

tcp_server.use_dbus = False

2346

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2347

service = AvahiServiceToSyslog(name =

2348

server_settings["servicename"],

2349

servicetype = "_mandos._tcp",

2350

protocol = protocol, bus = bus)

2351

if server_settings["interface"]:

2352

service.interface = (if_nametoindex

2353

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

2354

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

2355

3193

global multiprocessing_manager

2356

3194

multiprocessing_manager = multiprocessing.Manager()

2357

3195

2358

3196

client_class = Client

2359

3197

if use_dbus:

2360

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

2361

3198

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

3199

2362

3200

client_settings = Client.config_parser(client_config)

2363

3201

old_client_settings = {}

2364

3202

clients_data = {}

2365

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

2366

3212

# Get client data and settings from last running state.

2367

3213

if server_settings["restore"]:

2368

3214

try:

2369

3215

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

2370

clients_data, old_client_settings = (pickle.load

2371

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

2372

3265

os.remove(stored_state_path)

2373

3266

except IOError as e:

2374

3267

if e.errno == errno.ENOENT:

2375

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

2376

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

3268

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

3269

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

2377

3270

else:

2378

3271

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

2379

3272

exc_info=e)

2380

3273

raise

2381

3274

except EOFError as e:

2382

3275

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

2383

"EOFError:", exc_info=e)

2384

3276

"EOFError:",

3277

exc_info=e)

3278

2385

3279

with PGPEngine() as pgp:

2386

for client_name, client in clients_data.iteritems():

3280

for client_name, client in clients_data.items():

3281

# Skip removed clients

3282

if client_name not in client_settings:

3283

continue

3284

2387

3285

# Decide which value to use after restoring saved state.

2388

3286

# We have three different values: Old config file,

2389

3287

# new config file, and saved state.

2394

3292

# For each value in new config, check if it

2395

3293

# differs from the old config value (Except for

2396

3294

# the "secret" attribute)

2397

if (name != "secret" and

2398

value != old_client_settings[client_name]

2399

[name]):

3295

if (name != "secret"

3296

and (value !=

3297

old_client_settings[client_name][name])):

2400

3298

client[name] = value

2401

3299

except KeyError:

2402

3300

pass

2403

3301

2404

3302

# Clients who has passed its expire date can still be

2405

# enabled if its last checker was successful. Clients

3303

# enabled if its last checker was successful. A Client

2406

3304

# whose checker succeeded before we stored its state is

2407

3305

# assumed to have successfully run all checkers during

2408

3306

# downtime.

2410

3308

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

2411

3309

if not client["last_checked_ok"]:

2412

3310

logger.warning(

2413

"disabling client {0} - Client never "

2414

"performed a successful checker"

2415

.format(client_name))

3311

"disabling client {} - Client never "

3312

"performed a successful checker".format(

3313

client_name))

2416

3314

client["enabled"] = False

2417

3315

elif client["last_checker_status"] != 0:

2418

3316

logger.warning(

2419

"disabling client {0} - Client "

2420

"last checker failed with error code {1}"

2421

.format(client_name,

2422

client["last_checker_status"]))

3317

"disabling client {} - Client last"

3318

" checker failed with error code"

3319

" {}".format(

3320

client_name,

3321

client["last_checker_status"]))

2423

3322

client["enabled"] = False

2424

3323

else:

2425

client["expires"] = (datetime.datetime

2426

.utcnow()

2427

+ client["timeout"])

3324

client["expires"] = (

3325

datetime.datetime.utcnow()

3326

+ client["timeout"])

2428

3327

logger.debug("Last checker succeeded,"

2429

" keeping {0} enabled"

2430

.format(client_name))

3328

" keeping {} enabled".format(

3329

client_name))

2431

3330

try:

2432

client["secret"] = (

2433

pgp.decrypt(client["encrypted_secret"],

2434

client_settings[client_name]

2435

["secret"]))

3331

client["secret"] = pgp.decrypt(

3332

client["encrypted_secret"],

3333

client_settings[client_name]["secret"])

2436

3334

except PGPError:

2437

3335

# If decryption fails, we use secret from new settings

2438

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

2439

.format(client_name))

2440

client["secret"] = (

2441

client_settings[client_name]["secret"])

2442

3336

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

3337

client_name))

3338

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

3339

["secret"])

3340

2443

3341

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

2444

3342

for client_name in (set(old_client_settings)

2445

3343

- set(client_settings)):

2447

3345

for client_name in (set(client_settings)

2448

3346

- set(old_client_settings)):

2449

3347

clients_data[client_name] = client_settings[client_name]

2450

3348

2451

3349

# Create all client objects

2452

for client_name, client in clients_data.iteritems():

3350

for client_name, client in clients_data.items():

2453

3351

tcp_server.clients[client_name] = client_class(

2454

name = client_name, settings = client)

2455

3352

name=client_name,

3353

settings=client,

3354

server_settings=server_settings)

3355

2456

3356

if not tcp_server.clients:

2457

3357

logger.warning("No clients defined")

2458

2459

if not debug:

2460

try:

2461

with pidfile:

2462

pid = os.getpid()

2463

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

2464

del pidfile

2465

except IOError:

2466

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

2467

pidfilename, pid)

2468

except NameError:

2469

# "pidfile" was never created

2470

pass

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

2471

3369

del pidfilename

2472

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

2473

2474

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

2475

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

2476

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

2477

3375

if use_dbus:

2478

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

2479

"se.bsnet.fukt.Mandos"})

2480

class MandosDBusService(DBusObjectWithProperties):

3376

3377

@alternate_dbus_interfaces(

3378

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

3379

class MandosDBusService(DBusObjectWithObjectManager):

2481

3380

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

3381

2482

3382

def __init__(self):

2483

3383

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

3384

2484

3385

_interface = "se.recompile.Mandos"

2485

2486

@dbus_interface_annotations(_interface)

2487

def _foo(self):

2488

return { "org.freedesktop.DBus.Property"

2489

".EmitsChangedSignal":

2490

"false"}

2491

3386

2492

3387

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

2493

3388

def ClientAdded(self, objpath):

2494

3389

"D-Bus signal"

2495

3390

pass

2496

3391

2497

3392

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

2498

def ClientNotFound(self, fingerprint, address):

3393

def ClientNotFound(self, key_id, address):

2499

3394

"D-Bus signal"

2500

3395

pass

2501

3396

3397

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

3398

"true"})

2502

3399

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

2503

3400

def ClientRemoved(self, objpath, name):

2504

3401

"D-Bus signal"

2505

3402

pass

2506

3403

3404

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

3405

"true"})

2507

3406

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

2508

3407

def GetAllClients(self):

2509

3408

"D-Bus method"

2510

return dbus.Array(c.dbus_object_path

2511

for c in

2512

tcp_server.clients.itervalues())

2513

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

2514

3414

@dbus.service.method(_interface,

2515

3415

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

2516

3416

def GetAllClientsWithProperties(self):

2517

3417

"D-Bus method"

2518

3418

return dbus.Dictionary(

2519

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

2520

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

3419

{c.dbus_object_path: c.GetAll(

3420

"se.recompile.Mandos.Client")

3421

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

2521

3422

signature="oa{sv}")

2522

3423

2523

3424

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

2524

3425

def RemoveClient(self, object_path):

2525

3426

"D-Bus method"

2526

for c in tcp_server.clients.itervalues():

3427

for c in tcp_server.clients.values():

2527

3428

if c.dbus_object_path == object_path:

2528

3429

del tcp_server.clients[c.name]

2529

3430

c.remove_from_connection()

2530

# Don't signal anything except ClientRemoved

3431

# Don't signal the disabling

2531

3432

c.disable(quiet=True)

2532

# Emit D-Bus signal

2533

self.ClientRemoved(object_path, c.name)

3433

# Emit D-Bus signal for removal

3434

self.client_removed_signal(c)

2534

3435

return

2535

3436

raise KeyError(object_path)

2536

3437

2537

3438

del _interface

2538

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

2539

3476

mandos_dbus_service = MandosDBusService()

2540

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

2541

3483

def cleanup():

2542

3484

"Cleanup function; run on exit"

2543

service.cleanup()

2544

2545

multiprocessing.active_children()

3485

if zeroconf:

3486

service.cleanup()

3487

3488

mp.active_children()

3489

wn.close()

2546

3490

if not (tcp_server.clients or client_settings):

2547

3491

return

2548

3492

2549

3493

# Store client before exiting. Secrets are encrypted with key

2550

3494

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

2551

3495

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

2552

3496

clients = {}

2553

3497

with PGPEngine() as pgp:

2554

for client in tcp_server.clients.itervalues():

3498

for client in tcp_server.clients.values():

2555

3499

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

2556

3500

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

2557

3501

key)

2558

3502

client_dict = {}

2559

3503

2560

3504

# A list of attributes that can not be pickled

2561

3505

# + secret.

2562

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

2563

"checker"))

2564

for name, typ in (inspect.getmembers

2565

(dbus.service.Object)):

3506

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

3507

"checker", "server_settings"}

3508

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

3509

.Object):

2566

3510

exclude.add(name)

2567

3511

2568

3512

client_dict["encrypted_secret"] = (client

2569

3513

.encrypted_secret)

2570

3514

for attr in client.client_structure:

2571

3515

if attr not in exclude:

2572

3516

client_dict[attr] = getattr(client, attr)

2573

3517

2574

3518

clients[client.name] = client_dict

2575

3519

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

2576

3520

2577

3521

try:

2578

with (tempfile.NamedTemporaryFile

2579

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

2580

dir=os.path.dirname(stored_state_path),

2581

delete=False)) as stored_state:

2582

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

2583

tempname=stored_state.name

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

2584

3531

os.rename(tempname, stored_state_path)

2585

3532

except (IOError, OSError) as e:

2586

3533

if not debug:

2589

3536

except NameError:

2590

3537

pass

2591

3538

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

2592

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

3539

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

2593

3540

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

2594

3541

else:

2595

3542

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

2596

3543

exc_info=e)

2597

raise e

2598

3544

raise

3545

2599

3546

# Delete all clients, and settings from config

2600

3547

while tcp_server.clients:

2601

3548

name, client = tcp_server.clients.popitem()

2602

3549

if use_dbus:

2603

3550

client.remove_from_connection()

2604

# Don't signal anything except ClientRemoved

3551

# Don't signal the disabling

2605

3552

client.disable(quiet=True)

3553

# Emit D-Bus signal for removal

2606

3554

if use_dbus:

2607

# Emit D-Bus signal

2608

mandos_dbus_service.ClientRemoved(client

2609

.dbus_object_path,

2610

client.name)

3555

mandos_dbus_service.client_removed_signal(client)

2611

3556

client_settings.clear()

2612

3557

2613

3558

atexit.register(cleanup)

2614

2615

for client in tcp_server.clients.itervalues():

3559

3560

for client in tcp_server.clients.values():

2616

3561

if use_dbus:

2617

# Emit D-Bus signal

2618

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3562

# Emit D-Bus signal for adding

3563

mandos_dbus_service.client_added_signal(client)

2619

3564

# Need to initiate checking of clients

2620

3565

if client.enabled:

2621

3566

client.init_checker()

2622

3567

2623

3568

tcp_server.enable()

2624

3569

tcp_server.server_activate()

2625

3570

2626

3571

# Find out what port we got

2627

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

3572

if zeroconf:

3573

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

2628

3574

if use_ipv6:

2629

3575

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

2630

3576

" flowinfo %d, scope_id %d",

2632

3578

else: # IPv4

2633

3579

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

2634

3580

*tcp_server.socket.getsockname())

2635

2636

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

2637

3581

3582

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

3583

2638

3584

try:

2639

# From the Avahi example code

2640

try:

2641

service.activate()

2642

except dbus.exceptions.DBusException as error:

2643

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

2644

cleanup()

2645

sys.exit(1)

2646

# End of Avahi example code

2647

2648

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

2649

lambda *args, **kwargs:

2650

(tcp_server.handle_request

2651

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

2652

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

2653

3600

logger.debug("Starting main loop")

2654

3601

main_loop.run()

2655

3602

except AvahiError as error:

2664

3611

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

2665

3612

cleanup()

2666

3613

3614

2667

3615

if __name__ == '__main__':

2668

3616

main()