/mandos/release : revision 237.7.708

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

71

78

import collections

79

import codecs

72

80

73

81

import dbus

74

82

import dbus.service

75

import gobject

76

import avahi

83

import gi

84

from gi.repository import GLib

77

85

from dbus.mainloop.glib import DBusGMainLoop

78

86

import ctypes

79

87

import ctypes.util

80

88

import xml.dom.minidom

81

89

import inspect

82

import GnuPGInterface

83

90

91

if sys.version_info.major == 2:

92

__metaclass__ = type

93

94

# Try to find the value of SO_BINDTODEVICE:

84

95

try:

96

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

97

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

85

98

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

86

99

except AttributeError:

87

100

try:

101

# This is where SO_BINDTODEVICE was up to and including Python

102

# 2.6, and also 3.2:

88

103

from IN import SO_BINDTODEVICE

89

104

except ImportError:

90

SO_BINDTODEVICE = None

91

92

version = "1.6.0"

105

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

106

# Try running the C preprocessor:

107

try:

108

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

109

"/dev/stdin"],

110

stdin=subprocess.PIPE,

111

stdout=subprocess.PIPE)

112

stdout = cc.communicate(

113

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

114

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

115

except (OSError, ValueError, IndexError):

116

# No value found

117

SO_BINDTODEVICE = None

118

119

if sys.version_info.major == 2:

120

str = unicode

121

122

if sys.version_info < (3, 2):

123

configparser.Configparser = configparser.SafeConfigParser

124

125

version = "1.8.7"

93

126

stored_state_file = "clients.pickle"

94

127

95

128

logger = logging.getLogger()

96

syslogger = (logging.handlers.SysLogHandler

97

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

98

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

129

syslogger = None

99

130

100

131

try:

101

if_nametoindex = (ctypes.cdll.LoadLibrary

102

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

103

.if_nametoindex)

132

if_nametoindex = ctypes.cdll.LoadLibrary(

133

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

104

134

except (OSError, AttributeError):

135

105

136

def if_nametoindex(interface):

106

137

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

107

138

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

108

139

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

109

140

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

110

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

111

interface))

112

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

113

ifreq[16:20])[0]

141

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

142

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

114

143

return interface_index

115

144

116

145

146

def copy_function(func):

147

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

148

if sys.version_info.major == 2:

149

return types.FunctionType(func.func_code,

150

func.func_globals,

151

func.func_name,

152

func.func_defaults,

153

func.func_closure)

154

else:

155

return types.FunctionType(func.__code__,

156

func.__globals__,

157

func.__name__,

158

func.__defaults__,

159

func.__closure__)

160

161

117

162

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

118

163

"""init logger and add loglevel"""

119

164

165

global syslogger

166

syslogger = (logging.handlers.SysLogHandler(

167

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

168

address="/dev/log"))

120

169

syslogger.setFormatter(logging.Formatter

121

170

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

122

171

' %(message)s'))

123

172

logger.addHandler(syslogger)

124

173

125

174

if debug:

126

175

console = logging.StreamHandler()

127

176

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

137

186

pass

138

187

139

188

140

class PGPEngine(object):

189

class PGPEngine:

141

190

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

191

142

192

def __init__(self):

143

self.gnupg = GnuPGInterface.GnuPG()

144

193

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

145

self.gnupg = GnuPGInterface.GnuPG()

146

self.gnupg.options.meta_interactive = False

147

self.gnupg.options.homedir = self.tempdir

148

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

149

'--quiet',

150

'--no-use-agent'])

151

194

self.gpg = "gpg"

195

try:

196

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

197

for line in output.splitlines():

198

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

199

if name == "gpg":

200

self.gpg = path

201

break

202

except OSError as e:

203

if e.errno != errno.ENOENT:

204

raise

205

self.gnupgargs = ['--batch',

206

'--homedir', self.tempdir,

207

'--force-mdc',

208

'--quiet']

209

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

210

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

211

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

212

152

213

def __enter__(self):

153

214

return self

154

215

155

216

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

156

217

self._cleanup()

157

218

return False

158

219

159

220

def __del__(self):

160

221

self._cleanup()

161

222

162

223

def _cleanup(self):

163

224

if self.tempdir is not None:

164

225

# Delete contents of tempdir

165

226

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

166

topdown = False):

227

topdown=False):

167

228

for filename in files:

168

229

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

169

230

for dirname in dirs:

171

232

# Remove tempdir

172

233

os.rmdir(self.tempdir)

173

234

self.tempdir = None

174

235

175

236

def password_encode(self, password):

176

237

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

177

238

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

178

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

179

239

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

240

if len(encoded) > 2048:

241

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

242

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

243

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

244

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

245

return encoded

246

180

247

def encrypt(self, data, password):

181

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

182

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

183

try:

184

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

185

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

186

attach_fhs={'stderr': devnull})

187

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

188

f.write(data)

189

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

190

ciphertext = f.read()

191

proc.wait()

192

except IOError as e:

193

raise PGPError(e)

194

self.gnupg.passphrase = None

248

passphrase = self.password_encode(password)

249

with tempfile.NamedTemporaryFile(

250

dir=self.tempdir) as passfile:

251

passfile.write(passphrase)

252

passfile.flush()

253

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

254

'--passphrase-file',

255

passfile.name]

256

+ self.gnupgargs,

257

stdin=subprocess.PIPE,

258

stdout=subprocess.PIPE,

259

stderr=subprocess.PIPE)

260

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

261

if proc.returncode != 0:

262

raise PGPError(err)

195

263

return ciphertext

196

264

197

265

def decrypt(self, data, password):

198

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

199

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

200

try:

201

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

202

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

203

attach_fhs={'stderr': devnull})

204

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

205

f.write(data)

206

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

207

decrypted_plaintext = f.read()

208

proc.wait()

209

except IOError as e:

210

raise PGPError(e)

211

self.gnupg.passphrase = None

266

passphrase = self.password_encode(password)

267

with tempfile.NamedTemporaryFile(

268

dir=self.tempdir) as passfile:

269

passfile.write(passphrase)

270

passfile.flush()

271

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

272

'--passphrase-file',

273

passfile.name]

274

+ self.gnupgargs,

275

stdin=subprocess.PIPE,

276

stdout=subprocess.PIPE,

277

stderr=subprocess.PIPE)

278

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

279

if proc.returncode != 0:

280

raise PGPError(err)

212

281

return decrypted_plaintext

213

282

214

283

284

# Pretend that we have an Avahi module

285

class avahi:

286

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

287

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

288

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

289

PROTO_INET = 0 # avahi-common/address.h

290

PROTO_INET6 = 1 # avahi-common/address.h

291

DBUS_NAME = "org.freedesktop.Avahi"

292

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

293

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

294

DBUS_PATH_SERVER = "/"

295

296

@staticmethod

297

def string_array_to_txt_array(t):

298

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

299

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

300

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

301

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

302

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

303

SERVER_INVALID = 0 # avahi-common/defs.h

304

SERVER_REGISTERING = 1 # avahi-common/defs.h

305

SERVER_RUNNING = 2 # avahi-common/defs.h

306

SERVER_COLLISION = 3 # avahi-common/defs.h

307

SERVER_FAILURE = 4 # avahi-common/defs.h

308

309

215

310

class AvahiError(Exception):

216

311

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

217

312

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

313

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

314

**kwargs)

315

221

316

222

317

class AvahiServiceError(AvahiError):

223

318

pass

224

319

320

225

321

class AvahiGroupError(AvahiError):

226

322

pass

227

323

228

324

229

class AvahiService(object):

325

class AvahiService:

230

326

"""An Avahi (Zeroconf) service.

231

327

232

328

Attributes:

233

329

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

234

330

Used to optionally bind to the specified interface.

235

331

name: string; Example: 'Mandos'

236

332

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

237

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

333

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

238

334

port: integer; what port to announce

239

335

TXT: list of strings; TXT record for the service

240

336

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

246

342

server: D-Bus Server

247

343

bus: dbus.SystemBus()

248

344

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

345

346

def __init__(self,

347

interface=avahi.IF_UNSPEC,

348

name=None,

349

servicetype=None,

350

port=None,

351

TXT=None,

352

domain="",

353

host="",

354

max_renames=32768,

355

protocol=avahi.PROTO_UNSPEC,

356

bus=None):

254

357

self.interface = interface

255

358

self.name = name

256

359

self.type = servicetype

265

368

self.server = None

266

369

self.bus = bus

267

370

self.entry_group_state_changed_match = None

268

269

def rename(self):

371

372

def rename(self, remove=True):

270

373

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

271

374

if self.rename_count >= self.max_renames:

272

375

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

273

376

" after %i retries, exiting.",

274

377

self.rename_count)

275

378

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

379

self.name = str(

380

self.server.GetAlternativeServiceName(self.name))

381

self.rename_count += 1

278

382

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

279

383

self.name)

280

self.remove()

384

if remove:

385

self.remove()

281

386

try:

282

387

self.add()

283

388

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

389

if (error.get_dbus_name()

390

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

391

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

392

return self.rename(remove=False)

393

else:

394

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

395

self.cleanup()

396

os._exit(1)

397

289

398

def remove(self):

290

399

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

291

400

if self.entry_group_state_changed_match is not None:

293

402

self.entry_group_state_changed_match = None

294

403

if self.group is not None:

295

404

self.group.Reset()

296

405

297

406

def add(self):

298

407

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

299

408

self.remove()

316

425

dbus.UInt16(self.port),

317

426

avahi.string_array_to_txt_array(self.TXT))

318

427

self.group.Commit()

319

428

320

429

def entry_group_state_changed(self, state, error):

321

430

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

322

431

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

323

432

324

433

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

434

logger.debug("Zeroconf service established.")

326

435

elif state == avahi.ENTRY_GROUP_COLLISION:

328

437

self.rename()

329

438

elif state == avahi.ENTRY_GROUP_FAILURE:

330

439

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

331

unicode(error))

332

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

333

.format(error))

334

440

str(error))

441

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

442

335

443

def cleanup(self):

336

444

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

337

445

if self.group is not None:

342

450

pass

343

451

self.group = None

344

452

self.remove()

345

453

346

454

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

347

455

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

348

456

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

457

bad_states = {

458

avahi.SERVER_INVALID: "Zeroconf server invalid",

459

avahi.SERVER_REGISTERING: None,

460

avahi.SERVER_COLLISION: "Zeroconf server name collision",

461

avahi.SERVER_FAILURE: "Zeroconf server failure",

462

}

356

463

if state in bad_states:

357

464

if bad_states[state] is not None:

358

465

if error is None:

361

468

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

362

469

self.cleanup()

363

470

elif state == avahi.SERVER_RUNNING:

364

self.add()

471

try:

472

self.add()

473

except dbus.exceptions.DBusException as error:

474

if (error.get_dbus_name()

475

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

476

logger.info("Local Zeroconf service name"

477

" collision.")

478

return self.rename(remove=False)

479

else:

480

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

481

self.cleanup()

482

os._exit(1)

365

483

else:

366

484

if error is None:

367

485

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

368

486

else:

369

487

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

370

488

371

489

def activate(self):

372

490

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

373

491

if self.server is None:

377

495

follow_name_owner_changes=True),

378

496

avahi.DBUS_INTERFACE_SERVER)

379

497

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

498

self.server_state_changed)

381

499

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

382

500

383

501

384

502

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

503

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

386

504

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

505

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

506

syslogger.setFormatter(logging.Formatter(

507

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

508

.format(self.name)))

392

509

return ret

393

510

394

511

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

512

# Pretend that we have a GnuTLS module

513

class gnutls:

514

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

515

516

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

517

if library is None:

518

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

519

_library = ctypes.cdll.LoadLibrary(library)

520

del library

521

522

# Unless otherwise indicated, the constants and types below are

523

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

524

525

# Constants

526

E_SUCCESS = 0

527

E_INTERRUPTED = -52

528

E_AGAIN = -28

529

CRT_OPENPGP = 2

530

CRT_RAWPK = 3

531

CLIENT = 2

532

SHUT_RDWR = 0

533

CRD_CERTIFICATE = 1

534

E_NO_CERTIFICATE_FOUND = -49

535

X509_FMT_DER = 0

536

NO_TICKETS = 1<<10

537

ENABLE_RAWPK = 1<<18

538

CTYPE_PEERS = 3

539

KEYID_USE_SHA256 = 1 # gnutls/x509.h

540

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

541

542

# Types

543

class session_int(ctypes.Structure):

544

_fields_ = []

545

session_t = ctypes.POINTER(session_int)

546

547

class certificate_credentials_st(ctypes.Structure):

548

_fields_ = []

549

certificate_credentials_t = ctypes.POINTER(

550

certificate_credentials_st)

551

certificate_type_t = ctypes.c_int

552

553

class datum_t(ctypes.Structure):

554

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

555

('size', ctypes.c_uint)]

556

557

class openpgp_crt_int(ctypes.Structure):

558

_fields_ = []

559

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

560

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

561

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

562

credentials_type_t = ctypes.c_int

563

transport_ptr_t = ctypes.c_void_p

564

close_request_t = ctypes.c_int

565

566

# Exceptions

567

class Error(Exception):

568

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

569

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

570

# code is passed, convert it to a string with

571

# gnutls.strerror()

572

self.code = code

573

if message is None and code is not None:

574

message = gnutls.strerror(code)

575

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

576

message, *args)

577

578

class CertificateSecurityError(Error):

579

pass

580

581

# Classes

582

class Credentials:

583

def __init__(self):

584

self._c_object = gnutls.certificate_credentials_t()

585

gnutls.certificate_allocate_credentials(

586

ctypes.byref(self._c_object))

587

self.type = gnutls.CRD_CERTIFICATE

588

589

def __del__(self):

590

gnutls.certificate_free_credentials(self._c_object)

591

592

class ClientSession:

593

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

594

self._c_object = gnutls.session_t()

595

gnutls_flags = gnutls.CLIENT

596

if gnutls.check_version(b"3.5.6"):

597

gnutls_flags |= gnutls.NO_TICKETS

598

if gnutls.has_rawpk:

599

gnutls_flags |= gnutls.ENABLE_RAWPK

600

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

601

del gnutls_flags

602

gnutls.set_default_priority(self._c_object)

603

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

604

gnutls.handshake_set_private_extensions(self._c_object,

605

True)

606

self.socket = socket

607

if credentials is None:

608

credentials = gnutls.Credentials()

609

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

610

ctypes.cast(credentials._c_object,

611

ctypes.c_void_p))

612

self.credentials = credentials

613

614

def __del__(self):

615

gnutls.deinit(self._c_object)

616

617

def handshake(self):

618

return gnutls.handshake(self._c_object)

619

620

def send(self, data):

621

data = bytes(data)

622

data_len = len(data)

623

while data_len > 0:

624

data_len -= gnutls.record_send(self._c_object,

625

data[-data_len:],

626

data_len)

627

628

def bye(self):

629

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

630

631

# Error handling functions

632

def _error_code(result):

633

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

634

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

635

if result >= 0:

636

return result

637

if result == gnutls.E_NO_CERTIFICATE_FOUND:

638

raise gnutls.CertificateSecurityError(code=result)

639

raise gnutls.Error(code=result)

640

641

def _retry_on_error(result, func, arguments):

642

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

643

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

644

while result < 0:

645

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

646

return _error_code(result)

647

result = func(*arguments)

648

return result

649

650

# Unless otherwise indicated, the function declarations below are

651

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

652

653

# Functions

654

priority_set_direct = _library.gnutls_priority_set_direct

655

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

656

ctypes.POINTER(ctypes.c_char_p)]

657

priority_set_direct.restype = _error_code

658

659

init = _library.gnutls_init

660

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

661

init.restype = _error_code

662

663

set_default_priority = _library.gnutls_set_default_priority

664

set_default_priority.argtypes = [session_t]

665

set_default_priority.restype = _error_code

666

667

record_send = _library.gnutls_record_send

668

record_send.argtypes = [session_t, ctypes.c_void_p,

669

ctypes.c_size_t]

670

record_send.restype = ctypes.c_ssize_t

671

record_send.errcheck = _retry_on_error

672

673

certificate_allocate_credentials = (

674

_library.gnutls_certificate_allocate_credentials)

675

certificate_allocate_credentials.argtypes = [

676

ctypes.POINTER(certificate_credentials_t)]

677

certificate_allocate_credentials.restype = _error_code

678

679

certificate_free_credentials = (

680

_library.gnutls_certificate_free_credentials)

681

certificate_free_credentials.argtypes = [

682

certificate_credentials_t]

683

certificate_free_credentials.restype = None

684

685

handshake_set_private_extensions = (

686

_library.gnutls_handshake_set_private_extensions)

687

handshake_set_private_extensions.argtypes = [session_t,

688

ctypes.c_int]

689

handshake_set_private_extensions.restype = None

690

691

credentials_set = _library.gnutls_credentials_set

692

credentials_set.argtypes = [session_t, credentials_type_t,

693

ctypes.c_void_p]

694

credentials_set.restype = _error_code

695

696

strerror = _library.gnutls_strerror

697

strerror.argtypes = [ctypes.c_int]

698

strerror.restype = ctypes.c_char_p

699

700

certificate_type_get = _library.gnutls_certificate_type_get

701

certificate_type_get.argtypes = [session_t]

702

certificate_type_get.restype = _error_code

703

704

certificate_get_peers = _library.gnutls_certificate_get_peers

705

certificate_get_peers.argtypes = [session_t,

706

ctypes.POINTER(ctypes.c_uint)]

707

certificate_get_peers.restype = ctypes.POINTER(datum_t)

708

709

global_set_log_level = _library.gnutls_global_set_log_level

710

global_set_log_level.argtypes = [ctypes.c_int]

711

global_set_log_level.restype = None

712

713

global_set_log_function = _library.gnutls_global_set_log_function

714

global_set_log_function.argtypes = [log_func]

715

global_set_log_function.restype = None

716

717

deinit = _library.gnutls_deinit

718

deinit.argtypes = [session_t]

719

deinit.restype = None

720

721

handshake = _library.gnutls_handshake

722

handshake.argtypes = [session_t]

723

handshake.restype = _error_code

724

handshake.errcheck = _retry_on_error

725

726

transport_set_ptr = _library.gnutls_transport_set_ptr

727

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

728

transport_set_ptr.restype = None

729

730

bye = _library.gnutls_bye

731

bye.argtypes = [session_t, close_request_t]

732

bye.restype = _error_code

733

bye.errcheck = _retry_on_error

734

735

check_version = _library.gnutls_check_version

736

check_version.argtypes = [ctypes.c_char_p]

737

check_version.restype = ctypes.c_char_p

738

739

_need_version = b"3.3.0"

740

if check_version(_need_version) is None:

741

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

742

.format(_need_version))

743

744

_tls_rawpk_version = b"3.6.6"

745

has_rawpk = bool(check_version(_tls_rawpk_version))

746

747

if has_rawpk:

748

# Types

749

class pubkey_st(ctypes.Structure):

750

_fields = []

751

pubkey_t = ctypes.POINTER(pubkey_st)

752

753

x509_crt_fmt_t = ctypes.c_int

754

755

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

756

pubkey_init = _library.gnutls_pubkey_init

757

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

758

pubkey_init.restype = _error_code

759

760

pubkey_import = _library.gnutls_pubkey_import

761

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

762

x509_crt_fmt_t]

763

pubkey_import.restype = _error_code

764

765

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

766

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

767

ctypes.POINTER(ctypes.c_ubyte),

768

ctypes.POINTER(ctypes.c_size_t)]

769

pubkey_get_key_id.restype = _error_code

770

771

pubkey_deinit = _library.gnutls_pubkey_deinit

772

pubkey_deinit.argtypes = [pubkey_t]

773

pubkey_deinit.restype = None

774

else:

775

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

776

777

openpgp_crt_init = _library.gnutls_openpgp_crt_init

778

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

779

openpgp_crt_init.restype = _error_code

780

781

openpgp_crt_import = _library.gnutls_openpgp_crt_import

782

openpgp_crt_import.argtypes = [openpgp_crt_t,

783

ctypes.POINTER(datum_t),

784

openpgp_crt_fmt_t]

785

openpgp_crt_import.restype = _error_code

786

787

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

788

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

789

ctypes.POINTER(ctypes.c_uint)]

790

openpgp_crt_verify_self.restype = _error_code

791

792

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

793

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

794

openpgp_crt_deinit.restype = None

795

796

openpgp_crt_get_fingerprint = (

797

_library.gnutls_openpgp_crt_get_fingerprint)

798

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

799

ctypes.c_void_p,

800

ctypes.POINTER(

801

ctypes.c_size_t)]

802

openpgp_crt_get_fingerprint.restype = _error_code

803

804

if check_version(b"3.6.4"):

805

certificate_type_get2 = _library.gnutls_certificate_type_get2

806

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

807

certificate_type_get2.restype = _error_code

808

809

# Remove non-public functions

810

del _error_code, _retry_on_error

811

812

813

def call_pipe(connection, # : multiprocessing.Connection

814

func, *args, **kwargs):

815

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

816

817

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

818

return value on the provided multiprocessing.Connection.

819

"""

