/mandos/trunk : revision 237.4.132

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

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

81

import random

82

import shlex

72

83

73

84

import dbus

74

85

import dbus.service

75

import gobject

76

import avahi

86

import gi

87

from gi.repository import GLib

77

88

from dbus.mainloop.glib import DBusGMainLoop

78

89

import ctypes

79

90

import ctypes.util

80

91

import xml.dom.minidom

81

92

import inspect

82

93

83

try:

94

if sys.version_info.major == 2:

95

__metaclass__ = type

96

str = unicode

97

98

# Add collections.abc.Callable if it does not exist

99

try:

100

collections.abc.Callable

101

except AttributeError:

102

class abc:

103

Callable = collections.Callable

104

collections.abc = abc

105

del abc

106

107

# Add shlex.quote if it does not exist

108

try:

109

shlex.quote

110

except AttributeError:

111

shlex.quote = re.escape

112

113

# Show warnings by default

114

if not sys.warnoptions:

115

import warnings

116

warnings.simplefilter("default")

117

118

# Try to find the value of SO_BINDTODEVICE:

119

try:

120

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

121

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

84

122

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

123

except AttributeError:

86

124

try:

125

# This is where SO_BINDTODEVICE was up to and including Python

126

# 2.6, and also 3.2:

87

127

from IN import SO_BINDTODEVICE

88

128

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.4"

129

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

130

# Try running the C preprocessor:

131

try:

132

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

133

"/dev/stdin"],

134

stdin=subprocess.PIPE,

135

stdout=subprocess.PIPE)

136

stdout = cc.communicate(

137

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

138

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

139

except (OSError, ValueError, IndexError):

140

# No value found

141

SO_BINDTODEVICE = None

142

143

if sys.version_info < (3, 2):

144

configparser.Configparser = configparser.SafeConfigParser

145

146

version = "1.8.12"

92

147

stored_state_file = "clients.pickle"

93

148

94

149

logger = logging.getLogger()

150

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

95

151

syslogger = None

96

152

97

153

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

154

if_nametoindex = ctypes.cdll.LoadLibrary(

155

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

101

156

except (OSError, AttributeError):

157

102

158

def if_nametoindex(interface):

103

159

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

104

160

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

105

161

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

106

162

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

163

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

164

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

111

165

return interface_index

112

166

113

167

168

def copy_function(func):

169

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

170

if sys.version_info.major == 2:

171

return types.FunctionType(func.func_code,

172

func.func_globals,

173

func.func_name,

174

func.func_defaults,

175

func.func_closure)

176

else:

177

return types.FunctionType(func.__code__,

178

func.__globals__,

179

func.__name__,

180

func.__defaults__,

181

func.__closure__)

182

183

114

184

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

115

185

"""init logger and add loglevel"""

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

186

187

global syslogger

188

syslogger = (logging.handlers.SysLogHandler(

189

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

190

address="/dev/log"))

121

191

syslogger.setFormatter(logging.Formatter

122

192

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

123

193

' %(message)s'))

124

194

logger.addHandler(syslogger)

125

195

126

196

if debug:

127

197

console = logging.StreamHandler()

128

198

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

138

208

pass

139

209

140

210

141

class PGPEngine(object):

211

class PGPEngine:

142

212

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

213

143

214

def __init__(self):

144

215

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

216

self.gpg = "gpg"

217

try:

218

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

219

for line in output.splitlines():

220

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

221

if name == b"gpg":

222

self.gpg = path

223

break

224

except OSError as e:

225

if e.errno != errno.ENOENT:

226

raise

145

227

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

228

'--homedir', self.tempdir,

147

229

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

230

'--quiet']

231

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

232

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

233

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

234

151

235

def __enter__(self):

152

236

return self

153

237

154

238

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

155

239

self._cleanup()

156

240

return False

157

241

158

242

def __del__(self):

159

243

self._cleanup()

160

244

161

245

def _cleanup(self):

162

246

if self.tempdir is not None:

163

247

# Delete contents of tempdir

164

248

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

165

topdown = False):

249

topdown=False):

166

250

for filename in files:

167

251

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

168

252

for dirname in dirs:

170

254

# Remove tempdir

171

255

os.rmdir(self.tempdir)

172

256

self.tempdir = None

173

257

174

258

def password_encode(self, password):

175

259

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

176

260

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

181

265

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

182

266

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

183

267

return encoded

184

268

185

269

def encrypt(self, data, password):

186

270

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

271

with tempfile.NamedTemporaryFile(

272

dir=self.tempdir) as passfile:

189

273

passfile.write(passphrase)

190

274

passfile.flush()

191

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

275

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

192

276

'--passphrase-file',

193

277

passfile.name]

194

278

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

279

stdin=subprocess.PIPE,

280

stdout=subprocess.PIPE,

281

stderr=subprocess.PIPE)

282

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

199

283

if proc.returncode != 0:

200

284

raise PGPError(err)

201

285

return ciphertext

202

286

203

287

def decrypt(self, data, password):

204

288

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

289

with tempfile.NamedTemporaryFile(

290

dir=self.tempdir) as passfile:

207

291

passfile.write(passphrase)

208

292

passfile.flush()

209

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

293

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

210

294

'--passphrase-file',

211

295

passfile.name]

212

296

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

297

stdin=subprocess.PIPE,

298

stdout=subprocess.PIPE,

299

stderr=subprocess.PIPE)

300

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

218

301

if proc.returncode != 0:

219

302

raise PGPError(err)

220

303

return decrypted_plaintext

221

304

222

305

306

# Pretend that we have an Avahi module

307

class avahi:

308

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

309

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

310

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

311

PROTO_INET = 0 # avahi-common/address.h

312

PROTO_INET6 = 1 # avahi-common/address.h

313

DBUS_NAME = "org.freedesktop.Avahi"

314

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

315

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

316

DBUS_PATH_SERVER = "/"

317

318

@staticmethod

319

def string_array_to_txt_array(t):

320

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

321

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

322

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

323

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

324

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

325

SERVER_INVALID = 0 # avahi-common/defs.h

326

SERVER_REGISTERING = 1 # avahi-common/defs.h

327

SERVER_RUNNING = 2 # avahi-common/defs.h

328

SERVER_COLLISION = 3 # avahi-common/defs.h

329

SERVER_FAILURE = 4 # avahi-common/defs.h

330

331

223

332

class AvahiError(Exception):

224

333

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

225

334

self.value = value

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

335

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

336

**kwargs)

337

229

338

230

339

class AvahiServiceError(AvahiError):

231

340

pass

232

341

342

233

343

class AvahiGroupError(AvahiError):

234

344

pass

235

345

236

346

237

class AvahiService(object):

347

class AvahiService:

238

348

"""An Avahi (Zeroconf) service.

239

349

240

350

Attributes:

241

351

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

242

352

Used to optionally bind to the specified interface.

254

364

server: D-Bus Server

255

365

bus: dbus.SystemBus()

256

366

"""

257

258

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

259

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

260

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

261

protocol = avahi.PROTO_UNSPEC, bus = None):

367

368

def __init__(self,

369

interface=avahi.IF_UNSPEC,

370

name=None,

371

servicetype=None,

372

port=None,

373

TXT=None,

374

domain="",

375

host="",

376

max_renames=32768,

377

protocol=avahi.PROTO_UNSPEC,

378

bus=None):

262

379

self.interface = interface

263

380

self.name = name

264

381

self.type = servicetype

273

390

self.server = None

274

391

self.bus = bus

275

392

self.entry_group_state_changed_match = None

276

277

def rename(self):

393

394

def rename(self, remove=True):

278

395

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

279

396

if self.rename_count >= self.max_renames:

280

397

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

281

398

" after %i retries, exiting.",

282

399

self.rename_count)

283

400

raise AvahiServiceError("Too many renames")

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

401

self.name = str(

402

self.server.GetAlternativeServiceName(self.name))

403

self.rename_count += 1

286

404

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

287

405

self.name)

288

self.remove()

406

if remove:

407

self.remove()

289

408

try:

290

409

self.add()

291

410

except dbus.exceptions.DBusException as error:

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

411

if (error.get_dbus_name()

412

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

413

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

414

return self.rename(remove=False)

415

else:

416

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

417

self.cleanup()

418

os._exit(1)

419

297

420

def remove(self):

298

421

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

299

422

if self.entry_group_state_changed_match is not None:

301

424

self.entry_group_state_changed_match = None

302

425

if self.group is not None:

303

426

self.group.Reset()

304

427

305

428

def add(self):

306

429

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

307

430

self.remove()

324

447

dbus.UInt16(self.port),

325

448

avahi.string_array_to_txt_array(self.TXT))

326

449

self.group.Commit()

327

450

328

451

def entry_group_state_changed(self, state, error):

329

452

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

330

453

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

331

454

332

455

if state == avahi.ENTRY_GROUP_ESTABLISHED:

333

456

logger.debug("Zeroconf service established.")

334

457

elif state == avahi.ENTRY_GROUP_COLLISION:

336

459

self.rename()

337

460

elif state == avahi.ENTRY_GROUP_FAILURE:

338

461

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

339

unicode(error))

340

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

341

.format(error))

342

462

str(error))

463

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

464

343

465

def cleanup(self):

344

466

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

345

467

if self.group is not None:

350

472

pass

351

473

self.group = None

352

474

self.remove()

353

475

354

476

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

355

477

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

356

478

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

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"Zeroconf server failure" }

479

bad_states = {

480

avahi.SERVER_INVALID: "Zeroconf server invalid",

481

avahi.SERVER_REGISTERING: None,

482

avahi.SERVER_COLLISION: "Zeroconf server name collision",

483

avahi.SERVER_FAILURE: "Zeroconf server failure",

484

}

364

485

if state in bad_states:

365

486

if bad_states[state] is not None:

366

487

if error is None:

369

490

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

370

491

self.cleanup()

371

492

elif state == avahi.SERVER_RUNNING:

372

self.add()

493

try:

494

self.add()

495

except dbus.exceptions.DBusException as error:

496

if (error.get_dbus_name()

497

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

498

logger.info("Local Zeroconf service name"

499

" collision.")

500

return self.rename(remove=False)

501

else:

502

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

503

self.cleanup()

504

os._exit(1)

373

505

else:

374

506

if error is None:

375

507

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

376

508

else:

377

509

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

378

510

379

511

def activate(self):

380

512

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

381

513

if self.server is None:

385

517

follow_name_owner_changes=True),

386

518

avahi.DBUS_INTERFACE_SERVER)

387

519

self.server.connect_to_signal("StateChanged",

388

self.server_state_changed)

520

self.server_state_changed)

389

521

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

390

522

391

523

392

524

class AvahiServiceToSyslog(AvahiService):

393

def rename(self):

525

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

394

526

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

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

527

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

528

syslogger.setFormatter(logging.Formatter(

529

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

530

.format(self.name)))

400

531

return ret

401

532

402

533

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

408

409

410

class Client(object):

534

# Pretend that we have a GnuTLS module

535

class gnutls:

536

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

537

538

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

539

if library is None:

540

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

541

_library = ctypes.cdll.LoadLibrary(library)

542

del library

543

544

# Unless otherwise indicated, the constants and types below are

545

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

546

547

# Constants

548

E_SUCCESS = 0

549

E_INTERRUPTED = -52

550

E_AGAIN = -28

551

CRT_OPENPGP = 2

552

CRT_RAWPK = 3

553

CLIENT = 2

554

SHUT_RDWR = 0

555

CRD_CERTIFICATE = 1

556

E_NO_CERTIFICATE_FOUND = -49

557

X509_FMT_DER = 0

558

NO_TICKETS = 1<<10

559

ENABLE_RAWPK = 1<<18

560

CTYPE_PEERS = 3

561

KEYID_USE_SHA256 = 1 # gnutls/x509.h

562

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

563

564

# Types

565

class session_int(ctypes.Structure):

566

_fields_ = []

567

session_t = ctypes.POINTER(session_int)

568

569

class certificate_credentials_st(ctypes.Structure):

570

_fields_ = []

571

certificate_credentials_t = ctypes.POINTER(

572

certificate_credentials_st)

573

certificate_type_t = ctypes.c_int

574

575

class datum_t(ctypes.Structure):

576

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

577

('size', ctypes.c_uint)]

578

579

class openpgp_crt_int(ctypes.Structure):

580

_fields_ = []

581

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

582

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

583

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

584

credentials_type_t = ctypes.c_int

585

transport_ptr_t = ctypes.c_void_p

586

close_request_t = ctypes.c_int

587

588

# Exceptions

589

class Error(Exception):

590

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

591

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

592

# code is passed, convert it to a string with

593

# gnutls.strerror()

594

self.code = code

595

if message is None and code is not None:

596

message = gnutls.strerror(code)

597

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

598

message, *args)

599

600

class CertificateSecurityError(Error):

601

pass

602

603

# Classes

604

class Credentials:

605

def __init__(self):

606

self._c_object = gnutls.certificate_credentials_t()

607

gnutls.certificate_allocate_credentials(

608

ctypes.byref(self._c_object))

609

