/mandos/trunk : revision 1171

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -b

2

# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); coding: utf-8 -*-

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

80

import unittest

72

81

73

82

import dbus

74

83

import dbus.service

75

import gobject

76

import avahi

84

import gi

85

from gi.repository import GLib

77

86

from dbus.mainloop.glib import DBusGMainLoop

78

87

import ctypes

79

88

import ctypes.util

80

89

import xml.dom.minidom

81

90

import inspect

82

91

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

95

# Show warnings by default

96

if not sys.warnoptions:

97

import warnings

98

warnings.simplefilter("default")

99

100

# Try to find the value of SO_BINDTODEVICE:

83

101

try:

102

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

103

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

84

104

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

105

except AttributeError:

86

106

try:

107

# This is where SO_BINDTODEVICE was up to and including Python

108

# 2.6, and also 3.2:

87

109

from IN import SO_BINDTODEVICE

88

110

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

111

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

112

# Try running the C preprocessor:

113

try:

114

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

115

"/dev/stdin"],

116

stdin=subprocess.PIPE,

117

stdout=subprocess.PIPE)

118

stdout = cc.communicate(

119

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

120

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

121

except (OSError, ValueError, IndexError):

122

# No value found

123

SO_BINDTODEVICE = None

124

125

if sys.version_info.major == 2:

126

str = unicode

127

128

if sys.version_info < (3, 2):

129

configparser.Configparser = configparser.SafeConfigParser

130

131

version = "1.8.8"

92

132

stored_state_file = "clients.pickle"

93

133

94

134

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

135

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

136

syslogger = None

98

137

99

138

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

139

if_nametoindex = ctypes.cdll.LoadLibrary(

140

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

103

141

except (OSError, AttributeError):

142

104

143

def if_nametoindex(interface):

105

144

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

106

145

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

107

146

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

108

147

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

148

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

149

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

113

150

return interface_index

114

151

115

152

153

def copy_function(func):

154

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

155

if sys.version_info.major == 2:

156

return types.FunctionType(func.func_code,

157

func.func_globals,

158

func.func_name,

159

func.func_defaults,

160

func.func_closure)

161

else:

162

return types.FunctionType(func.__code__,

163

func.__globals__,

164

func.__name__,

165

func.__defaults__,

166

func.__closure__)

167

168

116

169

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

117

170

"""init logger and add loglevel"""

118

171

172

global syslogger

173

syslogger = (logging.handlers.SysLogHandler(

174

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

175

address="/dev/log"))

119

176

syslogger.setFormatter(logging.Formatter

120

177

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

121

178

' %(message)s'))

122

179

logger.addHandler(syslogger)

123

180

124

181

if debug:

125

182

console = logging.StreamHandler()

126

183

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

136

193

pass

137

194

138

195

139

class PGPEngine(object):

196

class PGPEngine:

140

197

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

198

141

199

def __init__(self):

142

200

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

201

self.gpg = "gpg"

202

try:

203

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

204

for line in output.splitlines():

205

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

206

if name == "gpg":

207

self.gpg = path

208

break

209

except OSError as e:

210

if e.errno != errno.ENOENT:

211

raise

143

212

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

213

'--homedir', self.tempdir,

145

214

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

215

'--quiet']

216

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

217

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

218

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

219

149

220

def __enter__(self):

150

221

return self

151

222

152

223

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

153

224

self._cleanup()

154

225

return False

155

226

156

227

def __del__(self):

157

228

self._cleanup()

158

229

159

230

def _cleanup(self):

160

231

if self.tempdir is not None:

161

232

# Delete contents of tempdir

162

233

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

163

topdown = False):

234

topdown=False):

164

235

for filename in files:

165

236

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

166

237

for dirname in dirs:

168

239

# Remove tempdir

169

240

os.rmdir(self.tempdir)

170

241

self.tempdir = None

171

242

172

243

def password_encode(self, password):

173

244

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

174

245

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

175

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

176

246

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

247

if len(encoded) > 2048:

248

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

249

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

250

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

251

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

252

return encoded

253

177

254

def encrypt(self, data, password):

178

255

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

256

with tempfile.NamedTemporaryFile(

257

dir=self.tempdir) as passfile:

181

258

passfile.write(passphrase)

182

259

passfile.flush()

183

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

260

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

184

261

'--passphrase-file',

185

262

passfile.name]

186

263

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

264

stdin=subprocess.PIPE,

265

stdout=subprocess.PIPE,

266

stderr=subprocess.PIPE)

267

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

191

268

if proc.returncode != 0:

192

269

raise PGPError(err)

193

270

return ciphertext

194

271

195

272

def decrypt(self, data, password):

196

273

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

274

with tempfile.NamedTemporaryFile(

275

dir=self.tempdir) as passfile:

199

276

passfile.write(passphrase)

200

277

passfile.flush()

201

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

278

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

202

279

'--passphrase-file',

203

280

passfile.name]

204

281

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

282

stdin=subprocess.PIPE,

283

stdout=subprocess.PIPE,

284

stderr=subprocess.PIPE)

285

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

210

286

if proc.returncode != 0:

211

287

raise PGPError(err)

212

288

return decrypted_plaintext

213

289

214

290

291

# Pretend that we have an Avahi module

292

class avahi:

293

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

294

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

295

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

296

PROTO_INET = 0 # avahi-common/address.h

297

PROTO_INET6 = 1 # avahi-common/address.h

298

DBUS_NAME = "org.freedesktop.Avahi"

299

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

300

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

301

DBUS_PATH_SERVER = "/"

302

303

@staticmethod

304

def string_array_to_txt_array(t):

305

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

306

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

307

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

308

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

309

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

310

SERVER_INVALID = 0 # avahi-common/defs.h

311

SERVER_REGISTERING = 1 # avahi-common/defs.h

312

SERVER_RUNNING = 2 # avahi-common/defs.h

313

SERVER_COLLISION = 3 # avahi-common/defs.h

314

SERVER_FAILURE = 4 # avahi-common/defs.h

315

316

215

317

class AvahiError(Exception):

216

318

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

217

319

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

320

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

321

**kwargs)

322

221

323

222

324

class AvahiServiceError(AvahiError):

223

325

pass

224

326

327

225

328

class AvahiGroupError(AvahiError):

226

329

pass

227

330

228

331

229

class AvahiService(object):

332

class AvahiService:

230

333

"""An Avahi (Zeroconf) service.

231

334

232

335

Attributes:

233

336

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

234

337

Used to optionally bind to the specified interface.

246

349

server: D-Bus Server

247

350

bus: dbus.SystemBus()

248

351

"""

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

352

353

def __init__(self,

354

interface=avahi.IF_UNSPEC,

355

name=None,

356

servicetype=None,

357

port=None,

358

TXT=None,

359

domain="",

360

host="",

361

max_renames=32768,

362

protocol=avahi.PROTO_UNSPEC,

363

bus=None):

254

364

self.interface = interface

255

365

self.name = name

256

366

self.type = servicetype

265

375

self.server = None

266

376

self.bus = bus

267

377

self.entry_group_state_changed_match = None

268

269

def rename(self):

378

379

def rename(self, remove=True):

270

380

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

271

381

if self.rename_count >= self.max_renames:

272

382

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

273

383

" after %i retries, exiting.",

274

384

self.rename_count)

275

385

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

386

self.name = str(

387

self.server.GetAlternativeServiceName(self.name))

388

self.rename_count += 1

278

389

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

279

390

self.name)

280

self.remove()

391

if remove:

392

self.remove()

281

393

try:

282

394

self.add()

283

395

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

396

if (error.get_dbus_name()

397

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

398

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

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

404

289

405

def remove(self):

290

406

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

291

407

if self.entry_group_state_changed_match is not None:

293

409

self.entry_group_state_changed_match = None

294

410

if self.group is not None:

295

411

self.group.Reset()

296

412

297

413

def add(self):

298

414

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

299

415

self.remove()

316

432

dbus.UInt16(self.port),

317

433

avahi.string_array_to_txt_array(self.TXT))

318

434

self.group.Commit()

319

435

320

436

def entry_group_state_changed(self, state, error):

321

437

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

322

438

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

323

439

324

440

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

441

logger.debug("Zeroconf service established.")

326

442

elif state == avahi.ENTRY_GROUP_COLLISION:

328

444

self.rename()

329

445

elif state == avahi.ENTRY_GROUP_FAILURE:

330

446

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

331

unicode(error))

332

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

333

.format(error))

334

447

str(error))

448

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

449

335

450

def cleanup(self):

336

451

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

337

452

if self.group is not None:

342

457

pass

343

458

self.group = None

344

459

self.remove()

345

460

346

461

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

347

462

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

348

463

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

464

bad_states = {

465

avahi.SERVER_INVALID: "Zeroconf server invalid",

466

avahi.SERVER_REGISTERING: None,

467

avahi.SERVER_COLLISION: "Zeroconf server name collision",

468

avahi.SERVER_FAILURE: "Zeroconf server failure",

469

}

356

470

if state in bad_states:

357

471

if bad_states[state] is not None:

358

472

if error is None:

361

475

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

362

476

self.cleanup()

363

477

elif state == avahi.SERVER_RUNNING:

364

self.add()

478

try:

479

self.add()

480

except dbus.exceptions.DBusException as error:

481

if (error.get_dbus_name()

482

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

483

logger.info("Local Zeroconf service name"

484

" collision.")

485

return self.rename(remove=False)

486

else:

487

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

488

self.cleanup()

489

os._exit(1)

365

490

else:

366

491

if error is None:

367

492

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

368

493

else:

369

494

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

370

495

371

496

def activate(self):

372

497

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

373

498

if self.server is None:

377

502

follow_name_owner_changes=True),

378

503

avahi.DBUS_INTERFACE_SERVER)

379

504

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

505

self.server_state_changed)

381

506

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

382

507

383

508

384

509

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

510

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

386

511

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

512

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

513

syslogger.setFormatter(logging.Formatter(

514

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

515

.format(self.name)))

392

516

return ret

393

517

394

518

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

519

# Pretend that we have a GnuTLS module

520

class gnutls:

521

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

522

523

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

524

if library is None:

525

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

526

_library = ctypes.cdll.LoadLibrary(library)

527

del library

528

529

# Unless otherwise indicated, the constants and types below are

530

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

531

532

# Constants

533

E_SUCCESS = 0

534

E_INTERRUPTED = -52

535

E_AGAIN = -28

536