820

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

821

connection.close()

822

823

824

class Client:

403

825

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

404

826

405

827

Attributes:

406

828

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

407

829

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

408

830

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

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

831

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

832

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

833

running.

834

checker_callback_tag: a GLib event source tag, or None

413

835

checker_command: string; External command which is run to check

414

836

if client lives. %() expansions are done at

415

837

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

416

838

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

417

checker_initiator_tag: a gobject event source tag, or None

839

checker_initiator_tag: a GLib event source tag, or None

418

840

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

419

841

client_structure: Object describing what attributes a client has

420

842

and is used for storing the client at exit

421

843

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

844

disable_initiator_tag: a GLib event source tag, or None

423

845

enabled: bool()

424

846

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

425

uniquely identify the client

847

uniquely identify an OpenPGP client

848

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

849

a client using raw public keys

426

850

host: string; available for use by the checker command

427

851

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

428

852

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

430

854

last_checker_status: integer between 0 and 255 reflecting exit

431

855

status of last checker. -1 reflects crashed

432

856

checker, -2 means no checker completed yet.

857

last_checker_signal: The signal which killed the last checker, if

858

last_checker_status is -1

433

859

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

434

860

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

435

861

D-Bus identifiers

440

866

runtime_expansions: Allowed attributes for runtime expansion.

441

867

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

442

868

disabled, or None

869

server_settings: The server_settings dict from main()

443

870

"""

444

871

445

872

runtime_expansions = ("approval_delay", "approval_duration",

446

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

873

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

447

874

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

448

875

"last_approval_request", "last_checked_ok",

449

876

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

450

client_defaults = { "timeout": "PT5M",

451

"extended_timeout": "PT15M",

452

"interval": "PT2M",

453

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

454

"host": "",

455

"approval_delay": "PT0S",

456

"approval_duration": "PT1S",

457

"approved_by_default": "True",

458

"enabled": "True",

459

}

460

461

def timeout_milliseconds(self):

462

"Return the 'timeout' attribute in milliseconds"

463

return timedelta_to_milliseconds(self.timeout)

464

465

def extended_timeout_milliseconds(self):

466

"Return the 'extended_timeout' attribute in milliseconds"

467

return timedelta_to_milliseconds(self.extended_timeout)

468

469

def interval_milliseconds(self):

470

"Return the 'interval' attribute in milliseconds"

471

return timedelta_to_milliseconds(self.interval)

472

473

def approval_delay_milliseconds(self):

474

return timedelta_to_milliseconds(self.approval_delay)

475

877

client_defaults = {

878

"timeout": "PT5M",

879

"extended_timeout": "PT15M",

880

"interval": "PT2M",

881

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

882

"host": "",

883

"approval_delay": "PT0S",

884

"approval_duration": "PT1S",

885

"approved_by_default": "True",

886

"enabled": "True",

887

}

888

476

889

@staticmethod

477

890

def config_parser(config):

478

891

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

485

898

for client_name in config.sections():

486

899

section = dict(config.items(client_name))

487

900

client = settings[client_name] = {}

488

901

489

902

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

490

903

# Reformat values from string types to Python types

491

904

client["approved_by_default"] = config.getboolean(

492

905

client_name, "approved_by_default")

493

906

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

494

907

"enabled")

495

908

909

# Uppercase and remove spaces from key_id and fingerprint

910

# for later comparison purposes with return value from the

911

# key_id() and fingerprint() functions

912

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

913

.replace(" ", ""))

496

914

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

497

915

.replace(" ", ""))

498

916

if "secret" in section:

499

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

917

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

918

.encode("utf-8"),

919

"base64")

500

920

elif "secfile" in section:

501

921

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

502

922

(section["secfile"])),

503

923

"rb") as secfile:

504

924

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

505

925

else:

506

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

926

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

507

927

.format(section))

508

928

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

509

929

client["extended_timeout"] = string_to_delta(

517

937

client["last_approval_request"] = None

518

938

client["last_checked_ok"] = None

519

939

client["last_checker_status"] = -2

520

940

521

941

return settings

522

523

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

942

943

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

524

944

self.name = name

945

if server_settings is None:

946

server_settings = {}

947

self.server_settings = server_settings

525

948

# adding all client settings

526

for setting, value in settings.iteritems():

949

for setting, value in settings.items():

527

950

setattr(self, setting, value)

528

951

529

952

if self.enabled:

530

953

if not hasattr(self, "last_enabled"):

531

954

self.last_enabled = datetime.datetime.utcnow()

535

958

else:

536

959

self.last_enabled = None

537

960

self.expires = None

538

961

539

962

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

540

# Uppercase and remove spaces from fingerprint for later

541

# comparison purposes with return value from the fingerprint()

542

# function

963

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

543

964

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

544

965

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

545

966

datetime.datetime.utcnow())

546

967

547

968

# attributes specific for this server instance

548

969

self.checker = None

549

970

self.checker_initiator_tag = None

552

973

self.current_checker_command = None

553

974

self.approved = None

554

975

self.approvals_pending = 0

555

self.changedstate = (multiprocessing_manager

556

.Condition(multiprocessing_manager

557

.Lock()))

558

self.client_structure = [attr for attr in

559

self.__dict__.iterkeys()

976

self.changedstate = multiprocessing_manager.Condition(

977

multiprocessing_manager.Lock())

978

self.client_structure = [attr

979

for attr in self.__dict__.keys()

560

980

if not attr.startswith("_")]

561

981

self.client_structure.append("client_structure")

562

563

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

564

lambda obj:

565

isinstance(obj,

566

property)):

982

983

for name, t in inspect.getmembers(

984

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

567

985

if not name.startswith("_"):

568

986

self.client_structure.append(name)

569

987

570

988

# Send notice to process children that client state has changed

571

989

def send_changedstate(self):

572

990

with self.changedstate:

573

991

self.changedstate.notify_all()

574

992

575

993

def enable(self):

576

994

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

577

995

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

582

1000

self.last_enabled = datetime.datetime.utcnow()

583

1001

self.init_checker()

584

1002

self.send_changedstate()

585

1003

586

1004

def disable(self, quiet=True):

587

1005

"""Disable this client."""

588

1006

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

590

1008

if not quiet:

591

1009

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

592

1010

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

593

gobject.source_remove(self.disable_initiator_tag)

1011

GLib.source_remove(self.disable_initiator_tag)

594

1012

self.disable_initiator_tag = None

595

1013

self.expires = None

596

1014

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

597

gobject.source_remove(self.checker_initiator_tag)

1015

GLib.source_remove(self.checker_initiator_tag)

598

1016

self.checker_initiator_tag = None

599

1017

self.stop_checker()

600

1018

self.enabled = False

601

1019

if not quiet:

602

1020

self.send_changedstate()

603

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

1021

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

604

1022

return False

605

1023

606

1024

def __del__(self):

607

1025

self.disable()

608

1026

609

1027

def init_checker(self):

610

1028

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

611

1029

# and every interval from then on.

612

1030

if self.checker_initiator_tag is not None:

613

gobject.source_remove(self.checker_initiator_tag)

614

self.checker_initiator_tag = (gobject.timeout_add

615

(self.interval_milliseconds(),

616

self.start_checker))

1031

GLib.source_remove(self.checker_initiator_tag)

1032

self.checker_initiator_tag = GLib.timeout_add(

1033

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

1034

self.start_checker)

617

1035

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

618

1036

if self.disable_initiator_tag is not None:

619

gobject.source_remove(self.disable_initiator_tag)

620

self.disable_initiator_tag = (gobject.timeout_add

621

(self.timeout_milliseconds(),

622

self.disable))

1037

GLib.source_remove(self.disable_initiator_tag)

1038

self.disable_initiator_tag = GLib.timeout_add(

1039

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

623

1040

# Also start a new checker *right now*.

624

1041

self.start_checker()

625

626

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

1042

1043

def checker_callback(self, source, condition, connection,

1044

command):

627

1045

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

1046

# Read return code from connection (see call_pipe)

1047

returncode = connection.recv()

1048

connection.close()

1049

self.checker.join()

628

1050

self.checker_callback_tag = None

629

1051

self.checker = None

630

if os.WIFEXITED(condition):

631

self.last_checker_status = os.WEXITSTATUS(condition)

1052

1053

if returncode >= 0:

1054

self.last_checker_status = returncode

1055

self.last_checker_signal = None

632

1056

if self.last_checker_status == 0:

633

1057

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

634

1058

vars(self))

635

1059

self.checked_ok()

636

1060

else:

637

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

638

vars(self))

1061

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

639

1062

else:

640

1063

self.last_checker_status = -1

1064

self.last_checker_signal = -returncode

641

1065

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

642

1066

vars(self))

643

1067

return False

1068

644

1069

def checked_ok(self):

645

1070

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

646

1071

self.last_checked_ok = datetime.datetime.utcnow()

647

1072

self.last_checker_status = 0

1073

self.last_checker_signal = None

648

1074

self.bump_timeout()

649

1075

650

1076

def bump_timeout(self, timeout=None):

651

1077

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

652

1078

if timeout is None:

653

1079

timeout = self.timeout

654

1080

if self.disable_initiator_tag is not None:

655

gobject.source_remove(self.disable_initiator_tag)

1081

GLib.source_remove(self.disable_initiator_tag)

656

1082

self.disable_initiator_tag = None

657

1083

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

658

self.disable_initiator_tag = (gobject.timeout_add

659

(timedelta_to_milliseconds

660

(timeout), self.disable))

1084

self.disable_initiator_tag = GLib.timeout_add(

1085

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

661

1086

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

662

1087

663

1088

def need_approval(self):

664

1089

self.last_approval_request = datetime.datetime.utcnow()

665

1090

666

1091

def start_checker(self):

667

1092

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

668

1093

669

1094

If a checker already exists, leave it running and do

670

1095

nothing."""

671

1096

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

676

1101

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

677

1102

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