self.type = gnutls.CRD_CERTIFICATE

610

611

def __del__(self):

612

gnutls.certificate_free_credentials(self._c_object)

613

614

class ClientSession:

615

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

616

self._c_object = gnutls.session_t()

617

gnutls_flags = gnutls.CLIENT

618

if gnutls.check_version(b"3.5.6"):

619

gnutls_flags |= gnutls.NO_TICKETS

620

if gnutls.has_rawpk:

621

gnutls_flags |= gnutls.ENABLE_RAWPK

622

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

623

del gnutls_flags

624

gnutls.set_default_priority(self._c_object)

625

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

626

gnutls.handshake_set_private_extensions(self._c_object,

627

True)

628

self.socket = socket

629

if credentials is None:

630

credentials = gnutls.Credentials()

631

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

632

ctypes.cast(credentials._c_object,

633

ctypes.c_void_p))

634

self.credentials = credentials

635

636

def __del__(self):

637

gnutls.deinit(self._c_object)

638

639

def handshake(self):

640

return gnutls.handshake(self._c_object)

641

642

def send(self, data):

643

data = bytes(data)

644

data_len = len(data)

645

while data_len > 0:

646

data_len -= gnutls.record_send(self._c_object,

647

data[-data_len:],

648

data_len)

649

650

def bye(self):

651

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

652

653

# Error handling functions

654

def _error_code(result):

655

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

656

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

657

if result >= 0:

658

return result

659

if result == gnutls.E_NO_CERTIFICATE_FOUND:

660

raise gnutls.CertificateSecurityError(code=result)

661

raise gnutls.Error(code=result)

662

663

def _retry_on_error(result, func, arguments):

664

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

665

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

666

while result < 0:

667

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

668

return _error_code(result)

669

result = func(*arguments)

670

return result

671

672

# Unless otherwise indicated, the function declarations below are

673

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

674

675

# Functions

676

priority_set_direct = _library.gnutls_priority_set_direct

677

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

678

ctypes.POINTER(ctypes.c_char_p)]

679

priority_set_direct.restype = _error_code

680

681

init = _library.gnutls_init

682

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

683

init.restype = _error_code

684

685

set_default_priority = _library.gnutls_set_default_priority

686

set_default_priority.argtypes = [session_t]

687

set_default_priority.restype = _error_code

688

689

record_send = _library.gnutls_record_send

690

record_send.argtypes = [session_t, ctypes.c_void_p,

691

ctypes.c_size_t]

692

record_send.restype = ctypes.c_ssize_t

693

record_send.errcheck = _retry_on_error

694

695

certificate_allocate_credentials = (

696

_library.gnutls_certificate_allocate_credentials)

697

certificate_allocate_credentials.argtypes = [

698

ctypes.POINTER(certificate_credentials_t)]

699

certificate_allocate_credentials.restype = _error_code

700

701

certificate_free_credentials = (

702

_library.gnutls_certificate_free_credentials)

703

certificate_free_credentials.argtypes = [

704

certificate_credentials_t]

705

certificate_free_credentials.restype = None

706

707

handshake_set_private_extensions = (

708

_library.gnutls_handshake_set_private_extensions)

709

handshake_set_private_extensions.argtypes = [session_t,

710

ctypes.c_int]

711

handshake_set_private_extensions.restype = None

712

713

credentials_set = _library.gnutls_credentials_set

714

credentials_set.argtypes = [session_t, credentials_type_t,

715

ctypes.c_void_p]

716

credentials_set.restype = _error_code

717

718

strerror = _library.gnutls_strerror

719

strerror.argtypes = [ctypes.c_int]

720

strerror.restype = ctypes.c_char_p

721

722

certificate_type_get = _library.gnutls_certificate_type_get

723

certificate_type_get.argtypes = [session_t]

724

certificate_type_get.restype = _error_code

725

726

certificate_get_peers = _library.gnutls_certificate_get_peers

727

certificate_get_peers.argtypes = [session_t,

728

ctypes.POINTER(ctypes.c_uint)]

729

certificate_get_peers.restype = ctypes.POINTER(datum_t)

730

731

global_set_log_level = _library.gnutls_global_set_log_level

732

global_set_log_level.argtypes = [ctypes.c_int]

733

global_set_log_level.restype = None

734

735

global_set_log_function = _library.gnutls_global_set_log_function

736

global_set_log_function.argtypes = [log_func]

737

global_set_log_function.restype = None

738

739

deinit = _library.gnutls_deinit

740

deinit.argtypes = [session_t]

741

deinit.restype = None

742

743

handshake = _library.gnutls_handshake

744

handshake.argtypes = [session_t]

745

handshake.restype = _error_code

746

handshake.errcheck = _retry_on_error

747

748

transport_set_ptr = _library.gnutls_transport_set_ptr

749

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

750

transport_set_ptr.restype = None

751

752

bye = _library.gnutls_bye

753

bye.argtypes = [session_t, close_request_t]

754

bye.restype = _error_code

755

bye.errcheck = _retry_on_error

756

757

check_version = _library.gnutls_check_version

758

check_version.argtypes = [ctypes.c_char_p]

759

check_version.restype = ctypes.c_char_p

760

761

_need_version = b"3.3.0"

762

if check_version(_need_version) is None:

763

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

764

.format(_need_version))

765

766

_tls_rawpk_version = b"3.6.6"

767

has_rawpk = bool(check_version(_tls_rawpk_version))

768

769

if has_rawpk:

770

# Types

771

class pubkey_st(ctypes.Structure):

772

_fields = []

773

pubkey_t = ctypes.POINTER(pubkey_st)

774

775

x509_crt_fmt_t = ctypes.c_int

776

777

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

778

pubkey_init = _library.gnutls_pubkey_init

779

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

780

pubkey_init.restype = _error_code

781

782

pubkey_import = _library.gnutls_pubkey_import

783

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

784

x509_crt_fmt_t]

785

pubkey_import.restype = _error_code

786

787

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

788

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

789

ctypes.POINTER(ctypes.c_ubyte),

790

ctypes.POINTER(ctypes.c_size_t)]

791

pubkey_get_key_id.restype = _error_code

792

793

pubkey_deinit = _library.gnutls_pubkey_deinit

794

pubkey_deinit.argtypes = [pubkey_t]

795

pubkey_deinit.restype = None

796

else:

797

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

798

799

openpgp_crt_init = _library.gnutls_openpgp_crt_init

800

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

801

openpgp_crt_init.restype = _error_code

802

803

openpgp_crt_import = _library.gnutls_openpgp_crt_import

804

openpgp_crt_import.argtypes = [openpgp_crt_t,

805

ctypes.POINTER(datum_t),

806

openpgp_crt_fmt_t]

807

openpgp_crt_import.restype = _error_code

808

809

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

810

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

811

ctypes.POINTER(ctypes.c_uint)]

812

openpgp_crt_verify_self.restype = _error_code

813

814

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

815

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

816

openpgp_crt_deinit.restype = None

817

818

openpgp_crt_get_fingerprint = (

819

_library.gnutls_openpgp_crt_get_fingerprint)

820

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

821

ctypes.c_void_p,

822

ctypes.POINTER(

823

ctypes.c_size_t)]

824

openpgp_crt_get_fingerprint.restype = _error_code

825

826

if check_version(b"3.6.4"):

827

certificate_type_get2 = _library.gnutls_certificate_type_get2

828

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

829

certificate_type_get2.restype = _error_code

830

831

# Remove non-public functions

832

del _error_code, _retry_on_error

833

834

835

def call_pipe(connection, # : multiprocessing.Connection

836

func, *args, **kwargs):

837

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

838

839

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

840

return value on the provided multiprocessing.Connection.

841

"""

842

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

843

connection.close()

844

845

846

class Client:

411

847

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

412

848

413

849

Attributes:

414

850

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

415

851

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

416

852

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

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

853

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

854

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

855

running.

856

checker_callback_tag: a GLib event source tag, or None

421

857

checker_command: string; External command which is run to check

422

858

if client lives. %() expansions are done at

423

859

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

424

860

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

425

checker_initiator_tag: a gobject event source tag, or None

861

checker_initiator_tag: a GLib event source tag, or None

426

862

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

427

863

client_structure: Object describing what attributes a client has

428

864

and is used for storing the client at exit

429

865

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

866

disable_initiator_tag: a GLib event source tag, or None

431

867

enabled: bool()

432

868

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

433

uniquely identify the client

869

uniquely identify an OpenPGP client

870

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

871

a client using raw public keys

434

872

host: string; available for use by the checker command

435

873

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

436

874

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

438

876

last_checker_status: integer between 0 and 255 reflecting exit

439

877

status of last checker. -1 reflects crashed

440

878

checker, -2 means no checker completed yet.

879

last_checker_signal: The signal which killed the last checker, if

880

last_checker_status is -1

441

881

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

442

882

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

443

883

D-Bus identifiers

450

890

disabled, or None

451

891

server_settings: The server_settings dict from main()

452

892

"""

453

893

454

894

runtime_expansions = ("approval_delay", "approval_duration",

455

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

895

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

456

896

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

457

897

"last_approval_request", "last_checked_ok",

458

898

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

899

client_defaults = {

900

"timeout": "PT5M",

901

"extended_timeout": "PT15M",

902

"interval": "PT2M",

903

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

904

"host": "",

905

"approval_delay": "PT0S",

906

"approval_duration": "PT1S",

907

"approved_by_default": "True",

908

"enabled": "True",

909

}

910

485

911

@staticmethod

486

912

def config_parser(config):

487

913

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

494

920

for client_name in config.sections():

495

921

section = dict(config.items(client_name))

496

922

client = settings[client_name] = {}

497

923

498

924

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

499

925

# Reformat values from string types to Python types

500

926

client["approved_by_default"] = config.getboolean(

501

927

client_name, "approved_by_default")

502

928

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

503

929

"enabled")

504

930

931

# Uppercase and remove spaces from key_id and fingerprint

932

# for later comparison purposes with return value from the

933

# key_id() and fingerprint() functions

934

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

935

.replace(" ", ""))

505

936

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

506

937

.replace(" ", ""))

507

938

if "secret" in section:

508

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

939

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

940

.encode("utf-8"),

941

"base64")

509

942

elif "secfile" in section:

510

943

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

511

944

(section["secfile"])),

512

945

"rb") as secfile:

513

946

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

514

947

else:

515

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

948

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

516

949

.format(section))

517

950

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

518

951

client["extended_timeout"] = string_to_delta(

526

959

client["last_approval_request"] = None

527

960

client["last_checked_ok"] = None

528

961

client["last_checker_status"] = -2

529

962

530

963

return settings

531

532

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

964

965

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

533

966

self.name = name

534

967

if server_settings is None:

535

968

server_settings = {}

536

969

self.server_settings = server_settings

537

970

# adding all client settings

538

for setting, value in settings.iteritems():

971

for setting, value in settings.items():

539

972

setattr(self, setting, value)

540

973

541

974

if self.enabled:

542

975

if not hasattr(self, "last_enabled"):

543

976

self.last_enabled = datetime.datetime.utcnow()

547

980

else:

548

981

self.last_enabled = None

549

982

self.expires = None

550

983

551

984

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

985

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

555

986

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

556

987

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

557

988

datetime.datetime.utcnow())

558

989

559

990

# attributes specific for this server instance

560

991

self.checker = None

561

992

self.checker_initiator_tag = None

564

995

self.current_checker_command = None

565

996

self.approved = None

566

997

self.approvals_pending = 0

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

998

self.changedstate = multiprocessing_manager.Condition(

999

multiprocessing_manager.Lock())

1000

self.client_structure = [attr

1001

for attr in self.__dict__.keys()

572

1002

if not attr.startswith("_")]

573

1003

self.client_structure.append("client_structure")

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

1004

1005

for name, t in inspect.getmembers(

1006

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

579

1007

if not name.startswith("_"):

580

1008

self.client_structure.append(name)

581

1009

582

1010

# Send notice to process children that client state has changed

583

1011

def send_changedstate(self):

584

1012

with self.changedstate:

585

1013

self.changedstate.notify_all()

586

1014

587

1015

def enable(self):

588

1016

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

589

1017

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

594

1022

self.last_enabled = datetime.datetime.utcnow()

595

1023

self.init_checker()

596

1024

self.send_changedstate()

597

1025

598

1026

def disable(self, quiet=True):

599

1027

"""Disable this client."""

600

1028

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

602

1030

if not quiet:

603

1031

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

604

1032

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

605

gobject.source_remove(self.disable_initiator_tag)

1033

GLib.source_remove(self.disable_initiator_tag)

606

1034

self.disable_initiator_tag = None

607

1035

self.expires = None

608

1036

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

609

gobject.source_remove(self.checker_initiator_tag)

1037

GLib.source_remove(self.checker_initiator_tag)

610

1038

self.checker_initiator_tag = None

611

1039

self.stop_checker()

612

1040

self.enabled = False

613

1041

if not quiet:

614

1042

self.send_changedstate()

615

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

1043

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

616

1044

return False

617

1045

618

1046

def __del__(self):

619

1047

self.disable()

620

1048

621

1049

def init_checker(self):

622

1050

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

623

1051

# and every interval from then on.

624

1052

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

1053

GLib.source_remove(self.checker_initiator_tag)

1054

self.checker_initiator_tag = GLib.timeout_add(

1055

random.randrange(int(self.interval.total_seconds() * 1000

1056

+ 1)),

1057

self.start_checker)

629

1058

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

630

1059

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

1060

GLib.source_remove(self.disable_initiator_tag)

1061

self.disable_initiator_tag = GLib.timeout_add(

1062

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

635

1063

# Also start a new checker *right now*.

636

1064

self.start_checker()

637

638

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

1065

1066

def checker_callback(self, source, condition, connection,

1067

command):

639

1068

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

1069

# Read return code from connection (see call_pipe)

1070

returncode = connection.recv()

1071

connection.close()

1072

if self.checker is not None:

1073

self.checker.join()

640

1074

self.checker_callback_tag = None

641

1075

self.checker = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1076

1077

if returncode >= 0:

1078

self.last_checker_status = returncode

1079

self.last_checker_signal = None

644

1080

if self.last_checker_status == 0:

645

1081

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

646

1082

vars(self))

647

1083

self.checked_ok()

648

1084

else:

649

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

650

vars(self))