CRT_OPENPGP = 2

537

CRT_RAWPK = 3

538

CLIENT = 2

539

SHUT_RDWR = 0

540

CRD_CERTIFICATE = 1

541

E_NO_CERTIFICATE_FOUND = -49

542

X509_FMT_DER = 0

543

NO_TICKETS = 1<<10

544

ENABLE_RAWPK = 1<<18

545

CTYPE_PEERS = 3

546

KEYID_USE_SHA256 = 1 # gnutls/x509.h

547

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

548

549

# Types

550

class session_int(ctypes.Structure):

551

_fields_ = []

552

session_t = ctypes.POINTER(session_int)

553

554

class certificate_credentials_st(ctypes.Structure):

555

_fields_ = []

556

certificate_credentials_t = ctypes.POINTER(

557

certificate_credentials_st)

558

certificate_type_t = ctypes.c_int

559

560

class datum_t(ctypes.Structure):

561

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

562

('size', ctypes.c_uint)]

563

564

class openpgp_crt_int(ctypes.Structure):

565

_fields_ = []

566

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

567

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

568

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

569

credentials_type_t = ctypes.c_int

570

transport_ptr_t = ctypes.c_void_p

571

close_request_t = ctypes.c_int

572

573

# Exceptions

574

class Error(Exception):

575

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

576

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

577

# code is passed, convert it to a string with

578

# gnutls.strerror()

579

self.code = code

580

if message is None and code is not None:

581

message = gnutls.strerror(code)

582

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

583

message, *args)

584

585

class CertificateSecurityError(Error):

586

pass

587

588

# Classes

589

class Credentials:

590

def __init__(self):

591

self._c_object = gnutls.certificate_credentials_t()

592

gnutls.certificate_allocate_credentials(

593

ctypes.byref(self._c_object))

594

self.type = gnutls.CRD_CERTIFICATE

595

596

def __del__(self):

597

gnutls.certificate_free_credentials(self._c_object)

598

599

class ClientSession:

600

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

601

self._c_object = gnutls.session_t()

602

gnutls_flags = gnutls.CLIENT

603

if gnutls.check_version(b"3.5.6"):

604

gnutls_flags |= gnutls.NO_TICKETS

605

if gnutls.has_rawpk:

606

gnutls_flags |= gnutls.ENABLE_RAWPK

607

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

608

del gnutls_flags

609

gnutls.set_default_priority(self._c_object)

610

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

611

gnutls.handshake_set_private_extensions(self._c_object,

612

True)

613

self.socket = socket

614

if credentials is None:

615

credentials = gnutls.Credentials()

616

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

617

ctypes.cast(credentials._c_object,

618

ctypes.c_void_p))

619

self.credentials = credentials

620

621

def __del__(self):

622

gnutls.deinit(self._c_object)

623

624

def handshake(self):

625

return gnutls.handshake(self._c_object)

626

627

def send(self, data):

628

data = bytes(data)

629

data_len = len(data)

630

while data_len > 0:

631

data_len -= gnutls.record_send(self._c_object,

632

data[-data_len:],

633

data_len)

634

635

def bye(self):

636

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

637

638

# Error handling functions

639

def _error_code(result):

640

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

641

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

642

if result >= 0:

643

return result

644

if result == gnutls.E_NO_CERTIFICATE_FOUND:

645

raise gnutls.CertificateSecurityError(code=result)

646

raise gnutls.Error(code=result)

647

648

def _retry_on_error(result, func, arguments):

649

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

650

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

651

while result < 0:

652

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

653

return _error_code(result)

654

result = func(*arguments)

655

return result

656

657

# Unless otherwise indicated, the function declarations below are

658

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

659

660

# Functions

661

priority_set_direct = _library.gnutls_priority_set_direct

662

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

663

ctypes.POINTER(ctypes.c_char_p)]

664

priority_set_direct.restype = _error_code

665

666

init = _library.gnutls_init

667

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

668

init.restype = _error_code

669

670

set_default_priority = _library.gnutls_set_default_priority

671

set_default_priority.argtypes = [session_t]

672

set_default_priority.restype = _error_code

673

674

record_send = _library.gnutls_record_send

675

record_send.argtypes = [session_t, ctypes.c_void_p,

676

ctypes.c_size_t]

677

record_send.restype = ctypes.c_ssize_t

678

record_send.errcheck = _retry_on_error

679

680

certificate_allocate_credentials = (

681

_library.gnutls_certificate_allocate_credentials)

682

certificate_allocate_credentials.argtypes = [

683

ctypes.POINTER(certificate_credentials_t)]

684

certificate_allocate_credentials.restype = _error_code

685

686

certificate_free_credentials = (

687

_library.gnutls_certificate_free_credentials)

688

certificate_free_credentials.argtypes = [

689

certificate_credentials_t]

690

certificate_free_credentials.restype = None

691

692

handshake_set_private_extensions = (

693

_library.gnutls_handshake_set_private_extensions)

694

handshake_set_private_extensions.argtypes = [session_t,

695

ctypes.c_int]

696

handshake_set_private_extensions.restype = None

697

698

credentials_set = _library.gnutls_credentials_set

699

credentials_set.argtypes = [session_t, credentials_type_t,

700

ctypes.c_void_p]

701

credentials_set.restype = _error_code

702

703

strerror = _library.gnutls_strerror

704

strerror.argtypes = [ctypes.c_int]

705

strerror.restype = ctypes.c_char_p

706

707

certificate_type_get = _library.gnutls_certificate_type_get

708

certificate_type_get.argtypes = [session_t]

709

certificate_type_get.restype = _error_code

710

711

certificate_get_peers = _library.gnutls_certificate_get_peers

712

certificate_get_peers.argtypes = [session_t,

713

ctypes.POINTER(ctypes.c_uint)]

714

certificate_get_peers.restype = ctypes.POINTER(datum_t)

715

716

global_set_log_level = _library.gnutls_global_set_log_level

717

global_set_log_level.argtypes = [ctypes.c_int]

718

global_set_log_level.restype = None

719

720

global_set_log_function = _library.gnutls_global_set_log_function

721

global_set_log_function.argtypes = [log_func]

722

global_set_log_function.restype = None

723

724

deinit = _library.gnutls_deinit

725

deinit.argtypes = [session_t]

726

deinit.restype = None

727

728

handshake = _library.gnutls_handshake

729

handshake.argtypes = [session_t]

730

handshake.restype = _error_code

731

handshake.errcheck = _retry_on_error

732

733

transport_set_ptr = _library.gnutls_transport_set_ptr

734

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

735

transport_set_ptr.restype = None

736

737

bye = _library.gnutls_bye

738

bye.argtypes = [session_t, close_request_t]

739

bye.restype = _error_code

740

bye.errcheck = _retry_on_error

741

742

check_version = _library.gnutls_check_version

743

check_version.argtypes = [ctypes.c_char_p]

744

check_version.restype = ctypes.c_char_p

745

746

_need_version = b"3.3.0"

747

if check_version(_need_version) is None:

748

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

749

.format(_need_version))

750

751

_tls_rawpk_version = b"3.6.6"

752

has_rawpk = bool(check_version(_tls_rawpk_version))

753

754

if has_rawpk:

755

# Types

756

class pubkey_st(ctypes.Structure):

757

_fields = []

758

pubkey_t = ctypes.POINTER(pubkey_st)

759

760

x509_crt_fmt_t = ctypes.c_int

761

762

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

763

pubkey_init = _library.gnutls_pubkey_init

764

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

765

pubkey_init.restype = _error_code

766

767

pubkey_import = _library.gnutls_pubkey_import

768

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

769

x509_crt_fmt_t]

770

pubkey_import.restype = _error_code

771

772

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

773

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

774

ctypes.POINTER(ctypes.c_ubyte),

775

ctypes.POINTER(ctypes.c_size_t)]

776

pubkey_get_key_id.restype = _error_code

777

778

pubkey_deinit = _library.gnutls_pubkey_deinit

779

pubkey_deinit.argtypes = [pubkey_t]

780

pubkey_deinit.restype = None

781

else:

782

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

783

784

openpgp_crt_init = _library.gnutls_openpgp_crt_init

785

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

786

openpgp_crt_init.restype = _error_code

787

788

openpgp_crt_import = _library.gnutls_openpgp_crt_import

789

openpgp_crt_import.argtypes = [openpgp_crt_t,

790

ctypes.POINTER(datum_t),

791

openpgp_crt_fmt_t]

792

openpgp_crt_import.restype = _error_code

793

794

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

795

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

796

ctypes.POINTER(ctypes.c_uint)]

797

openpgp_crt_verify_self.restype = _error_code

798

799

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

800

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

801

openpgp_crt_deinit.restype = None

802

803

openpgp_crt_get_fingerprint = (

804

_library.gnutls_openpgp_crt_get_fingerprint)

805

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

806

ctypes.c_void_p,

807

ctypes.POINTER(

808

ctypes.c_size_t)]

809

openpgp_crt_get_fingerprint.restype = _error_code

810

811

if check_version(b"3.6.4"):

812

certificate_type_get2 = _library.gnutls_certificate_type_get2

813

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

814

certificate_type_get2.restype = _error_code

815

816

# Remove non-public functions

817

del _error_code, _retry_on_error

818

819

820

def call_pipe(connection, # : multiprocessing.Connection

821

func, *args, **kwargs):

822

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

823

824

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

825

return value on the provided multiprocessing.Connection.

826

"""

827

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

828

connection.close()

829

830

831

class Client:

403

832

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

404

833

405

834

Attributes:

406

835

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

407

836

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

408

837

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

838

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

839

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

840

running.

841

checker_callback_tag: a GLib event source tag, or None

413

842

checker_command: string; External command which is run to check

414

843

if client lives. %() expansions are done at

415

844

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

416

845

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

417

checker_initiator_tag: a gobject event source tag, or None

846

checker_initiator_tag: a GLib event source tag, or None

418

847

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

419

848

client_structure: Object describing what attributes a client has

420

849

and is used for storing the client at exit

421

850

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

851

disable_initiator_tag: a GLib event source tag, or None

423

852

enabled: bool()

424

853

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

425

uniquely identify the client

854

uniquely identify an OpenPGP client

855

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

856

a client using raw public keys

426

857

host: string; available for use by the checker command

427

858

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

428

859

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

430

861

last_checker_status: integer between 0 and 255 reflecting exit

431

862

status of last checker. -1 reflects crashed

432

863

checker, -2 means no checker completed yet.

864

last_checker_signal: The signal which killed the last checker, if

865

last_checker_status is -1

433

866

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

434

867

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

435

868

D-Bus identifiers

442

875

disabled, or None

443

876

server_settings: The server_settings dict from main()

444

877

"""