678

1103

# should be.

679

680

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

681

try:

682

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

683

except (AttributeError, OSError) as error:

684

if (isinstance(error, OSError)

685

and error.errno != errno.ECHILD):

686

raise error

687

else:

688

if pid:

689

logger.warning("Checker was a zombie")

690

gobject.source_remove(self.checker_callback_tag)

691

self.checker_callback(pid, status,

692

self.current_checker_command)

1104

1105

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

1106

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

1107

self.checker.join()

1108

self.checker = None

693

1109

# Start a new checker if needed

694

1110

if self.checker is None:

695

1111

# Escape attributes for the shell

696

escaped_attrs = dict(

697

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

698

for attr in

699

self.runtime_expansions)

1112

escaped_attrs = {

1113

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

1114

for attr in self.runtime_expansions}

700

1115

try:

701

1116

command = self.checker_command % escaped_attrs

702

1117

except TypeError as error:

703

1118

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

704

self.checker_command, exc_info=error)

705

return True # Try again later

1119

self.checker_command,

1120

exc_info=error)

1121

return True # Try again later

706

1122

self.current_checker_command = command

707

try:

708

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

709

command, self.name)

710

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

711

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

712

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

713

# always replaced by /dev/null.)

714

self.checker = subprocess.Popen(command,

715

close_fds=True,

716

shell=True, cwd="/")

717

except OSError as error:

718

logger.error("Failed to start subprocess",

719

exc_info=error)

720

return True

721

self.checker_callback_tag = (gobject.child_watch_add

722

(self.checker.pid,

723

self.checker_callback,

724

data=command))

725

# The checker may have completed before the gobject

726

# watch was added. Check for this.

727

try:

728

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

729

except OSError as error:

730

if error.errno == errno.ECHILD:

731

logger.error("Child process vanished", exc_info=error)

732

return True

733

raise

734

if pid:

735

gobject.source_remove(self.checker_callback_tag)

736

self.checker_callback(pid, status, command)

737

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

1123

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

1124

self.name)

1125

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

1126

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

1127

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

1128

# always replaced by /dev/null.)

1129

# The exception is when not debugging but nevertheless

1130

# running in the foreground; use the previously

1131

# created wnull.

1132

popen_args = {"close_fds": True,

1133

"shell": True,

1134

"cwd": "/"}

1135

if (not self.server_settings["debug"]

1136

and self.server_settings["foreground"]):

1137

popen_args.update({"stdout": wnull,

1138

"stderr": wnull})

1139

pipe = multiprocessing.Pipe(duplex=False)

1140

self.checker = multiprocessing.Process(

1141

target=call_pipe,

1142

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

1143

kwargs=popen_args)

1144

self.checker.start()

1145

self.checker_callback_tag = GLib.io_add_watch(

1146

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

1147

self.checker_callback, pipe[0], command)

1148

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

738

1149

return True

739

1150

740

1151

def stop_checker(self):

741

1152

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

742

1153

if self.checker_callback_tag:

743

gobject.source_remove(self.checker_callback_tag)

1154

GLib.source_remove(self.checker_callback_tag)

744

1155

self.checker_callback_tag = None

745

1156

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

746

1157

return

747

1158

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

748

try:

749

self.checker.terminate()

750

#time.sleep(0.5)

751

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

752

# self.checker.kill()

753

except OSError as error:

754

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

755

raise

1159

self.checker.terminate()

756

1160

self.checker = None

757

1161

758

1162

759

def dbus_service_property(dbus_interface, signature="v",

760

access="readwrite", byte_arrays=False):

1163

def dbus_service_property(dbus_interface,

1164

signature="v",

1165

access="readwrite",

1166

byte_arrays=False):

761

1167

"""Decorators for marking methods of a DBusObjectWithProperties to

762

1168

become properties on the D-Bus.

763

1169

764

1170

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

765

1171

and with one argument by "Set".

766

1172

767

1173

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

768

1174

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

769

1175

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

772

1178

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

773

1179

if byte_arrays and signature != "ay":

774

1180

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

775

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

1181

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

1182

776

1183

def decorator(func):

777

1184

func._dbus_is_property = True

778

1185

func._dbus_interface = dbus_interface

781

1188

func._dbus_name = func.__name__

782

1189

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

783

1190

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

784

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1191

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

785

1192

return func

1193

786

1194

return decorator

787

1195

788

1196

789

1197

def dbus_interface_annotations(dbus_interface):

790

1198

"""Decorator for marking functions returning interface annotations

791

1199

792

1200

Usage:

793

1201

794

1202

@dbus_interface_annotations("org.example.Interface")

795

1203

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

796

1204

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

797

1205

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

798

1206

"false"}

799

1207

"""

1208

800

1209

def decorator(func):

801

1210

func._dbus_is_interface = True

802

1211

func._dbus_interface = dbus_interface

803

1212

func._dbus_name = dbus_interface

804

1213

return func

1214

805

1215

return decorator

806

1216

807

1217

808

1218

def dbus_annotations(annotations):

809

1219

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

810

1220

Usage:

811

1221

1222

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

1223

"org.freedesktop.DBus.Property."

1224

"EmitsChangedSignal": "false"})

812

1225

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

813

1226

access="r")

814

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

815

"org.freedesktop.DBus.Property."

816

"EmitsChangedSignal": "false"})

817

1227

def Property_dbus_property(self):

818

1228

return dbus.Boolean(False)

1229

1230

See also the DBusObjectWithAnnotations class.

819

1231

"""

1232

820

1233

def decorator(func):

821

1234

func._dbus_annotations = annotations

822

1235

return func

1236

823

1237

return decorator

824

1238

825

1239

826

1240

class DBusPropertyException(dbus.exceptions.DBusException):

827

1241

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

828

1242

"""

829

def __unicode__(self):

830

return unicode(str(self))

1243

pass

831

1244

832

1245

833

1246

class DBusPropertyAccessException(DBusPropertyException):

842

1255

pass

843

1256

844

1257

845

class DBusObjectWithProperties(dbus.service.Object):

846

"""A D-Bus object with properties.

847

848

Classes inheriting from this can use the dbus_service_property

849

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

850

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

1258

class DBusObjectWithAnnotations(dbus.service.Object):

1259

"""A D-Bus object with annotations.

1260

1261

Classes inheriting from this can use the dbus_annotations

1262

decorator to add annotations to methods or signals.

851

1263

"""

852

1264

853

1265

@staticmethod

854

1266

def _is_dbus_thing(thing):

855

1267

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

856

1268

857

1269

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

858

1270

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

859

1271

"""

860

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

1272

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

861

1273

False)

862

1274

863

1275

def _get_all_dbus_things(self, thing):

864

1276

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

865

1277

"""

866

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

867

name),

1278

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

868

1279

athing.__get__(self))

869

1280

for cls in self.__class__.__mro__

870

1281

for name, athing in

871

inspect.getmembers(cls,

872

self._is_dbus_thing(thing)))

873

1282

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

1283

1284

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1285

out_signature="s",

1286

path_keyword='object_path',

1287

connection_keyword='connection')

1288

def Introspect(self, object_path, connection):

1289

"""Overloading of standard D-Bus method.

1290

1291

Inserts annotation tags on methods and signals.

1292

"""

1293

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

1294

connection)

1295

try:

1296

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

1297

1298

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

1299

# Add annotation tags

1300

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

1301

for tag in if_tag.getElementsByTagName(typ):

1302

annots = dict()

1303

for name, prop in (self.

1304

_get_all_dbus_things(typ)):

1305

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

1306

and prop._dbus_interface

1307

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

1308

annots.update(getattr(

1309

prop, "_dbus_annotations", {}))

1310

for name, value in annots.items():

1311

ann_tag = document.createElement(

1312

"annotation")

1313

ann_tag.setAttribute("name", name)

1314

ann_tag.setAttribute("value", value)

1315

tag.appendChild(ann_tag)

1316

# Add interface annotation tags

1317

for annotation, value in dict(

1318

itertools.chain.from_iterable(

1319

annotations().items()

1320

for name, annotations

1321

in self._get_all_dbus_things("interface")

1322

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

1323

)).items():

1324

ann_tag = document.createElement("annotation")

1325

ann_tag.setAttribute("name", annotation)

1326

ann_tag.setAttribute("value", value)

1327

if_tag.appendChild(ann_tag)

1328

# Fix argument name for the Introspect method itself

1329

if (if_tag.getAttribute("name")

1330

== dbus.INTROSPECTABLE_IFACE):

1331

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

1332

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

1333

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

1334

if (arg.getAttribute("direction")

1335

== "out"):

1336

arg.setAttribute("name",

1337

"xml_data")

1338

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

1339

document.unlink()

1340

except (AttributeError, xml.dom.DOMException,

1341

xml.parsers.expat.ExpatError) as error:

1342

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

1343

exc_info=error)

1344

return xmlstring

1345

1346

1347

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1348

"""A D-Bus object with properties.

1349

1350

Classes inheriting from this can use the dbus_service_property

1351

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

1352

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

1353

"""

1354

874

1355

def _get_dbus_property(self, interface_name, property_name):

875

1356

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

876

1357

property with the specified name and interface.

877

1358

"""

878

for cls in self.__class__.__mro__:

879

for name, value in (inspect.getmembers

880

(cls,

881

self._is_dbus_thing("property"))):

1359

for cls in self.__class__.__mro__:

1360

for name, value in inspect.getmembers(

1361

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

882

1362

if (value._dbus_name == property_name

883

1363

and value._dbus_interface == interface_name):

884

1364

return value.__get__(self)

885

1365

886

1366

# No such property

887

raise DBusPropertyNotFound(self.dbus_object_path + ":"

888

+ interface_name + "."

889

+ property_name)

890

891

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

1367

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

1368

self.dbus_object_path, interface_name, property_name))

1369

1370

@classmethod

1371

def _get_all_interface_names(cls):

1372

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

1373

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

1374

"_dbus_interface", None)

1375

for x in (inspect.getmro(cls))

1376

for attr in dir(x))

1377

if name is not None)

1378

1379

@dbus.service.method(dbus.PROPERTIES_IFACE,

1380

in_signature="ss",

892

1381

out_signature="v")

893

1382

def Get(self, interface_name, property_name):

894

1383

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

900

1389

if not hasattr(value, "variant_level"):

901

1390

return value

902

1391

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

903

1392

904

1393

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

905

1394

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

906

1395

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

912

1401

# The byte_arrays option is not supported yet on

913

1402

# signatures other than "ay".

914

1403

if prop._dbus_signature != "ay":

915

raise ValueError

1404

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

1405

"'ay' signature {!r}"

1406

.format(prop._dbus_signature))

916

1407

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

917

1408

for byte in value))

918

1409

prop(value)

919

920

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

1410

1411

@dbus.service.method(dbus.PROPERTIES_IFACE,

1412

in_signature="s",

921

1413

out_signature="a{sv}")

922

1414

def GetAll(self, interface_name):

923

1415

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

924

1416

standard.

925

1417

926

1418

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

927

1419

"""

928

1420

properties = {}

938

1430

if not hasattr(value, "variant_level"):

939

1431

properties[name] = value

940

1432

continue

941

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

942

value.variant_level+1)

1433

properties[name] = type(value)(

1434

value, variant_level=value.variant_level + 1)

943

1435

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

944

1436

1437

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

1438

def PropertiesChanged(self, interface_name, changed_properties,

1439

invalidated_properties):

1440

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

1441

standard.

1442

"""

1443

pass

1444

945

1445

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

946

1446

out_signature="s",

947

1447

path_keyword='object_path',

948

1448

connection_keyword='connection')

949

1449

def Introspect(self, object_path, connection):

950

1450

"""Overloading of standard D-Bus method.

951

1451

952

1452

Inserts property tags and interface annotation tags.

953

1453

"""

954

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

955

connection)

1454

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1455

object_path,

1456

connection)

956

1457

try:

957

1458

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

1459

958

1460

def make_tag(document, name, prop):

959

1461

e = document.createElement("property")

960

1462

e.setAttribute("name", name)

961

1463

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

962

1464

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

963

1465

return e

1466

964

1467

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

965

1468

# Add property tags

966

1469

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

969

1472

if prop._dbus_interface

970

1473

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

971

1474

if_tag.appendChild(tag)

972

# Add annotation tags

973

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

974

for tag in if_tag.getElementsByTagName(typ):

975

annots = dict()

976

for name, prop in (self.

977

_get_all_dbus_things(typ)):

978

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

979

and prop._dbus_interface

980

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

981

annots.update(getattr

982

(prop,

983

"_dbus_annotations",

984

{}))

985

for name, value in annots.iteritems():

986

ann_tag = document.createElement(

987

"annotation")

988

ann_tag.setAttribute("name", name)

989

ann_tag.setAttribute("value", value)

990

tag.appendChild(ann_tag)

991

# Add interface annotation tags

992

for annotation, value in dict(

993

itertools.chain.from_iterable(

994

annotations().iteritems()

995

for name, annotations in

996

self._get_all_dbus_things("interface")

997

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

998

)).iteritems():

999

ann_tag = document.createElement("annotation")

1000

ann_tag.setAttribute("name", annotation)

1001

ann_tag.setAttribute("value", value)

1002

if_tag.appendChild(ann_tag)

1475

# Add annotation tags for properties

1476

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

1477

annots = dict()

1478

for name, prop in self._get_all_dbus_things(

1479

"property"):

1480

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

1481

and prop._dbus_interface

1482

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

1483

annots.update(getattr(

1484

prop, "_dbus_annotations", {}))

1485

for name, value in annots.items():

1486

ann_tag = document.createElement(

1487

"annotation")

1488

ann_tag.setAttribute("name", name)

1489

ann_tag.setAttribute("value", value)

1490

tag.appendChild(ann_tag)

1003

1491

# Add the names to the return values for the

1004

1492

# "org.freedesktop.DBus.Properties" methods

1005

1493

if (if_tag.getAttribute("name")

1024

1512

return xmlstring

1025

1513

1026

1514

1515

try:

1516

dbus.OBJECT_MANAGER_IFACE

1517

except AttributeError:

1518

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

1519

1520

1521

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1522

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

1523

1524

Classes inheriting from this exposes the standard

1525

GetManagedObjects call and the InterfacesAdded and

1526

InterfacesRemoved signals on the standard

1527

"org.freedesktop.DBus.ObjectManager" interface.

1528

1529

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

1530

manually.

1531

"""

1532

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1533

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

1534

def GetManagedObjects(self):

1535

"""This function must be overridden"""

1536

raise NotImplementedError()

1537

1538

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1539

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

1540

def InterfacesAdded(self, object_path, interfaces_and_properties):

1541

pass

1542

1543

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

1544

def InterfacesRemoved(self, object_path, interfaces):

1545

pass

1546

1547

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1548

out_signature="s",

1549

path_keyword='object_path',

1550

connection_keyword='connection')

1551

def Introspect(self, object_path, connection):

1552

"""Overloading of standard D-Bus method.

1553

1554

Override return argument name of GetManagedObjects to be

1555

"objpath_interfaces_and_properties"

1556

"""

1557

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1558

object_path,

1559

connection)

1560

try:

1561

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

1562

1563

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

1564

# Fix argument name for the GetManagedObjects method

1565

if (if_tag.getAttribute("name")

1566

== dbus.OBJECT_MANAGER_IFACE):

1567

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

1568

if (cn.getAttribute("name")

1569

== "GetManagedObjects"):

1570

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

1571

if (arg.getAttribute("direction")

1572

== "out"):

1573