1085

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

651

1086

else:

652

1087

self.last_checker_status = -1

1088

self.last_checker_signal = -returncode

653

1089

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

654

1090

vars(self))

655

1091

return False

1092

656

1093

def checked_ok(self):

657

1094

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

658

1095

self.last_checked_ok = datetime.datetime.utcnow()

659

1096

self.last_checker_status = 0

1097

self.last_checker_signal = None

660

1098

self.bump_timeout()

661

1099

662

1100

def bump_timeout(self, timeout=None):

663

1101

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

664

1102

if timeout is None:

665

1103

timeout = self.timeout

666

1104

if self.disable_initiator_tag is not None:

667

gobject.source_remove(self.disable_initiator_tag)

1105

GLib.source_remove(self.disable_initiator_tag)

668

1106

self.disable_initiator_tag = None

669

1107

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1108

self.disable_initiator_tag = GLib.timeout_add(

1109

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

673

1110

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

674

1111

675

1112

def need_approval(self):

676

1113

self.last_approval_request = datetime.datetime.utcnow()

677

1114

678

1115

def start_checker(self):

679

1116

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

680

1117

681

1118

If a checker already exists, leave it running and do

682

1119

nothing."""

683

1120

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

688

1125

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

689

1126

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

690

1127

# should be.

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1128

1129

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

1130

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

1131

self.checker.join()

1132

self.checker = None

706

1133

# Start a new checker if needed

707

1134

if self.checker is None:

708

1135

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1136

escaped_attrs = {

1137

attr: shlex.quote(str(getattr(self, attr)))

1138

for attr in self.runtime_expansions}

713

1139

try:

714

1140

command = self.checker_command % escaped_attrs

715

1141

except TypeError as error:

716

1142

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1143

self.checker_command,

1144

exc_info=error)

1145

return True # Try again later

719

1146

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1147

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

1148

self.name)

1149

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

1150

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

1151

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

1152

# always replaced by /dev/null.)

1153

# The exception is when not debugging but nevertheless

1154

# running in the foreground; use the previously

1155

# created wnull.

1156

popen_args = {"close_fds": True,

1157

"shell": True,

1158

"cwd": "/"}

1159

if (not self.server_settings["debug"]

1160

and self.server_settings["foreground"]):

1161

popen_args.update({"stdout": wnull,

1162

"stderr": wnull})

1163

pipe = multiprocessing.Pipe(duplex=False)

1164

self.checker = multiprocessing.Process(

1165

target=call_pipe,

1166

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

1167

kwargs=popen_args)

1168

self.checker.start()

1169

self.checker_callback_tag = GLib.io_add_watch(

1170

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

1171

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1172

self.checker_callback, pipe[0], command)

1173

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

762

1174

return True

763

1175

764

1176

def stop_checker(self):

765

1177

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

766

1178

if self.checker_callback_tag:

767

gobject.source_remove(self.checker_callback_tag)

1179

GLib.source_remove(self.checker_callback_tag)

768

1180

self.checker_callback_tag = None

769

1181

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

770

1182

return

771

1183

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

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1184

self.checker.terminate()

780

1185

self.checker = None

781

1186

782

1187

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1188

def dbus_service_property(dbus_interface,

1189

signature="v",

1190

access="readwrite",

1191

byte_arrays=False):

785

1192

"""Decorators for marking methods of a DBusObjectWithProperties to

786

1193

become properties on the D-Bus.

787

1194

788

1195

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

789

1196

and with one argument by "Set".

790

1197

791

1198

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

792

1199

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

793

1200

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

796

1203

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

797

1204

if byte_arrays and signature != "ay":

798

1205

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

799

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

1206

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

1207

800

1208

def decorator(func):

801

1209

func._dbus_is_property = True

802

1210

func._dbus_interface = dbus_interface

805

1213

func._dbus_name = func.__name__

806

1214

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

807

1215

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

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1216

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

1217

return func

1218

810

1219

return decorator

811

1220

812

1221

813

1222

def dbus_interface_annotations(dbus_interface):

814

1223

"""Decorator for marking functions returning interface annotations

815

1224

816

1225

Usage:

817

1226

818

1227

@dbus_interface_annotations("org.example.Interface")

819

1228

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

820

1229

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

821

1230

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

822

1231

"false"}

823

1232

"""

1233

824

1234

def decorator(func):

825

1235

func._dbus_is_interface = True

826

1236

func._dbus_interface = dbus_interface

827

1237

func._dbus_name = dbus_interface

828

1238

return func

1239

829

1240

return decorator

830

1241

831

1242

832

1243

def dbus_annotations(annotations):

833

1244

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

834

1245

Usage:

835

1246

1247

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

1248

"org.freedesktop.DBus.Property."

1249

"EmitsChangedSignal": "false"})

836

1250

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

837

1251

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

1252

def Property_dbus_property(self):

842

1253

return dbus.Boolean(False)

1254

1255

See also the DBusObjectWithAnnotations class.

843

1256

"""

1257

844

1258

def decorator(func):

845

1259

func._dbus_annotations = annotations

846

1260

return func

1261

847

1262

return decorator

848

1263

849

1264

850

1265

class DBusPropertyException(dbus.exceptions.DBusException):

851

1266

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

852

1267

"""

853

def __unicode__(self):

854

return unicode(str(self))

1268

pass

855

1269

856

1270

857

1271

class DBusPropertyAccessException(DBusPropertyException):

866

1280

pass

867

1281

868

1282

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1283

class DBusObjectWithAnnotations(dbus.service.Object):

1284

"""A D-Bus object with annotations.

1285

1286

Classes inheriting from this can use the dbus_annotations

1287

decorator to add annotations to methods or signals.

875

1288

"""

876

1289

877

1290

@staticmethod

878

1291

def _is_dbus_thing(thing):

879

1292

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

880

1293

881

1294

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

882

1295

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

883

1296

"""

884

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

1297

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

885

1298

False)

886

1299

887

1300

def _get_all_dbus_things(self, thing):

888

1301

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

889

1302

"""

890

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

891

name),

1303

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

892

1304

athing.__get__(self))

893

1305

for cls in self.__class__.__mro__

894

1306

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1307

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

1308

1309

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1310

out_signature="s",

1311

path_keyword='object_path',

1312

connection_keyword='connection')

1313

def Introspect(self, object_path, connection):

1314

"""Overloading of standard D-Bus method.

1315

1316

Inserts annotation tags on methods and signals.

1317

"""

1318

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

1319

connection)

1320

try:

1321

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

1322

1323

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

1324

# Add annotation tags

1325

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

1326

for tag in if_tag.getElementsByTagName(typ):

1327

annots = dict()

1328

for name, prop in (self.

1329

_get_all_dbus_things(typ)):

1330

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

1331

and prop._dbus_interface

1332

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

1333

annots.update(getattr(

1334

prop, "_dbus_annotations", {}))

1335

for name, value in annots.items():

1336

ann_tag = document.createElement(

1337

"annotation")

1338

ann_tag.setAttribute("name", name)

1339

ann_tag.setAttribute("value", value)

1340

tag.appendChild(ann_tag)

1341

# Add interface annotation tags

1342

for annotation, value in dict(

1343

itertools.chain.from_iterable(

1344

annotations().items()

1345

for name, annotations

1346

in self._get_all_dbus_things("interface")

1347

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

1348

)).items():

1349

ann_tag = document.createElement("annotation")

1350

ann_tag.setAttribute("name", annotation)

1351

ann_tag.setAttribute("value", value)

1352

if_tag.appendChild(ann_tag)

1353

# Fix argument name for the Introspect method itself

1354

if (if_tag.getAttribute("name")

1355

== dbus.INTROSPECTABLE_IFACE):

1356

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

1357

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

1358

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

1359

if (arg.getAttribute("direction")

1360

== "out"):

1361

arg.setAttribute("name",

1362

"xml_data")

1363

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

1364

document.unlink()

1365

except (AttributeError, xml.dom.DOMException,

1366

xml.parsers.expat.ExpatError) as error:

1367

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

1368

exc_info=error)

1369

return xmlstring

1370

1371

1372

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1373

"""A D-Bus object with properties.

1374

1375

Classes inheriting from this can use the dbus_service_property

1376

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

1377

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

1378

"""

1379

898

1380

def _get_dbus_property(self, interface_name, property_name):

899

1381

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

900

1382

property with the specified name and interface.

901

1383

"""

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1384

for cls in self.__class__.__mro__:

1385

for name, value in inspect.getmembers(

1386

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

906

1387

if (value._dbus_name == property_name

907

1388

and value._dbus_interface == interface_name):

908

1389

return value.__get__(self)

909

1390

910

1391

# No such property

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1392

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

1393

self.dbus_object_path, interface_name, property_name))

1394

1395

@classmethod

1396

def _get_all_interface_names(cls):

1397

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

1398

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

1399

"_dbus_interface", None)

1400

for x in (inspect.getmro(cls))

1401

for attr in dir(x))

1402

if name is not None)

1403

1404

@dbus.service.method(dbus.PROPERTIES_IFACE,

1405

in_signature="ss",

916

1406

out_signature="v")

917

1407

def Get(self, interface_name, property_name):

918

1408

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

924

1414

if not hasattr(value, "variant_level"):

925

1415

return value

926

1416

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

927

1417

928

1418

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

929

1419

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

930

1420

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

937

1427

# signatures other than "ay".

938

1428

if prop._dbus_signature != "ay":

939

1429

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

940

"'ay' signature {0!r}"

1430

"'ay' signature {!r}"

941

1431

.format(prop._dbus_signature))

942

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

943

for byte in value))

1432

value = dbus.ByteArray(bytes(value))

944

1433

prop(value)

945

946

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

1434

1435

@dbus.service.method(dbus.PROPERTIES_IFACE,

1436

in_signature="s",

947

1437

out_signature="a{sv}")

948

1438

def GetAll(self, interface_name):

949

1439

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

950

1440

standard.

951

1441

952

1442

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

953

1443

"""

954

1444

properties = {}

964

1454

if not hasattr(value, "variant_level"):

965

1455

properties[name] = value

966

1456

continue

967

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

968

value.variant_level+1)

1457

properties[name] = type(value)(

1458

value, variant_level=value.variant_level + 1)

969

1459

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

970

1460

1461

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

1462

def PropertiesChanged(self, interface_name, changed_properties,

1463

invalidated_properties):

1464

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

1465

standard.

1466

"""

1467

pass

1468

971

1469

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

972

1470

out_signature="s",

973

1471

path_keyword='object_path',

974

1472

connection_keyword='connection')

975

1473

def Introspect(self, object_path, connection):

976

1474

"""Overloading of standard D-Bus method.

977

1475

978

1476

Inserts property tags and interface annotation tags.

979

1477

"""

980

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

981

connection)

1478

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1479

object_path,

1480

connection)

982

1481

try:

983

1482

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

1483

984

1484

def make_tag(document, name, prop):

985

1485

e = document.createElement("property")

986

1486

e.setAttribute("name", name)

987

1487

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

988

1488

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

989

1489

return e

1490

990

1491

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

991

1492

# Add property tags

992

1493

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

995

1496

if prop._dbus_interface

996

1497

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

997

1498

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1499

# Add annotation tags for properties

1500

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

1501

annots = dict()

1502

for name, prop in self._get_all_dbus_things(

1503

"property"):

1504

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

1505

and prop._dbus_interface

1506

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

1507

annots.update(getattr(

1508

prop, "_dbus_annotations", {}))

1509

for name, value in annots.items():

1510

ann_tag = document.createElement(

1511

"annotation")

1512

ann_tag.setAttribute("name", name)

1513

ann_tag.setAttribute("value", value)

1514

tag.appendChild(ann_tag)

1029

1515

# Add the names to the return values for the

1030

1516

# "org.freedesktop.DBus.Properties" methods

1031

1517

if (if_tag.getAttribute("name")

1050

1536

return xmlstring

1051

1537

1052

1538

1539

try:

1540

dbus.OBJECT_MANAGER_IFACE

1541

except AttributeError:

1542

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

1543

1544

1545

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1546

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

1547

1548

Classes inheriting from this exposes the standard

1549

GetManagedObjects call and the InterfacesAdded and

1550

InterfacesRemoved signals on the standard

1551

"org.freedesktop.DBus.ObjectManager" interface.

1552

1553

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

1554

manually.

1555

"""