445

878

446

879

runtime_expansions = ("approval_delay", "approval_duration",

447

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

880

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

448

881

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

449

882

"last_approval_request", "last_checked_ok",

450

883

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

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

884

client_defaults = {

885

"timeout": "PT5M",

886

"extended_timeout": "PT15M",

887

"interval": "PT2M",

888

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

889

"host": "",

890

"approval_delay": "PT0S",

891

"approval_duration": "PT1S",

892

"approved_by_default": "True",

893

"enabled": "True",

894

}

895

477

896

@staticmethod

478

897

def config_parser(config):

479

898

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

486

905

for client_name in config.sections():

487

906

section = dict(config.items(client_name))

488

907

client = settings[client_name] = {}

489

908

490

909

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

491

910

# Reformat values from string types to Python types

492

911

client["approved_by_default"] = config.getboolean(

493

912

client_name, "approved_by_default")

494

913

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

495

914

"enabled")

496

915

916

# Uppercase and remove spaces from key_id and fingerprint

917

# for later comparison purposes with return value from the

918

# key_id() and fingerprint() functions

919

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

920

.replace(" ", ""))

497

921

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

498

922

.replace(" ", ""))

499

923

if "secret" in section:

500

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

924

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

925

.encode("utf-8"),

926

"base64")

501

927

elif "secfile" in section:

502

928

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

503

929

(section["secfile"])),

504

930

"rb") as secfile:

505

931

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

506

932

else:

507

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

933

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

508

934

.format(section))

509

935

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

510

936

client["extended_timeout"] = string_to_delta(

518

944

client["last_approval_request"] = None

519

945

client["last_checked_ok"] = None

520

946

client["last_checker_status"] = -2

521

947

522

948

return settings

523

524

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

949

950

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

525

951

self.name = name

526

952

if server_settings is None:

527

953

server_settings = {}

528

954

self.server_settings = server_settings

529

955

# adding all client settings

530

for setting, value in settings.iteritems():

956

for setting, value in settings.items():

531

957

setattr(self, setting, value)

532

958

533

959

if self.enabled:

534

960

if not hasattr(self, "last_enabled"):

535

961

self.last_enabled = datetime.datetime.utcnow()

539

965

else:

540

966

self.last_enabled = None

541

967

self.expires = None

542

968

543

969

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

970

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

547

971

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

548

972

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

549

973

datetime.datetime.utcnow())

550

974

551

975

# attributes specific for this server instance

552

976

self.checker = None

553

977

self.checker_initiator_tag = None

556

980

self.current_checker_command = None

557

981

self.approved = None

558

982

self.approvals_pending = 0

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

983

self.changedstate = multiprocessing_manager.Condition(

984

multiprocessing_manager.Lock())

985

self.client_structure = [attr

986

for attr in self.__dict__.keys()

564

987

if not attr.startswith("_")]

565

988

self.client_structure.append("client_structure")

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

989

990

for name, t in inspect.getmembers(

991

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

571

992

if not name.startswith("_"):

572

993

self.client_structure.append(name)

573

994

574

995

# Send notice to process children that client state has changed

575

996

def send_changedstate(self):

576

997

with self.changedstate:

577

998

self.changedstate.notify_all()

578

999

579

1000

def enable(self):

580

1001

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

581

1002

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

586

1007

self.last_enabled = datetime.datetime.utcnow()

587

1008

self.init_checker()

588

1009

self.send_changedstate()

589

1010

590

1011

def disable(self, quiet=True):

591

1012

"""Disable this client."""

592

1013

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

594

1015

if not quiet:

595

1016

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

596

1017

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

597

gobject.source_remove(self.disable_initiator_tag)

1018

GLib.source_remove(self.disable_initiator_tag)

598

1019

self.disable_initiator_tag = None

599

1020

self.expires = None

600

1021

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

601

gobject.source_remove(self.checker_initiator_tag)

1022

GLib.source_remove(self.checker_initiator_tag)

602

1023

self.checker_initiator_tag = None

603

1024

self.stop_checker()

604

1025

self.enabled = False

605

1026

if not quiet:

606

1027

self.send_changedstate()

607

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

1028

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

608

1029

return False

609

1030

610

1031

def __del__(self):

611

1032

self.disable()

612

1033

613

1034

def init_checker(self):

614

1035

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

615

1036

# and every interval from then on.

616

1037

if self.checker_initiator_tag is not None:

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

1038

GLib.source_remove(self.checker_initiator_tag)

1039

self.checker_initiator_tag = GLib.timeout_add(

1040

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

1041

self.start_checker)

621

1042

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

622

1043

if self.disable_initiator_tag is not None:

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

627

1047

# Also start a new checker *right now*.

628

1048

self.start_checker()

629

630

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

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

631

1052

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

self.checker.join()

632

1057

self.checker_callback_tag = None

633

1058

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1059

1060

if returncode >= 0:

1061

self.last_checker_status = returncode

1062

self.last_checker_signal = None

636

1063

if self.last_checker_status == 0:

637

1064

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

638

1065

vars(self))

639

1066

self.checked_ok()

640

1067

else:

641

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

642

vars(self))

1068

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

643

1069

else:

644

1070

self.last_checker_status = -1

1071

self.last_checker_signal = -returncode

645

1072

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

646

1073

vars(self))

647

1074

return False

1075

648

1076

def checked_ok(self):

649

1077

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

650

1078

self.last_checked_ok = datetime.datetime.utcnow()

651

1079

self.last_checker_status = 0

1080

self.last_checker_signal = None

652

1081

self.bump_timeout()

653

1082

654

1083

def bump_timeout(self, timeout=None):

655

1084

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

656

1085

if timeout is None:

657

1086

timeout = self.timeout

658

1087

if self.disable_initiator_tag is not None:

659

gobject.source_remove(self.disable_initiator_tag)

1088

GLib.source_remove(self.disable_initiator_tag)

660

1089

self.disable_initiator_tag = None

661

1090

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1091

self.disable_initiator_tag = GLib.timeout_add(

1092

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

665

1093

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

666

1094

667

1095

def need_approval(self):

668

1096

self.last_approval_request = datetime.datetime.utcnow()

669

1097

670

1098

def start_checker(self):

671

1099

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

672

1100

673

1101

If a checker already exists, leave it running and do

674

1102

nothing."""

675

1103

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

680

1108

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

681

1109

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

682

1110

# should be.

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1111

1112

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

1113

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

1114

self.checker.join()

1115

self.checker = None

697

1116

# Start a new checker if needed

698

1117

if self.checker is None:

699

1118

# Escape attributes for the shell

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1119

escaped_attrs = {

1120

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

1121

for attr in self.runtime_expansions}

704

1122

try:

705

1123

command = self.checker_command % escaped_attrs

706

1124

except TypeError as error:

707

1125

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1126

self.checker_command,

1127

exc_info=error)

1128

return True # Try again later

710

1129

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1130

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

1131

self.name)

1132

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

1133

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

1134

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

1135

# always replaced by /dev/null.)

1136

# The exception is when not debugging but nevertheless

1137

# running in the foreground; use the previously

1138

# created wnull.

1139

popen_args = {"close_fds": True,

1140

"shell": True,

1141

"cwd": "/"}

1142

if (not self.server_settings["debug"]

1143

and self.server_settings["foreground"]):

1144

popen_args.update({"stdout": wnull,

1145

"stderr": wnull})

1146

pipe = multiprocessing.Pipe(duplex=False)

1147

self.checker = multiprocessing.Process(

1148

target=call_pipe,

1149

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

1150

kwargs=popen_args)

1151

self.checker.start()

1152

self.checker_callback_tag = GLib.io_add_watch(

1153

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

1154

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1155

self.checker_callback, pipe[0], command)

1156

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

753

1157

return True

754

1158

755

1159

def stop_checker(self):

756

1160

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

757

1161

if self.checker_callback_tag:

758

gobject.source_remove(self.checker_callback_tag)

1162

GLib.source_remove(self.checker_callback_tag)

759

1163

self.checker_callback_tag = None

760

1164

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

761

1165

return

762

1166

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1167

self.checker.terminate()

771

1168

self.checker = None

772

1169

773

1170

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1171

def dbus_service_property(dbus_interface,

1172

signature="v",

1173

access="readwrite",

1174

byte_arrays=False):

776

1175

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1176

become properties on the D-Bus.

778

1177

779

1178

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

780

1179

and with one argument by "Set".

781

1180

782

1181

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

783

1182

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

784

1183

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

787

1186

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

788

1187

if byte_arrays and signature != "ay":

789

1188

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

790

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

1189

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

1190

791

1191

def decorator(func):

792

1192

func._dbus_is_property = True

793

1193

func._dbus_interface = dbus_interface

796

1196

func._dbus_name = func.__name__

797

1197

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

798

1198

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

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1199

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

800

1200

return func

1201

801

1202

return decorator

802

1203

803

1204

804

1205

def dbus_interface_annotations(dbus_interface):

805

1206

"""Decorator for marking functions returning interface annotations

806

1207

807

1208

Usage:

808

1209

809

1210

@dbus_interface_annotations("org.example.Interface")

810

1211

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

811

1212

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

812

1213

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

813

1214

"false"}

814

1215

"""

1216

815

1217

def decorator(func):

816

1218

func._dbus_is_interface = True

817

1219

func._dbus_interface = dbus_interface

818

1220

func._dbus_name = dbus_interface

819

1221

return func

1222

820

1223

return decorator

821

1224

822

1225

823

1226

def dbus_annotations(annotations):

824

1227

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

825

1228

Usage:

826

1229

1230

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

1231

"org.freedesktop.DBus.Property."

1232

"EmitsChangedSignal": "false"})

827

1233

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

828

1234

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1235

def Property_dbus_property(self):

833

1236

return dbus.Boolean(False)

1237

1238

See also the DBusObjectWithAnnotations class.

834

1239

"""

1240

835

1241

def decorator(func):

836

1242

func._dbus_annotations = annotations

837

1243

return func

1244

838

1245

return decorator

839

1246

840

1247

841

1248

class DBusPropertyException(dbus.exceptions.DBusException):

842

1249

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

843

1250