arg.setAttribute(

1574

"name",

1575

"objpath_interfaces"

1576

"_and_properties")

1577

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

1578

document.unlink()

1579

except (AttributeError, xml.dom.DOMException,

1580

xml.parsers.expat.ExpatError) as error:

1581

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

1582

exc_info=error)

1583

return xmlstring

1584

1585

1027

1586

def datetime_to_dbus(dt, variant_level=0):

1028

1587

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

1029

1588

if dt is None:

1030

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

1031

return dbus.String(dt.isoformat(),

1032

variant_level=variant_level)

1589

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

1590

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

1033

1591

1034

1592

1035

1593

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1037

1595

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

1038

1596

interface names according to the "alt_interface_names" mapping.

1039

1597

Usage:

1040

1598

1041

1599

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

1042

1600

"net.example.AlternateInterface"})

1043

1601

class SampleDBusObject(dbus.service.Object):

1044

1602

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

1045

1603

def SampleDBusMethod():

1046

1604

pass

1047

1605

1048

1606

The above "SampleDBusMethod" on "SampleDBusObject" will be

1049

1607

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

1050

1608

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

1051

1609

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

1052

1610

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

1053

1611

1054

1612

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

1055

1613

(from DBusObjectWithProperties) and interfaces (from the

1056

1614

dbus_interface_annotations decorator).

1057

1615

"""

1616

1058

1617

def wrapper(cls):

1059

1618

for orig_interface_name, alt_interface_name in (

1060

alt_interface_names.iteritems()):

1619

alt_interface_names.items()):

1061

1620

attr = {}

1062

1621

interface_names = set()

1063

1622

# Go though all attributes of the class

1065

1624

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

1066

1625

# with the wrong interface name

1067

1626

if (not hasattr(attribute, "_dbus_interface")

1068

or not attribute._dbus_interface

1069

.startswith(orig_interface_name)):

1627

or not attribute._dbus_interface.startswith(

1628

orig_interface_name)):

1070

1629

continue

1071

1630

# Create an alternate D-Bus interface name based on

1072

1631

# the current name

1073

alt_interface = (attribute._dbus_interface

1074

.replace(orig_interface_name,

1075

alt_interface_name))

1632

alt_interface = attribute._dbus_interface.replace(

1633

orig_interface_name, alt_interface_name)

1076

1634

interface_names.add(alt_interface)

1077

1635

# Is this a D-Bus signal?

1078

1636

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

1079

# Extract the original non-method function by

1080

# black magic

1081

nonmethod_func = (dict(

1637

# Extract the original non-method undecorated

1638

# function by black magic

1639

if sys.version_info.major == 2:

1640

nonmethod_func = (dict(

1082

1641

zip(attribute.func_code.co_freevars,

1083

attribute.__closure__))["func"]

1084

.cell_contents)

1642

attribute.__closure__))

1643

["func"].cell_contents)

1644

else:

1645

nonmethod_func = (dict(

1646

zip(attribute.__code__.co_freevars,

1647

attribute.__closure__))

1648

["func"].cell_contents)

1085

1649

# Create a new, but exactly alike, function

1086

1650

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

1087

1651

# with the alternate D-Bus interface name

1088

new_function = (dbus.service.signal

1089

(alt_interface,

1090

attribute._dbus_signature)

1091

(types.FunctionType(

1092

nonmethod_func.func_code,

1093

nonmethod_func.func_globals,

1094

nonmethod_func.func_name,

1095

nonmethod_func.func_defaults,

1096

nonmethod_func.func_closure)))

1652

new_function = copy_function(nonmethod_func)

1653

new_function = (dbus.service.signal(

1654

alt_interface,

1655

attribute._dbus_signature)(new_function))

1097

1656

# Copy annotations, if any

1098

1657

try:

1099

new_function._dbus_annotations = (

1100

dict(attribute._dbus_annotations))

1658

new_function._dbus_annotations = dict(

1659

attribute._dbus_annotations)

1101

1660

except AttributeError:

1102

1661

pass

1662

1103

1663

# Define a creator of a function to call both the

1104

1664

# original and alternate functions, so both the

1105

1665

# original and alternate signals gets sent when

1108

1668

"""This function is a scope container to pass

1109

1669

func1 and func2 to the "call_both" function

1110

1670

outside of its arguments"""

1671

1672

@functools.wraps(func2)

1111

1673

def call_both(*args, **kwargs):

1112

1674

"""This function will emit two D-Bus

1113

1675

signals by calling func1 and func2"""

1114

1676

func1(*args, **kwargs)

1115

1677

func2(*args, **kwargs)

1678

# Make wrapper function look like a D-Bus

1679

# signal

1680

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

1681

if name.startswith("_dbus_"):

1682

setattr(call_both, name, attr)

1683

1116

1684

return call_both

1117

1685

# Create the "call_both" function and add it to

1118

1686

# the class

1123

1691

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

1124

1692

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

1125

1693

# to the class.

1126

attr[attrname] = (dbus.service.method

1127

(alt_interface,

1128

attribute._dbus_in_signature,

1129

attribute._dbus_out_signature)

1130

(types.FunctionType

1131

(attribute.func_code,

1132

attribute.func_globals,

1133

attribute.func_name,

1134

attribute.func_defaults,

1135

attribute.func_closure)))

1694

attr[attrname] = (

1695

dbus.service.method(

1696

alt_interface,

1697

attribute._dbus_in_signature,

1698

attribute._dbus_out_signature)

1699

(copy_function(attribute)))

1136

1700

# Copy annotations, if any

1137

1701

try:

1138

attr[attrname]._dbus_annotations = (

1139

dict(attribute._dbus_annotations))

1702

attr[attrname]._dbus_annotations = dict(

1703

attribute._dbus_annotations)

1140

1704

except AttributeError:

1141

1705

pass

1142

1706

# Is this a D-Bus property?

1145

1709

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

1146

1710

# property with the alternate D-Bus interface

1147

1711

# name. Add it to the class.

1148

attr[attrname] = (dbus_service_property

1149

(alt_interface,

1150

attribute._dbus_signature,

1151

attribute._dbus_access,

1152

attribute

1153

._dbus_get_args_options

1154

["byte_arrays"])

1155

(types.FunctionType

1156

(attribute.func_code,

1157

attribute.func_globals,

1158

attribute.func_name,

1159

attribute.func_defaults,

1160

attribute.func_closure)))

1712

attr[attrname] = (dbus_service_property(

1713

alt_interface, attribute._dbus_signature,

1714

attribute._dbus_access,

1715

attribute._dbus_get_args_options

1716

["byte_arrays"])

1717

(copy_function(attribute)))

1161

1718

# Copy annotations, if any

1162

1719

try:

1163

attr[attrname]._dbus_annotations = (

1164

dict(attribute._dbus_annotations))

1720

attr[attrname]._dbus_annotations = dict(

1721

attribute._dbus_annotations)

1165

1722

except AttributeError:

1166

1723

pass

1167

1724

# Is this a D-Bus interface?

1170

1727

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

1171

1728

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

1172

1729

# to the class.

1173

attr[attrname] = (dbus_interface_annotations

1174

(alt_interface)

1175

(types.FunctionType

1176

(attribute.func_code,

1177

attribute.func_globals,

1178

attribute.func_name,

1179

attribute.func_defaults,

1180

attribute.func_closure)))

1730

attr[attrname] = (

1731

dbus_interface_annotations(alt_interface)

1732

(copy_function(attribute)))

1181

1733

if deprecate:

1182

1734

# Deprecate all alternate interfaces

1183

iname="_AlternateDBusNames_interface_annotation{0}"

1735

iname = "_AlternateDBusNames_interface_annotation{}"

1184

1736

for interface_name in interface_names:

1737

1185

1738

@dbus_interface_annotations(interface_name)

1186

1739

def func(self):

1187

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

1188

"true" }

1740

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

1741

"true"}

1189

1742

# Find an unused name

1190

1743

for aname in (iname.format(i)

1191

1744

for i in itertools.count()):

1195

1748

if interface_names:

1196

1749

# Replace the class with a new subclass of it with

1197

1750

# methods, signals, etc. as created above.

1198

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

1199

(cls,), attr)

1751

if sys.version_info.major == 2:

1752

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

1753

(cls, ), attr)

1754

else:

1755

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

1756

(cls, ), attr)

1200

1757

return cls

1758

1201

1759

return wrapper

1202

1760

1203

1761

1204

1762

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

1205

"se.bsnet.fukt.Mandos"})

1763

"se.bsnet.fukt.Mandos"})

1206

1764

class ClientDBus(Client, DBusObjectWithProperties):

1207

1765

"""A Client class using D-Bus

1208

1766

1209

1767

Attributes:

1210

1768

dbus_object_path: dbus.ObjectPath

1211

1769

bus: dbus.SystemBus()

1212

1770

"""

1213

1771

1214

1772

runtime_expansions = (Client.runtime_expansions

1215

+ ("dbus_object_path",))

1216

1773

+ ("dbus_object_path", ))

1774

1775

_interface = "se.recompile.Mandos.Client"

1776

1217

1777

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

1218

1219

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

1778

1779

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

1220

1780

self.bus = bus

1221

1781

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

1222

1782

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

1223

1783

# the D-Bus

1224

client_object_name = unicode(self.name).translate(

1784

client_object_name = str(self.name).translate(

1225

1785

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

1226

1786

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

1227

self.dbus_object_path = (dbus.ObjectPath

1228

("/clients/" + client_object_name))

1787

self.dbus_object_path = dbus.ObjectPath(

1788

"/clients/" + client_object_name)

1229

1789

DBusObjectWithProperties.__init__(self, self.bus,

1230

1790

self.dbus_object_path)

1231

1232

def notifychangeproperty(transform_func,

1233

dbus_name, type_func=lambda x: x,

1234

variant_level=1):

1791

1792

def notifychangeproperty(transform_func, dbus_name,

1793

type_func=lambda x: x,

1794

variant_level=1,

1795

invalidate_only=False,

1796

_interface=_interface):

1235

1797

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

1236

1798

its changes to DBus.

1237

1799

1238

1800

transform_fun: Function that takes a value and a variant_level

1239

1801

and transforms it to a D-Bus type.

1240

1802

dbus_name: D-Bus name of the variable

1242

1804

to the D-Bus. Default: no transform

1243

1805

variant_level: D-Bus variant level. Default: 1

1244

1806

"""

1245

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

1807

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

1808

1246

1809

def setter(self, value):

1247

1810

if hasattr(self, "dbus_object_path"):

1248

1811

if (not hasattr(self, attrname) or

1249

1812

type_func(getattr(self, attrname, None))

1250

1813

!= type_func(value)):

1251

dbus_value = transform_func(type_func(value),

1252

variant_level

1253

=variant_level)

1254

self.PropertyChanged(dbus.String(dbus_name),

1255

dbus_value)

1814

if invalidate_only:

1815

self.PropertiesChanged(

1816

_interface, dbus.Dictionary(),

1817

dbus.Array((dbus_name, )))

1818

else:

1819

dbus_value = transform_func(

1820

type_func(value),

1821

variant_level=variant_level)

1822

self.PropertyChanged(dbus.String(dbus_name),

1823

dbus_value)

1824

self.PropertiesChanged(

1825

_interface,

1826

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

1827

dbus_value}),

1828

dbus.Array())

1256

1829

setattr(self, attrname, value)

1257

1830

1258

1831

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

1259

1832

1260

1833

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1261

1834

approvals_pending = notifychangeproperty(dbus.Boolean,

1262

1835

"ApprovalPending",

1263

type_func = bool)

1836

type_func=bool)

1264

1837

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

1265

1838

last_enabled = notifychangeproperty(datetime_to_dbus,

1266

1839

"LastEnabled")

1267

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

1268

type_func = lambda checker:

1269

checker is not None)

1840

checker = notifychangeproperty(

1841

dbus.Boolean, "CheckerRunning",

1842

type_func=lambda checker: checker is not None)

1270

1843

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1271

1844

"LastCheckedOK")

1272

1845

last_checker_status = notifychangeproperty(dbus.Int16,

1275

1848

datetime_to_dbus, "LastApprovalRequest")

1276

1849

approved_by_default = notifychangeproperty(dbus.Boolean,

1277

1850

"ApprovedByDefault")

1278

approval_delay = notifychangeproperty(dbus.UInt64,

1279

"ApprovalDelay",

1280

type_func =

1281

timedelta_to_milliseconds)

1851

approval_delay = notifychangeproperty(

1852

dbus.UInt64, "ApprovalDelay",

1853

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

1282

1854

approval_duration = notifychangeproperty(

1283

1855

dbus.UInt64, "ApprovalDuration",

1284

type_func = timedelta_to_milliseconds)

1856

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

1285

1857

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

1286

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

1287

type_func =

1288

timedelta_to_milliseconds)

1858

timeout = notifychangeproperty(

1859

dbus.UInt64, "Timeout",

1860

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

1289

1861

extended_timeout = notifychangeproperty(

1290

1862

dbus.UInt64, "ExtendedTimeout",

1291

type_func = timedelta_to_milliseconds)

1292

interval = notifychangeproperty(dbus.UInt64,

1293

"Interval",

1294

type_func =

1295

timedelta_to_milliseconds)

1863

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

1864

interval = notifychangeproperty(

1865

dbus.UInt64, "Interval",

1866

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

1296

1867

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

1297

1868

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

1869

invalidate_only=True)

1870

1298

1871

del notifychangeproperty

1299

1872

1300

1873

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

1301

1874

try:

1302

1875

self.remove_from_connection()

1305

1878

if hasattr(DBusObjectWithProperties, "__del__"):

1306

1879

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

1307

1880

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

1308

1309

def checker_callback(self, pid, condition, command,

1310

*args, **kwargs):

1311

self.checker_callback_tag = None

1312

self.checker = None

1313

if os.WIFEXITED(condition):

1314

exitstatus = os.WEXITSTATUS(condition)

1881

1882

def checker_callback(self, source, condition,

1883

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

1884

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

1885

connection, command, *args,

1886

**kwargs)

1887

exitstatus = self.last_checker_status

1888

if exitstatus >= 0:

1315

1889

# Emit D-Bus signal

1316

1890

self.CheckerCompleted(dbus.Int16(exitstatus),

1317

dbus.Int64(condition),

1891

# This is specific to GNU libC

1892

dbus.Int64(exitstatus << 8),

1318

1893

dbus.String(command))

1319

1894

else:

1320

1895

# Emit D-Bus signal

1321

1896

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

1322

dbus.Int64(condition),

1897

dbus.Int64(

1898

# This is specific to GNU libC

1899

(exitstatus << 8)

1900

| self.last_checker_signal),

1323

1901

dbus.String(command))

1324

1325

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

1326

*args, **kwargs)

1327

1902

return ret

1903

1328

1904

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

1329

old_checker = self.checker

1330

if self.checker is not None:

1331

old_checker_pid = self.checker.pid

1332

else:

1333

old_checker_pid = None

1905

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

1334

1906

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

1335

1907

# Only if new checker process was started

1336

1908

if (self.checker is not None

1338

1910

# Emit D-Bus signal

1339

1911

self.CheckerStarted(self.current_checker_command)

1340

1912

return r

1341

1913

1342

1914

def _reset_approved(self):

1343

1915

self.approved = None

1344

1916

return False

1345

1917

1346

1918

def approve(self, value=True):

1347

1919

self.approved = value

1348

gobject.timeout_add(timedelta_to_milliseconds

1349

(self.approval_duration),

1350

self._reset_approved)

1920

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

1921

* 1000), self._reset_approved)