1556

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1557

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

1558

def GetManagedObjects(self):

1559

"""This function must be overridden"""

1560

raise NotImplementedError()

1561

1562

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1563

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

1564

def InterfacesAdded(self, object_path, interfaces_and_properties):

1565

pass

1566

1567

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

1568

def InterfacesRemoved(self, object_path, interfaces):

1569

pass

1570

1571

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1572

out_signature="s",

1573

path_keyword='object_path',

1574

connection_keyword='connection')

1575

def Introspect(self, object_path, connection):

1576

"""Overloading of standard D-Bus method.

1577

1578

Override return argument name of GetManagedObjects to be

1579

"objpath_interfaces_and_properties"

1580

"""

1581

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1582

object_path,

1583

connection)

1584

try:

1585

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

1586

1587

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

1588

# Fix argument name for the GetManagedObjects method

1589

if (if_tag.getAttribute("name")

1590

== dbus.OBJECT_MANAGER_IFACE):

1591

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

1592

if (cn.getAttribute("name")

1593

== "GetManagedObjects"):

1594

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

1595

if (arg.getAttribute("direction")

1596

== "out"):

1597

arg.setAttribute(

1598

"name",

1599

"objpath_interfaces"

1600

"_and_properties")

1601

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

1602

document.unlink()

1603

except (AttributeError, xml.dom.DOMException,

1604

xml.parsers.expat.ExpatError) as error:

1605

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

1606

exc_info=error)

1607

return xmlstring

1608

1609

1053

1610

def datetime_to_dbus(dt, variant_level=0):

1054

1611

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

1055

1612

if dt is None:

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1613

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

1614

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

1059

1615

1060

1616

1061

1617

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1063

1619

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

1064

1620

interface names according to the "alt_interface_names" mapping.

1065

1621

Usage:

1066

1622

1067

1623

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

1068

1624

"net.example.AlternateInterface"})

1069

1625

class SampleDBusObject(dbus.service.Object):

1070

1626

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

1071

1627

def SampleDBusMethod():

1072

1628

pass

1073

1629

1074

1630

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

1631

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

1076

1632

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

1077

1633

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

1078

1634

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

1079

1635

1080

1636

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

1081

1637

(from DBusObjectWithProperties) and interfaces (from the

1082

1638

dbus_interface_annotations decorator).

1083

1639

"""

1640

1084

1641

def wrapper(cls):

1085

1642

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1643

alt_interface_names.items()):

1087

1644

attr = {}

1088

1645

interface_names = set()

1089

1646

# Go though all attributes of the class

1091

1648

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

1092

1649

# with the wrong interface name

1093

1650

if (not hasattr(attribute, "_dbus_interface")

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1651

or not attribute._dbus_interface.startswith(

1652

orig_interface_name)):

1096

1653

continue

1097

1654

# Create an alternate D-Bus interface name based on

1098

1655

# the current name

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1656

alt_interface = attribute._dbus_interface.replace(

1657

orig_interface_name, alt_interface_name)

1102

1658

interface_names.add(alt_interface)

1103

1659

# Is this a D-Bus signal?

1104

1660

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

1105

1661

# Extract the original non-method undecorated

1106

1662

# function by black magic

1107

nonmethod_func = (dict(

1663

if sys.version_info.major == 2:

1664

nonmethod_func = (dict(

1108

1665

zip(attribute.func_code.co_freevars,

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1666

attribute.__closure__))

1667

["func"].cell_contents)

1668

else:

1669

nonmethod_func = (dict(

1670

zip(attribute.__code__.co_freevars,

1671

attribute.__closure__))

1672

["func"].cell_contents)

1111

1673

# Create a new, but exactly alike, function

1112

1674

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

1113

1675

# with the alternate D-Bus interface name

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1676

new_function = copy_function(nonmethod_func)

1677

new_function = (dbus.service.signal(

1678

alt_interface,

1679

attribute._dbus_signature)(new_function))

1123

1680

# Copy annotations, if any

1124

1681

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1682

new_function._dbus_annotations = dict(

1683

attribute._dbus_annotations)

1127

1684

except AttributeError:

1128

1685

pass

1686

1129

1687

# Define a creator of a function to call both the

1130

1688

# original and alternate functions, so both the

1131

1689

# original and alternate signals gets sent when

1134

1692

"""This function is a scope container to pass

1135

1693

func1 and func2 to the "call_both" function

1136

1694

outside of its arguments"""

1695

1696

@functools.wraps(func2)

1137

1697

def call_both(*args, **kwargs):

1138

1698

"""This function will emit two D-Bus

1139

1699

signals by calling func1 and func2"""

1140

1700

func1(*args, **kwargs)

1141

1701

func2(*args, **kwargs)

1702

# Make wrapper function look like a D-Bus

1703

# signal

1704

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

1705

if name.startswith("_dbus_"):

1706

setattr(call_both, name, attr)

1707

1142

1708

return call_both

1143

1709

# Create the "call_both" function and add it to

1144

1710

# the class

1149

1715

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

1150

1716

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

1151

1717

# to the class.

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1718

attr[attrname] = (

1719

dbus.service.method(

1720

alt_interface,

1721

attribute._dbus_in_signature,

1722

attribute._dbus_out_signature)

1723

(copy_function(attribute)))

1162

1724

# Copy annotations, if any

1163

1725

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1726

attr[attrname]._dbus_annotations = dict(

1727

attribute._dbus_annotations)

1166

1728

except AttributeError:

1167

1729

pass

1168

1730

# Is this a D-Bus property?

1171

1733

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

1172

1734

# property with the alternate D-Bus interface

1173

1735

# name. Add it to the class.

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1736

attr[attrname] = (dbus_service_property(

1737

alt_interface, attribute._dbus_signature,

1738

attribute._dbus_access,

1739

attribute._dbus_get_args_options

1740

["byte_arrays"])

1741

(copy_function(attribute)))

1187

1742

# Copy annotations, if any

1188

1743

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1744

attr[attrname]._dbus_annotations = dict(

1745

attribute._dbus_annotations)

1191

1746

except AttributeError:

1192

1747

pass

1193

1748

# Is this a D-Bus interface?

1196

1751

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

1197

1752

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

1198

1753

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1754

attr[attrname] = (

1755

dbus_interface_annotations(alt_interface)

1756

(copy_function(attribute)))

1207

1757

if deprecate:

1208

1758

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1759

iname = "_AlternateDBusNames_interface_annotation{}"

1210

1760

for interface_name in interface_names:

1761

1211

1762

@dbus_interface_annotations(interface_name)

1212

1763

def func(self):

1213

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

1214

"true" }

1764

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

1765

"true"}

1215

1766

# Find an unused name

1216

1767

for aname in (iname.format(i)

1217

1768

for i in itertools.count()):

1221

1772

if interface_names:

1222

1773

# Replace the class with a new subclass of it with

1223

1774

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1775

if sys.version_info.major == 2:

1776

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

1777

(cls, ), attr)

1778

else:

1779

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

1780

(cls, ), attr)

1226

1781

return cls

1782

1227

1783

return wrapper

1228

1784

1229

1785

1230

1786

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

1231

"se.bsnet.fukt.Mandos"})

1787

"se.bsnet.fukt.Mandos"})

1232

1788

class ClientDBus(Client, DBusObjectWithProperties):

1233

1789

"""A Client class using D-Bus

1234

1790

1235

1791

Attributes:

1236

1792

dbus_object_path: dbus.ObjectPath

1237

1793

bus: dbus.SystemBus()

1238

1794

"""

1239

1795

1240

1796

runtime_expansions = (Client.runtime_expansions

1241

+ ("dbus_object_path",))

1242

1797

+ ("dbus_object_path", ))

1798

1799

_interface = "se.recompile.Mandos.Client"

1800

1243

1801

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

1244

1245

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

1802

1803

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

1246

1804

self.bus = bus

1247

1805

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

1248

1806

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

1249

1807

# the D-Bus

1250

client_object_name = unicode(self.name).translate(

1808

client_object_name = str(self.name).translate(

1251

1809

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

1252

1810

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

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1811

self.dbus_object_path = dbus.ObjectPath(

1812

"/clients/" + client_object_name)

1255

1813

DBusObjectWithProperties.__init__(self, self.bus,

1256

1814

self.dbus_object_path)

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1815

1816

def notifychangeproperty(transform_func, dbus_name,

1817

type_func=lambda x: x,

1818

variant_level=1,

1819

invalidate_only=False,

1820

_interface=_interface):

1261

1821

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

1262

1822

its changes to DBus.

1263

1823

1264

1824

transform_fun: Function that takes a value and a variant_level

1265

1825

and transforms it to a D-Bus type.

1266

1826

dbus_name: D-Bus name of the variable

1268

1828

to the D-Bus. Default: no transform

1269

1829

variant_level: D-Bus variant level. Default: 1

1270

1830

"""

1271

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

1831

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

1832

1272

1833

def setter(self, value):

1273

1834

if hasattr(self, "dbus_object_path"):

1274

1835

if (not hasattr(self, attrname) or

1275

1836

type_func(getattr(self, attrname, None))

1276

1837

!= type_func(value)):

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1838

if invalidate_only:

1839

self.PropertiesChanged(

1840

_interface, dbus.Dictionary(),

1841

dbus.Array((dbus_name, )))

1842

else:

1843

dbus_value = transform_func(

1844

type_func(value),

1845

variant_level=variant_level)

1846

self.PropertyChanged(dbus.String(dbus_name),

1847

dbus_value)

1848

self.PropertiesChanged(

1849

_interface,

1850

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

1851

dbus_value}),

1852

dbus.Array())

1282

1853

setattr(self, attrname, value)

1283

1854

1284

1855

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

1285

1856

1286

1857

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1287

1858

approvals_pending = notifychangeproperty(dbus.Boolean,

1288

1859

"ApprovalPending",

1289

type_func = bool)

1860

type_func=bool)

1290

1861

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

1291

1862

last_enabled = notifychangeproperty(datetime_to_dbus,

1292

1863

"LastEnabled")

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1864

checker = notifychangeproperty(

1865

dbus.Boolean, "CheckerRunning",

1866

type_func=lambda checker: checker is not None)

1296

1867

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1297

1868

"LastCheckedOK")

1298

1869

last_checker_status = notifychangeproperty(dbus.Int16,

1301

1872

datetime_to_dbus, "LastApprovalRequest")

1302

1873

approved_by_default = notifychangeproperty(dbus.Boolean,

1303

1874

"ApprovedByDefault")

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1875

approval_delay = notifychangeproperty(

1876

dbus.UInt64, "ApprovalDelay",

1877

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

1308

1878

approval_duration = notifychangeproperty(

1309

1879

dbus.UInt64, "ApprovalDuration",

1310

type_func = timedelta_to_milliseconds)

1880

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

1311

1881

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1882

timeout = notifychangeproperty(

1883

dbus.UInt64, "Timeout",

1884

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

1315

1885

extended_timeout = notifychangeproperty(

1316

1886

dbus.UInt64, "ExtendedTimeout",

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1887

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

1888

interval = notifychangeproperty(

1889

dbus.UInt64, "Interval",

1890

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

1322

1891

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

1323

1892

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

1893

invalidate_only=True)

1894

1324

1895

del notifychangeproperty

1325

1896

1326

1897

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

1327

1898

try:

1328

1899

self.remove_from_connection()

1331

1902

if hasattr(DBusObjectWithProperties, "__del__"):

1332

1903

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

1333

1904

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

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1905

1906

def checker_callback(self, source, condition,

1907

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

1908

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

1909

connection, command, *args,

1910

**kwargs)

1911

exitstatus = self.last_checker_status

1912

if exitstatus >= 0:

1341

1913

# Emit D-Bus signal

1342

1914

self.CheckerCompleted(dbus.Int16(exitstatus),

1343

dbus.Int64(condition),

1915

# This is specific to GNU libC

1916

dbus.Int64(exitstatus << 8),

1344

1917

dbus.String(command))

1345

1918

else:

1346

1919

# Emit D-Bus signal

1347

1920

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

1348

dbus.Int64(condition),

1921

dbus.Int64(

1922

# This is specific to GNU libC

1923

(exitstatus << 8)

1924

| self.last_checker_signal),

1349

1925

dbus.String(command))

1350

1351

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

1352

*args, **kwargs)

1353

1926

return ret

1927

1354

1928

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

1355

1929

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

1356

1930

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

1360

1934

# Emit D-Bus signal

1361

1935

self.CheckerStarted(self.current_checker_command)

1362

1936

return r

1363

1937

1364

1938

def _reset_approved(self):

1365

1939

self.approved = None

1366

1940

return False

1367

1941

1368

1942

def approve(self, value=True):

1369

1943

self.approved = value

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1944

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

1945

* 1000), self._reset_approved)