"""

844

def __unicode__(self):

845

return unicode(str(self))

1251

pass

846

1252

847

1253

848

1254

class DBusPropertyAccessException(DBusPropertyException):

857

1263

pass

858

1264

859

1265

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1266

class DBusObjectWithAnnotations(dbus.service.Object):

1267

"""A D-Bus object with annotations.

1268

1269

Classes inheriting from this can use the dbus_annotations

1270

decorator to add annotations to methods or signals.

866

1271

"""

867

1272

868

1273

@staticmethod

869

1274

def _is_dbus_thing(thing):

870

1275

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

871

1276

872

1277

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

873

1278

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

874

1279

"""

875

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

1280

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

876

1281

False)

877

1282

878

1283

def _get_all_dbus_things(self, thing):

879

1284

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

880

1285

"""

881

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

882

name),

1286

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

883

1287

athing.__get__(self))

884

1288

for cls in self.__class__.__mro__

885

1289

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1290

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

1291

1292

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1293

out_signature="s",

1294

path_keyword='object_path',

1295

connection_keyword='connection')

1296

def Introspect(self, object_path, connection):

1297

"""Overloading of standard D-Bus method.

1298

1299

Inserts annotation tags on methods and signals.

1300

"""

1301

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

1302

connection)

1303

try:

1304

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

1305

1306

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

1307

# Add annotation tags

1308

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

1309

for tag in if_tag.getElementsByTagName(typ):

1310

annots = dict()

1311

for name, prop in (self.

1312

_get_all_dbus_things(typ)):

1313

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

1314

and prop._dbus_interface

1315

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

1316

annots.update(getattr(

1317

prop, "_dbus_annotations", {}))

1318

for name, value in annots.items():

1319

ann_tag = document.createElement(

1320

"annotation")

1321

ann_tag.setAttribute("name", name)

1322

ann_tag.setAttribute("value", value)

1323

tag.appendChild(ann_tag)

1324

# Add interface annotation tags

1325

for annotation, value in dict(

1326

itertools.chain.from_iterable(

1327

annotations().items()

1328

for name, annotations

1329

in self._get_all_dbus_things("interface")

1330

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

1331

)).items():

1332

ann_tag = document.createElement("annotation")

1333

ann_tag.setAttribute("name", annotation)

1334

ann_tag.setAttribute("value", value)

1335

if_tag.appendChild(ann_tag)

1336

# Fix argument name for the Introspect method itself

1337

if (if_tag.getAttribute("name")

1338

== dbus.INTROSPECTABLE_IFACE):

1339

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

1340

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

1341

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

1342

if (arg.getAttribute("direction")

1343

== "out"):

1344

arg.setAttribute("name",

1345

"xml_data")

1346

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

1347

document.unlink()

1348

except (AttributeError, xml.dom.DOMException,

1349

xml.parsers.expat.ExpatError) as error:

1350

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

1351

exc_info=error)

1352

return xmlstring

1353

1354

1355

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1356

"""A D-Bus object with properties.

1357

1358

Classes inheriting from this can use the dbus_service_property

1359

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

1360

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

1361

"""

1362

889

1363

def _get_dbus_property(self, interface_name, property_name):

890

1364

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

891

1365

property with the specified name and interface.

892

1366

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1367

for cls in self.__class__.__mro__:

1368

for name, value in inspect.getmembers(

1369

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

897

1370

if (value._dbus_name == property_name

898

1371

and value._dbus_interface == interface_name):

899

1372

return value.__get__(self)

900

1373

901

1374

# No such property

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1375

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

1376

self.dbus_object_path, interface_name, property_name))

1377

1378

@classmethod

1379

def _get_all_interface_names(cls):

1380

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

1381

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

1382

"_dbus_interface", None)

1383

for x in (inspect.getmro(cls))

1384

for attr in dir(x))

1385

if name is not None)

1386

1387

@dbus.service.method(dbus.PROPERTIES_IFACE,

1388

in_signature="ss",

907

1389

out_signature="v")

908

1390

def Get(self, interface_name, property_name):

909

1391

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

915

1397

if not hasattr(value, "variant_level"):

916

1398

return value

917

1399

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

918

1400

919

1401

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

920

1402

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

921

1403

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

927

1409

# The byte_arrays option is not supported yet on

928

1410

# signatures other than "ay".

929

1411

if prop._dbus_signature != "ay":

930

raise ValueError

1412

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

1413

"'ay' signature {!r}"

1414

.format(prop._dbus_signature))

931

1415

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

932

1416

for byte in value))

933

1417

prop(value)

934

935

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

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

936

1421

out_signature="a{sv}")

937

1422

def GetAll(self, interface_name):

938

1423

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

939

1424

standard.

940

1425

941

1426

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

942

1427

"""

943

1428

properties = {}

953

1438

if not hasattr(value, "variant_level"):

954

1439

properties[name] = value

955

1440

continue

956

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

957

value.variant_level+1)

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

958

1443

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

959

1444

1445

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

1446

def PropertiesChanged(self, interface_name, changed_properties,

1447

invalidated_properties):

1448

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

1449

standard.

1450

"""

1451

pass

1452

960

1453

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1454

out_signature="s",

962

1455

path_keyword='object_path',

963

1456

connection_keyword='connection')

964

1457

def Introspect(self, object_path, connection):

965

1458

"""Overloading of standard D-Bus method.

966

1459

967

1460

Inserts property tags and interface annotation tags.

968

1461

"""

969

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

970

connection)

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

971

1465

try:

972

1466

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

1467

973

1468

def make_tag(document, name, prop):

974

1469

e = document.createElement("property")

975

1470

e.setAttribute("name", name)

976

1471

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

977

1472

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

978

1473

return e

1474

979

1475

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

980

1476

# Add property tags

981

1477

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

984

1480

if prop._dbus_interface

985

1481

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

986

1482

if_tag.appendChild(tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

1018

1499

# Add the names to the return values for the

1019

1500

# "org.freedesktop.DBus.Properties" methods

1020

1501

if (if_tag.getAttribute("name")

1039

1520

return xmlstring

1040

1521

1041

1522

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1042

1594

def datetime_to_dbus(dt, variant_level=0):

1043

1595

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

1044

1596

if dt is None:

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1597

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

1598

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

1048

1599

1049

1600

1050

1601

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1052

1603

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

1053

1604

interface names according to the "alt_interface_names" mapping.

1054

1605

Usage:

1055

1606

1056

1607

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

1057

1608

"net.example.AlternateInterface"})

1058

1609

class SampleDBusObject(dbus.service.Object):

1059

1610

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

1060

1611

def SampleDBusMethod():

1061

1612

pass

1062

1613

1063

1614

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

1615

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

1065

1616

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

1066

1617

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

1067

1618

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

1068

1619

1069

1620

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

1070

1621

(from DBusObjectWithProperties) and interfaces (from the

1071

1622

dbus_interface_annotations decorator).

1072

1623

"""

1624

1073

1625

def wrapper(cls):

1074

1626

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1627

alt_interface_names.items()):

1076

1628

attr = {}

1077

1629

interface_names = set()

1078

1630

# Go though all attributes of the class

1080

1632

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

1081

1633

# with the wrong interface name

1082

1634

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1085

1637

continue

1086

1638

# Create an alternate D-Bus interface name based on

1087

1639

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1091

1642

interface_names.add(alt_interface)

1092

1643

# Is this a D-Bus signal?

1093

1644

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

1094

1645

# Extract the original non-method undecorated

1095

1646

# function by black magic

1096

nonmethod_func = (dict(

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1097

1649

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1100

1657

# Create a new, but exactly alike, function

1101

1658

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

1102

1659

# with the alternate D-Bus interface name

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

1112

1664

# Copy annotations, if any

1113

1665

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1116

1668

except AttributeError:

1117

1669

pass

1670

1118

1671

# Define a creator of a function to call both the

1119

1672

# original and alternate functions, so both the

1120

1673

# original and alternate signals gets sent when

1123

1676

"""This function is a scope container to pass

1124

1677

func1 and func2 to the "call_both" function

1125

1678

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1126

1681

def call_both(*args, **kwargs):

1127

1682

"""This function will emit two D-Bus

1128

1683

signals by calling func1 and func2"""

1129

1684

func1(*args, **kwargs)

1130

1685

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1131

1692

return call_both

1132

1693

# Create the "call_both" function and add it to

1133

1694

# the class

1138

1699

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

1139

1700

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

1140

1701

# to the class.

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

1151

1708

# Copy annotations, if any

1152

1709

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1155

1712

except AttributeError:

1156

1713

pass

1157

1714

# Is this a D-Bus property?

1160

1717

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

1161

1718

# property with the alternate D-Bus interface

1162

1719

# name. Add it to the class.

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

1176

1726

# Copy annotations, if any

1177

1727

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1180

1730

except AttributeError:

1181

1731

pass

1182

1732

# Is this a D-Bus interface?

1185

1735

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

1186

1736

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

1187

1737

# to the class.

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1196

1741

if deprecate:

1197

1742

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1199

1744

for interface_name in interface_names:

1745

1200

1746

@dbus_interface_annotations(interface_name)

1201

1747

def func(self):

1202

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

1203

"true" }

1748

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

1749

"true"}

1204

1750

# Find an unused name

1205

1751

for aname in (iname.format(i)

1206

1752

for i in itertools.count()):

1210

1756

if interface_names:

1211

1757

# Replace the class with a new subclass of it with

1212

1758

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1215

1765

return cls

1766

1216

1767

return wrapper

1217

1768

1218

1769

1219

1770

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

1220

"se.bsnet.fukt.Mandos"})

1771

"se.bsnet.fukt.Mandos"})

1221

1772

class ClientDBus(Client, DBusObjectWithProperties):

1222

1773

"""A Client class using D-Bus

1223

1774

1224

1775

Attributes:

1225

1776

dbus_object_path: dbus.ObjectPath

1226

1777

bus: dbus.SystemBus()

1227

1778

"""

1228

1779

1229

1780

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1231

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1232

1785

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

1233

1234

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

1786

1787

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

1235

1788

self.bus = bus

1236

1789

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

1237

1790

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

1238

1791

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1792

client_object_name = str(self.name).translate(

1240

1793

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

1241

1794

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1244

1797

DBusObjectWithProperties.__init__(self, self.bus,

1245

1798

self.dbus_object_path)

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1804

_interface=_interface):

1250

1805

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

1251

1806

its changes to DBus.

1252

1807

1253

1808

transform_fun: Function that takes a value and a variant_level

1254

1809

and transforms it to a D-Bus type.

1255

1810

dbus_name: D-Bus name of the variable

1257

1812

to the D-Bus. Default: no transform

1258

1813

variant_level: D-Bus variant level. Default: 1

1259

1814

"""

1260

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

1815

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

1816

1261

1817

def setter(self, value):

1262

1818

if hasattr(self, "dbus_object_path"):

1263

1819

if (not hasattr(self, attrname) or

1264

1820

type_func(getattr(self, attrname, None))

1265

1821

!= type_func(value)):

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1822

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1826

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1830

self.PropertyChanged(dbus.String(dbus_name),

1831

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1271

1837

setattr(self, attrname, value)

1272

1838

1273

1839

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

1274

1840

1275

1841

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1276

1842

approvals_pending = notifychangeproperty(dbus.Boolean,

1277

1843

"ApprovalPending",

1278

type_func = bool)

1844

type_func=bool)

1279

1845

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

1280

1846

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1847

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1285

1851

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1852

"LastCheckedOK")

1287

1853

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1856

datetime_to_dbus, "LastApprovalRequest")