1351

1922

self.send_changedstate()

1352

1353

## D-Bus methods, signals & properties

1354

_interface = "se.recompile.Mandos.Client"

1355

1356

## Interfaces

1357

1358

@dbus_interface_annotations(_interface)

1359

def _foo(self):

1360

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

1361

"false"}

1362

1363

## Signals

1364

1923

1924

# D-Bus methods, signals & properties

1925

1926

# Interfaces

1927

1928

# Signals

1929

1365

1930

# CheckerCompleted - signal

1366

1931

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

1367

1932

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

1368

1933

"D-Bus signal"

1369

1934

pass

1370

1935

1371

1936

# CheckerStarted - signal

1372

1937

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

1373

1938

def CheckerStarted(self, command):

1374

1939

"D-Bus signal"

1375

1940

pass

1376

1941

1377

1942

# PropertyChanged - signal

1943

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

1378

1944

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

1379

1945

def PropertyChanged(self, property, value):

1380

1946

"D-Bus signal"

1381

1947

pass

1382

1948

1383

1949

# GotSecret - signal

1384

1950

@dbus.service.signal(_interface)

1385

1951

def GotSecret(self):

1388

1954

server to mandos-client

1389

1955

"""

1390

1956

pass

1391

1957

1392

1958

# Rejected - signal

1393

1959

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

1394

1960

def Rejected(self, reason):

1395

1961

"D-Bus signal"

1396

1962

pass

1397

1963

1398

1964

# NeedApproval - signal

1399

1965

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

1400

1966

def NeedApproval(self, timeout, default):

1401

1967

"D-Bus signal"

1402

1968

return self.need_approval()

1403

1404

## Methods

1405

1969

1970

# Methods

1971

1406

1972

# Approve - method

1407

1973

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

1408

1974

def Approve(self, value):

1409

1975

self.approve(value)

1410

1976

1411

1977

# CheckedOK - method

1412

1978

@dbus.service.method(_interface)

1413

1979

def CheckedOK(self):

1414

1980

self.checked_ok()

1415

1981

1416

1982

# Enable - method

1983

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

1417

1984

@dbus.service.method(_interface)

1418

1985

def Enable(self):

1419

1986

"D-Bus method"

1420

1987

self.enable()

1421

1988

1422

1989

# StartChecker - method

1990

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

1423

1991

@dbus.service.method(_interface)

1424

1992

def StartChecker(self):

1425

1993

"D-Bus method"

1426

1994

self.start_checker()

1427

1995

1428

1996

# Disable - method

1997

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

1429

1998

@dbus.service.method(_interface)

1430

1999

def Disable(self):

1431

2000

"D-Bus method"

1432

2001

self.disable()

1433

2002

1434

2003

# StopChecker - method

2004

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

1435

2005

@dbus.service.method(_interface)

1436

2006

def StopChecker(self):

1437

2007

self.stop_checker()

1438

1439

## Properties

1440

2008

2009

# Properties

2010

1441

2011

# ApprovalPending - property

1442

2012

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

1443

2013

def ApprovalPending_dbus_property(self):

1444

2014

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

1445

2015

1446

2016

# ApprovedByDefault - property

1447

@dbus_service_property(_interface, signature="b",

2017

@dbus_service_property(_interface,

2018

signature="b",

1448

2019

access="readwrite")

1449

2020

def ApprovedByDefault_dbus_property(self, value=None):

1450

2021

if value is None: # get

1451

2022

return dbus.Boolean(self.approved_by_default)

1452

2023

self.approved_by_default = bool(value)

1453

2024

1454

2025

# ApprovalDelay - property

1455

@dbus_service_property(_interface, signature="t",

2026

@dbus_service_property(_interface,

2027

signature="t",

1456

2028

access="readwrite")

1457

2029

def ApprovalDelay_dbus_property(self, value=None):

1458

2030

if value is None: # get

1459

return dbus.UInt64(self.approval_delay_milliseconds())

2031

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

2032

* 1000)

1460

2033

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

1461

2034

1462

2035

# ApprovalDuration - property

1463

@dbus_service_property(_interface, signature="t",

2036

@dbus_service_property(_interface,

2037

signature="t",

1464

2038

access="readwrite")

1465

2039

def ApprovalDuration_dbus_property(self, value=None):

1466

2040

if value is None: # get

1467

return dbus.UInt64(timedelta_to_milliseconds(

1468

self.approval_duration))

2041

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

2042

* 1000)

1469

2043

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

1470

2044

1471

2045

# Name - property

2046

@dbus_annotations(

2047

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

1472

2048

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

1473

2049

def Name_dbus_property(self):

1474

2050

return dbus.String(self.name)

1475

2051

2052

# KeyID - property

2053

@dbus_annotations(

2054

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

2055

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

2056

def KeyID_dbus_property(self):

2057

return dbus.String(self.key_id)

2058

1476

2059

# Fingerprint - property

2060

@dbus_annotations(

2061

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

1477

2062

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

1478

2063

def Fingerprint_dbus_property(self):

1479

2064

return dbus.String(self.fingerprint)

1480

2065

1481

2066

# Host - property

1482

@dbus_service_property(_interface, signature="s",

2067

@dbus_service_property(_interface,

2068

signature="s",

1483

2069

access="readwrite")

1484

2070

def Host_dbus_property(self, value=None):

1485

2071

if value is None: # get

1486

2072

return dbus.String(self.host)

1487

self.host = unicode(value)

1488

2073

self.host = str(value)

2074

1489

2075

# Created - property

2076

@dbus_annotations(

2077

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

1490

2078

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

1491

2079

def Created_dbus_property(self):

1492

2080

return datetime_to_dbus(self.created)

1493

2081

1494

2082

# LastEnabled - property

1495

2083

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

1496

2084

def LastEnabled_dbus_property(self):

1497

2085

return datetime_to_dbus(self.last_enabled)

1498

2086

1499

2087

# Enabled - property

1500

@dbus_service_property(_interface, signature="b",

2088

@dbus_service_property(_interface,

2089

signature="b",

1501

2090

access="readwrite")

1502

2091

def Enabled_dbus_property(self, value=None):

1503

2092

if value is None: # get

1506

2095

self.enable()

1507

2096

else:

1508

2097

self.disable()

1509

2098

1510

2099

# LastCheckedOK - property

1511

@dbus_service_property(_interface, signature="s",

2100

@dbus_service_property(_interface,

2101

signature="s",

1512

2102

access="readwrite")

1513

2103

def LastCheckedOK_dbus_property(self, value=None):

1514

2104

if value is not None:

1515

2105

self.checked_ok()

1516

2106

return

1517

2107

return datetime_to_dbus(self.last_checked_ok)

1518

2108

1519

2109

# LastCheckerStatus - property

1520

@dbus_service_property(_interface, signature="n",

1521

access="read")

2110

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

1522

2111

def LastCheckerStatus_dbus_property(self):

1523

2112

return dbus.Int16(self.last_checker_status)

1524

2113

1525

2114

# Expires - property

1526

2115

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

1527

2116

def Expires_dbus_property(self):

1528

2117

return datetime_to_dbus(self.expires)

1529

2118

1530

2119

# LastApprovalRequest - property

1531

2120

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

1532

2121

def LastApprovalRequest_dbus_property(self):

1533

2122

return datetime_to_dbus(self.last_approval_request)

1534

2123

1535

2124

# Timeout - property

1536

@dbus_service_property(_interface, signature="t",

2125

@dbus_service_property(_interface,

2126

signature="t",

1537

2127

access="readwrite")

1538

2128

def Timeout_dbus_property(self, value=None):

1539

2129

if value is None: # get

1540

return dbus.UInt64(self.timeout_milliseconds())

2130

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

1541

2131

old_timeout = self.timeout

1542

2132

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

1543

2133

# Reschedule disabling

1551

2141

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

1552

2142

is None):

1553

2143

return

1554

gobject.source_remove(self.disable_initiator_tag)

1555

self.disable_initiator_tag = (

1556

gobject.timeout_add(

1557

timedelta_to_milliseconds(self.expires - now),

1558

self.disable))

1559

2144

GLib.source_remove(self.disable_initiator_tag)

2145

self.disable_initiator_tag = GLib.timeout_add(

2146

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

2147

self.disable)

2148

1560

2149

# ExtendedTimeout - property

1561

@dbus_service_property(_interface, signature="t",

2150

@dbus_service_property(_interface,

2151

signature="t",

1562

2152

access="readwrite")

1563

2153

def ExtendedTimeout_dbus_property(self, value=None):

1564

2154

if value is None: # get

1565

return dbus.UInt64(self.extended_timeout_milliseconds())

2155

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

2156

* 1000)

1566

2157

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

1567

2158

1568

2159

# Interval - property

1569

@dbus_service_property(_interface, signature="t",

2160

@dbus_service_property(_interface,

2161

signature="t",

1570

2162

access="readwrite")

1571

2163

def Interval_dbus_property(self, value=None):

1572

2164

if value is None: # get

1573

return dbus.UInt64(self.interval_milliseconds())

2165

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

1574

2166

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

1575

2167

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

1576

2168

return

1577

2169

if self.enabled:

1578

2170

# Reschedule checker run

1579

gobject.source_remove(self.checker_initiator_tag)

1580

self.checker_initiator_tag = (gobject.timeout_add

1581

(value, self.start_checker))

1582

self.start_checker() # Start one now, too

1583

2171

GLib.source_remove(self.checker_initiator_tag)

2172

self.checker_initiator_tag = GLib.timeout_add(

2173

value, self.start_checker)

2174

self.start_checker() # Start one now, too

2175

1584

2176

# Checker - property

1585

@dbus_service_property(_interface, signature="s",

2177

@dbus_service_property(_interface,

2178

signature="s",

1586

2179

access="readwrite")

1587

2180

def Checker_dbus_property(self, value=None):

1588

2181

if value is None: # get

1589

2182

return dbus.String(self.checker_command)

1590

self.checker_command = unicode(value)

1591

2183

self.checker_command = str(value)

2184

1592

2185

# CheckerRunning - property

1593

@dbus_service_property(_interface, signature="b",

2186

@dbus_service_property(_interface,

2187

signature="b",

1594

2188

access="readwrite")

1595

2189

def CheckerRunning_dbus_property(self, value=None):

1596

2190

if value is None: # get

1599

2193

self.start_checker()

1600

2194

else:

1601

2195

self.stop_checker()

1602

2196

1603

2197

# ObjectPath - property

2198

@dbus_annotations(

2199

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

2200

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

1604

2201

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

1605

2202

def ObjectPath_dbus_property(self):

1606

return self.dbus_object_path # is already a dbus.ObjectPath

1607

2203

return self.dbus_object_path # is already a dbus.ObjectPath

2204

1608

2205

# Secret = property

1609

@dbus_service_property(_interface, signature="ay",

1610

access="write", byte_arrays=True)

2206

@dbus_annotations(

2207

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

2208

"invalidates"})

2209

@dbus_service_property(_interface,

2210

signature="ay",

2211

access="write",

2212

byte_arrays=True)

1611

2213

def Secret_dbus_property(self, value):

1612

self.secret = str(value)

1613

2214

self.secret = bytes(value)

2215

1614

2216

del _interface

1615

2217

1616

2218

1617

class ProxyClient(object):

1618

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

2219

class ProxyClient:

2220

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

1619

2221

self._pipe = child_pipe

1620

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

2222

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

1621

2223

if not self._pipe.recv():

1622

raise KeyError()

1623

2224

raise KeyError(key_id or fpr)

2225

1624

2226

def __getattribute__(self, name):

1625

2227

if name == '_pipe':

1626

2228

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

1629

2231

if data[0] == 'data':

1630

2232

return data[1]

1631

2233

if data[0] == 'function':

2234

1632

2235

def func(*args, **kwargs):

1633

2236

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

1634

2237

return self._pipe.recv()[1]

2238

1635

2239

return func

1636

2240

1637

2241

def __setattr__(self, name, value):

1638

2242

if name == '_pipe':

1639

2243

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

1642

2246

1643

2247

class ClientHandler(socketserver.BaseRequestHandler, object):

1644

2248

"""A class to handle client connections.

1645

2249

1646

2250

Instantiated once for each connection to handle it.

1647

2251

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

1648

2252

1649

2253

def handle(self):

1650

2254

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

1651

2255

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

1652

unicode(self.client_address))

2256

str(self.client_address))

1653

2257

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

1654

2258

self.server.child_pipe.fileno())

1655

1656

session = (gnutls.connection

1657

.ClientSession(self.request,

1658

gnutls.connection

1659

.X509Credentials()))

1660

1661

# Note: gnutls.connection.X509Credentials is really a

1662

# generic GnuTLS certificate credentials object so long as

1663

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

1664

# here despite using OpenPGP certificates.

1665

1666

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

1667

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

1668

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

1669

# "+DHE-DSS"))

2259

2260

session = gnutls.ClientSession(self.request)

2261

2262

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

2263

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

2264

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

2265

# "+DHE-DSS"))

1670

2266

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

1671

2267

priority = self.server.gnutls_priority

1672

2268

if priority is None:

1673

2269

priority = "NORMAL"

1674

(gnutls.library.functions

1675

.gnutls_priority_set_direct(session._c_object,

1676

priority, None))

1677

2270

gnutls.priority_set_direct(session._c_object,

2271

priority.encode("utf-8"),

2272

None)

2273

1678

2274

# Start communication using the Mandos protocol

1679

2275

# Get protocol number

1680

2276

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

1681

2277

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

1682

2278

try:

1683

2279

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

1684

raise RuntimeError

2280

raise RuntimeError(line)

1685

2281

except (ValueError, IndexError, RuntimeError) as error:

1686

2282

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

1687

2283

return

1688

2284

1689

2285

# Start GnuTLS connection

1690

2286

try:

1691

2287

session.handshake()

1692

except gnutls.errors.GNUTLSError as error:

2288

except gnutls.Error as error:

1693

2289

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

1694

2290

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

1695

2291

# established. Just abandon the request.

1696

2292

return

1697

2293

logger.debug("Handshake succeeded")

1698

2294

1699

2295

approval_required = False

1700

2296

try:

1701

try:

1702

fpr = self.fingerprint(self.peer_certificate

1703

(session))

1704

except (TypeError,

1705

gnutls.errors.GNUTLSError) as error:

1706

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

1707

return

1708

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

1709

1710

try:

1711

client = ProxyClient(child_pipe, fpr,

2297

if gnutls.has_rawpk:

2298

fpr = b""

2299

try:

2300

key_id = self.key_id(

2301

self.peer_certificate(session))

2302

except (TypeError, gnutls.Error) as error:

2303

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

2304

return

2305

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

2306

2307

else:

2308

key_id = b""

2309

try:

2310

fpr = self.fingerprint(

2311

self.peer_certificate(session))

2312

except (TypeError, gnutls.Error) as error:

2313

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

2314

return

2315

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

2316

2317

try:

2318

client = ProxyClient(child_pipe, key_id, fpr,

1712

2319

self.client_address)

1713

2320

except KeyError:

1714

2321

return

1715

2322

1716

2323

if client.approval_delay:

1717

2324

delay = client.approval_delay

1718

2325

client.approvals_pending += 1

1719

2326

approval_required = True

1720

2327

1721

2328

while True:

1722

2329

if not client.enabled:

1723

2330

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

1724

client.name)

2331

client.name)

1725

2332

if self.server.use_dbus:

1726

2333

# Emit D-Bus signal

1727

2334