1373

1946

self.send_changedstate()

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

1947

1948

# D-Bus methods, signals & properties

1949

1950

# Interfaces

1951

1952

# Signals

1953

1387

1954

# CheckerCompleted - signal

1388

1955

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

1389

1956

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

1390

1957

"D-Bus signal"

1391

1958

pass

1392

1959

1393

1960

# CheckerStarted - signal

1394

1961

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

1395

1962

def CheckerStarted(self, command):

1396

1963

"D-Bus signal"

1397

1964

pass

1398

1965

1399

1966

# PropertyChanged - signal

1967

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

1400

1968

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

1401

1969

def PropertyChanged(self, property, value):

1402

1970

"D-Bus signal"

1403

1971

pass

1404

1972

1405

1973

# GotSecret - signal

1406

1974

@dbus.service.signal(_interface)

1407

1975

def GotSecret(self):

1410

1978

server to mandos-client

1411

1979

"""

1412

1980

pass

1413

1981

1414

1982

# Rejected - signal

1415

1983

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

1416

1984

def Rejected(self, reason):

1417

1985

"D-Bus signal"

1418

1986

pass

1419

1987

1420

1988

# NeedApproval - signal

1421

1989

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

1422

1990

def NeedApproval(self, timeout, default):

1423

1991

"D-Bus signal"

1424

1992

return self.need_approval()

1425

1426

## Methods

1427

1993

1994

# Methods

1995

1428

1996

# Approve - method

1429

1997

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

1430

1998

def Approve(self, value):

1431

1999

self.approve(value)

1432

2000

1433

2001

# CheckedOK - method

1434

2002

@dbus.service.method(_interface)

1435

2003

def CheckedOK(self):

1436

2004

self.checked_ok()

1437

2005

1438

2006

# Enable - method

2007

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

1439

2008

@dbus.service.method(_interface)

1440

2009

def Enable(self):

1441

2010

"D-Bus method"

1442

2011

self.enable()

1443

2012

1444

2013

# StartChecker - method

2014

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

1445

2015

@dbus.service.method(_interface)

1446

2016

def StartChecker(self):

1447

2017

"D-Bus method"

1448

2018

self.start_checker()

1449

2019

1450

2020

# Disable - method

2021

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

1451

2022

@dbus.service.method(_interface)

1452

2023

def Disable(self):

1453

2024

"D-Bus method"

1454

2025

self.disable()

1455

2026

1456

2027

# StopChecker - method

2028

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

1457

2029

@dbus.service.method(_interface)

1458

2030

def StopChecker(self):

1459

2031

self.stop_checker()

1460

1461

## Properties

1462

2032

2033

# Properties

2034

1463

2035

# ApprovalPending - property

1464

2036

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

1465

2037

def ApprovalPending_dbus_property(self):

1466

2038

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

1467

2039

1468

2040

# ApprovedByDefault - property

1469

@dbus_service_property(_interface, signature="b",

2041

@dbus_service_property(_interface,

2042

signature="b",

1470

2043

access="readwrite")

1471

2044

def ApprovedByDefault_dbus_property(self, value=None):

1472

2045

if value is None: # get

1473

2046

return dbus.Boolean(self.approved_by_default)

1474

2047

self.approved_by_default = bool(value)

1475

2048

1476

2049

# ApprovalDelay - property

1477

@dbus_service_property(_interface, signature="t",

2050

@dbus_service_property(_interface,

2051

signature="t",

1478

2052

access="readwrite")

1479

2053

def ApprovalDelay_dbus_property(self, value=None):

1480

2054

if value is None: # get

1481

return dbus.UInt64(self.approval_delay_milliseconds())

2055

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

2056

* 1000)

1482

2057

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

1483

2058

1484

2059

# ApprovalDuration - property

1485

@dbus_service_property(_interface, signature="t",

2060

@dbus_service_property(_interface,

2061

signature="t",

1486

2062

access="readwrite")

1487

2063

def ApprovalDuration_dbus_property(self, value=None):

1488

2064

if value is None: # get

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

2065

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

2066

* 1000)

1491

2067

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

1492

2068

1493

2069

# Name - property

2070

@dbus_annotations(

2071

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

1494

2072

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

1495

2073

def Name_dbus_property(self):

1496

2074

return dbus.String(self.name)

1497

2075

2076

# KeyID - property

2077

@dbus_annotations(

2078

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

2079

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

2080

def KeyID_dbus_property(self):

2081

return dbus.String(self.key_id)

2082

1498

2083

# Fingerprint - property

2084

@dbus_annotations(

2085

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

1499

2086

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

1500

2087

def Fingerprint_dbus_property(self):

1501

2088

return dbus.String(self.fingerprint)

1502

2089

1503

2090

# Host - property

1504

@dbus_service_property(_interface, signature="s",

2091

@dbus_service_property(_interface,

2092

signature="s",

1505

2093

access="readwrite")

1506

2094

def Host_dbus_property(self, value=None):

1507

2095

if value is None: # get

1508

2096

return dbus.String(self.host)

1509

self.host = unicode(value)

1510

2097

self.host = str(value)

2098

1511

2099

# Created - property

2100

@dbus_annotations(

2101

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

1512

2102

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

1513

2103

def Created_dbus_property(self):

1514

2104

return datetime_to_dbus(self.created)

1515

2105

1516

2106

# LastEnabled - property

1517

2107

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

1518

2108

def LastEnabled_dbus_property(self):

1519

2109

return datetime_to_dbus(self.last_enabled)

1520

2110

1521

2111

# Enabled - property

1522

@dbus_service_property(_interface, signature="b",

2112

@dbus_service_property(_interface,

2113

signature="b",

1523

2114

access="readwrite")

1524

2115

def Enabled_dbus_property(self, value=None):

1525

2116

if value is None: # get

1528

2119

self.enable()

1529

2120

else:

1530

2121

self.disable()

1531

2122

1532

2123

# LastCheckedOK - property

1533

@dbus_service_property(_interface, signature="s",

2124

@dbus_service_property(_interface,

2125

signature="s",

1534

2126

access="readwrite")

1535

2127

def LastCheckedOK_dbus_property(self, value=None):

1536

2128

if value is not None:

1537

2129

self.checked_ok()

1538

2130

return

1539

2131

return datetime_to_dbus(self.last_checked_ok)

1540

2132

1541

2133

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2134

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

1544

2135

def LastCheckerStatus_dbus_property(self):

1545

2136

return dbus.Int16(self.last_checker_status)

1546

2137

1547

2138

# Expires - property

1548

2139

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

1549

2140

def Expires_dbus_property(self):

1550

2141

return datetime_to_dbus(self.expires)

1551

2142

1552

2143

# LastApprovalRequest - property

1553

2144

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

1554

2145

def LastApprovalRequest_dbus_property(self):

1555

2146

return datetime_to_dbus(self.last_approval_request)

1556

2147

1557

2148

# Timeout - property

1558

@dbus_service_property(_interface, signature="t",

2149

@dbus_service_property(_interface,

2150

signature="t",

1559

2151

access="readwrite")

1560

2152

def Timeout_dbus_property(self, value=None):

1561

2153

if value is None: # get

1562

return dbus.UInt64(self.timeout_milliseconds())

2154

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

1563

2155

old_timeout = self.timeout

1564

2156

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

1565

2157

# Reschedule disabling

1573

2165

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

1574

2166

is None):

1575

2167

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2168

GLib.source_remove(self.disable_initiator_tag)

2169

self.disable_initiator_tag = GLib.timeout_add(

2170

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

2171

self.disable)

2172

1582

2173

# ExtendedTimeout - property

1583

@dbus_service_property(_interface, signature="t",

2174

@dbus_service_property(_interface,

2175

signature="t",

1584

2176

access="readwrite")

1585

2177

def ExtendedTimeout_dbus_property(self, value=None):

1586

2178

if value is None: # get

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2179

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

2180

* 1000)

1588

2181

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

1589

2182

1590

2183

# Interval - property

1591

@dbus_service_property(_interface, signature="t",

2184

@dbus_service_property(_interface,

2185

signature="t",

1592

2186

access="readwrite")

1593

2187

def Interval_dbus_property(self, value=None):

1594

2188

if value is None: # get

1595

return dbus.UInt64(self.interval_milliseconds())

2189

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

1596

2190

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

1597

2191

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

1598

2192

return

1599

2193

if self.enabled:

1600

2194

# Reschedule checker run

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2195

GLib.source_remove(self.checker_initiator_tag)

2196

self.checker_initiator_tag = GLib.timeout_add(

2197

value, self.start_checker)

2198

self.start_checker() # Start one now, too

2199

1606

2200

# Checker - property

1607

@dbus_service_property(_interface, signature="s",

2201

@dbus_service_property(_interface,

2202

signature="s",

1608

2203

access="readwrite")

1609

2204

def Checker_dbus_property(self, value=None):

1610

2205

if value is None: # get

1611

2206

return dbus.String(self.checker_command)

1612

self.checker_command = unicode(value)

1613

2207

self.checker_command = str(value)

2208

1614

2209

# CheckerRunning - property

1615

@dbus_service_property(_interface, signature="b",

2210

@dbus_service_property(_interface,

2211

signature="b",

1616

2212

access="readwrite")

1617

2213

def CheckerRunning_dbus_property(self, value=None):

1618

2214

if value is None: # get

1621

2217

self.start_checker()

1622

2218

else:

1623

2219

self.stop_checker()

1624

2220

1625

2221

# ObjectPath - property

2222

@dbus_annotations(

2223

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

2224

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

1626

2225

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

1627

2226

def ObjectPath_dbus_property(self):

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2227

return self.dbus_object_path # is already a dbus.ObjectPath

2228

1630

2229

# Secret = property

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2230

@dbus_annotations(

2231

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

2232

"invalidates"})

2233

@dbus_service_property(_interface,

2234

signature="ay",

2235

access="write",

2236

byte_arrays=True)

1633

2237

def Secret_dbus_property(self, value):

1634

self.secret = str(value)

1635

2238

self.secret = bytes(value)

2239

1636

2240

del _interface

1637

2241

1638

2242

1639

class ProxyClient(object):

1640

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

2243

class ProxyClient:

2244

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

1641

2245

self._pipe = child_pipe

1642

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

2246

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

1643

2247

if not self._pipe.recv():

1644

raise KeyError()

1645

2248

raise KeyError(key_id or fpr)

2249

1646

2250

def __getattribute__(self, name):

1647

2251

if name == '_pipe':

1648

2252

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

1651

2255

if data[0] == 'data':

1652

2256

return data[1]

1653

2257

if data[0] == 'function':

2258

1654

2259

def func(*args, **kwargs):

1655

2260

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

1656

2261

return self._pipe.recv()[1]

2262

1657

2263

return func

1658

2264

1659

2265

def __setattr__(self, name, value):

1660

2266

if name == '_pipe':

1661

2267

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

1664

2270

1665

2271

class ClientHandler(socketserver.BaseRequestHandler, object):

1666

2272

"""A class to handle client connections.

1667

2273

1668

2274

Instantiated once for each connection to handle it.

1669

2275

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

1670

2276

1671

2277

def handle(self):

1672

2278

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

1673

2279

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

1674

unicode(self.client_address))

2280

str(self.client_address))

1675

2281

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

1676

2282

self.server.child_pipe.fileno())

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2283

2284

session = gnutls.ClientSession(self.request)

2285

2286

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

2287

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

2288

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

2289

# "+DHE-DSS"))

1692

2290

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

1693

2291

priority = self.server.gnutls_priority

1694

2292

if priority is None:

1695

2293

priority = "NORMAL"

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2294

gnutls.priority_set_direct(session._c_object,

2295

priority.encode("utf-8"),

2296

None)

2297

1700

2298

# Start communication using the Mandos protocol

1701

2299

# Get protocol number

1702

2300

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

1707

2305

except (ValueError, IndexError, RuntimeError) as error:

1708

2306

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

1709

2307

return

1710

2308

1711

2309

# Start GnuTLS connection

1712

2310

try:

1713

2311

session.handshake()

1714

except gnutls.errors.GNUTLSError as error:

2312

except gnutls.Error as error:

1715

2313

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

1716

2314

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

1717

2315

# established. Just abandon the request.

1718

2316

return

1719

2317

logger.debug("Handshake succeeded")

1720

2318

1721

2319

approval_required = False

1722

2320

try:

1723

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

1728

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

1729

return

1730

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

1731

1732

try:

1733