1291

1857

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1858

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1297

1862

approval_duration = notifychangeproperty(

1298

1863

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1864

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

1300

1865

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1304

1869

extended_timeout = notifychangeproperty(

1305

1870

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

1311

1875

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

1312

1876

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

1877

invalidate_only=True)

1878

1313

1879

del notifychangeproperty

1314

1880

1315

1881

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

1316

1882

try:

1317

1883

self.remove_from_connection()

1320

1886

if hasattr(DBusObjectWithProperties, "__del__"):

1321

1887

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

1322

1888

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

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

1330

1897

# Emit D-Bus signal

1331

1898

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1333

1901

dbus.String(command))

1334

1902

else:

1335

1903

# Emit D-Bus signal

1336

1904

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

1337

dbus.Int64(condition),

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1338

1909

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1342

1910

return ret

1911

1343

1912

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1913

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

1349

1914

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

1350

1915

# Only if new checker process was started

1351

1916

if (self.checker is not None

1353

1918

# Emit D-Bus signal

1354

1919

self.CheckerStarted(self.current_checker_command)

1355

1920

return r

1356

1921

1357

1922

def _reset_approved(self):

1358

1923

self.approved = None

1359

1924

return False

1360

1925

1361

1926

def approve(self, value=True):

1362

1927

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1928

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

1929

* 1000), self._reset_approved)

1366

1930

self.send_changedstate()

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1380

1938

# CheckerCompleted - signal

1381

1939

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

1382

1940

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

1383

1941

"D-Bus signal"

1384

1942

pass

1385

1943

1386

1944

# CheckerStarted - signal

1387

1945

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

1388

1946

def CheckerStarted(self, command):

1389

1947

"D-Bus signal"

1390

1948

pass

1391

1949

1392

1950

# PropertyChanged - signal

1951

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

1393

1952

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

1394

1953

def PropertyChanged(self, property, value):

1395

1954

"D-Bus signal"

1396

1955

pass

1397

1956

1398

1957

# GotSecret - signal

1399

1958

@dbus.service.signal(_interface)

1400

1959

def GotSecret(self):

1403

1962

server to mandos-client

1404

1963

"""

1405

1964

pass

1406

1965

1407

1966

# Rejected - signal

1408

1967

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

1409

1968

def Rejected(self, reason):

1410

1969

"D-Bus signal"

1411

1970

pass

1412

1971

1413

1972

# NeedApproval - signal

1414

1973

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

1415

1974

def NeedApproval(self, timeout, default):

1416

1975

"D-Bus signal"

1417

1976

return self.need_approval()

1418

1419

## Methods

1420

1977

1978

# Methods

1979

1421

1980

# Approve - method

1422

1981

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

1423

1982

def Approve(self, value):

1424

1983

self.approve(value)

1425

1984

1426

1985

# CheckedOK - method

1427

1986

@dbus.service.method(_interface)

1428

1987

def CheckedOK(self):

1429

1988

self.checked_ok()

1430

1989

1431

1990

# Enable - method

1991

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

1432

1992

@dbus.service.method(_interface)

1433

1993

def Enable(self):

1434

1994

"D-Bus method"

1435

1995

self.enable()

1436

1996

1437

1997

# StartChecker - method

1998

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

1438

1999

@dbus.service.method(_interface)

1439

2000

def StartChecker(self):

1440

2001

"D-Bus method"

1441

2002

self.start_checker()

1442

2003

1443

2004

# Disable - method

2005

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

1444

2006

@dbus.service.method(_interface)

1445

2007

def Disable(self):

1446

2008

"D-Bus method"

1447

2009

self.disable()

1448

2010

1449

2011

# StopChecker - method

2012

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

1450

2013

@dbus.service.method(_interface)

1451

2014

def StopChecker(self):

1452

2015

self.stop_checker()

1453

1454

## Properties

1455

2016

2017

# Properties

2018

1456

2019

# ApprovalPending - property

1457

2020

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

1458

2021

def ApprovalPending_dbus_property(self):

1459

2022

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

1460

2023

1461

2024

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

2025

@dbus_service_property(_interface,

2026

signature="b",

1463

2027

access="readwrite")

1464

2028

def ApprovedByDefault_dbus_property(self, value=None):

1465

2029

if value is None: # get

1466

2030

return dbus.Boolean(self.approved_by_default)

1467

2031

self.approved_by_default = bool(value)

1468

2032

1469

2033

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

2034

@dbus_service_property(_interface,

2035

signature="t",

1471

2036

access="readwrite")

1472

2037

def ApprovalDelay_dbus_property(self, value=None):

1473

2038

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2039

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

2040

* 1000)

1475

2041

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

1476

2042

1477

2043

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

2044

@dbus_service_property(_interface,

2045

signature="t",

1479

2046

access="readwrite")

1480

2047

def ApprovalDuration_dbus_property(self, value=None):

1481

2048

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2049

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

2050

* 1000)

1484

2051

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

1485

2052

1486

2053

# Name - property

2054

@dbus_annotations(

2055

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

1487

2056

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

1488

2057

def Name_dbus_property(self):

1489

2058

return dbus.String(self.name)

1490

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1491

2067

# Fingerprint - property

2068

@dbus_annotations(

2069

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

1492

2070

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

1493

2071

def Fingerprint_dbus_property(self):

1494

2072

return dbus.String(self.fingerprint)

1495

2073

1496

2074

# Host - property

1497

@dbus_service_property(_interface, signature="s",

2075

@dbus_service_property(_interface,

2076

signature="s",

1498

2077

access="readwrite")

1499

2078

def Host_dbus_property(self, value=None):

1500

2079

if value is None: # get

1501

2080

return dbus.String(self.host)

1502

self.host = unicode(value)

1503

2081

self.host = str(value)

2082

1504

2083

# Created - property

2084

@dbus_annotations(

2085

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

1505

2086

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

1506

2087

def Created_dbus_property(self):

1507

2088

return datetime_to_dbus(self.created)

1508

2089

1509

2090

# LastEnabled - property

1510

2091

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

1511

2092

def LastEnabled_dbus_property(self):

1512

2093

return datetime_to_dbus(self.last_enabled)

1513

2094

1514

2095

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

2096

@dbus_service_property(_interface,

2097

signature="b",

1516

2098

access="readwrite")

1517

2099

def Enabled_dbus_property(self, value=None):

1518

2100

if value is None: # get

1521

2103

self.enable()

1522

2104

else:

1523

2105

self.disable()

1524

2106

1525

2107

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

2108

@dbus_service_property(_interface,

2109

signature="s",

1527

2110

access="readwrite")

1528

2111

def LastCheckedOK_dbus_property(self, value=None):

1529

2112

if value is not None:

1530

2113

self.checked_ok()

1531

2114

return

1532

2115

return datetime_to_dbus(self.last_checked_ok)

1533

2116

1534

2117

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2118

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

1537

2119

def LastCheckerStatus_dbus_property(self):

1538

2120

return dbus.Int16(self.last_checker_status)

1539

2121

1540

2122

# Expires - property

1541

2123

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

1542

2124

def Expires_dbus_property(self):

1543

2125

return datetime_to_dbus(self.expires)

1544

2126

1545

2127

# LastApprovalRequest - property

1546

2128

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

1547

2129

def LastApprovalRequest_dbus_property(self):

1548

2130

return datetime_to_dbus(self.last_approval_request)

1549

2131

1550

2132

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

2133

@dbus_service_property(_interface,

2134

signature="t",

1552

2135

access="readwrite")

1553

2136

def Timeout_dbus_property(self, value=None):

1554

2137

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

2138

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

1556

2139

old_timeout = self.timeout

1557

2140

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

1558

2141

# Reschedule disabling

1566

2149

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

1567

2150

is None):

1568

2151

return

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

1575

2157

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2158

@dbus_service_property(_interface,

2159

signature="t",

1577

2160

access="readwrite")

1578

2161

def ExtendedTimeout_dbus_property(self, value=None):

1579

2162

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2163

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

2164

* 1000)

1581

2165

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

1582

2166

1583

2167

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2168

@dbus_service_property(_interface,

2169

signature="t",

1585

2170

access="readwrite")

1586

2171

def Interval_dbus_property(self, value=None):

1587

2172

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2173

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

1589

2174

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

1590

2175

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

1591

2176

return

1592

2177

if self.enabled:

1593

2178

# Reschedule checker run

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

1599

2184

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2185

@dbus_service_property(_interface,

2186

signature="s",

1601

2187

access="readwrite")

1602

2188

def Checker_dbus_property(self, value=None):

1603

2189

if value is None: # get

1604

2190

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

1606

2191

self.checker_command = str(value)

2192

1607

2193

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2194

@dbus_service_property(_interface,

2195

signature="b",

1609

2196

access="readwrite")

1610

2197

def CheckerRunning_dbus_property(self, value=None):

1611

2198

if value is None: # get

1614

2201

self.start_checker()

1615

2202

else:

1616

2203

self.stop_checker()

1617

2204

1618

2205

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

1619

2209

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

1620

2210

def ObjectPath_dbus_property(self):

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1623

2213

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1626

2221

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

1628

2222

self.secret = bytes(value)

2223

1629

2224

del _interface

1630

2225

1631

2226

1632

class ProxyClient(object):

1633

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

2227

class ProxyClient:

2228

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

1634

2229

self._pipe = child_pipe

1635

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

2230

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

1636

2231

if not self._pipe.recv():

1637

raise KeyError()

1638

2232

raise KeyError(key_id or fpr)

2233

1639

2234

def __getattribute__(self, name):

1640

2235

if name == '_pipe':

1641

2236

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

1644

2239

if data[0] == 'data':

1645

2240

return data[1]

1646

2241

if data[0] == 'function':

2242

1647

2243

def func(*args, **kwargs):

1648

2244

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

1649

2245

return self._pipe.recv()[1]

2246

1650

2247

return func

1651

2248

1652

2249

def __setattr__(self, name, value):

1653

2250

if name == '_pipe':

1654

2251

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

1657

2254

1658

2255

class ClientHandler(socketserver.BaseRequestHandler, object):

1659

2256

"""A class to handle client connections.