client.Rejected("Disabled")

1728

2335

return

1729

2336

1730

2337

if client.approved or not client.approval_delay:

1731

#We are approved or approval is disabled

2338

# We are approved or approval is disabled

1732

2339

break

1733

2340

elif client.approved is None:

1734

2341

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

1736

2343

if self.server.use_dbus:

1737

2344

# Emit D-Bus signal

1738

2345

client.NeedApproval(

1739

client.approval_delay_milliseconds(),

1740

client.approved_by_default)

2346

client.approval_delay.total_seconds()

2347

* 1000, client.approved_by_default)

1741

2348

else:

1742

2349

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

1743

2350

client.name)

1745

2352

# Emit D-Bus signal

1746

2353

client.Rejected("Denied")

1747

2354

return

1748

1749

#wait until timeout or approved

2355

2356

# wait until timeout or approved

1750

2357

time = datetime.datetime.now()

1751

2358

client.changedstate.acquire()

1752

client.changedstate.wait(

1753

float(timedelta_to_milliseconds(delay)

1754

/ 1000))

2359

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

1755

2360

client.changedstate.release()

1756

2361

time2 = datetime.datetime.now()

1757

2362

if (time2 - time) >= delay:

1767

2372

break

1768

2373

else:

1769

2374

delay -= time2 - time

1770

1771

sent_size = 0

1772

while sent_size < len(client.secret):

1773

try:

1774

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

1775

except gnutls.errors.GNUTLSError as error:

1776

logger.warning("gnutls send failed",

1777

exc_info=error)

1778

return

1779

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

1780

sent, len(client.secret)

1781

- (sent_size + sent))

1782

sent_size += sent

1783

2375

2376

try:

2377

session.send(client.secret)

2378

except gnutls.Error as error:

2379

logger.warning("gnutls send failed",

2380

exc_info=error)

2381

return

2382

1784

2383

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

1785

2384

# bump the timeout using extended_timeout

1786

2385

client.bump_timeout(client.extended_timeout)

1787

2386

if self.server.use_dbus:

1788

2387

# Emit D-Bus signal

1789

2388

client.GotSecret()

1790

2389

1791

2390

finally:

1792

2391

if approval_required:

1793

2392

client.approvals_pending -= 1

1794

2393

try:

1795

2394

session.bye()

1796

except gnutls.errors.GNUTLSError as error:

2395

except gnutls.Error as error:

1797

2396

logger.warning("GnuTLS bye failed",

1798

2397

exc_info=error)

1799

2398

1800

2399

@staticmethod

1801

2400

def peer_certificate(session):

1802

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

1803

# If not an OpenPGP certificate...

1804

if (gnutls.library.functions

1805

.gnutls_certificate_type_get(session._c_object)

1806

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1807

# ...do the normal thing

1808

return session.peer_certificate

2401

"Return the peer's certificate as a bytestring"

2402

try:

2403

cert_type = gnutls.certificate_type_get2(session._c_object,

2404

gnutls.CTYPE_PEERS)

2405

except AttributeError:

2406

cert_type = gnutls.certificate_type_get(session._c_object)

2407

if gnutls.has_rawpk:

2408

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2409

else:

2410

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2411

# If not a valid certificate type...

2412

if cert_type not in valid_cert_types:

2413

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

2414

valid_cert_types)

2415

# ...return invalid data

2416

return b""

1809

2417

list_size = ctypes.c_uint(1)

1810

cert_list = (gnutls.library.functions

1811

.gnutls_certificate_get_peers

2418

cert_list = (gnutls.certificate_get_peers

1812

2419

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

1813

2420

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

1814

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

1815

" certificate")

2421

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

1816

2422

if list_size.value == 0:

1817

2423

return None

1818

2424

cert = cert_list[0]

1819

2425

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

1820

2426

2427

@staticmethod

2428

def key_id(certificate):

2429

"Convert a certificate bytestring to a hexdigit key ID"

2430

# New GnuTLS "datum" with the public key

2431

datum = gnutls.datum_t(

2432

ctypes.cast(ctypes.c_char_p(certificate),

2433

ctypes.POINTER(ctypes.c_ubyte)),

2434

ctypes.c_uint(len(certificate)))

2435

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

2436

# New empty GnuTLS certificate

2437

pubkey = gnutls.pubkey_t()

2438

gnutls.pubkey_init(ctypes.byref(pubkey))

2439

# Import the raw public key into the certificate

2440

gnutls.pubkey_import(pubkey,

2441

ctypes.byref(datum),

2442

gnutls.X509_FMT_DER)

2443

# New buffer for the key ID

2444

buf = ctypes.create_string_buffer(32)

2445

buf_len = ctypes.c_size_t(len(buf))

2446

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

2447

gnutls.pubkey_get_key_id(pubkey,

2448

gnutls.KEYID_USE_SHA256,

2449

ctypes.cast(ctypes.byref(buf),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.byref(buf_len))

2452

# Deinit the certificate

2453

gnutls.pubkey_deinit(pubkey)

2454

2455

# Convert the buffer to a Python bytestring

2456

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

2457

# Convert the bytestring to hexadecimal notation

2458

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

2459

return hex_key_id

2460

1821

2461

@staticmethod

1822

2462

def fingerprint(openpgp):

1823

2463

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1824

2464

# New GnuTLS "datum" with the OpenPGP public key

1825

datum = (gnutls.library.types

1826

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

1827

ctypes.POINTER

1828

(ctypes.c_ubyte)),

1829

ctypes.c_uint(len(openpgp))))

2465

datum = gnutls.datum_t(

2466

ctypes.cast(ctypes.c_char_p(openpgp),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.c_uint(len(openpgp)))

1830

2469

# New empty GnuTLS certificate

1831

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1832

(gnutls.library.functions

1833

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2470

crt = gnutls.openpgp_crt_t()

2471

gnutls.openpgp_crt_init(ctypes.byref(crt))

1834

2472

# Import the OpenPGP public key into the certificate

1835

(gnutls.library.functions

1836

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

1837

gnutls.library.constants

1838

.GNUTLS_OPENPGP_FMT_RAW))

2473

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

2474

gnutls.OPENPGP_FMT_RAW)

1839

2475

# Verify the self signature in the key

1840

2476

crtverify = ctypes.c_uint()

1841

(gnutls.library.functions

1842

.gnutls_openpgp_crt_verify_self(crt, 0,

1843

ctypes.byref(crtverify)))

2477

gnutls.openpgp_crt_verify_self(crt, 0,

2478

ctypes.byref(crtverify))

1844

2479

if crtverify.value != 0:

1845

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1846

raise (gnutls.errors.CertificateSecurityError

1847

("Verify failed"))

2480

gnutls.openpgp_crt_deinit(crt)

2481

raise gnutls.CertificateSecurityError(code

2482

=crtverify.value)

1848

2483

# New buffer for the fingerprint

1849

2484

buf = ctypes.create_string_buffer(20)

1850

2485

buf_len = ctypes.c_size_t()

1851

2486

# Get the fingerprint from the certificate into the buffer

1852

(gnutls.library.functions

1853

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

1854

ctypes.byref(buf_len)))

2487

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

2488

ctypes.byref(buf_len))

1855

2489

# Deinit the certificate

1856

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2490

gnutls.openpgp_crt_deinit(crt)

1857

2491

# Convert the buffer to a Python bytestring

1858

2492

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

1859

2493

# Convert the bytestring to hexadecimal notation

1861

2495

return hex_fpr

1862

2496

1863

2497

1864

class MultiprocessingMixIn(object):

2498

class MultiprocessingMixIn:

1865

2499

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

2500

1866

2501

def sub_process_main(self, request, address):

1867

2502

try:

1868

2503

self.finish_request(request, address)

1869

2504

except Exception:

1870

2505

self.handle_error(request, address)

1871

2506

self.close_request(request)

1872

2507

1873

2508

def process_request(self, request, address):

1874

2509

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

1875

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

1876

args = (request, address))

2510

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

2511

args=(request, address))

1877

2512

proc.start()

1878

2513

return proc

1879

2514

1880

2515

1881

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2516

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1882

2517

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

2518

1883

2519

def process_request(self, request, client_address):

1884

2520

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

1885

2521

1886

2522

This function creates a new pipe in self.pipe

1887

2523

"""

1888

2524

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1889

2525

1890

2526

proc = MultiprocessingMixIn.process_request(self, request,

1891

2527

client_address)

1892

2528

self.child_pipe.close()

1893

2529

self.add_pipe(parent_pipe, proc)

1894

2530

1895

2531

def add_pipe(self, parent_pipe, proc):

1896

2532

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

1897

raise NotImplementedError

2533

raise NotImplementedError()

1898

2534

1899

2535

1900

2536

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1901

socketserver.TCPServer, object):

2537

socketserver.TCPServer):

1902

2538

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

1903

2539

1904

2540

Attributes:

1905

2541

enabled: Boolean; whether this server is activated yet

1906

2542

interface: None or a network interface name (string)

1907

2543

use_ipv6: Boolean; to use IPv6 or not

1908

2544

"""

2545

1909

2546

def __init__(self, server_address, RequestHandlerClass,

1910

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

2547

interface=None,

2548

use_ipv6=True,

2549

socketfd=None):

1911

2550

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

1912

2551

creating a new one with socket.socket().

1913

2552

"""

1919

2558

self.socketfd = socketfd

1920

2559

# Save the original socket.socket() function

1921

2560

self.socket_socket = socket.socket

2561

1922

2562

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

1923

#

2563

#

1924

2564

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

1925

2565

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

1926

2566

# patching socket.socket.)

1927

#

2567

#

1928

2568

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

1929

2569

@functools.wraps(socket.socket)

1930

2570

def socket_wrapper(*args, **kwargs):

1942

2582

# socket_wrapper(), if socketfd was set.

1943

2583

socketserver.TCPServer.__init__(self, server_address,

1944

2584

RequestHandlerClass)

1945

2585

1946

2586

def server_bind(self):

1947

2587

"""This overrides the normal server_bind() function

1948

2588

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

1949

2589

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

2590

global SO_BINDTODEVICE

1950

2591

if self.interface is not None:

1951

2592

if SO_BINDTODEVICE is None:

1952

logger.error("SO_BINDTODEVICE does not exist;"

1953

" cannot bind to interface %s",

1954

self.interface)

1955

else:

1956

try:

1957

self.socket.setsockopt(socket.SOL_SOCKET,

1958

SO_BINDTODEVICE,

1959

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

1960

except socket.error as error:

1961

if error.errno == errno.EPERM:

1962

logger.error("No permission to bind to"

1963

" interface %s", self.interface)

1964

elif error.errno == errno.ENOPROTOOPT:

1965

logger.error("SO_BINDTODEVICE not available;"

1966

" cannot bind to interface %s",

1967

self.interface)

1968

elif error.errno == errno.ENODEV:

1969

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

1970

" cannot bind", self.interface)

1971

else:

1972

raise

2593

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

2594

# common enough.

2595

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

2596

SO_BINDTODEVICE = 25

2597

try:

2598

self.socket.setsockopt(

2599

socket.SOL_SOCKET, SO_BINDTODEVICE,

2600

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

2601

except socket.error as error:

2602

if error.errno == errno.EPERM:

2603

logger.error("No permission to bind to"

2604

" interface %s", self.interface)

2605

elif error.errno == errno.ENOPROTOOPT:

2606

logger.error("SO_BINDTODEVICE not available;"

2607

" cannot bind to interface %s",

2608

self.interface)

2609

elif error.errno == errno.ENODEV:

2610

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

2611

" cannot bind", self.interface)

2612

else:

2613

raise

1973

2614

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

1974

2615

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

2616

if self.server_address[1]:

2617

self.allow_reuse_address = True

1975

2618

if not self.server_address[0]:

1976

2619

if self.address_family == socket.AF_INET6:

1977

any_address = "::" # in6addr_any

2620

any_address = "::" # in6addr_any

1978

2621

else:

1979

any_address = socket.INADDR_ANY

2622

any_address = "0.0.0.0" # INADDR_ANY

1980

2623

self.server_address = (any_address,

1981

2624

self.server_address[1])

1982

2625

elif not self.server_address[1]:

1983

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

1984

0)

2626

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

1985

2627

# if self.interface:

1986

2628

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

1987

2629

# 0, # port

1993

2635

1994

2636

class MandosServer(IPv6_TCPServer):

1995

2637

"""Mandos server.

1996

2638

1997

2639

Attributes:

1998

2640

clients: set of Client objects

1999

2641

gnutls_priority GnuTLS priority string

2000

2642

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

2001

2002

Assumes a gobject.MainLoop event loop.

2643

2644

Assumes a GLib.MainLoop event loop.

2003

2645

"""

2646

2004

2647

def __init__(self, server_address, RequestHandlerClass,

2005

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

2006

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

2648

interface=None,

2649

use_ipv6=True,

2650

clients=None,

2651

gnutls_priority=None,

2652

use_dbus=True,

2653

socketfd=None):

2007

2654

self.enabled = False

2008

2655

self.clients = clients

2009

2656

if self.clients is None:

2012

2659

self.gnutls_priority = gnutls_priority

2013

2660

IPv6_TCPServer.__init__(self, server_address,

2014

2661

RequestHandlerClass,

2015

interface = interface,

2016

use_ipv6 = use_ipv6,

2017

socketfd = socketfd)

2662

interface=interface,

2663

use_ipv6=use_ipv6,

2664

socketfd=socketfd)

2665

2018

2666

def server_activate(self):

2019

2667

if self.enabled:

2020

2668

return socketserver.TCPServer.server_activate(self)

2021

2669

2022

2670

def enable(self):

2023

2671

self.enabled = True

2024

2672

2025

2673

def add_pipe(self, parent_pipe, proc):

2026

2674

# Call "handle_ipc" for both data and EOF events

2027

gobject.io_add_watch(parent_pipe.fileno(),

2028

gobject.IO_IN | gobject.IO_HUP,

2029

functools.partial(self.handle_ipc,

2030

parent_pipe =

2031

parent_pipe,

2032

proc = proc))

2033

2034

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

2035

proc = None, client_object=None):

2675

GLib.io_add_watch(

2676

parent_pipe.fileno(),

2677

GLib.IO_IN | GLib.IO_HUP,

2678

functools.partial(self.handle_ipc,

2679

parent_pipe=parent_pipe,

2680

proc=proc))

2681

2682

def handle_ipc(self, source, condition,

2683

parent_pipe=None,

2684

proc=None,

2685

client_object=None):

2036

2686

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

2037

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

2687

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

2038

2688

# Wait for other process to exit

2039

2689

proc.join()

2040

2690

return False

2041

2691

2042

2692

# Read a request from the child

2043

2693

request = parent_pipe.recv()

2044

2694

command = request[0]

2045

2695

2046

2696

if command == 'init':

2047

fpr = request[1]

2048

address = request[2]

2049

2050

for c in self.clients.itervalues():

2051

if c.fingerprint == fpr:

2697

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

2698

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

2699

address = request[3]

2700

2701

for c in self.clients.values():

2702

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2703

continue

2704

if key_id and c.key_id == key_id:

2705

client = c

2706

break

2707

if fpr and c.fingerprint == fpr:

2052

2708

client = c

2053

2709

break

2054

2710

else:

2055

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

2056

"dress: %s", fpr, address)

2711

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

2712

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

2057

2713

if self.use_dbus:

2058

2714

# Emit D-Bus signal

2059