client = ProxyClient(child_pipe, fpr,

2321

if gnutls.has_rawpk:

2322

fpr = b""

2323

try:

2324

key_id = self.key_id(

2325

self.peer_certificate(session))

2326

except (TypeError, gnutls.Error) as error:

2327

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

2328

return

2329

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

2330

2331

else:

2332

key_id = b""

2333

try:

2334

fpr = self.fingerprint(

2335

self.peer_certificate(session))

2336

except (TypeError, gnutls.Error) as error:

2337

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

2338

return

2339

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

2340

2341

try:

2342

client = ProxyClient(child_pipe, key_id, fpr,

1734

2343

self.client_address)

1735

2344

except KeyError:

1736

2345

return

1737

2346

1738

2347

if client.approval_delay:

1739

2348

delay = client.approval_delay

1740

2349

client.approvals_pending += 1

1741

2350

approval_required = True

1742

2351

1743

2352

while True:

1744

2353

if not client.enabled:

1745

2354

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

1746

client.name)

2355

client.name)

1747

2356

if self.server.use_dbus:

1748

2357

# Emit D-Bus signal

1749

2358

client.Rejected("Disabled")

1750

2359

return

1751

2360

1752

2361

if client.approved or not client.approval_delay:

1753

#We are approved or approval is disabled

2362

# We are approved or approval is disabled

1754

2363

break

1755

2364

elif client.approved is None:

1756

2365

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

1758

2367

if self.server.use_dbus:

1759

2368

# Emit D-Bus signal

1760

2369

client.NeedApproval(

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2370

client.approval_delay.total_seconds()

2371

* 1000, client.approved_by_default)

1763

2372

else:

1764

2373

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

1765

2374

client.name)

1767

2376

# Emit D-Bus signal

1768

2377

client.Rejected("Denied")

1769

2378

return

1770

1771

#wait until timeout or approved

2379

2380

# wait until timeout or approved

1772

2381

time = datetime.datetime.now()

1773

2382

client.changedstate.acquire()

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2383

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

1777

2384

client.changedstate.release()

1778

2385

time2 = datetime.datetime.now()

1779

2386

if (time2 - time) >= delay:

1789

2396

break

1790

2397

else:

1791

2398

delay -= time2 - time

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

2399

2400

try:

2401

session.send(client.secret)

2402

except gnutls.Error as error:

2403

logger.warning("gnutls send failed",

2404

exc_info=error)

2405

return

2406

1806

2407

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

1807

2408

# bump the timeout using extended_timeout

1808

2409

client.bump_timeout(client.extended_timeout)

1809

2410

if self.server.use_dbus:

1810

2411

# Emit D-Bus signal

1811

2412

client.GotSecret()

1812

2413

1813

2414

finally:

1814

2415

if approval_required:

1815

2416

client.approvals_pending -= 1

1816

2417

try:

1817

2418

session.bye()

1818

except gnutls.errors.GNUTLSError as error:

2419

except gnutls.Error as error:

1819

2420

logger.warning("GnuTLS bye failed",

1820

2421

exc_info=error)

1821

2422

1822

2423

@staticmethod

1823

2424

def peer_certificate(session):

1824

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

1825

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2425

"Return the peer's certificate as a bytestring"

2426

try:

2427

cert_type = gnutls.certificate_type_get2(session._c_object,

2428

gnutls.CTYPE_PEERS)

2429

except AttributeError:

2430

cert_type = gnutls.certificate_type_get(session._c_object)

2431

if gnutls.has_rawpk:

2432

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2433

else:

2434

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2435

# If not a valid certificate type...

2436

if cert_type not in valid_cert_types:

2437

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

2438

valid_cert_types)

2439

# ...return invalid data

2440

return b""

1831

2441

list_size = ctypes.c_uint(1)

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

2442

cert_list = (gnutls.certificate_get_peers

1834

2443

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

1835

2444

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

1836

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

1837

" certificate")

2445

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

1838

2446

if list_size.value == 0:

1839

2447

return None

1840

2448

cert = cert_list[0]

1841

2449

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

1842

2450

2451

@staticmethod

2452

def key_id(certificate):

2453

"Convert a certificate bytestring to a hexdigit key ID"

2454

# New GnuTLS "datum" with the public key

2455

datum = gnutls.datum_t(

2456

ctypes.cast(ctypes.c_char_p(certificate),

2457

ctypes.POINTER(ctypes.c_ubyte)),

2458

ctypes.c_uint(len(certificate)))

2459

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

2460

# New empty GnuTLS certificate

2461

pubkey = gnutls.pubkey_t()

2462

gnutls.pubkey_init(ctypes.byref(pubkey))

2463

# Import the raw public key into the certificate

2464

gnutls.pubkey_import(pubkey,

2465

ctypes.byref(datum),

2466

gnutls.X509_FMT_DER)

2467

# New buffer for the key ID

2468

buf = ctypes.create_string_buffer(32)

2469

buf_len = ctypes.c_size_t(len(buf))

2470

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

2471

gnutls.pubkey_get_key_id(pubkey,

2472

gnutls.KEYID_USE_SHA256,

2473

ctypes.cast(ctypes.byref(buf),

2474

ctypes.POINTER(ctypes.c_ubyte)),

2475

ctypes.byref(buf_len))

2476

# Deinit the certificate

2477

gnutls.pubkey_deinit(pubkey)

2478

2479

# Convert the buffer to a Python bytestring

2480

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

2481

# Convert the bytestring to hexadecimal notation

2482

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

2483

return hex_key_id

2484

1843

2485

@staticmethod

1844

2486

def fingerprint(openpgp):

1845

2487

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1846

2488

# New GnuTLS "datum" with the OpenPGP public key

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2489

datum = gnutls.datum_t(

2490

ctypes.cast(ctypes.c_char_p(openpgp),

2491

ctypes.POINTER(ctypes.c_ubyte)),

2492

ctypes.c_uint(len(openpgp)))

1852

2493

# New empty GnuTLS certificate

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2494

crt = gnutls.openpgp_crt_t()

2495

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

2496

# Import the OpenPGP public key into the certificate

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2497

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

2498

gnutls.OPENPGP_FMT_RAW)

1861

2499

# Verify the self signature in the key

1862

2500

crtverify = ctypes.c_uint()

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2501

gnutls.openpgp_crt_verify_self(crt, 0,

2502

ctypes.byref(crtverify))

1866

2503

if crtverify.value != 0:

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2504

gnutls.openpgp_crt_deinit(crt)

2505

raise gnutls.CertificateSecurityError(code

2506

=crtverify.value)

1870

2507

# New buffer for the fingerprint

1871

2508

buf = ctypes.create_string_buffer(20)

1872

2509

buf_len = ctypes.c_size_t()

1873

2510

# Get the fingerprint from the certificate into the buffer

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2511

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

2512

ctypes.byref(buf_len))

1877

2513

# Deinit the certificate

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2514

gnutls.openpgp_crt_deinit(crt)

1879

2515

# Convert the buffer to a Python bytestring

1880

2516

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

1881

2517

# Convert the bytestring to hexadecimal notation

1883

2519

return hex_fpr

1884

2520

1885

2521

1886

class MultiprocessingMixIn(object):

2522

class MultiprocessingMixIn:

1887

2523

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

2524

1888

2525

def sub_process_main(self, request, address):

1889

2526

try:

1890

2527

self.finish_request(request, address)

1891

2528

except Exception:

1892

2529

self.handle_error(request, address)

1893

2530

self.close_request(request)

1894

2531

1895

2532

def process_request(self, request, address):

1896

2533

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

1897

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

1898

args = (request, address))

2534

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

2535

args=(request, address))

1899

2536

proc.start()

1900

2537

return proc

1901

2538

1902

2539

1903

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2540

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1904

2541

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

2542

1905

2543

def process_request(self, request, client_address):

1906

2544

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

1907

2545

1908

2546

This function creates a new pipe in self.pipe

1909

2547

"""

1910

2548

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1911

2549

1912

2550

proc = MultiprocessingMixIn.process_request(self, request,

1913

2551

client_address)

1914

2552

self.child_pipe.close()

1915

2553

self.add_pipe(parent_pipe, proc)

1916

2554

1917

2555

def add_pipe(self, parent_pipe, proc):

1918

2556

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

1919

2557

raise NotImplementedError()

1920

2558

1921

2559

1922

2560

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1923

socketserver.TCPServer, object):

2561

socketserver.TCPServer):

1924

2562

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

1925

2563

1926

2564

Attributes:

1927

2565

enabled: Boolean; whether this server is activated yet

1928

2566

interface: None or a network interface name (string)

1929

2567

use_ipv6: Boolean; to use IPv6 or not

1930

2568

"""

2569

1931

2570

def __init__(self, server_address, RequestHandlerClass,

1932

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

2571

interface=None,

2572

use_ipv6=True,

2573

socketfd=None):

1933

2574

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

1934

2575

creating a new one with socket.socket().

1935

2576

"""

1941

2582

self.socketfd = socketfd

1942

2583

# Save the original socket.socket() function

1943

2584

self.socket_socket = socket.socket

2585

1944

2586

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

1945

#

2587

#

1946

2588

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

1947

2589

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

1948

2590

# patching socket.socket.)

1949

#

2591

#

1950

2592

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

1951

2593

@functools.wraps(socket.socket)

1952

2594

def socket_wrapper(*args, **kwargs):

1964

2606

# socket_wrapper(), if socketfd was set.

1965

2607

socketserver.TCPServer.__init__(self, server_address,

1966

2608

RequestHandlerClass)

1967

2609

1968

2610

def server_bind(self):

1969

2611

"""This overrides the normal server_bind() function

1970

2612

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

1971

2613

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

2614

global SO_BINDTODEVICE

1972

2615

if self.interface is not None:

1973

2616

if SO_BINDTODEVICE is None:

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2617

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

2618

# common enough.

2619

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

2620

SO_BINDTODEVICE = 25

2621

try:

2622

self.socket.setsockopt(

2623

socket.SOL_SOCKET, SO_BINDTODEVICE,

2624

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

2625

except socket.error as error:

2626

if error.errno == errno.EPERM:

2627

logger.error("No permission to bind to"

2628

" interface %s", self.interface)

2629

elif error.errno == errno.ENOPROTOOPT:

2630

logger.error("SO_BINDTODEVICE not available;"

2631

" cannot bind to interface %s",

2632

self.interface)

2633

elif error.errno == errno.ENODEV:

2634

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

2635

" cannot bind", self.interface)

2636

else:

2637

raise

1995

2638

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

1996

2639

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

2640

if self.server_address[1]:

2641

self.allow_reuse_address = True

1997

2642

if not self.server_address[0]:

1998

2643

if self.address_family == socket.AF_INET6:

1999

any_address = "::" # in6addr_any

2644

any_address = "::" # in6addr_any

2000

2645

else:

2001

any_address = "0.0.0.0" # INADDR_ANY

2646

any_address = "0.0.0.0" # INADDR_ANY

2002

2647

self.server_address = (any_address,

2003

2648

self.server_address[1])

2004

2649

elif not self.server_address[1]:

2005

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

2006

0)

2650

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

2007

2651

# if self.interface:

2008

2652

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

2009

2653

# 0, # port

2015

2659

2016

2660

class MandosServer(IPv6_TCPServer):

2017

2661

"""Mandos server.

2018

2662

2019

2663

Attributes:

2020

2664

clients: set of Client objects

2021

2665

gnutls_priority GnuTLS priority string

2022

2666

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

2023

2024

Assumes a gobject.MainLoop event loop.

2667

2668

Assumes a GLib.MainLoop event loop.

2025

2669

"""

2670

2026

2671

def __init__(self, server_address, RequestHandlerClass,

2027

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

2028

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

2672

interface=None,

2673

use_ipv6=True,

2674

clients=None,

2675

gnutls_priority=None,

2676

use_dbus=True,

2677

socketfd=None):

2029

2678

self.enabled = False

2030

2679

self.clients = clients

2031

2680

if self.clients is None:

2034

2683

self.gnutls_priority = gnutls_priority

2035

2684

IPv6_TCPServer.__init__(self, server_address,

2036

2685

RequestHandlerClass,

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2686

interface=interface,

2687

use_ipv6=use_ipv6,

2688

socketfd=socketfd)

2689

2040

2690

def server_activate(self):

2041

2691

if self.enabled:

2042

2692

return socketserver.TCPServer.server_activate(self)

2043

2693

2044

2694

def enable(self):

2045

2695

self.enabled = True

2046

2696

2047

2697

def add_pipe(self, parent_pipe, proc):

2048

2698

# Call "handle_ipc" for both data and EOF events

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2699

GLib.io_add_watch(

2700

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

2701

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

2702

functools.partial(self.handle_ipc,

2703

parent_pipe=parent_pipe,

2704

proc=proc))

2705

2706

def handle_ipc(self, source, condition,

2707

parent_pipe=None,

2708

proc=None,

2709

client_object=None):

2058

2710

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

2059

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

2711

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

2060

2712

# Wait for other process to exit

2061

2713

proc.join()

2062

2714

return False

2063

2715

2064

2716

# Read a request from the child

2065

2717

request = parent_pipe.recv()

2066

2718

command = request[0]

2067

2719

2068

2720

if command == 'init':

2069

fpr = request[1]

2070

address = request[2]

2071

2072

for c in self.clients.itervalues():

2073

if c.fingerprint == fpr:

2721

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

2722

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

2723

address = request[3]

2724

2725

for c in self.clients.values():

2726

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2727