1660

2257

1661

2258

Instantiated once for each connection to handle it.

1662

2259

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

1663

2260

1664

2261

def handle(self):

1665

2262

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

1666

2263

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

1667

unicode(self.client_address))

2264

str(self.client_address))

1668

2265

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

1669

2266

self.server.child_pipe.fileno())

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

1685

2274

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

1686

2275

priority = self.server.gnutls_priority

1687

2276

if priority is None:

1688

2277

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1693

2282

# Start communication using the Mandos protocol

1694

2283

# Get protocol number

1695

2284

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

1696

2285

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

1697

2286

try:

1698

2287

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

1699

raise RuntimeError

2288

raise RuntimeError(line)

1700

2289

except (ValueError, IndexError, RuntimeError) as error:

1701

2290

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

1702

2291

return

1703

2292

1704

2293

# Start GnuTLS connection

1705

2294

try:

1706

2295

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

2296

except gnutls.Error as error:

1708

2297

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

1709

2298

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

1710

2299

# established. Just abandon the request.

1711

2300

return

1712

2301

logger.debug("Handshake succeeded")

1713

2302

1714

2303

approval_required = False

1715

2304

try:

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

1727

2327

self.client_address)

1728

2328

except KeyError:

1729

2329

return

1730

2330

1731

2331

if client.approval_delay:

1732

2332

delay = client.approval_delay

1733

2333

client.approvals_pending += 1

1734

2334

approval_required = True

1735

2335

1736

2336

while True:

1737

2337

if not client.enabled:

1738

2338

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

1739

client.name)

2339

client.name)

1740

2340

if self.server.use_dbus:

1741

2341

# Emit D-Bus signal

1742

2342

client.Rejected("Disabled")

1743

2343

return

1744

2344

1745

2345

if client.approved or not client.approval_delay:

1746

#We are approved or approval is disabled

2346

# We are approved or approval is disabled

1747

2347

break

1748

2348

elif client.approved is None:

1749

2349

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

1751

2351

if self.server.use_dbus:

1752

2352

# Emit D-Bus signal

1753

2353

client.NeedApproval(

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2354

client.approval_delay.total_seconds()

2355

* 1000, client.approved_by_default)

1756

2356

else:

1757

2357

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

1758

2358

client.name)

1760

2360

# Emit D-Bus signal

1761

2361

client.Rejected("Denied")

1762

2362

return

1763

1764

#wait until timeout or approved

2363

2364

# wait until timeout or approved

1765

2365

time = datetime.datetime.now()

1766

2366

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2367

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

1770

2368

client.changedstate.release()

1771

2369

time2 = datetime.datetime.now()

1772

2370

if (time2 - time) >= delay:

1782

2380

break

1783

2381

else:

1784

2382

delay -= time2 - time

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

1799

2391

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

1800

2392

# bump the timeout using extended_timeout

1801

2393

client.bump_timeout(client.extended_timeout)

1802

2394

if self.server.use_dbus:

1803

2395

# Emit D-Bus signal

1804

2396

client.GotSecret()

1805

2397

1806

2398

finally:

1807

2399

if approval_required:

1808

2400

client.approvals_pending -= 1

1809

2401

try:

1810

2402

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

2403

except gnutls.Error as error:

1812

2404

logger.warning("GnuTLS bye failed",

1813

2405

exc_info=error)

1814

2406

1815

2407

@staticmethod

1816

2408

def peer_certificate(session):

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

1824

2425

list_size = ctypes.c_uint(1)

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2426

cert_list = (gnutls.certificate_get_peers

1827

2427

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

1828

2428

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

1829

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

1830

" certificate")

2429

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

1831

2430

if list_size.value == 0:

1832

2431

return None

1833

2432

cert = cert_list[0]

1834

2433

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

1835

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1836

2469

@staticmethod

1837

2470

def fingerprint(openpgp):

1838

2471

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2472

# New GnuTLS "datum" with the OpenPGP public key

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

1845

2477

# New empty GnuTLS certificate

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2480

# Import the OpenPGP public key into the certificate

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1854

2483

# Verify the self signature in the key

1855

2484

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1859

2487

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1863

2491

# New buffer for the fingerprint

1864

2492

buf = ctypes.create_string_buffer(20)

1865

2493

buf_len = ctypes.c_size_t()

1866

2494

# Get the fingerprint from the certificate into the buffer

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2495

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

2496

ctypes.byref(buf_len))

1870

2497

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2498

gnutls.openpgp_crt_deinit(crt)

1872

2499

# Convert the buffer to a Python bytestring

1873

2500

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

1874

2501

# Convert the bytestring to hexadecimal notation

1876

2503

return hex_fpr

1877

2504

1878

2505

1879

class MultiprocessingMixIn(object):

2506

class MultiprocessingMixIn:

1880

2507

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

2508

1881

2509

def sub_process_main(self, request, address):

1882

2510

try:

1883

2511

self.finish_request(request, address)

1884

2512

except Exception:

1885

2513

self.handle_error(request, address)

1886

2514

self.close_request(request)

1887

2515

1888

2516

def process_request(self, request, address):

1889

2517

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

1890

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

1891

args = (request, address))

2518

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

2519

args=(request, address))

1892

2520

proc.start()

1893

2521

return proc

1894

2522

1895

2523

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1897

2525

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

2526

1898

2527

def process_request(self, request, client_address):

1899

2528

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

1900

2529

1901

2530

This function creates a new pipe in self.pipe

1902

2531

"""

1903

2532

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1904

2533

1905

2534

proc = MultiprocessingMixIn.process_request(self, request,

1906

2535

client_address)

1907

2536

self.child_pipe.close()

1908

2537

self.add_pipe(parent_pipe, proc)

1909

2538

1910

2539

def add_pipe(self, parent_pipe, proc):

1911

2540

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

1912

raise NotImplementedError

2541

raise NotImplementedError()

1913

2542

1914

2543

1915

2544

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1916

socketserver.TCPServer, object):

2545

socketserver.TCPServer):

1917

2546

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

1918

2547

1919

2548

Attributes:

1920

2549

enabled: Boolean; whether this server is activated yet

1921

2550

interface: None or a network interface name (string)

1922

2551

use_ipv6: Boolean; to use IPv6 or not

1923

2552

"""

2553

1924

2554

def __init__(self, server_address, RequestHandlerClass,

1925

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

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1926

2558

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

1927

2559

creating a new one with socket.socket().

1928

2560

"""

1934

2566

self.socketfd = socketfd

1935

2567

# Save the original socket.socket() function

1936

2568

self.socket_socket = socket.socket

2569

1937

2570

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

1938

#

2571

#

1939

2572

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

1940

2573

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

1941

2574

# patching socket.socket.)

1942

#

2575

#

1943

2576

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

1944

2577

@functools.wraps(socket.socket)

1945

2578

def socket_wrapper(*args, **kwargs):

1957

2590

# socket_wrapper(), if socketfd was set.

1958

2591

socketserver.TCPServer.__init__(self, server_address,

1959

2592

RequestHandlerClass)

1960

2593

1961

2594

def server_bind(self):

1962

2595

"""This overrides the normal server_bind() function

1963

2596

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

1964

2597

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

2598

global SO_BINDTODEVICE

1965

2599

if self.interface is not None:

1966

2600

if SO_BINDTODEVICE is None:

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

1988

2622

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

1989

2623

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

1990

2626

if not self.server_address[0]:

1991

2627

if self.address_family == socket.AF_INET6:

1992

any_address = "::" # in6addr_any

2628

any_address = "::" # in6addr_any

1993

2629

else:

1994

any_address = "0.0.0.0" # INADDR_ANY

2630

any_address = "0.0.0.0" # INADDR_ANY

1995

2631

self.server_address = (any_address,

1996

2632

self.server_address[1])

1997

2633

elif not self.server_address[1]:

1998

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

1999

0)

2634

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

2000

2635

# if self.interface:

2001

2636

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

2002

2637

# 0, # port

2008

2643

2009

2644

class MandosServer(IPv6_TCPServer):

2010

2645

"""Mandos server.

2011

2646

2012

2647

Attributes:

2013

2648

clients: set of Client objects

2014

2649

gnutls_priority GnuTLS priority string

2015

2650

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

2016

2017

Assumes a gobject.MainLoop event loop.

2651

2652

Assumes a GLib.MainLoop event loop.

2018

2653

"""

2654

2019

2655

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

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

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2022

2662

self.enabled = False

2023

2663

self.clients = clients

2024

2664

if self.clients is None:

2027

2667

self.gnutls_priority = gnutls_priority

2028

2668

IPv6_TCPServer.__init__(self, server_address,

2029

2669

RequestHandlerClass,

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2033

2674

def server_activate(self):

2034

2675

if self.enabled:

2035

2676

return socketserver.TCPServer.server_activate(self)

2036

2677

2037

2678

def enable(self):

2038

2679

self.enabled = True

2039

2680

2040

2681

def add_pipe(self, parent_pipe, proc):

2041

2682

# Call "handle_ipc" for both data and EOF events

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

2051

2694

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

2052

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

2695

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

2053

2696

# Wait for other process to exit

2054

2697

proc.join()

2055

2698

return False

2056

2699

2057

2700

# Read a request from the child

2058

2701

request = parent_pipe.recv()

2059

2702

command = request[0]

2060

2703

2061

2704

if command == 'init':

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2067

2716

client = c

2068

2717

break

2069

2718

else:

2070

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

2071

"dress: %s", fpr, address)

2719

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

2720

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

2072

2721

if self.use_dbus:

2073

2722

# Emit D-Bus signal