mandos_dbus_service.ClientNotFound(fpr,

2715

mandos_dbus_service.ClientNotFound(key_id or fpr,

2060

2716

address[0])

2061

2717

parent_pipe.send(False)

2062

2718

return False

2063

2064

gobject.io_add_watch(parent_pipe.fileno(),

2065

gobject.IO_IN | gobject.IO_HUP,

2066

functools.partial(self.handle_ipc,

2067

parent_pipe =

2068

parent_pipe,

2069

proc = proc,

2070

client_object =

2071

client))

2719

2720

GLib.io_add_watch(

2721

parent_pipe.fileno(),

2722

GLib.IO_IN | GLib.IO_HUP,

2723

functools.partial(self.handle_ipc,

2724

parent_pipe=parent_pipe,

2725

proc=proc,

2726

client_object=client))

2072

2727

parent_pipe.send(True)

2073

2728

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

2074

2729

# same fileno

2077

2732

funcname = request[1]

2078

2733

args = request[2]

2079

2734

kwargs = request[3]

2080

2735

2081

2736

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

2082

2737

funcname)(*args,

2083

**kwargs)))

2084

2738

**kwargs)))

2739

2085

2740

if command == 'getattr':

2086

2741

attrname = request[1]

2087

if callable(client_object.__getattribute__(attrname)):

2088

parent_pipe.send(('function',))

2742

if isinstance(client_object.__getattribute__(attrname),

2743

collections.Callable):

2744

parent_pipe.send(('function', ))

2089

2745

else:

2090

parent_pipe.send(('data', client_object

2091

.__getattribute__(attrname)))

2092

2746

parent_pipe.send((

2747

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

2748

2093

2749

if command == 'setattr':

2094

2750

attrname = request[1]

2095

2751

value = request[2]

2096

2752

setattr(client_object, attrname, value)

2097

2753

2098

2754

return True

2099

2755

2100

2756

2101

2757

def rfc3339_duration_to_delta(duration):

2102

2758

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

2103

2759

2104

2760

>>> rfc3339_duration_to_delta("P7D")

2105

2761

datetime.timedelta(7)

2106

2762

>>> rfc3339_duration_to_delta("PT60S")

2116

2772

>>> rfc3339_duration_to_delta("P1DT3M20S")

2117

2773

datetime.timedelta(1, 200)

2118

2774

"""

2119

2775

2120

2776

# Parsing an RFC 3339 duration with regular expressions is not

2121

2777

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

2122

2778

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

2123

2779

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

2124

2780

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

2125

2781

# avoid excessive use of external libraries.

2126

2782

2127

2783

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

2128

Token = collections.namedtuple("Token",

2129

("regexp", # To match token; if

2130

# "value" is not None,

2131

# must have a "group"

2132

# containing digits

2133

"value", # datetime.timedelta or

2134

# None

2135

"followers")) # Tokens valid after

2136

# this token

2784

Token = collections.namedtuple("Token", (

2785

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

2786

# a "group" containing digits

2787

"value", # datetime.timedelta or None

2788

"followers")) # Tokens valid after this token

2137

2789

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

2138

2790

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

2139

2791

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

2140

2792

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

2141

2793

datetime.timedelta(seconds=1),

2142

frozenset((token_end,)))

2794

frozenset((token_end, )))

2143

2795

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

2144

2796

datetime.timedelta(minutes=1),

2145

2797

frozenset((token_second, token_end)))

2161

2813

frozenset((token_month, token_end)))

2162

2814

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

2163

2815

datetime.timedelta(weeks=1),

2164

frozenset((token_end,)))

2816

frozenset((token_end, )))

2165

2817

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

2166

2818

frozenset((token_year, token_month,

2167

2819

token_day, token_time,

2168

token_week))),

2169

# Define starting values

2170

value = datetime.timedelta() # Value so far

2820

token_week)))

2821

# Define starting values:

2822

# Value so far

2823

value = datetime.timedelta()

2171

2824

found_token = None

2172

followers = frozenset(token_duration,) # Following valid tokens

2173

s = duration # String left to parse

2825

# Following valid tokens

2826

followers = frozenset((token_duration, ))

2827

# String left to parse

2828

s = duration

2174

2829

# Loop until end token is found

2175

2830

while found_token is not token_end:

2176

2831

# Search for any currently valid tokens

2192

2847

break

2193

2848

else:

2194

2849

# No currently valid tokens were found

2195

raise ValueError("Invalid RFC 3339 duration")

2850

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

2851

.format(duration))

2196

2852

# End token found

2197

2853

return value

2198

2854

2199

2855

2200

2856

def string_to_delta(interval):

2201

2857

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

2202

2858

2203

2859

>>> string_to_delta('7d')

2204

2860

datetime.timedelta(7)

2205

2861

>>> string_to_delta('60s')

2213

2869

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

2214

2870

datetime.timedelta(0, 330)

2215

2871

"""

2216

2872

2217

2873

try:

2218

2874

return rfc3339_duration_to_delta(interval)

2219

2875

except ValueError:

2220

2876

pass

2221

2877

2222

2878

timevalue = datetime.timedelta(0)

2223

2879

for s in interval.split():

2224

2880

try:

2225

suffix = unicode(s[-1])

2881

suffix = s[-1]

2226

2882

value = int(s[:-1])

2227

2883

if suffix == "d":

2228

2884

delta = datetime.timedelta(value)

2235

2891

elif suffix == "w":

2236

2892

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

2237

2893

else:

2238

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

2239

.format(suffix))

2240

except (ValueError, IndexError) as e:

2894

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

2895

except IndexError as e:

2241

2896

raise ValueError(*(e.args))

2242

2897

timevalue += delta

2243

2898

return timevalue

2244

2899

2245

2900

2246

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

2901

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

2247

2902

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

2248

2903

2249

2904

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

2250

2905

if os.fork():

2251

2906

sys.exit()

2259

2914

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

2260

2915

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

2261

2916

raise OSError(errno.ENODEV,

2262

"{0} not a character device"

2917

"{} not a character device"

2263

2918

.format(os.devnull))

2264

2919

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

2265

2920

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

2269

2924

2270

2925

2271

2926

def main():

2272

2927

2273

2928

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

2274

2929

# Parsing of options, both command line and config file

2275

2930

2276

2931

parser = argparse.ArgumentParser()

2277

2932

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

2278

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

2933

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

2279

2934

help="show version number and exit")

2280

2935

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

2281

2936

help="Bind to interface IF")

2287

2942

help="Run self-test")

2288

2943

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

2289

2944

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

2290

" to terminal")

2945

" to terminal", default=None)

2291

2946

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

2292

2947

help="Debug level for stdout output")

2293

2948

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

2300

2955

" files")

2301

2956

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

2302

2957

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

2303

" system bus interface")

2958

" system bus interface", default=None)

2304

2959

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

2305

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

2960

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

2961

default=None)

2306

2962

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

2307

2963

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

2308

" state")

2964

" state", default=None)

2309

2965

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

2310

2966

help="Specify a file descriptor to a network"

2311

2967

" socket to use instead of creating one")

2312

2968

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

2313

2969

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

2314

2970

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

2315

help="Run in foreground")

2316

2971

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

2972

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

2973

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

2974

default=None)

2975

2317

2976

options = parser.parse_args()

2318

2977

2319

2978

if options.check:

2320

2979

import doctest

2321

doctest.testmod()

2322

sys.exit()

2323

2980

fail_count, test_count = doctest.testmod()

2981

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

2982

2324

2983

# Default values for config file for server-global settings

2325

server_defaults = { "interface": "",

2326

"address": "",

2327

"port": "",

2328

"debug": "False",

2329

"priority":

2330

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

2331

"servicename": "Mandos",

2332

"use_dbus": "True",

2333

"use_ipv6": "True",

2334

"debuglevel": "",

2335

"restore": "True",

2336

"socket": "",

2337

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

2338

"foreground": "False",

2339

}

2340

2984

if gnutls.has_rawpk:

2985

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

2986

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

2987

else:

2988

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

2989

":+SIGN-DSA-SHA256")

2990

server_defaults = {"interface": "",

2991

"address": "",

2992

"port": "",

2993

"debug": "False",

2994

"priority": priority,

2995

"servicename": "Mandos",

2996

"use_dbus": "True",

2997

"use_ipv6": "True",

2998

"debuglevel": "",

2999

"restore": "True",

3000

"socket": "",

3001

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

3002

"foreground": "False",

3003

"zeroconf": "True",

3004

}

3005

del priority

3006

2341

3007

# Parse config file for server-global settings

2342

server_config = configparser.SafeConfigParser(server_defaults)

3008

server_config = configparser.ConfigParser(server_defaults)

2343

3009

del server_defaults

2344

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

2345

"mandos.conf"))

2346

# Convert the SafeConfigParser object to a dict

3010

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

3011

# Convert the ConfigParser object to a dict

2347

3012

server_settings = server_config.defaults()

2348

3013

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

2349

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

3014

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

3015

"foreground", "zeroconf"):

2350

3016

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

2351

3017

option)

2352

3018

if server_settings["port"]:

2362

3028

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

2363

3029

["socket"])

2364

3030

del server_config

2365

3031

2366

3032

# Override the settings from the config file with command line

2367

3033

# options, if set.

2368

3034

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

2369

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

2370

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

2371

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

3035

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

3036

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

3037

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

2372

3038

value = getattr(options, option)

2373

3039

if value is not None:

2374

3040

server_settings[option] = value

2375

3041

del options

2376

3042

# Force all strings to be unicode

2377

3043

for option in server_settings.keys():

2378

if type(server_settings[option]) is str:

2379

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

3044

if isinstance(server_settings[option], bytes):

3045

server_settings[option] = (server_settings[option]

3046

.decode("utf-8"))

3047

# Force all boolean options to be boolean

3048

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

3049

"foreground", "zeroconf"):

3050

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

2380

3051

# Debug implies foreground

2381

3052

if server_settings["debug"]:

2382

3053

server_settings["foreground"] = True

2383

3054

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

2384

3055

2385

3056

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

2386

3057

3058

if (not server_settings["zeroconf"]

3059

and not (server_settings["port"]

3060

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

3061

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

3062

2387

3063

# For convenience

2388

3064

debug = server_settings["debug"]

2389

3065

debuglevel = server_settings["debuglevel"]

2392

3068

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

2393

3069

stored_state_file)

2394

3070

foreground = server_settings["foreground"]

2395

3071

zeroconf = server_settings["zeroconf"]

3072

2396

3073

if debug:

2397

3074

initlogger(debug, logging.DEBUG)

2398

3075

else:

2401

3078

else:

2402

3079

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

2403

3080

initlogger(debug, level)

2404

3081

2405

3082

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

2406

syslogger.setFormatter(logging.Formatter

2407

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

2408

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

2409

.format(server_settings

2410

["servicename"])))

2411

3083

syslogger.setFormatter(

3084

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

3085

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

3086

server_settings["servicename"])))

3087

2412

3088

# Parse config file with clients

2413

client_config = configparser.SafeConfigParser(Client

2414

.client_defaults)

3089

client_config = configparser.ConfigParser(Client.client_defaults)

2415

3090

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

2416

3091

"clients.conf"))

2417

3092

2418

3093

global mandos_dbus_service

2419

3094

mandos_dbus_service = None

2420

2421

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

2422

server_settings["port"]),

2423

ClientHandler,

2424

interface=(server_settings["interface"]

2425

or None),

2426

use_ipv6=use_ipv6,

2427

gnutls_priority=

2428

server_settings["priority"],

2429

use_dbus=use_dbus,

2430

socketfd=(server_settings["socket"]

2431

or None))

3095

3096

socketfd = None

3097

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

3098

socketfd = server_settings["socket"]

3099

tcp_server = MandosServer(

3100

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

3101

ClientHandler,

3102

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

3103

use_ipv6=use_ipv6,

3104

gnutls_priority=server_settings["priority"],

3105

use_dbus=use_dbus,

3106

socketfd=socketfd)

2432

3107

if not foreground:

2433

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

3108

pidfilename = "/run/mandos.pid"

3109

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

3110

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

2434

3111

pidfile = None

2435

3112

try:

2436

pidfile = open(pidfilename, "w")

3113

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

2437

3114

except IOError as e:

2438

3115

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

2439

3116

exc_info=e)

2440

2441

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

3117

3118

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

3119

("mandos", "mandos"),

3120

("nobody", "nogroup")):

2442

3121

try:

2443

3122

uid = pwd.getpwnam(name).pw_uid

2444

gid = pwd.getpwnam(name).pw_gid

3123

gid = pwd.getpwnam(group).pw_gid

2445

3124

break

2446

3125

except KeyError:

2447

3126

continue

2451

3130

try:

2452

3131

os.setgid(gid)

2453

3132

os.setuid(uid)

3133

if debug:

3134

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

3135

gid))

2454

3136

except OSError as error:

3137

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

3138

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

2455

3139

if error.errno != errno.EPERM:

2456

raise error

2457

3140

raise

3141

2458

3142

if debug:

2459

3143

# Enable all possible GnuTLS debugging

2460

3144

2461

3145

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

2462

3146

# - GnuTLS manual

2463

gnutls.library.functions.gnutls_global_set_log_level(11)

2464

2465

@gnutls.library.types.gnutls_log_func

3147

gnutls.global_set_log_level(11)

3148

3149

@gnutls.log_func

2466

3150

def debug_gnutls(level, string):

2467

3151

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

2468

2469

(gnutls.library.functions

2470

.gnutls_global_set_log_function(debug_gnutls))

2471

3152

3153

gnutls.global_set_log_function(debug_gnutls)

3154

2472

3155

# Redirect stdin so all checkers get /dev/null

2473

3156

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

2474

3157

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

2475

3158

if null > 2:

2476

3159

os.close(null)

2477

3160

2478

3161

# Need to fork before connecting to D-Bus

2479

3162

if not foreground:

2480

3163

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

2481

3164

daemon()

2482

2483

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

2484

# need to inform gobject that threads will be used.

2485

gobject.threads_init()

2486

3165

3166

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

3167

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

3168

# need to inform GLib that threads will be used.

3169

GLib.threads_init()

3170

2487

3171

global main_loop

2488

3172

# From the Avahi example code

2489

3173

DBusGMainLoop(set_as_default=True)

2490

main_loop = gobject.MainLoop()

3174

main_loop = GLib.MainLoop()

2491

3175

bus = dbus.SystemBus()

2492

3176

# End of Avahi example code

2493

3177

if use_dbus:

2494

3178

try:

2495

3179

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

2496

bus, do_not_queue=True)

2497

old_bus_name = (dbus.service.BusName

2498

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

2499

do_not_queue=True))

2500

except dbus.exceptions.NameExistsException as e:

3180

bus,

3181

do_not_queue=True)

3182

old_bus_name = dbus.service.BusName(

3183

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

3184

do_not_queue=True)

3185

except dbus.exceptions.DBusException as e:

2501

3186

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

2502

3187

use_dbus = False

2503

3188

server_settings["use_dbus"] = False

2504

3189

tcp_server.use_dbus = False

2505

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2506

service = AvahiServiceToSyslog(name =

2507

server_settings["servicename"],

2508

servicetype = "_mandos._tcp",

2509

protocol = protocol, bus = bus)

2510

if server_settings["interface"]:

2511