continue

2728

if key_id and c.key_id == key_id:

2729

client = c

2730

break

2731

if fpr and c.fingerprint == fpr:

2074

2732

client = c

2075

2733

break

2076

2734

else:

2077

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

2078

"dress: %s", fpr, address)

2735

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

2736

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

2079

2737

if self.use_dbus:

2080

2738

# Emit D-Bus signal

2081

mandos_dbus_service.ClientNotFound(fpr,

2739

mandos_dbus_service.ClientNotFound(key_id or fpr,

2082

2740

address[0])

2083

2741

parent_pipe.send(False)

2084

2742

return False

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2743

2744

GLib.io_add_watch(

2745

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

2746

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

2747

functools.partial(self.handle_ipc,

2748

parent_pipe=parent_pipe,

2749

proc=proc,

2750

client_object=client))

2094

2751

parent_pipe.send(True)

2095

2752

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

2096

2753

# same fileno

2099

2756

funcname = request[1]

2100

2757

args = request[2]

2101

2758

kwargs = request[3]

2102

2759

2103

2760

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

2104

2761

funcname)(*args,

2105

**kwargs)))

2106

2762

**kwargs)))

2763

2107

2764

if command == 'getattr':

2108

2765

attrname = request[1]

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2766

if isinstance(client_object.__getattribute__(attrname),

2767

collections.abc.Callable):

2768

parent_pipe.send(('function', ))

2111

2769

else:

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2770

parent_pipe.send((

2771

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

2772

2115

2773

if command == 'setattr':

2116

2774

attrname = request[1]

2117

2775

value = request[2]

2118

2776

setattr(client_object, attrname, value)

2119

2777

2120

2778

return True

2121

2779

2122

2780

2123

2781

def rfc3339_duration_to_delta(duration):

2124

2782

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

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2783

2784

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

2785

True

2786

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

2787

True

2788

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

2789

True

2790

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

2791

True

2792

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

2793

True

2794

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

2795

True

2796

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

2797

True

2140

2798

"""

2141

2799

2142

2800

# Parsing an RFC 3339 duration with regular expressions is not

2143

2801

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

2144

2802

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

2145

2803

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

2146

2804

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

2147

2805

# avoid excessive use of external libraries.

2148

2806

2149

2807

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2808

Token = collections.namedtuple("Token", (

2809

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

2810

# a "group" containing digits

2811

"value", # datetime.timedelta or None

2812

"followers")) # Tokens valid after this token

2159

2813

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

2160

2814

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

2161

2815

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

2162

2816

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

2163

2817

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2818

frozenset((token_end, )))

2165

2819

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

2166

2820

datetime.timedelta(minutes=1),

2167

2821

frozenset((token_second, token_end)))

2183

2837

frozenset((token_month, token_end)))

2184

2838

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

2185

2839

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2840

frozenset((token_end, )))

2187

2841

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

2188

2842

frozenset((token_year, token_month,

2189

2843

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2844

token_week)))

2845

# Define starting values:

2846

# Value so far

2847

value = datetime.timedelta()

2193

2848

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2849

# Following valid tokens

2850

followers = frozenset((token_duration, ))

2851

# String left to parse

2852

s = duration

2196

2853

# Loop until end token is found

2197

2854

while found_token is not token_end:

2198

2855

# Search for any currently valid tokens

2214

2871

break

2215

2872

else:

2216

2873

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2874

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

2875

.format(duration))

2218

2876

# End token found

2219

2877

return value

2220

2878

2221

2879

2222

2880

def string_to_delta(interval):

2223

2881

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

2224

2225

>>> string_to_delta('7d')

2226

datetime.timedelta(7)

2227

>>> string_to_delta('60s')

2228

datetime.timedelta(0, 60)

2229

>>> string_to_delta('60m')

2230

datetime.timedelta(0, 3600)

2231

>>> string_to_delta('24h')

2232

datetime.timedelta(1)

2233

>>> string_to_delta('1w')

2234

datetime.timedelta(7)

2235

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

2236

datetime.timedelta(0, 330)

2882

2883

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

2884

True

2885

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

2886

True

2887

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

2888

True

2889

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

2890

True

2891

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

2892

True

2893

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

2894

True

2237

2895

"""

2238

2896

2239

2897

try:

2240

2898

return rfc3339_duration_to_delta(interval)

2241

2899

except ValueError:

2242

2900

pass

2243

2901

2244

2902

timevalue = datetime.timedelta(0)

2245

2903

for s in interval.split():

2246

2904

try:

2247

suffix = unicode(s[-1])

2905

suffix = s[-1]

2248

2906

value = int(s[:-1])

2249

2907

if suffix == "d":

2250

2908

delta = datetime.timedelta(value)

2257

2915

elif suffix == "w":

2258

2916

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

2259

2917

else:

2260

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

2261

.format(suffix))

2918

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

2262

2919

except IndexError as e:

2263

2920

raise ValueError(*(e.args))

2264

2921

timevalue += delta

2265

2922

return timevalue

2266

2923

2267

2924

2268

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

2925

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

2269

2926

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

2270

2927

2271

2928

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

2272

2929

if os.fork():

2273

2930

sys.exit()

2281

2938

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

2282

2939

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

2283

2940

raise OSError(errno.ENODEV,

2284

"{0} not a character device"

2941

"{} not a character device"

2285

2942

.format(os.devnull))

2286

2943

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

2287

2944

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

2291

2948

2292

2949

2293

2950

def main():

2294

2951

2295

2952

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

2296

2953

# Parsing of options, both command line and config file

2297

2954

2298

2955

parser = argparse.ArgumentParser()

2299

2956

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

2300

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

2957

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

2301

2958

help="show version number and exit")

2302

2959

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

2303

2960

help="Bind to interface IF")

2336

2993

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

2337

2994

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

2338

2995

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

2339

2996

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

2997

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

2998

default=None)

2999

2340

3000

options = parser.parse_args()

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

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

2346

3001

2347

3002

# Default values for config file for server-global settings

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

3003

if gnutls.has_rawpk:

3004

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

3005

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

3006

else:

3007

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

3008

":+SIGN-DSA-SHA256")

3009

server_defaults = {"interface": "",

3010

"address": "",

3011

"port": "",

3012

"debug": "False",

3013

"priority": priority,

3014

"servicename": "Mandos",

3015

"use_dbus": "True",

3016

"use_ipv6": "True",

3017

"debuglevel": "",

3018

"restore": "True",

3019

"socket": "",

3020

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

3021

"foreground": "False",

3022

"zeroconf": "True",

3023

}

3024

del priority

3025

2364

3026

# Parse config file for server-global settings

2365

server_config = configparser.SafeConfigParser(server_defaults)

3027

server_config = configparser.ConfigParser(server_defaults)

2366

3028

del server_defaults

2367

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

2368

"mandos.conf"))

2369

# Convert the SafeConfigParser object to a dict

3029

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

3030

# Convert the ConfigParser object to a dict

2370

3031

server_settings = server_config.defaults()

2371

3032

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

2372

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

3033

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

3034

"foreground", "zeroconf"):

2373

3035

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

2374

3036

option)

2375

3037

if server_settings["port"]:

2385

3047

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

2386

3048

["socket"])

2387

3049

del server_config

2388

3050

2389

3051

# Override the settings from the config file with command line

2390

3052

# options, if set.

2391

3053

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

2392

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

2393

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

2394

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

3054

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

3055

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

3056

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

2395

3057

value = getattr(options, option)

2396

3058

if value is not None:

2397

3059

server_settings[option] = value

2398

3060

del options

2399

3061

# Force all strings to be unicode

2400

3062

for option in server_settings.keys():

2401

if type(server_settings[option]) is str:

2402

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

3063

if isinstance(server_settings[option], bytes):

3064

server_settings[option] = (server_settings[option]

3065

.decode("utf-8"))

2403

3066

# Force all boolean options to be boolean

2404

3067

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

2405

"foreground"):

3068

"foreground", "zeroconf"):

2406

3069

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

2407

3070

# Debug implies foreground

2408

3071

if server_settings["debug"]:

2409

3072

server_settings["foreground"] = True

2410

3073

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

2411

3074

2412

3075

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

2413

3076

3077

if (not server_settings["zeroconf"]

3078

and not (server_settings["port"]

3079

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

3080

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

3081

2414

3082

# For convenience

2415

3083

debug = server_settings["debug"]

2416

3084

debuglevel = server_settings["debuglevel"]

2419

3087

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

2420

3088

stored_state_file)

2421

3089

foreground = server_settings["foreground"]

2422

3090

zeroconf = server_settings["zeroconf"]

3091

2423

3092

if debug:

2424

3093

initlogger(debug, logging.DEBUG)

2425

3094

else:

2428

3097

else:

2429

3098

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

2430

3099

initlogger(debug, level)

2431

3100

2432

3101

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

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

3102

syslogger.setFormatter(

3103

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

3104

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

3105

server_settings["servicename"])))

3106

2439

3107

# Parse config file with clients

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

3108

client_config = configparser.ConfigParser(Client.client_defaults)

2442

3109

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

2443

3110

"clients.conf"))

2444

3111

2445

3112

global mandos_dbus_service

2446

3113

mandos_dbus_service = None

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

3114

3115

socketfd = None

3116

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

3117

socketfd = server_settings["socket"]

3118

tcp_server = MandosServer(

3119

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

3120

ClientHandler,

3121

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

3122

use_ipv6=use_ipv6,

3123

gnutls_priority=server_settings["priority"],

3124

use_dbus=use_dbus,

3125

socketfd=socketfd)

2459

3126

if not foreground:

2460

3127

pidfilename = "/run/mandos.pid"

2461

3128

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

2462

3129

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

2463

3130

pidfile = None

2464

3131

try:

2465

pidfile = open(pidfilename, "w")

3132

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

2466

3133

except IOError as e:

2467

3134

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

2468

3135

exc_info=e)

2469

2470

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

3136

3137

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

3138

("mandos", "mandos"),

3139

("nobody", "nogroup")):

2471

3140

try:

2472

3141

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

3142

gid = pwd.getpwnam(group).pw_gid

2474

3143

break

2475

3144

except KeyError:

2476

3145

continue

2480

3149

try:

2481

3150

os.setgid(gid)

2482

3151

os.setuid(uid)

3152

if debug:

3153

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

3154

gid))

2483

3155

except OSError as error:

3156

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

3157

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

2484

3158

if error.errno != errno.EPERM:

2485

3159

raise

2486

3160

2487

3161

if debug:

2488

3162

# Enable all possible GnuTLS debugging

2489

3163

2490

3164

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

2491

3165

# - GnuTLS manual

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3166

gnutls.global_set_log_level(11)

3167

3168

@gnutls.log_func

2495

3169

def debug_gnutls(level, string):

2496

3170

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

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3171

3172

gnutls.global_set_log_function(debug_gnutls)

3173

2501

3174

# Redirect stdin so all checkers get /dev/null

2502

3175

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

2503

3176

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

2504

3177

if null > 2:

2505

3178

os.close(null)

2506

3179

2507

3180

# Need to fork before connecting to D-Bus

2508

3181

if not foreground:

2509

3182

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

2510

3183

daemon()

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3184

3185

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

3186

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

3187

# need to inform GLib that threads will be used.

3188

GLib.threads_init()

3189

2516

3190

global main_loop

2517

3191

# From the Avahi example code

2518

3192

DBusGMainLoop(set_as_default=True)

2519

main_loop = gobject.MainLoop()

3193

main_loop = GLib.MainLoop()

2520

3194

bus = dbus.SystemBus()

2521

3195

# End of Avahi example code

2522

3196

if use_dbus:

2523

3197

try:

2524

3198

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

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

3199

bus,

3200

do_not_queue=True)

3201

old_bus_name = dbus.service.BusName(

3202

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

3203

do_not_queue=True)

3204

except dbus.exceptions.DBusException as e:

2530

3205

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

2531

3206

use_dbus = False

2532

3207

server_settings["use_dbus"] = False

2533

3208

tcp_server.use_dbus = False

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3209

if zeroconf:

3210

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3211

service = AvahiServiceToSyslog(

3212

name=server_settings["servicename"],

3213

servicetype="_mandos._tcp",

3214

protocol=protocol,

3215

bus=bus)

3216

if server_settings["interface"]:

3217

service.interface = if_nametoindex(

3218

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

3219

2543

3220

global multiprocessing_manager

2544

3221

multiprocessing_manager = multiprocessing.Manager()

2545

3222

2546

3223

client_class = Client

2547

3224

if use_dbus:

2548

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

2549

3225

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

3226

2550

3227

client_settings = Client.config_parser(client_config)

2551

3228

old_client_settings = {}

2552

3229

clients_data = {}

2553

3230

2554

3231

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

2555

3232

global wnull

2556

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

3233

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

2557

3234

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

2558

3235

# mode

2559

3236

if debug or not foreground:

2560

3237

wnull.close()

2561

3238

2562

3239

# Get client data and settings from last running state.

2563

3240

if server_settings["restore"]:

2564

3241

try:

2565

3242

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

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3243

if sys.version_info.major == 2:

3244

clients_data, old_client_settings = pickle.load(

3245

stored_state)

3246

else:

3247

bytes_clients_data, bytes_old_client_settings = (

3248

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

3249

# Fix bytes to strings

3250

# clients_data

3251

# .keys()

3252

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

3253

if isinstance(key, bytes)

3254

else key): value

3255

for key, value in

3256

bytes_clients_data.items()}