2074

mandos_dbus_service.ClientNotFound(fpr,

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2075

2724

address[0])

2076

2725

parent_pipe.send(False)

2077

2726

return False

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

2087

2735

parent_pipe.send(True)

2088

2736

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

2089

2737

# same fileno

2092

2740

funcname = request[1]

2093

2741

args = request[2]

2094

2742

kwargs = request[3]

2095

2743

2096

2744

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

2097

2745

funcname)(*args,

2098

**kwargs)))

2099

2746

**kwargs)))

2747

2100

2748

if command == 'getattr':

2101

2749

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2104

2753

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2754

parent_pipe.send((

2755

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

2756

2108

2757

if command == 'setattr':

2109

2758

attrname = request[1]

2110

2759

value = request[2]

2111

2760

setattr(client_object, attrname, value)

2112

2761

2113

2762

return True

2114

2763

2115

2764

2116

2765

def rfc3339_duration_to_delta(duration):

2117

2766

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

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

2133

2782

"""

2134

2783

2135

2784

# Parsing an RFC 3339 duration with regular expressions is not

2136

2785

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

2137

2786

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

2138

2787

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

2139

2788

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

2140

2789

# avoid excessive use of external libraries.

2141

2790

2142

2791

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

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

2152

2797

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

2153

2798

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

2154

2799

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

2155

2800

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

2156

2801

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2802

frozenset((token_end, )))

2158

2803

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

2159

2804

datetime.timedelta(minutes=1),

2160

2805

frozenset((token_second, token_end)))

2176

2821

frozenset((token_month, token_end)))

2177

2822

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

2178

2823

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2824

frozenset((token_end, )))

2180

2825

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

2181

2826

frozenset((token_year, token_month,

2182

2827

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2828

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2186

2832

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2189

2837

# Loop until end token is found

2190

2838

while found_token is not token_end:

2191

2839

# Search for any currently valid tokens

2207

2855

break

2208

2856

else:

2209

2857

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2858

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

2859

.format(duration))

2211

2860

# End token found

2212

2861

return value

2213

2862

2214

2863

2215

2864

def string_to_delta(interval):

2216

2865

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

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

2230

2879

"""

2231

2880

2232

2881

try:

2233

2882

return rfc3339_duration_to_delta(interval)

2234

2883

except ValueError:

2235

2884

pass

2236

2885

2237

2886

timevalue = datetime.timedelta(0)

2238

2887

for s in interval.split():

2239

2888

try:

2240

suffix = unicode(s[-1])

2889

suffix = s[-1]

2241

2890

value = int(s[:-1])

2242

2891

if suffix == "d":

2243

2892

delta = datetime.timedelta(value)

2250

2899

elif suffix == "w":

2251

2900

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

2252

2901

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2902

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

2903

except IndexError as e:

2256

2904

raise ValueError(*(e.args))

2257

2905

timevalue += delta

2258

2906

return timevalue

2259

2907

2260

2908

2261

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

2909

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

2262

2910

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

2263

2911

2264

2912

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

2265

2913

if os.fork():

2266

2914

sys.exit()

2274

2922

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

2275

2923

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

2276

2924

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2925

"{} not a character device"

2278

2926

.format(os.devnull))

2279

2927

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

2280

2928

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

2284

2932

2285

2933

2286

2934

def main():

2287

2935

2288

2936

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

2289

2937

# Parsing of options, both command line and config file

2290

2938

2291

2939

parser = argparse.ArgumentParser()

2292

2940

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

2293

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

2941

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

2294

2942

help="show version number and exit")

2295

2943

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

2296

2944

help="Bind to interface IF")

2329

2977

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

2330

2978

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

2331

2979

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

2332

2980

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

2981

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

2982

default=None)

2983

2333

2984

options = parser.parse_args()

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

2985

2340

2986

# Default values for config file for server-global settings

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

2357

3010

# Parse config file for server-global settings

2358

server_config = configparser.SafeConfigParser(server_defaults)

3011

server_config = configparser.ConfigParser(server_defaults)

2359

3012

del server_defaults

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3013

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

3014

# Convert the ConfigParser object to a dict

2363

3015

server_settings = server_config.defaults()

2364

3016

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

2365

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

3017

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

3018

"foreground", "zeroconf"):

2366

3019

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

2367

3020

option)

2368

3021

if server_settings["port"]:

2378

3031

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

2379

3032

["socket"])

2380

3033

del server_config

2381

3034

2382

3035

# Override the settings from the config file with command line

2383

3036

# options, if set.

2384

3037

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

2385

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

2386

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

2387

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

3038

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

3039

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

3040

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

2388

3041

value = getattr(options, option)

2389

3042

if value is not None:

2390

3043

server_settings[option] = value

2391

3044

del options

2392

3045

# Force all strings to be unicode

2393

3046

for option in server_settings.keys():

2394

if type(server_settings[option]) is str:

2395

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

3047

if isinstance(server_settings[option], bytes):

3048

server_settings[option] = (server_settings[option]

3049

.decode("utf-8"))

2396

3050

# Force all boolean options to be boolean

2397

3051

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

2398

"foreground"):

3052

"foreground", "zeroconf"):

2399

3053

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

2400

3054

# Debug implies foreground

2401

3055

if server_settings["debug"]:

2402

3056

server_settings["foreground"] = True

2403

3057

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

2404

3058

2405

3059

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

2406

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

2407

3066

# For convenience

2408

3067

debug = server_settings["debug"]

2409

3068

debuglevel = server_settings["debuglevel"]

2412

3071

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

2413

3072

stored_state_file)

2414

3073

foreground = server_settings["foreground"]

2415

3074

zeroconf = server_settings["zeroconf"]

3075

2416

3076

if debug:

2417

3077

initlogger(debug, logging.DEBUG)

2418

3078

else:

2421

3081

else:

2422

3082

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

2423

3083

initlogger(debug, level)

2424

3084

2425

3085

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

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2432

3091

# Parse config file with clients

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2435

3093

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

2436

3094

"clients.conf"))

2437

3095

2438

3096

global mandos_dbus_service

2439

3097

mandos_dbus_service = None

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3098

3099

socketfd = None

3100

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

3101

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

2452

3110

if not foreground:

2453

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

3111

pidfilename = "/run/mandos.pid"

3112

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

3113

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

2454

3114

pidfile = None

2455

3115

try:

2456

pidfile = open(pidfilename, "w")

3116

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

2457

3117

except IOError as e:

2458

3118

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

2459

3119

exc_info=e)

2460

2461

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

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2462

3124

try:

2463

3125

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

3126

gid = pwd.getpwnam(group).pw_gid

2465

3127

break

2466

3128

except KeyError:

2467

3129

continue

2471

3133

try:

2472

3134

os.setgid(gid)

2473

3135

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

2474

3139

except OSError as error:

3140

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

3141

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

2475

3142

if error.errno != errno.EPERM:

2476

raise error

2477

3143

raise

3144

2478

3145

if debug:

2479

3146

# Enable all possible GnuTLS debugging

2480

3147

2481

3148

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

2482

3149

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2486

3153

def debug_gnutls(level, string):

2487

3154

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2492

3158

# Redirect stdin so all checkers get /dev/null

2493

3159

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

2494

3160

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

2495

3161

if null > 2:

2496

3162

os.close(null)

2497

3163

2498

3164

# Need to fork before connecting to D-Bus

2499

3165

if not foreground:

2500

3166

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

2501

3167

daemon()

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

2507

3174

global main_loop

2508

3175

# From the Avahi example code

2509

3176

DBusGMainLoop(set_as_default=True)

2510

main_loop = gobject.MainLoop()

3177

main_loop = GLib.MainLoop()

2511

3178

bus = dbus.SystemBus()

2512

3179

# End of Avahi example code

2513

3180

if use_dbus:

2514

3181

try:

2515

3182

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

2521

3189

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

2522

3190

use_dbus = False

2523

3191

server_settings["use_dbus"] = False

2524

3192

tcp_server.use_dbus = False

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3193

if zeroconf:

3194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

3200

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

2534

3204

global multiprocessing_manager

2535

3205

multiprocessing_manager = multiprocessing.Manager()

2536

3206

2537

3207

client_class = Client

2538

3208

if use_dbus:

2539

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

2540

3209

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

3210

2541

3211

client_settings = Client.config_parser(client_config)

2542

3212

old_client_settings = {}

2543

3213

clients_data = {}

2544

3214

2545

3215

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

2546

3216

global wnull

2547

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

3217

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

2548

3218

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

2549

3219

# mode

2550

3220

if debug or not foreground:

2551

3221

wnull.close()

2552

3222

2553

3223

# Get client data and settings from last running state.

2554

3224

if server_settings["restore"]:

2555

3225

try:

2556

3226

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

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name & .host

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host

3272

for value in old_client_settings.values():

3273

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

3274

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

3275

.decode("utf-8"))

2559

3276

os.remove(stored_state_path)

2560

3277

except IOError as e:

2561

3278

if e.errno == errno.ENOENT:

2562

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

2563

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

3279

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

3280

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

2564

3281

else:

2565

3282

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

2566

3283

exc_info=e)

2567

3284

raise

2568

3285

except EOFError as e:

2569

3286

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

2570

"EOFError:", exc_info=e)

2571

3287

"EOFError:",

3288

exc_info=e)

3289

2572

3290

with PGPEngine() as pgp:

2573

for client_name, client in clients_data.iteritems():

3291

for client_name, client in clients_data.items():

2574

3292

# Skip removed clients

2575

3293

if client_name not in client_settings:

2576

3294

continue

2577

3295

2578

3296

# Decide which value to use after restoring saved state.

2579

3297

# We have three different values: Old config file,

2580

3298

# new config file, and saved state.

2585

3303

# For each value in new config, check if it

2586

3304

# differs from the old config value (Except for

2587

3305

# the "secret" attribute)

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3306

if (name != "secret"

3307

and (value !=

3308

old_client_settings[client_name][name])):

2591

3309

client[name] = value

2592

3310

except KeyError:

2593

3311

pass

2594

3312

2595

3313

# Clients who has passed its expire date can still be

2596

# enabled if its last checker was successful. Clients

3314

# enabled if its last checker was successful. A Client

2597

3315

# whose checker succeeded before we stored its state is

2598

3316

# assumed to have successfully run all checkers during

2599

3317

# downtime.

2601

3319

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

2602

3320

if not client["last_checked_ok"]:

2603