service.interface = (if_nametoindex

2512

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

2513

3190

if zeroconf:

3191

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3192

service = AvahiServiceToSyslog(

3193

name=server_settings["servicename"],

3194

servicetype="_mandos._tcp",

3195

protocol=protocol,

3196

bus=bus)

3197

if server_settings["interface"]:

3198

service.interface = if_nametoindex(

3199

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

3200

2514

3201

global multiprocessing_manager

2515

3202

multiprocessing_manager = multiprocessing.Manager()

2516

3203

2517

3204

client_class = Client

2518

3205

if use_dbus:

2519

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

2520

3206

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

3207

2521

3208

client_settings = Client.config_parser(client_config)

2522

3209

old_client_settings = {}

2523

3210

clients_data = {}

2524

3211

3212

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

3213

global wnull

3214

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

3215

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

3216

# mode

3217

if debug or not foreground:

3218

wnull.close()

3219

2525

3220

# Get client data and settings from last running state.

2526

3221

if server_settings["restore"]:

2527

3222

try:

2528

3223

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

2529

clients_data, old_client_settings = (pickle.load

2530

(stored_state))

3224

if sys.version_info.major == 2:

3225

clients_data, old_client_settings = pickle.load(

3226

stored_state)

3227

else:

3228

bytes_clients_data, bytes_old_client_settings = (

3229

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

3230

# Fix bytes to strings

3231

# clients_data

3232

# .keys()

3233

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

3234

if isinstance(key, bytes)

3235

else key): value

3236

for key, value in

3237

bytes_clients_data.items()}

3238

del bytes_clients_data

3239

for key in clients_data:

3240

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

3241

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

3242

for k, v in

3243

clients_data[key].items()}

3244

clients_data[key] = value

3245

# .client_structure

3246

value["client_structure"] = [

3247

(s.decode("utf-8")

3248

if isinstance(s, bytes)

3249

else s) for s in

3250

value["client_structure"]]

3251

# .name & .host

3252

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

3253

if isinstance(value[k], bytes):

3254

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

3255

if "key_id" not in value:

3256

value["key_id"] = ""

3257

elif "fingerprint" not in value:

3258

value["fingerprint"] = ""

3259

# old_client_settings

3260

# .keys()

3261

old_client_settings = {

3262

(key.decode("utf-8")

3263

if isinstance(key, bytes)

3264

else key): value

3265

for key, value in

3266

bytes_old_client_settings.items()}

3267

del bytes_old_client_settings

3268

# .host

3269

for value in old_client_settings.values():

3270

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

3271

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

3272

.decode("utf-8"))

2531

3273

os.remove(stored_state_path)

2532

3274

except IOError as e:

2533

3275

if e.errno == errno.ENOENT:

2534

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

2535

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

3276

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

3277

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

2536

3278

else:

2537

3279

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

2538

3280

exc_info=e)

2539

3281

raise

2540

3282

except EOFError as e:

2541

3283

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

2542

"EOFError:", exc_info=e)

2543

3284

"EOFError:",

3285

exc_info=e)

3286

2544

3287

with PGPEngine() as pgp:

2545

for client_name, client in clients_data.iteritems():

3288

for client_name, client in clients_data.items():

3289

# Skip removed clients

3290

if client_name not in client_settings:

3291

continue

3292

2546

3293

# Decide which value to use after restoring saved state.

2547

3294

# We have three different values: Old config file,

2548

3295

# new config file, and saved state.

2553

3300

# For each value in new config, check if it

2554

3301

# differs from the old config value (Except for

2555

3302

# the "secret" attribute)

2556

if (name != "secret" and

2557

value != old_client_settings[client_name]

2558

[name]):

3303

if (name != "secret"

3304

and (value !=

3305

old_client_settings[client_name][name])):

2559

3306

client[name] = value

2560

3307

except KeyError:

2561

3308

pass

2562

3309

2563

3310

# Clients who has passed its expire date can still be

2564

# enabled if its last checker was successful. Clients

3311

# enabled if its last checker was successful. A Client

2565

3312

# whose checker succeeded before we stored its state is

2566

3313

# assumed to have successfully run all checkers during

2567

3314

# downtime.

2569

3316

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

2570

3317

if not client["last_checked_ok"]:

2571

3318

logger.warning(

2572

"disabling client {0} - Client never "

2573

"performed a successful checker"

2574

.format(client_name))

3319

"disabling client {} - Client never "

3320

"performed a successful checker".format(

3321

client_name))

2575

3322

client["enabled"] = False

2576

3323

elif client["last_checker_status"] != 0:

2577

3324

logger.warning(

2578

"disabling client {0} - Client "

2579

"last checker failed with error code {1}"

2580

.format(client_name,

2581

client["last_checker_status"]))

3325

"disabling client {} - Client last"

3326

" checker failed with error code"

3327

" {}".format(

3328

client_name,

3329

client["last_checker_status"]))

2582

3330

client["enabled"] = False

2583

3331

else:

2584

client["expires"] = (datetime.datetime

2585

.utcnow()

2586

+ client["timeout"])

3332

client["expires"] = (

3333

datetime.datetime.utcnow()

3334

+ client["timeout"])

2587

3335

logger.debug("Last checker succeeded,"

2588

" keeping {0} enabled"

2589

.format(client_name))

3336

" keeping {} enabled".format(

3337

client_name))

2590

3338

try:

2591

client["secret"] = (

2592

pgp.decrypt(client["encrypted_secret"],

2593

client_settings[client_name]

2594

["secret"]))

3339

client["secret"] = pgp.decrypt(

3340

client["encrypted_secret"],

3341

client_settings[client_name]["secret"])

2595

3342

except PGPError:

2596

3343

# If decryption fails, we use secret from new settings

2597

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

2598

.format(client_name))

2599

client["secret"] = (

2600

client_settings[client_name]["secret"])

2601

3344

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

3345

client_name))

3346

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

3347

["secret"])

3348

2602

3349

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

2603

3350

for client_name in (set(old_client_settings)

2604

3351

- set(client_settings)):

2606

3353

for client_name in (set(client_settings)

2607

3354

- set(old_client_settings)):

2608

3355

clients_data[client_name] = client_settings[client_name]

2609

3356

2610

3357

# Create all client objects

2611

for client_name, client in clients_data.iteritems():

3358

for client_name, client in clients_data.items():

2612

3359

tcp_server.clients[client_name] = client_class(

2613

name = client_name, settings = client)

2614

3360

name=client_name,

3361

settings=client,

3362

server_settings=server_settings)

3363

2615

3364

if not tcp_server.clients:

2616

3365

logger.warning("No clients defined")

2617

3366

2618

3367

if not foreground:

2619

3368

if pidfile is not None:

3369

pid = os.getpid()

2620

3370

try:

2621

3371

with pidfile:

2622

pid = os.getpid()

2623

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

3372

print(pid, file=pidfile)

2624

3373

except IOError:

2625

3374

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

2626

3375

pidfilename, pid)

2627

3376

del pidfile

2628

3377

del pidfilename

2629

2630

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

2631

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

2632

3378

3379

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

3380

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3381

lambda: main_loop.quit() and False)

3382

2633

3383

if use_dbus:

2634

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

2635

"se.bsnet.fukt.Mandos"})

2636

class MandosDBusService(DBusObjectWithProperties):

3384

3385

@alternate_dbus_interfaces(

3386

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

3387

class MandosDBusService(DBusObjectWithObjectManager):

2637

3388

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

3389

2638

3390

def __init__(self):

2639

3391

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

3392

2640

3393

_interface = "se.recompile.Mandos"

2641

2642

@dbus_interface_annotations(_interface)

2643

def _foo(self):

2644

return { "org.freedesktop.DBus.Property"

2645

".EmitsChangedSignal":

2646

"false"}

2647

3394

2648

3395

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

2649

3396

def ClientAdded(self, objpath):

2650

3397

"D-Bus signal"

2651

3398

pass

2652

3399

2653

3400

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

2654

def ClientNotFound(self, fingerprint, address):

3401

def ClientNotFound(self, key_id, address):

2655

3402

"D-Bus signal"

2656

3403

pass

2657

3404

3405

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

3406

"true"})

2658

3407

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

2659

3408

def ClientRemoved(self, objpath, name):

2660

3409

"D-Bus signal"

2661

3410

pass

2662

3411

3412

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

3413

"true"})

2663

3414

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

2664

3415

def GetAllClients(self):

2665

3416

"D-Bus method"

2666

return dbus.Array(c.dbus_object_path

2667

for c in

2668

tcp_server.clients.itervalues())

2669

3417

return dbus.Array(c.dbus_object_path for c in

3418

tcp_server.clients.values())

3419

3420

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

3421

"true"})

2670

3422

@dbus.service.method(_interface,

2671

3423

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

2672

3424

def GetAllClientsWithProperties(self):

2673

3425

"D-Bus method"

2674

3426

return dbus.Dictionary(

2675

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

2676

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

3427

{c.dbus_object_path: c.GetAll(

3428

"se.recompile.Mandos.Client")

3429

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

2677

3430

signature="oa{sv}")

2678

3431

2679

3432

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

2680

3433

def RemoveClient(self, object_path):

2681

3434

"D-Bus method"

2682

for c in tcp_server.clients.itervalues():

3435

for c in tcp_server.clients.values():

2683

3436

if c.dbus_object_path == object_path:

2684

3437

del tcp_server.clients[c.name]

2685

3438

c.remove_from_connection()

2686

# Don't signal anything except ClientRemoved

3439

# Don't signal the disabling

2687

3440

c.disable(quiet=True)

2688

# Emit D-Bus signal

2689

self.ClientRemoved(object_path, c.name)

3441

# Emit D-Bus signal for removal

3442

self.client_removed_signal(c)

2690

3443

return

2691

3444

raise KeyError(object_path)

2692

3445

2693

3446

del _interface

2694

3447

3448

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3449

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

3450

def GetManagedObjects(self):

3451

"""D-Bus method"""

3452

return dbus.Dictionary(

3453

{client.dbus_object_path:

3454

dbus.Dictionary(

3455

{interface: client.GetAll(interface)

3456

for interface in

3457

client._get_all_interface_names()})

3458

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

3459

3460

def client_added_signal(self, client):

3461

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

3462

if use_dbus:

3463

# New standard signal

3464

self.InterfacesAdded(

3465

client.dbus_object_path,

3466

dbus.Dictionary(

3467

{interface: client.GetAll(interface)

3468

for interface in

3469

client._get_all_interface_names()}))

3470

# Old signal

3471

self.ClientAdded(client.dbus_object_path)

3472

3473

def client_removed_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesRemoved(

3478

client.dbus_object_path,

3479

client._get_all_interface_names())

3480

# Old signal

3481

self.ClientRemoved(client.dbus_object_path,

3482

client.name)

3483

2695

3484

mandos_dbus_service = MandosDBusService()

2696

3485

3486

# Save modules to variables to exempt the modules from being

3487

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

3488

mp = multiprocessing

3489

wn = wnull

3490

2697

3491

def cleanup():

2698

3492

"Cleanup function; run on exit"

2699

service.cleanup()

2700

2701

multiprocessing.active_children()

3493

if zeroconf:

3494

service.cleanup()

3495

3496

mp.active_children()

3497

wn.close()

2702

3498

if not (tcp_server.clients or client_settings):

2703

3499

return

2704

3500

2705

3501

# Store client before exiting. Secrets are encrypted with key

2706

3502

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

2707

3503

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

2708

3504

clients = {}

2709

3505

with PGPEngine() as pgp:

2710

for client in tcp_server.clients.itervalues():

3506

for client in tcp_server.clients.values():

2711

3507

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

2712

3508

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

2713

3509

key)

2714

3510

client_dict = {}

2715

3511

2716

3512

# A list of attributes that can not be pickled

2717

3513

# + secret.

2718

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

2719

"checker"))

2720

for name, typ in (inspect.getmembers

2721

(dbus.service.Object)):

3514

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

3515

"checker", "server_settings"}

3516

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

3517

.Object):

2722

3518

exclude.add(name)

2723

3519

2724

3520

client_dict["encrypted_secret"] = (client

2725

3521

.encrypted_secret)

2726

3522

for attr in client.client_structure:

2727

3523

if attr not in exclude:

2728

3524

client_dict[attr] = getattr(client, attr)

2729

3525

2730

3526

clients[client.name] = client_dict

2731

3527

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

2732

3528

2733

3529

try:

2734

with (tempfile.NamedTemporaryFile

2735

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

2736

dir=os.path.dirname(stored_state_path),

2737

delete=False)) as stored_state:

2738

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

2739

tempname=stored_state.name

3530

with tempfile.NamedTemporaryFile(

3531

mode='wb',

3532

suffix=".pickle",

3533

prefix='clients-',

3534

dir=os.path.dirname(stored_state_path),

3535

delete=False) as stored_state:

3536

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

3537

protocol=2)

3538

tempname = stored_state.name

2740

3539

os.rename(tempname, stored_state_path)

2741

3540

except (IOError, OSError) as e:

2742

3541

if not debug:

2745

3544

except NameError:

2746

3545

pass

2747

3546

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

2748

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

3547

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

2749

3548

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

2750

3549

else:

2751

3550

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

2752

3551

exc_info=e)

2753

raise e

2754

3552

raise

3553

2755

3554

# Delete all clients, and settings from config

2756

3555

while tcp_server.clients:

2757

3556

name, client = tcp_server.clients.popitem()

2758

3557

if use_dbus:

2759

3558

client.remove_from_connection()

2760

# Don't signal anything except ClientRemoved

3559

# Don't signal the disabling

2761

3560

client.disable(quiet=True)

3561

# Emit D-Bus signal for removal

2762

3562

if use_dbus:

2763

# Emit D-Bus signal

2764

mandos_dbus_service.ClientRemoved(client

2765

.dbus_object_path,

2766

client.name)

3563

mandos_dbus_service.client_removed_signal(client)

2767

3564

client_settings.clear()

2768

3565

2769

3566

atexit.register(cleanup)

2770

2771

for client in tcp_server.clients.itervalues():

3567

3568

for client in tcp_server.clients.values():

2772

3569

if use_dbus:

2773

# Emit D-Bus signal

2774

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3570

# Emit D-Bus signal for adding

3571

mandos_dbus_service.client_added_signal(client)

2775

3572

# Need to initiate checking of clients

2776

3573

if client.enabled:

2777

3574

client.init_checker()

2778

3575

2779

3576

tcp_server.enable()

2780

3577

tcp_server.server_activate()

2781

3578

2782

3579

# Find out what port we got

2783

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

3580

if zeroconf:

3581

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

2784

3582

if use_ipv6:

2785

3583

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

2786

3584

" flowinfo %d, scope_id %d",

2788

3586

else: # IPv4

2789

3587

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

2790

3588

*tcp_server.socket.getsockname())

2791

2792

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

2793

3589

3590

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

3591

2794

3592

try:

2795

# From the Avahi example code

2796

try:

2797

service.activate()

2798

except dbus.exceptions.DBusException as error:

2799

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

2800

cleanup()

2801

sys.exit(1)

2802

# End of Avahi example code

2803

2804

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

2805

lambda *args, **kwargs:

2806

(tcp_server.handle_request

2807

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

2808

3593

if zeroconf:

3594

# From the Avahi example code

3595

try:

3596

service.activate()

3597

except dbus.exceptions.DBusException as error:

3598

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

3599

cleanup()

3600

sys.exit(1)

3601

# End of Avahi example code

3602

3603

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

3604

lambda *args, **kwargs:

3605

(tcp_server.handle_request

3606

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

3607

2809

3608

logger.debug("Starting main loop")

2810

3609

main_loop.run()

2811

3610

except AvahiError as error:

2820

3619

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

2821

3620

cleanup()

2822

3621

3622

2823

3623

if __name__ == '__main__':

2824

3624

main()