3257

del bytes_clients_data

3258

for key in clients_data:

3259

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

3260

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

3261

for k, v in

3262

clients_data[key].items()}

3263

clients_data[key] = value

3264

# .client_structure

3265

value["client_structure"] = [

3266

(s.decode("utf-8")

3267

if isinstance(s, bytes)

3268

else s) for s in

3269

value["client_structure"]]

3270

# .name, .host, and .checker_command

3271

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

3272

if isinstance(value[k], bytes):

3273

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

3274

if "key_id" not in value:

3275

value["key_id"] = ""

3276

elif "fingerprint" not in value:

3277

value["fingerprint"] = ""

3278

# old_client_settings

3279

# .keys()

3280

old_client_settings = {

3281

(key.decode("utf-8")

3282

if isinstance(key, bytes)

3283

else key): value

3284

for key, value in

3285

bytes_old_client_settings.items()}

3286

del bytes_old_client_settings

3287

# .host and .checker_command

3288

for value in old_client_settings.values():

3289

for attribute in ("host", "checker_command"):

3290

if isinstance(value[attribute], bytes):

3291

value[attribute] = (value[attribute]

3292

.decode("utf-8"))

2568

3293

os.remove(stored_state_path)

2569

3294

except IOError as e:

2570

3295

if e.errno == errno.ENOENT:

2571

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

2572

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

3296

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

3297

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

2573

3298

else:

2574

3299

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

2575

3300

exc_info=e)

2576

3301

raise

2577

3302

except EOFError as e:

2578

3303

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

2579

"EOFError:", exc_info=e)

2580

3304

"EOFError:",

3305

exc_info=e)

3306

2581

3307

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

3308

for client_name, client in clients_data.items():

2583

3309

# Skip removed clients

2584

3310

if client_name not in client_settings:

2585

3311

continue

2586

3312

2587

3313

# Decide which value to use after restoring saved state.

2588

3314

# We have three different values: Old config file,

2589

3315

# new config file, and saved state.

2594

3320

# For each value in new config, check if it

2595

3321

# differs from the old config value (Except for

2596

3322

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3323

if (name != "secret"

3324

and (value !=

3325

old_client_settings[client_name][name])):

2600

3326

client[name] = value

2601

3327

except KeyError:

2602

3328

pass

2603

3329

2604

3330

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

3331

# enabled if its last checker was successful. A Client

2606

3332

# whose checker succeeded before we stored its state is

2607

3333

# assumed to have successfully run all checkers during

2608

3334

# downtime.

2610

3336

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

2611

3337

if not client["last_checked_ok"]:

2612

3338

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3339

"disabling client {} - Client never "

3340

"performed a successful checker".format(

3341

client_name))

2616

3342

client["enabled"] = False

2617

3343

elif client["last_checker_status"] != 0:

2618

3344

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3345

"disabling client {} - Client last"

3346

" checker failed with error code"

3347

" {}".format(

3348

client_name,

3349

client["last_checker_status"]))

2623

3350

client["enabled"] = False

2624

3351

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3352

client["expires"] = (

3353

datetime.datetime.utcnow()

3354

+ client["timeout"])

2628

3355

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3356

" keeping {} enabled".format(

3357

client_name))

2631

3358

try:

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3359

client["secret"] = pgp.decrypt(

3360

client["encrypted_secret"],

3361

client_settings[client_name]["secret"])

2636

3362

except PGPError:

2637

3363

# If decryption fails, we use secret from new settings

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3364

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

3365

client_name))

3366

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

3367

["secret"])

3368

2643

3369

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

2644

3370

for client_name in (set(old_client_settings)

2645

3371

- set(client_settings)):

2647

3373

for client_name in (set(client_settings)

2648

3374

- set(old_client_settings)):

2649

3375

clients_data[client_name] = client_settings[client_name]

2650

3376

2651

3377

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

3378

for client_name, client in clients_data.items():

2653

3379

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3380

name=client_name,

3381

settings=client,

3382

server_settings=server_settings)

3383

2657

3384

if not tcp_server.clients:

2658

3385

logger.warning("No clients defined")

2659

3386

2660

3387

if not foreground:

2661

3388

if pidfile is not None:

3389

pid = os.getpid()

2662

3390

try:

2663

3391

with pidfile:

2664

pid = os.getpid()

2665

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

3392

print(pid, file=pidfile)

2666

3393

except IOError:

2667

3394

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

2668

3395

pidfilename, pid)

2669

3396

del pidfile

2670

3397

del pidfilename

2671

2672

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

2673

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

2674

3398

3399

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

3400

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3401

lambda: main_loop.quit() and False)

3402

2675

3403

if use_dbus:

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3404

3405

@alternate_dbus_interfaces(

3406

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

3407

class MandosDBusService(DBusObjectWithObjectManager):

2679

3408

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

3409

2680

3410

def __init__(self):

2681

3411

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

3412

2682

3413

_interface = "se.recompile.Mandos"

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3414

2690

3415

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

2691

3416

def ClientAdded(self, objpath):

2692

3417

"D-Bus signal"

2693

3418

pass

2694

3419

2695

3420

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

2696

def ClientNotFound(self, fingerprint, address):

3421

def ClientNotFound(self, key_id, address):

2697

3422

"D-Bus signal"

2698

3423

pass

2699

3424

3425

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

3426

"true"})

2700

3427

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

2701

3428

def ClientRemoved(self, objpath, name):

2702

3429

"D-Bus signal"

2703

3430

pass

2704

3431

3432

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

3433

"true"})

2705

3434

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

2706

3435

def GetAllClients(self):

2707

3436

"D-Bus method"

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3437

return dbus.Array(c.dbus_object_path for c in

3438

tcp_server.clients.values())

3439

3440

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

3441

"true"})

2712

3442

@dbus.service.method(_interface,

2713

3443

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

2714

3444

def GetAllClientsWithProperties(self):

2715

3445

"D-Bus method"

2716

3446

return dbus.Dictionary(

2717

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

2718

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

3447

{c.dbus_object_path: c.GetAll(

3448

"se.recompile.Mandos.Client")

3449

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

2719

3450

signature="oa{sv}")

2720

3451

2721

3452

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

2722

3453

def RemoveClient(self, object_path):

2723

3454

"D-Bus method"

2724

for c in tcp_server.clients.itervalues():

3455

for c in tcp_server.clients.values():

2725

3456

if c.dbus_object_path == object_path:

2726

3457

del tcp_server.clients[c.name]

2727

3458

c.remove_from_connection()

2728

# Don't signal anything except ClientRemoved

3459

# Don't signal the disabling

2729

3460

c.disable(quiet=True)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3461

# Emit D-Bus signal for removal

3462

self.client_removed_signal(c)

2732

3463

return

2733

3464

raise KeyError(object_path)

2734

3465

2735

3466

del _interface

2736

3467

3468

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3469

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

3470

def GetManagedObjects(self):

3471

"""D-Bus method"""

3472

return dbus.Dictionary(

3473

{client.dbus_object_path:

3474

dbus.Dictionary(

3475

{interface: client.GetAll(interface)

3476

for interface in

3477

client._get_all_interface_names()})

3478

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

3479

3480

def client_added_signal(self, client):

3481

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

3482

if use_dbus:

3483

# New standard signal

3484

self.InterfacesAdded(

3485

client.dbus_object_path,

3486

dbus.Dictionary(

3487

{interface: client.GetAll(interface)

3488

for interface in

3489

client._get_all_interface_names()}))

3490

# Old signal

3491

self.ClientAdded(client.dbus_object_path)

3492

3493

def client_removed_signal(self, client):

3494

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

3495

if use_dbus:

3496

# New standard signal

3497

self.InterfacesRemoved(

3498

client.dbus_object_path,

3499

client._get_all_interface_names())

3500

# Old signal

3501

self.ClientRemoved(client.dbus_object_path,

3502

client.name)

3503

2737

3504

mandos_dbus_service = MandosDBusService()

2738

3505

3506

# Save modules to variables to exempt the modules from being

3507

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

3508

mp = multiprocessing

3509

wn = wnull

3510

2739

3511

def cleanup():

2740

3512

"Cleanup function; run on exit"

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3513

if zeroconf:

3514

service.cleanup()

3515

3516

mp.active_children()

3517

wn.close()

2745

3518

if not (tcp_server.clients or client_settings):

2746

3519

return

2747

3520

2748

3521

# Store client before exiting. Secrets are encrypted with key

2749

3522

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

2750

3523

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

2751

3524

clients = {}

2752

3525

with PGPEngine() as pgp:

2753

for client in tcp_server.clients.itervalues():

3526

for client in tcp_server.clients.values():

2754

3527

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

2755

3528

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

2756

3529

key)

2757

3530

client_dict = {}

2758

3531

2759

3532

# A list of attributes that can not be pickled

2760

3533

# + secret.

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3534

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

3535

"checker", "server_settings"}

3536

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

3537

.Object):

2765

3538

exclude.add(name)

2766

3539

2767

3540

client_dict["encrypted_secret"] = (client

2768

3541

.encrypted_secret)

2769

3542

for attr in client.client_structure:

2770

3543

if attr not in exclude:

2771

3544

client_dict[attr] = getattr(client, attr)

2772

3545

2773

3546

clients[client.name] = client_dict

2774

3547

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

2775

3548

2776

3549

try:

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3550

with tempfile.NamedTemporaryFile(

3551

mode='wb',

3552

suffix=".pickle",

3553

prefix='clients-',

3554

dir=os.path.dirname(stored_state_path),

3555

delete=False) as stored_state:

3556

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

3557

protocol=2)

3558

tempname = stored_state.name

2783

3559

os.rename(tempname, stored_state_path)

2784

3560

except (IOError, OSError) as e:

2785

3561

if not debug:

2788

3564

except NameError:

2789

3565

pass

2790

3566

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

2791

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

3567

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

2792

3568

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

2793

3569

else:

2794

3570

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

2795

3571

exc_info=e)

2796

3572

raise

2797

3573

2798

3574

# Delete all clients, and settings from config

2799

3575

while tcp_server.clients:

2800

3576

name, client = tcp_server.clients.popitem()

2801

3577

if use_dbus:

2802

3578

client.remove_from_connection()

2803

# Don't signal anything except ClientRemoved

3579

# Don't signal the disabling

2804

3580

client.disable(quiet=True)

3581

# Emit D-Bus signal for removal

2805

3582

if use_dbus:

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3583

mandos_dbus_service.client_removed_signal(client)

2810

3584

client_settings.clear()

2811

3585

2812

3586

atexit.register(cleanup)

2813

2814

for client in tcp_server.clients.itervalues():

3587

3588

for client in tcp_server.clients.values():

2815

3589

if use_dbus:

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3590

# Emit D-Bus signal for adding

3591

mandos_dbus_service.client_added_signal(client)

2818

3592

# Need to initiate checking of clients

2819

3593

if client.enabled:

2820

3594

client.init_checker()

2821

3595

2822

3596

tcp_server.enable()

2823

3597

tcp_server.server_activate()

2824

3598

2825

3599

# Find out what port we got

2826

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

3600

if zeroconf:

3601

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

2827

3602

if use_ipv6:

2828

3603

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

2829

3604

" flowinfo %d, scope_id %d",

2831

3606

else: # IPv4

2832

3607

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

2833

3608

*tcp_server.socket.getsockname())

2834

2835

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

2836

3609

3610

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

3611

2837

3612

try:

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

3613

if zeroconf:

3614

# From the Avahi example code

3615

try:

3616

service.activate()

3617

except dbus.exceptions.DBusException as error:

3618

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

3619

cleanup()

3620

sys.exit(1)

3621

# End of Avahi example code

3622

3623

GLib.io_add_watch(

3624

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

3625

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3626

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

3627

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

3628

2852

3629

logger.debug("Starting main loop")

2853

3630

main_loop.run()

2854

3631

except AvahiError as error:

2863

3640

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

2864

3641

cleanup()

2865

3642

3643

3644

def should_only_run_tests():

3645

parser = argparse.ArgumentParser(add_help=False)

3646

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

3647

args, unknown_args = parser.parse_known_args()

3648

run_tests = args.check

3649

if run_tests:

3650

# Remove --check argument from sys.argv

3651

sys.argv[1:] = unknown_args

3652

return run_tests

3653

3654

# Add all tests from doctest strings

3655

def load_tests(loader, tests, none):

3656

import doctest

3657

tests.addTests(doctest.DocTestSuite())

3658

return tests

3659

2866

3660

if __name__ == '__main__':

2867

main()

3661

try:

3662

if should_only_run_tests():

3663

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

3664

unittest.main()

3665

else:

3666

main()

3667

finally:

3668

logging.shutdown()