3321

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3322

"disabling client {} - Client never "

3323

"performed a successful checker".format(

3324

client_name))

2607

3325

client["enabled"] = False

2608

3326

elif client["last_checker_status"] != 0:

2609

3327

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3328

"disabling client {} - Client last"

3329

" checker failed with error code"

3330

" {}".format(

3331

client_name,

3332

client["last_checker_status"]))

2614

3333

client["enabled"] = False

2615

3334

else:

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3335

client["expires"] = (

3336

datetime.datetime.utcnow()

3337

+ client["timeout"])

2619

3338

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3339

" keeping {} enabled".format(

3340

client_name))

2622

3341

try:

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3342

client["secret"] = pgp.decrypt(

3343

client["encrypted_secret"],

3344

client_settings[client_name]["secret"])

2627

3345

except PGPError:

2628

3346

# If decryption fails, we use secret from new settings

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3347

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

3348

client_name))

3349

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

3350

["secret"])

3351

2634

3352

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

2635

3353

for client_name in (set(old_client_settings)

2636

3354

- set(client_settings)):

2638

3356

for client_name in (set(client_settings)

2639

3357

- set(old_client_settings)):

2640

3358

clients_data[client_name] = client_settings[client_name]

2641

3359

2642

3360

# Create all client objects

2643

for client_name, client in clients_data.iteritems():

3361

for client_name, client in clients_data.items():

2644

3362

tcp_server.clients[client_name] = client_class(

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3363

name=client_name,

3364

settings=client,

3365

server_settings=server_settings)

3366

2648

3367

if not tcp_server.clients:

2649

3368

logger.warning("No clients defined")

2650

3369

2651

3370

if not foreground:

2652

3371

if pidfile is not None:

3372

pid = os.getpid()

2653

3373

try:

2654

3374

with pidfile:

2655

pid = os.getpid()

2656

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

3375

print(pid, file=pidfile)

2657

3376

except IOError:

2658

3377

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

2659

3378

pidfilename, pid)

2660

3379

del pidfile

2661

3380

del pidfilename

2662

2663

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

2664

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

2665

3381

3382

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

3383

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3384

lambda: main_loop.quit() and False)

3385

2666

3386

if use_dbus:

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3387

3388

@alternate_dbus_interfaces(

3389

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

3390

class MandosDBusService(DBusObjectWithObjectManager):

2670

3391

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

3392

2671

3393

def __init__(self):

2672

3394

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

3395

2673

3396

_interface = "se.recompile.Mandos"

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3397

2681

3398

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

2682

3399

def ClientAdded(self, objpath):

2683

3400

"D-Bus signal"

2684

3401

pass

2685

3402

2686

3403

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

2687

def ClientNotFound(self, fingerprint, address):

3404

def ClientNotFound(self, key_id, address):

2688

3405

"D-Bus signal"

2689

3406

pass

2690

3407

3408

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

3409

"true"})

2691

3410

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

2692

3411

def ClientRemoved(self, objpath, name):

2693

3412

"D-Bus signal"

2694

3413

pass

2695

3414

3415

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

3416

"true"})

2696

3417

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

2697

3418

def GetAllClients(self):

2698

3419

"D-Bus method"

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3420

return dbus.Array(c.dbus_object_path for c in

3421

tcp_server.clients.values())

3422

3423

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

3424

"true"})

2703

3425

@dbus.service.method(_interface,

2704

3426

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

2705

3427

def GetAllClientsWithProperties(self):

2706

3428

"D-Bus method"

2707

3429

return dbus.Dictionary(

2708

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

2709

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

3430

{c.dbus_object_path: c.GetAll(

3431

"se.recompile.Mandos.Client")

3432

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

2710

3433

signature="oa{sv}")

2711

3434

2712

3435

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

2713

3436

def RemoveClient(self, object_path):

2714

3437

"D-Bus method"

2715

for c in tcp_server.clients.itervalues():

3438

for c in tcp_server.clients.values():

2716

3439

if c.dbus_object_path == object_path:

2717

3440

del tcp_server.clients[c.name]

2718

3441

c.remove_from_connection()

2719

# Don't signal anything except ClientRemoved

3442

# Don't signal the disabling

2720

3443

c.disable(quiet=True)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3444

# Emit D-Bus signal for removal

3445

self.client_removed_signal(c)

2723

3446

return

2724

3447

raise KeyError(object_path)

2725

3448

2726

3449

del _interface

2727

3450

3451

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3452

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

3453

def GetManagedObjects(self):

3454

"""D-Bus method"""

3455

return dbus.Dictionary(

3456

{client.dbus_object_path:

3457

dbus.Dictionary(

3458

{interface: client.GetAll(interface)

3459

for interface in

3460

client._get_all_interface_names()})

3461

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

3462

3463

def client_added_signal(self, client):

3464

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

3465

if use_dbus:

3466

# New standard signal

3467

self.InterfacesAdded(

3468

client.dbus_object_path,

3469

dbus.Dictionary(

3470

{interface: client.GetAll(interface)

3471

for interface in

3472

client._get_all_interface_names()}))

3473

# Old signal

3474

self.ClientAdded(client.dbus_object_path)

3475

3476

def client_removed_signal(self, client):

3477

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

3478

if use_dbus:

3479

# New standard signal

3480

self.InterfacesRemoved(

3481

client.dbus_object_path,

3482

client._get_all_interface_names())

3483

# Old signal

3484

self.ClientRemoved(client.dbus_object_path,

3485

client.name)

3486

2728

3487

mandos_dbus_service = MandosDBusService()

2729

3488

3489

# Save modules to variables to exempt the modules from being

3490

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

3491

mp = multiprocessing

3492

wn = wnull

3493

2730

3494

def cleanup():

2731

3495

"Cleanup function; run on exit"

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3496

if zeroconf:

3497

service.cleanup()

3498

3499

mp.active_children()

3500

wn.close()

2736

3501

if not (tcp_server.clients or client_settings):

2737

3502

return

2738

3503

2739

3504

# Store client before exiting. Secrets are encrypted with key

2740

3505

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

2741

3506

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

2742

3507

clients = {}

2743

3508

with PGPEngine() as pgp:

2744

for client in tcp_server.clients.itervalues():

3509

for client in tcp_server.clients.values():

2745

3510

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

2746

3511

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

2747

3512

key)

2748

3513

client_dict = {}

2749

3514

2750

3515

# A list of attributes that can not be pickled

2751

3516

# + secret.

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3517

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

3518

"checker", "server_settings"}

3519

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

3520

.Object):

2756

3521

exclude.add(name)

2757

3522

2758

3523

client_dict["encrypted_secret"] = (client

2759

3524

.encrypted_secret)

2760

3525

for attr in client.client_structure:

2761

3526

if attr not in exclude:

2762

3527

client_dict[attr] = getattr(client, attr)

2763

3528

2764

3529

clients[client.name] = client_dict

2765

3530

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

2766

3531

2767

3532

try:

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3533

with tempfile.NamedTemporaryFile(

3534

mode='wb',

3535

suffix=".pickle",

3536

prefix='clients-',

3537

dir=os.path.dirname(stored_state_path),

3538

delete=False) as stored_state:

3539

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

3540

protocol=2)

3541

tempname = stored_state.name

2774

3542

os.rename(tempname, stored_state_path)

2775

3543

except (IOError, OSError) as e:

2776

3544

if not debug:

2779

3547

except NameError:

2780

3548

pass

2781

3549

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

2782

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

3550

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

2783

3551

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

2784

3552

else:

2785

3553

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

2786

3554

exc_info=e)

2787

raise e

2788

3555

raise

3556

2789

3557

# Delete all clients, and settings from config

2790

3558

while tcp_server.clients:

2791

3559

name, client = tcp_server.clients.popitem()

2792

3560

if use_dbus:

2793

3561

client.remove_from_connection()

2794

# Don't signal anything except ClientRemoved

3562

# Don't signal the disabling

2795

3563

client.disable(quiet=True)

3564

# Emit D-Bus signal for removal

2796

3565

if use_dbus:

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3566

mandos_dbus_service.client_removed_signal(client)

2801

3567

client_settings.clear()

2802

3568

2803

3569

atexit.register(cleanup)

2804

2805

for client in tcp_server.clients.itervalues():

3570

3571

for client in tcp_server.clients.values():

2806

3572

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3573

# Emit D-Bus signal for adding

3574

mandos_dbus_service.client_added_signal(client)

2809

3575

# Need to initiate checking of clients

2810

3576

if client.enabled:

2811

3577

client.init_checker()

2812

3578

2813

3579

tcp_server.enable()

2814

3580

tcp_server.server_activate()

2815

3581

2816

3582

# Find out what port we got

2817

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

3583

if zeroconf:

3584

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

2818

3585

if use_ipv6:

2819

3586

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

2820

3587

" flowinfo %d, scope_id %d",

2822

3589

else: # IPv4

2823

3590

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

2824

3591

*tcp_server.socket.getsockname())

2825

2826

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

2827

3592

3593

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

3594

2828

3595

try:

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3596

if zeroconf:

3597

# From the Avahi example code

3598

try:

3599

service.activate()

3600

except dbus.exceptions.DBusException as error:

3601

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

3602

cleanup()

3603

sys.exit(1)

3604

# End of Avahi example code

3605

3606

GLib.io_add_watch(

3607

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

3608

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3609

lambda *args, **kwargs: (tcp_server.handle_request

3610

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

3611

2843

3612

logger.debug("Starting main loop")

2844

3613

main_loop.run()

2845

3614

except AvahiError as error:

2854

3623

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

2855

3624

cleanup()

2856

3625

3626

3627

def should_only_run_tests():

3628

parser = argparse.ArgumentParser(add_help=False)

3629

parser.add_argument("--check", action='store_true')

3630

args, unknown_args = parser.parse_known_args()

3631

run_tests = args.check

3632

if run_tests:

3633

# Remove --check argument from sys.argv

3634

sys.argv[1:] = unknown_args

3635

return run_tests

3636

3637

# Add all tests from doctest strings

3638

def load_tests(loader, tests, none):

3639

import doctest

3640

tests.addTests(doctest.DocTestSuite())

3641

return tests

3642

2857

3643

if __name__ == '__main__':

2858

main()

3644

try:

3645

if should_only_run_tests():

3646

# Call using ./mandos --check [--verbose]

3647

unittest.main()

3648

else:

3649

main()

3650

finally:

3651

logging.shutdown()