/mandos/trunk : revision 1202

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

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

76

import avahi

85

import gi

86

from gi.repository import GLib

77

87

from dbus.mainloop.glib import DBusGMainLoop

78

88

import ctypes

79

89

import ctypes.util

80

90

import xml.dom.minidom

81

91

import inspect

82

92

83

try:

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

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

98

try:

99

collections.abc.Callable

100

except AttributeError:

101

class abc:

102

Callable = collections.Callable

103

collections.abc = abc

104

del abc

105

106

# Show warnings by default

107

if not sys.warnoptions:

108

import warnings

109

warnings.simplefilter("default")

110

111

# Try to find the value of SO_BINDTODEVICE:

112

try:

113

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

114

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

84

115

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

116

except AttributeError:

86

117

try:

118

# This is where SO_BINDTODEVICE was up to and including Python

119

# 2.6, and also 3.2:

87

120

from IN import SO_BINDTODEVICE

88

121

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.0"

122

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

123

# Try running the C preprocessor:

124

try:

125

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

126

"/dev/stdin"],

127

stdin=subprocess.PIPE,

128

stdout=subprocess.PIPE)

129

stdout = cc.communicate(

130

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

131

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

132

except (OSError, ValueError, IndexError):

133

# No value found

134

SO_BINDTODEVICE = None

135

136

if sys.version_info < (3, 2):

137

configparser.Configparser = configparser.SafeConfigParser

138

139

version = "1.8.9"

92

140

stored_state_file = "clients.pickle"

93

141

94

142

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

143

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

144

syslogger = None

98

145

99

146

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

147

if_nametoindex = ctypes.cdll.LoadLibrary(

148

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

103

149

except (OSError, AttributeError):

150

104

151

def if_nametoindex(interface):

105

152

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

106

153

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

107

154

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

108

155

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

156

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

157

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

113

158

return interface_index

114

159

115

160

161

def copy_function(func):

162

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

163

if sys.version_info.major == 2:

164

return types.FunctionType(func.func_code,

165

func.func_globals,

166

func.func_name,

167

func.func_defaults,

168

func.func_closure)

169

else:

170

return types.FunctionType(func.__code__,

171

func.__globals__,

172

func.__name__,

173

func.__defaults__,

174

func.__closure__)

175

176

116

177

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

117

178

"""init logger and add loglevel"""

118

179

180

global syslogger

181

syslogger = (logging.handlers.SysLogHandler(

182

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

183

address="/dev/log"))

119

184

syslogger.setFormatter(logging.Formatter

120

185

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

121

186

' %(message)s'))

122

187

logger.addHandler(syslogger)

123

188

124

189

if debug:

125

190

console = logging.StreamHandler()

126

191

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

136

201

pass

137

202

138

203

139

class PGPEngine(object):

204

class PGPEngine:

140

205

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

206

141

207

def __init__(self):

142

208

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

209

self.gpg = "gpg"

210

try:

211

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

212

for line in output.splitlines():

213

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

214

if name == b"gpg":

215

self.gpg = path

216

break

217

except OSError as e:

218

if e.errno != errno.ENOENT:

219

raise

143

220

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

221

'--homedir', self.tempdir,

145

222

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

223

'--quiet']

224

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

225

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

226

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

227

149

228

def __enter__(self):

150

229

return self

151

230

152

231

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

153

232

self._cleanup()

154

233

return False

155

234

156

235

def __del__(self):

157

236

self._cleanup()

158

237

159

238

def _cleanup(self):

160

239

if self.tempdir is not None:

161

240

# Delete contents of tempdir

162

241

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

163

topdown = False):

242

topdown=False):

164

243

for filename in files:

165

244

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

166

245

for dirname in dirs:

168

247

# Remove tempdir

169

248

os.rmdir(self.tempdir)

170

249

self.tempdir = None

171

250

172

251

def password_encode(self, password):

173

252

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

174

253

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

175

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

176

254

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

255

if len(encoded) > 2048:

256

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

257

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

258

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

259

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

260

return encoded

261

177

262

def encrypt(self, data, password):

178

263

passphrase = self.password_encode(password)

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

181

266

passfile.write(passphrase)

182

267

passfile.flush()

183

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

268

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

184

269

'--passphrase-file',

185

270

passfile.name]

186

271

+ self.gnupgargs,

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

191

276

if proc.returncode != 0:

192

277

raise PGPError(err)

193

278

return ciphertext

194

279

195

280

def decrypt(self, data, password):

196

281

passphrase = self.password_encode(password)

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

282

with tempfile.NamedTemporaryFile(

283

dir=self.tempdir) as passfile:

199

284

passfile.write(passphrase)

200

285

passfile.flush()

201

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

286

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

202

287

'--passphrase-file',

203

288

passfile.name]

204

289

+ self.gnupgargs,

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

290

stdin=subprocess.PIPE,

291

stdout=subprocess.PIPE,

292

stderr=subprocess.PIPE)

293

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

210

294

if proc.returncode != 0:

211

295

raise PGPError(err)

212

296

return decrypted_plaintext

213

297

214

298

299

# Pretend that we have an Avahi module

300

class avahi:

301

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

302

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

303

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

304

PROTO_INET = 0 # avahi-common/address.h

305

PROTO_INET6 = 1 # avahi-common/address.h

306

DBUS_NAME = "org.freedesktop.Avahi"

307

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

308

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

309

DBUS_PATH_SERVER = "/"

310

311

@staticmethod

312

def string_array_to_txt_array(t):

313

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

314

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

315

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

316

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

317

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

318

SERVER_INVALID = 0 # avahi-common/defs.h

319

SERVER_REGISTERING = 1 # avahi-common/defs.h

320

SERVER_RUNNING = 2 # avahi-common/defs.h

321

SERVER_COLLISION = 3 # avahi-common/defs.h

322

SERVER_FAILURE = 4 # avahi-common/defs.h

323

324

215

325

class AvahiError(Exception):

216

326

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

217

327

self.value = value

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

328

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

329

**kwargs)

330

221

331

222

332

class AvahiServiceError(AvahiError):

223

333

pass

224

334

335

225

336

class AvahiGroupError(AvahiError):

226

337

pass

227

338

228

339

229

class AvahiService(object):

340

class AvahiService:

230

341

"""An Avahi (Zeroconf) service.

231

342

232

343

Attributes:

233

344

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

234

345

Used to optionally bind to the specified interface.

246

357

server: D-Bus Server

247

358

bus: dbus.SystemBus()

248

359

"""

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

360

361

def __init__(self,

362

interface=avahi.IF_UNSPEC,

363

name=None,

364

servicetype=None,

365

port=None,

366

TXT=None,

367

domain="",

368

host="",

369

max_renames=32768,

370

protocol=avahi.PROTO_UNSPEC,

371

bus=None):

254

372

self.interface = interface

255

373

self.name = name

256

374

self.type = servicetype

265

383

self.server = None

266

384

self.bus = bus

267

385

self.entry_group_state_changed_match = None

268

269

def rename(self):

386

387

def rename(self, remove=True):

270

388

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

271

389

if self.rename_count >= self.max_renames:

272

390

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

273

391

" after %i retries, exiting.",

274

392

self.rename_count)

275

393

raise AvahiServiceError("Too many renames")

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

394

self.name = str(

395

self.server.GetAlternativeServiceName(self.name))

396

self.rename_count += 1

278

397

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

279

398

self.name)

280

self.remove()

399

if remove:

400

self.remove()

281

401

try:

282

402

self.add()

283

403

except dbus.exceptions.DBusException as error:

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

404

if (error.get_dbus_name()

405

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

406

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

407

return self.rename(remove=False)

408

else:

409

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

410

self.cleanup()

411

os._exit(1)

412

289

413

def remove(self):

290

414

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

291

415

if self.entry_group_state_changed_match is not None:

293

417

self.entry_group_state_changed_match = None

294

418

if self.group is not None:

295

419

self.group.Reset()

296

420

297

421

def add(self):

298

422

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

299

423

self.remove()

316

440

dbus.UInt16(self.port),

317

441

avahi.string_array_to_txt_array(self.TXT))

318

442

self.group.Commit()

319

443

320

444

def entry_group_state_changed(self, state, error):

321

445

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

322

446

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

323

447

324

448

if state == avahi.ENTRY_GROUP_ESTABLISHED:

325

449

logger.debug("Zeroconf service established.")

326

450

elif state == avahi.ENTRY_GROUP_COLLISION:

328

452

self.rename()

329

453

elif state == avahi.ENTRY_GROUP_FAILURE:

330

454

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

331

unicode(error))

332

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

333

.format(error))

334

455

str(error))

456

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

457

335

458

def cleanup(self):

336

459

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

337

460

if self.group is not None:

342

465

pass

343

466

self.group = None

344

467

self.remove()

345

468

346

469

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

347

470

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

348

471

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

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

472

bad_states = {

473

avahi.SERVER_INVALID: "Zeroconf server invalid",

474

avahi.SERVER_REGISTERING: None,

475

avahi.SERVER_COLLISION: "Zeroconf server name collision",

476

avahi.SERVER_FAILURE: "Zeroconf server failure",

477

}

356

478

if state in bad_states:

357

479

if bad_states[state] is not None:

358

480

if error is None:

361

483

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

362

484

self.cleanup()

363

485

elif state == avahi.SERVER_RUNNING:

364

self.add()

486

try:

487

self.add()

488

except dbus.exceptions.DBusException as error:

489

if (error.get_dbus_name()

490

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

491

logger.info("Local Zeroconf service name"

492

" collision.")

493

return self.rename(remove=False)

494

else:

495

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

496

self.cleanup()

497

os._exit(1)

365

498

else:

366

499

if error is None:

367

500

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

368

501

else:

369

502

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

370

503

371

504

def activate(self):

372

505

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

373

506

if self.server is None:

377

510

follow_name_owner_changes=True),

378

511

avahi.DBUS_INTERFACE_SERVER)

379

512

self.server.connect_to_signal("StateChanged",

380

self.server_state_changed)

513

self.server_state_changed)

381

514

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

382

515

383

516

384

517

class AvahiServiceToSyslog(AvahiService):

385

def rename(self):

518

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

386

519

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

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

520

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

521

syslogger.setFormatter(logging.Formatter(

522

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

523

.format(self.name)))

392

524

return ret

393

525

394

526

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

527

# Pretend that we have a GnuTLS module

528

class gnutls:

529

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

530

531

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

532

if library is None:

533

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

534

_library = ctypes.cdll.LoadLibrary(library)

535

del library

536

537

# Unless otherwise indicated, the constants and types below are

538

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

539

540

# Constants

541

E_SUCCESS = 0

542

E_INTERRUPTED = -52

543

E_AGAIN = -28

544

CRT_OPENPGP = 2

545

CRT_RAWPK = 3

546

CLIENT = 2

547

SHUT_RDWR = 0

548

CRD_CERTIFICATE = 1

549

E_NO_CERTIFICATE_FOUND = -49

550

X509_FMT_DER = 0

551

NO_TICKETS = 1<<10

552

ENABLE_RAWPK = 1<<18

553

CTYPE_PEERS = 3

554

KEYID_USE_SHA256 = 1 # gnutls/x509.h

555

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

556

557

# Types

558

class session_int(ctypes.Structure):

559

_fields_ = []

560

session_t = ctypes.POINTER(session_int)

561

562

class certificate_credentials_st(ctypes.Structure):

563

_fields_ = []

564

certificate_credentials_t = ctypes.POINTER(

565

certificate_credentials_st)

566

certificate_type_t = ctypes.c_int

567

568

class datum_t(ctypes.Structure):

569

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

570

('size', ctypes.c_uint)]

571

572

class openpgp_crt_int(ctypes.Structure):

573

_fields_ = []

574

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

575

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

576

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

577

credentials_type_t = ctypes.c_int

578

transport_ptr_t = ctypes.c_void_p

579

close_request_t = ctypes.c_int

580

581

# Exceptions

582

class Error(Exception):

583

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

584

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

585

# code is passed, convert it to a string with

586

# gnutls.strerror()

587

self.code = code

588

if message is None and code is not None:

589

message = gnutls.strerror(code)

590

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

591

message, *args)

592

593

class CertificateSecurityError(Error):

594

pass

595

596

# Classes

597

class Credentials:

598

def __init__(self):

599

self._c_object = gnutls.certificate_credentials_t()

600

gnutls.certificate_allocate_credentials(

601

ctypes.byref(self._c_object))

602

self.type = gnutls.CRD_CERTIFICATE

603

604

def __del__(self):

605

gnutls.certificate_free_credentials(self._c_object)

606

607

class ClientSession:

608

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

609

self._c_object = gnutls.session_t()

610

gnutls_flags = gnutls.CLIENT

611

if gnutls.check_version(b"3.5.6"):

612

gnutls_flags |= gnutls.NO_TICKETS

613

if gnutls.has_rawpk:

614

gnutls_flags |= gnutls.ENABLE_RAWPK

615

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

616

del gnutls_flags

617

gnutls.set_default_priority(self._c_object)

618

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

619

gnutls.handshake_set_private_extensions(self._c_object,

620

True)

621

self.socket = socket

622

if credentials is None:

623

credentials = gnutls.Credentials()

624

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

625

ctypes.cast(credentials._c_object,

626

ctypes.c_void_p))

627

self.credentials = credentials

628

629

def __del__(self):

630

gnutls.deinit(self._c_object)

631

632

def handshake(self):

633

return gnutls.handshake(self._c_object)

634

635

def send(self, data):

636

data = bytes(data)

637

data_len = len(data)

638

while data_len > 0:

639

data_len -= gnutls.record_send(self._c_object,

640

data[-data_len:],

641

data_len)

642

643

def bye(self):

644

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

645

646

# Error handling functions

647

def _error_code(result):

648

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

649

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

650

if result >= 0:

651

return result

652

if result == gnutls.E_NO_CERTIFICATE_FOUND:

653

raise gnutls.CertificateSecurityError(code=result)

654

raise gnutls.Error(code=result)

655

656

def _retry_on_error(result, func, arguments):

657

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

658

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

659

while result < 0:

660

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

661

return _error_code(result)

662

result = func(*arguments)

663

return result

664

665

# Unless otherwise indicated, the function declarations below are

666

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

667

668

# Functions

669

priority_set_direct = _library.gnutls_priority_set_direct

670

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

671

ctypes.POINTER(ctypes.c_char_p)]

672

priority_set_direct.restype = _error_code

673

674

init = _library.gnutls_init

675

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

676

init.restype = _error_code

677

678

set_default_priority = _library.gnutls_set_default_priority

679

set_default_priority.argtypes = [session_t]

680

set_default_priority.restype = _error_code

681

682

record_send = _library.gnutls_record_send

683

record_send.argtypes = [session_t, ctypes.c_void_p,

684

ctypes.c_size_t]

685

record_send.restype = ctypes.c_ssize_t

686

record_send.errcheck = _retry_on_error

687

688

certificate_allocate_credentials = (

689

_library.gnutls_certificate_allocate_credentials)

690

certificate_allocate_credentials.argtypes = [

691

ctypes.POINTER(certificate_credentials_t)]

692

certificate_allocate_credentials.restype = _error_code

693

694

certificate_free_credentials = (

695

_library.gnutls_certificate_free_credentials)

696

certificate_free_credentials.argtypes = [

697

certificate_credentials_t]

698

certificate_free_credentials.restype = None

699

700

handshake_set_private_extensions = (

701

_library.gnutls_handshake_set_private_extensions)

702

handshake_set_private_extensions.argtypes = [session_t,

703

ctypes.c_int]

704

handshake_set_private_extensions.restype = None

705

706

credentials_set = _library.gnutls_credentials_set

707

credentials_set.argtypes = [session_t, credentials_type_t,

708

ctypes.c_void_p]

709

credentials_set.restype = _error_code

710

711

strerror = _library.gnutls_strerror

712

strerror.argtypes = [ctypes.c_int]

713

strerror.restype = ctypes.c_char_p

714

715

certificate_type_get = _library.gnutls_certificate_type_get

716

certificate_type_get.argtypes = [session_t]

717

certificate_type_get.restype = _error_code

718

719

certificate_get_peers = _library.gnutls_certificate_get_peers

720

certificate_get_peers.argtypes = [session_t,

721

ctypes.POINTER(ctypes.c_uint)]

722

certificate_get_peers.restype = ctypes.POINTER(datum_t)

723

724

global_set_log_level = _library.gnutls_global_set_log_level

725

global_set_log_level.argtypes = [ctypes.c_int]

726

global_set_log_level.restype = None

727

728

global_set_log_function = _library.gnutls_global_set_log_function

729

global_set_log_function.argtypes = [log_func]

730

global_set_log_function.restype = None

731

732

deinit = _library.gnutls_deinit

733

deinit.argtypes = [session_t]

734

deinit.restype = None

735

736

handshake = _library.gnutls_handshake

737

handshake.argtypes = [session_t]

738

handshake.restype = _error_code

739

handshake.errcheck = _retry_on_error

740

741

transport_set_ptr = _library.gnutls_transport_set_ptr

742

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

743

transport_set_ptr.restype = None

744

745

bye = _library.gnutls_bye

746

bye.argtypes = [session_t, close_request_t]

747

bye.restype = _error_code

748

bye.errcheck = _retry_on_error

749

750

check_version = _library.gnutls_check_version

751

check_version.argtypes = [ctypes.c_char_p]

752

check_version.restype = ctypes.c_char_p

753

754

_need_version = b"3.3.0"

755

if check_version(_need_version) is None:

756

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

757

.format(_need_version))

758

759

_tls_rawpk_version = b"3.6.6"

760

has_rawpk = bool(check_version(_tls_rawpk_version))

761

762

if has_rawpk:

763

# Types

764

class pubkey_st(ctypes.Structure):

765

_fields = []

766

pubkey_t = ctypes.POINTER(pubkey_st)

767

768

x509_crt_fmt_t = ctypes.c_int

769

770

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

771

pubkey_init = _library.gnutls_pubkey_init

772

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

773

pubkey_init.restype = _error_code

774

775

pubkey_import = _library.gnutls_pubkey_import

776

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

777

x509_crt_fmt_t]

778

pubkey_import.restype = _error_code

779

780

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

781

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

782

ctypes.POINTER(ctypes.c_ubyte),

783

ctypes.POINTER(ctypes.c_size_t)]

784

pubkey_get_key_id.restype = _error_code

785

786

pubkey_deinit = _library.gnutls_pubkey_deinit

787

pubkey_deinit.argtypes = [pubkey_t]

788

pubkey_deinit.restype = None

789

else:

790

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

791

792

openpgp_crt_init = _library.gnutls_openpgp_crt_init

793

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

794

openpgp_crt_init.restype = _error_code

795

796

openpgp_crt_import = _library.gnutls_openpgp_crt_import

797

openpgp_crt_import.argtypes = [openpgp_crt_t,

798

ctypes.POINTER(datum_t),

799

openpgp_crt_fmt_t]

800

openpgp_crt_import.restype = _error_code

801

802

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

803

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

804

ctypes.POINTER(ctypes.c_uint)]

805

openpgp_crt_verify_self.restype = _error_code

806

807

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

808

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

809

openpgp_crt_deinit.restype = None

810

811

openpgp_crt_get_fingerprint = (

812

_library.gnutls_openpgp_crt_get_fingerprint)

813

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

814

ctypes.c_void_p,

815

ctypes.POINTER(

816

ctypes.c_size_t)]

817

openpgp_crt_get_fingerprint.restype = _error_code

818

819

if check_version(b"3.6.4"):

820

certificate_type_get2 = _library.gnutls_certificate_type_get2

821

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

822

certificate_type_get2.restype = _error_code

823

824

# Remove non-public functions

825

del _error_code, _retry_on_error

826

827

828

def call_pipe(connection, # : multiprocessing.Connection

829

func, *args, **kwargs):

830

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

831

832

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

833

return value on the provided multiprocessing.Connection.

834

"""

835

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

836

connection.close()

837

838

839

class Client:

403

840

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

404

841

405

842

Attributes:

406

843

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

407

844

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

408

845

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

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

846

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

847

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

848

running.

849

checker_callback_tag: a GLib event source tag, or None

413

850

checker_command: string; External command which is run to check

414

851

if client lives. %() expansions are done at

415

852

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

416

853

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

417

checker_initiator_tag: a gobject event source tag, or None

854

checker_initiator_tag: a GLib event source tag, or None

418

855

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

419

856

client_structure: Object describing what attributes a client has

420

857

and is used for storing the client at exit

421

858

current_checker_command: string; current running checker_command

422

disable_initiator_tag: a gobject event source tag, or None

859

disable_initiator_tag: a GLib event source tag, or None

423

860

enabled: bool()

424

861

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

425

uniquely identify the client

862

uniquely identify an OpenPGP client

863

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

864

a client using raw public keys

426

865

host: string; available for use by the checker command

427

866

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

428

867

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

430

869

last_checker_status: integer between 0 and 255 reflecting exit

431

870

status of last checker. -1 reflects crashed

432

871

checker, -2 means no checker completed yet.

872

last_checker_signal: The signal which killed the last checker, if

873

last_checker_status is -1

433

874

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

434

875

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

435

876

D-Bus identifiers

442

883

disabled, or None

443

884

server_settings: The server_settings dict from main()

444

885

"""

445

886

446

887

runtime_expansions = ("approval_delay", "approval_duration",

447

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

888

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

448

889

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

449

890

"last_approval_request", "last_checked_ok",

450

891

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

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

892

client_defaults = {

893

"timeout": "PT5M",

894

"extended_timeout": "PT15M",

895

"interval": "PT2M",

896

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

897

"host": "",

898

"approval_delay": "PT0S",

899

"approval_duration": "PT1S",

900

"approved_by_default": "True",

901

"enabled": "True",

902

}

903

477

904

@staticmethod

478

905

def config_parser(config):

479

906

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

486

913

for client_name in config.sections():

487

914

section = dict(config.items(client_name))

488

915

client = settings[client_name] = {}

489

916

490

917

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

491

918

# Reformat values from string types to Python types

492

919

client["approved_by_default"] = config.getboolean(

493

920

client_name, "approved_by_default")

494

921

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

495

922

"enabled")

496

923

924

# Uppercase and remove spaces from key_id and fingerprint

925

# for later comparison purposes with return value from the

926

# key_id() and fingerprint() functions

927

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

928

.replace(" ", ""))

497

929

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

498

930

.replace(" ", ""))

499

931

if "secret" in section:

500

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

932

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

933

.encode("utf-8"),

934

"base64")

501

935

elif "secfile" in section:

502

936

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

503

937

(section["secfile"])),

504

938

"rb") as secfile:

505

939

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

506

940

else:

507

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

941

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

508

942

.format(section))

509

943

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

510

944

client["extended_timeout"] = string_to_delta(

518

952

client["last_approval_request"] = None

519

953

client["last_checked_ok"] = None

520

954

client["last_checker_status"] = -2

521

955

522

956

return settings

523

524

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

957

958

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

525

959

self.name = name

526

960

if server_settings is None:

527

961

server_settings = {}

528

962

self.server_settings = server_settings

529

963

# adding all client settings

530

for setting, value in settings.iteritems():

964

for setting, value in settings.items():

531

965

setattr(self, setting, value)

532

966

533

967

if self.enabled:

534

968

if not hasattr(self, "last_enabled"):

535

969

self.last_enabled = datetime.datetime.utcnow()

539

973

else:

540

974

self.last_enabled = None

541

975

self.expires = None

542

976

543

977

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

978

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

547

979

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

548

980

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

549

981

datetime.datetime.utcnow())

550

982

551

983

# attributes specific for this server instance

552

984

self.checker = None

553

985

self.checker_initiator_tag = None

556

988

self.current_checker_command = None

557

989

self.approved = None

558

990

self.approvals_pending = 0

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

991

self.changedstate = multiprocessing_manager.Condition(

992

multiprocessing_manager.Lock())

993

self.client_structure = [attr

994

for attr in self.__dict__.keys()

564

995

if not attr.startswith("_")]

565

996

self.client_structure.append("client_structure")

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

997

998

for name, t in inspect.getmembers(

999

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

571

1000

if not name.startswith("_"):

572

1001

self.client_structure.append(name)

573

1002

574

1003

# Send notice to process children that client state has changed

575

1004

def send_changedstate(self):

576

1005

with self.changedstate:

577

1006

self.changedstate.notify_all()

578

1007

579

1008

def enable(self):

580

1009

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

581

1010

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

586

1015

self.last_enabled = datetime.datetime.utcnow()

587

1016

self.init_checker()

588

1017

self.send_changedstate()

589

1018

590

1019

def disable(self, quiet=True):

591

1020

"""Disable this client."""

592

1021

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

594

1023

if not quiet:

595

1024

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

596

1025

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

597

gobject.source_remove(self.disable_initiator_tag)

1026

GLib.source_remove(self.disable_initiator_tag)

598

1027

self.disable_initiator_tag = None

599

1028

self.expires = None

600

1029

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

601

gobject.source_remove(self.checker_initiator_tag)

1030

GLib.source_remove(self.checker_initiator_tag)

602

1031

self.checker_initiator_tag = None

603

1032

self.stop_checker()

604

1033

self.enabled = False

605

1034

if not quiet:

606

1035

self.send_changedstate()

607

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

1036

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

608

1037

return False

609

1038

610

1039

def __del__(self):

611

1040

self.disable()

612

1041

613

1042

def init_checker(self):

614

1043

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

615

1044

# and every interval from then on.

616

1045

if self.checker_initiator_tag is not None:

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

1046

GLib.source_remove(self.checker_initiator_tag)

1047

self.checker_initiator_tag = GLib.timeout_add(

1048

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

1049

+ 1)),

1050

self.start_checker)

621

1051

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

622

1052

if self.disable_initiator_tag is not None:

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

1053

GLib.source_remove(self.disable_initiator_tag)

1054

self.disable_initiator_tag = GLib.timeout_add(

1055

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

627

1056

# Also start a new checker *right now*.

628

1057

self.start_checker()

629

630

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

1058

1059

def checker_callback(self, source, condition, connection,

1060

command):

631

1061

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

1062

# Read return code from connection (see call_pipe)

1063

returncode = connection.recv()

1064

connection.close()

1065

if self.checker is not None:

1066

self.checker.join()

632

1067

self.checker_callback_tag = None

633

1068

self.checker = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1069

1070

if returncode >= 0:

1071

self.last_checker_status = returncode

1072

self.last_checker_signal = None

636

1073

if self.last_checker_status == 0:

637

1074

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

638

1075

vars(self))

639

1076

self.checked_ok()

640

1077

else:

641

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

642

vars(self))

1078

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

643

1079

else:

644

1080

self.last_checker_status = -1

1081

self.last_checker_signal = -returncode

645

1082

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

646

1083

vars(self))

647

1084

return False

1085

648

1086

def checked_ok(self):

649

1087

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

650

1088

self.last_checked_ok = datetime.datetime.utcnow()

651

1089

self.last_checker_status = 0

1090

self.last_checker_signal = None

652

1091

self.bump_timeout()

653

1092

654

1093

def bump_timeout(self, timeout=None):

655

1094

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

656

1095

if timeout is None:

657

1096

timeout = self.timeout

658

1097

if self.disable_initiator_tag is not None:

659

gobject.source_remove(self.disable_initiator_tag)

1098

GLib.source_remove(self.disable_initiator_tag)

660

1099

self.disable_initiator_tag = None

661

1100

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1101

self.disable_initiator_tag = GLib.timeout_add(

1102

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

665

1103

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

666

1104

667

1105

def need_approval(self):

668

1106

self.last_approval_request = datetime.datetime.utcnow()

669

1107

670

1108

def start_checker(self):

671

1109

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

672

1110

673

1111

If a checker already exists, leave it running and do

674

1112

nothing."""

675

1113

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

680

1118

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

681

1119

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

682

1120

# should be.

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1121

1122

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

1123

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

1124

self.checker.join()

1125

self.checker = None

697

1126

# Start a new checker if needed

698

1127

if self.checker is None:

699

1128

# Escape attributes for the shell

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1129

escaped_attrs = {

1130

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

1131

for attr in self.runtime_expansions}

704

1132

try:

705

1133

command = self.checker_command % escaped_attrs

706

1134

except TypeError as error:

707

1135

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

708

self.checker_command, exc_info=error)

709

return True # Try again later

1136

self.checker_command,

1137

exc_info=error)

1138

return True # Try again later

710

1139

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

732

exc_info=error)

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1140

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

1141

self.name)

1142

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

1143

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

1144

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

1145

# always replaced by /dev/null.)

1146

# The exception is when not debugging but nevertheless

1147

# running in the foreground; use the previously

1148

# created wnull.

1149

popen_args = {"close_fds": True,

1150

"shell": True,

1151

"cwd": "/"}

1152

if (not self.server_settings["debug"]

1153

and self.server_settings["foreground"]):

1154

popen_args.update({"stdout": wnull,

1155

"stderr": wnull})

1156

pipe = multiprocessing.Pipe(duplex=False)

1157

self.checker = multiprocessing.Process(

1158

target=call_pipe,

1159

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

1160

kwargs=popen_args)

1161

self.checker.start()

1162

self.checker_callback_tag = GLib.io_add_watch(

1163

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

1164

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1165

self.checker_callback, pipe[0], command)

1166

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

753

1167

return True

754

1168

755

1169

def stop_checker(self):

756

1170

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

757

1171

if self.checker_callback_tag:

758

gobject.source_remove(self.checker_callback_tag)

1172

GLib.source_remove(self.checker_callback_tag)

759

1173

self.checker_callback_tag = None

760

1174

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

761

1175

return

762

1176

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

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1177

self.checker.terminate()

771

1178

self.checker = None

772

1179

773

1180

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1181

def dbus_service_property(dbus_interface,

1182

signature="v",

1183

access="readwrite",

1184

byte_arrays=False):

776

1185

"""Decorators for marking methods of a DBusObjectWithProperties to

777

1186

become properties on the D-Bus.

778

1187

779

1188

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

780

1189

and with one argument by "Set".

781

1190

782

1191

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

783

1192

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

784

1193

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

787

1196

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

788

1197

if byte_arrays and signature != "ay":

789

1198

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

790

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

1199

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

1200

791

1201

def decorator(func):

792

1202

func._dbus_is_property = True

793

1203

func._dbus_interface = dbus_interface

796

1206

func._dbus_name = func.__name__

797

1207

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

798

1208

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

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1209

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

800

1210

return func

1211

801

1212

return decorator

802

1213

803

1214

804

1215

def dbus_interface_annotations(dbus_interface):

805

1216

"""Decorator for marking functions returning interface annotations

806

1217

807

1218

Usage:

808

1219

809

1220

@dbus_interface_annotations("org.example.Interface")

810

1221

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

811

1222

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

812

1223

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

813

1224

"false"}

814

1225

"""

1226

815

1227

def decorator(func):

816

1228

func._dbus_is_interface = True

817

1229

func._dbus_interface = dbus_interface

818

1230

func._dbus_name = dbus_interface

819

1231

return func

1232

820

1233

return decorator

821

1234

822

1235

823

1236

def dbus_annotations(annotations):

824

1237

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

825

1238

Usage:

826

1239

1240

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

1241

"org.freedesktop.DBus.Property."

1242

"EmitsChangedSignal": "false"})

827

1243

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

828

1244

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

832

1245

def Property_dbus_property(self):

833

1246

return dbus.Boolean(False)

1247

1248

See also the DBusObjectWithAnnotations class.

834

1249

"""

1250

835

1251

def decorator(func):

836

1252

func._dbus_annotations = annotations

837

1253

return func

1254

838

1255

return decorator

839

1256

840

1257

841

1258

class DBusPropertyException(dbus.exceptions.DBusException):

842

1259

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

843

1260

"""

844

def __unicode__(self):

845

return unicode(str(self))

1261

pass

846

1262

847

1263

848

1264

class DBusPropertyAccessException(DBusPropertyException):

857

1273

pass

858

1274

859

1275

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1276

class DBusObjectWithAnnotations(dbus.service.Object):

1277

"""A D-Bus object with annotations.

1278

1279

Classes inheriting from this can use the dbus_annotations

1280

decorator to add annotations to methods or signals.

866

1281

"""

867

1282

868

1283

@staticmethod

869

1284

def _is_dbus_thing(thing):

870

1285

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

871

1286

872

1287

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

873

1288

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

874

1289

"""

875

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

1290

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

876

1291

False)

877

1292

878

1293

def _get_all_dbus_things(self, thing):

879

1294

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

880

1295

"""

881

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

882

name),

1296

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

883

1297

athing.__get__(self))

884

1298

for cls in self.__class__.__mro__

885

1299

for name, athing in

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1300

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

1301

1302

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1303

out_signature="s",

1304

path_keyword='object_path',

1305

connection_keyword='connection')

1306

def Introspect(self, object_path, connection):

1307

"""Overloading of standard D-Bus method.

1308

1309

Inserts annotation tags on methods and signals.

1310

"""

1311

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

1312

connection)

1313

try:

1314

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

1315

1316

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

1317

# Add annotation tags

1318

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

1319

for tag in if_tag.getElementsByTagName(typ):

1320

annots = dict()

1321

for name, prop in (self.

1322

_get_all_dbus_things(typ)):

1323

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

1324

and prop._dbus_interface

1325

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

1326

annots.update(getattr(

1327

prop, "_dbus_annotations", {}))

1328

for name, value in annots.items():

1329

ann_tag = document.createElement(

1330

"annotation")

1331

ann_tag.setAttribute("name", name)

1332

ann_tag.setAttribute("value", value)

1333

tag.appendChild(ann_tag)

1334

# Add interface annotation tags

1335

for annotation, value in dict(

1336

itertools.chain.from_iterable(

1337

annotations().items()

1338

for name, annotations

1339

in self._get_all_dbus_things("interface")

1340

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

1341

)).items():

1342

ann_tag = document.createElement("annotation")

1343

ann_tag.setAttribute("name", annotation)

1344

ann_tag.setAttribute("value", value)

1345

if_tag.appendChild(ann_tag)

1346

# Fix argument name for the Introspect method itself

1347

if (if_tag.getAttribute("name")

1348

== dbus.INTROSPECTABLE_IFACE):

1349

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

1350

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

1351

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

1352

if (arg.getAttribute("direction")

1353

== "out"):

1354

arg.setAttribute("name",

1355

"xml_data")

1356

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

1357

document.unlink()

1358

except (AttributeError, xml.dom.DOMException,

1359

xml.parsers.expat.ExpatError) as error:

1360

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

1361

exc_info=error)

1362

return xmlstring

1363

1364

1365

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1366

"""A D-Bus object with properties.

1367

1368

Classes inheriting from this can use the dbus_service_property

1369

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

1370

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

1371

"""

1372

889

1373

def _get_dbus_property(self, interface_name, property_name):

890

1374

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

891

1375

property with the specified name and interface.

892

1376

"""

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1377

for cls in self.__class__.__mro__:

1378

for name, value in inspect.getmembers(

1379

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

897

1380

if (value._dbus_name == property_name

898

1381

and value._dbus_interface == interface_name):

899

1382

return value.__get__(self)

900

1383

901

1384

# No such property

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1385

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

1386

self.dbus_object_path, interface_name, property_name))

1387

1388

@classmethod

1389

def _get_all_interface_names(cls):

1390

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

1391

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

1392

"_dbus_interface", None)

1393

for x in (inspect.getmro(cls))

1394

for attr in dir(x))

1395

if name is not None)

1396

1397

@dbus.service.method(dbus.PROPERTIES_IFACE,

1398

in_signature="ss",

907

1399

out_signature="v")

908

1400

def Get(self, interface_name, property_name):

909

1401

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

915

1407

if not hasattr(value, "variant_level"):

916

1408

return value

917

1409

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

918

1410

919

1411

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

920

1412

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

921

1413

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

927

1419

# The byte_arrays option is not supported yet on

928

1420

# signatures other than "ay".

929

1421

if prop._dbus_signature != "ay":

930

raise ValueError

931

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

932

for byte in value))

1422

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

1423

"'ay' signature {!r}"

1424

.format(prop._dbus_signature))

1425

value = dbus.ByteArray(bytes(value))

933

1426

prop(value)

934

935

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

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="s",

936

1430

out_signature="a{sv}")

937

1431

def GetAll(self, interface_name):

938

1432

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

939

1433

standard.

940

1434

941

1435

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

942

1436

"""

943

1437

properties = {}

953

1447

if not hasattr(value, "variant_level"):

954

1448

properties[name] = value

955

1449

continue

956

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

957

value.variant_level+1)

1450

properties[name] = type(value)(

1451

value, variant_level=value.variant_level + 1)

958

1452

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

959

1453

1454

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

1455

def PropertiesChanged(self, interface_name, changed_properties,

1456

invalidated_properties):

1457

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

1458

standard.

1459

"""

1460

pass

1461

960

1462

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

961

1463

out_signature="s",

962

1464

path_keyword='object_path',

963

1465

connection_keyword='connection')

964

1466

def Introspect(self, object_path, connection):

965

1467

"""Overloading of standard D-Bus method.

966

1468

967

1469

Inserts property tags and interface annotation tags.

968

1470

"""

969

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

970

connection)

1471

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1472

object_path,

1473

connection)

971

1474

try:

972

1475

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

1476

973

1477

def make_tag(document, name, prop):

974

1478

e = document.createElement("property")

975

1479

e.setAttribute("name", name)

976

1480

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

977

1481

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

978

1482

return e

1483

979

1484

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

980

1485

# Add property tags

981

1486

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

984

1489

if prop._dbus_interface

985

1490

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

986

1491

if_tag.appendChild(tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1492

# Add annotation tags for properties

1493

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

1494

annots = dict()

1495

for name, prop in self._get_all_dbus_things(

1496

"property"):

1497

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

1498

and prop._dbus_interface

1499

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

1500

annots.update(getattr(

1501

prop, "_dbus_annotations", {}))

1502

for name, value in annots.items():

1503

ann_tag = document.createElement(

1504

"annotation")

1505

ann_tag.setAttribute("name", name)

1506

ann_tag.setAttribute("value", value)

1507

tag.appendChild(ann_tag)

1018

1508

# Add the names to the return values for the

1019

1509

# "org.freedesktop.DBus.Properties" methods

1020

1510

if (if_tag.getAttribute("name")

1039

1529

return xmlstring

1040

1530

1041

1531

1532

try:

1533

dbus.OBJECT_MANAGER_IFACE

1534

except AttributeError:

1535

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

1536

1537

1538

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1539

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

1540

1541

Classes inheriting from this exposes the standard

1542

GetManagedObjects call and the InterfacesAdded and

1543

InterfacesRemoved signals on the standard

1544

"org.freedesktop.DBus.ObjectManager" interface.

1545

1546

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

1547

manually.

1548

"""

1549

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1550

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

1551

def GetManagedObjects(self):

1552

"""This function must be overridden"""

1553

raise NotImplementedError()

1554

1555

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1556

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

1557

def InterfacesAdded(self, object_path, interfaces_and_properties):

1558

pass

1559

1560

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

1561

def InterfacesRemoved(self, object_path, interfaces):

1562

pass

1563

1564

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1565

out_signature="s",

1566

path_keyword='object_path',

1567

connection_keyword='connection')

1568

def Introspect(self, object_path, connection):

1569

"""Overloading of standard D-Bus method.

1570

1571

Override return argument name of GetManagedObjects to be

1572

"objpath_interfaces_and_properties"

1573

"""

1574

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1575

object_path,

1576

connection)

1577

try:

1578

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

1579

1580

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

1581

# Fix argument name for the GetManagedObjects method

1582

if (if_tag.getAttribute("name")

1583

== dbus.OBJECT_MANAGER_IFACE):

1584

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

1585

if (cn.getAttribute("name")

1586

== "GetManagedObjects"):

1587

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

1588

if (arg.getAttribute("direction")

1589

== "out"):

1590

arg.setAttribute(

1591

"name",

1592

"objpath_interfaces"

1593

"_and_properties")

1594

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

1595

document.unlink()

1596

except (AttributeError, xml.dom.DOMException,

1597

xml.parsers.expat.ExpatError) as error:

1598

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

1599

exc_info=error)

1600

return xmlstring

1601

1602

1042

1603

def datetime_to_dbus(dt, variant_level=0):

1043

1604

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

1044

1605

if dt is None:

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1606

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

1607

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

1048

1608

1049

1609

1050

1610

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1052

1612

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

1053

1613

interface names according to the "alt_interface_names" mapping.

1054

1614

Usage:

1055

1615

1056

1616

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

1057

1617

"net.example.AlternateInterface"})

1058

1618

class SampleDBusObject(dbus.service.Object):

1059

1619

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

1060

1620

def SampleDBusMethod():

1061

1621

pass

1062

1622

1063

1623

The above "SampleDBusMethod" on "SampleDBusObject" will be

1064

1624

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

1065

1625

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

1066

1626

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

1067

1627

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

1068

1628

1069

1629

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

1070

1630

(from DBusObjectWithProperties) and interfaces (from the

1071

1631

dbus_interface_annotations decorator).

1072

1632

"""

1633

1073

1634

def wrapper(cls):

1074

1635

for orig_interface_name, alt_interface_name in (

1075

alt_interface_names.iteritems()):

1636

alt_interface_names.items()):

1076

1637

attr = {}

1077

1638

interface_names = set()

1078

1639

# Go though all attributes of the class

1080

1641

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

1081

1642

# with the wrong interface name

1082

1643

if (not hasattr(attribute, "_dbus_interface")

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1644

or not attribute._dbus_interface.startswith(

1645

orig_interface_name)):

1085

1646

continue

1086

1647

# Create an alternate D-Bus interface name based on

1087

1648

# the current name

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1649

alt_interface = attribute._dbus_interface.replace(

1650

orig_interface_name, alt_interface_name)

1091

1651

interface_names.add(alt_interface)

1092

1652

# Is this a D-Bus signal?

1093

1653

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

1094

1654

# Extract the original non-method undecorated

1095

1655

# function by black magic

1096

nonmethod_func = (dict(

1656

if sys.version_info.major == 2:

1657

nonmethod_func = (dict(

1097

1658

zip(attribute.func_code.co_freevars,

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1659

attribute.__closure__))

1660

["func"].cell_contents)

1661

else:

1662

nonmethod_func = (dict(

1663

zip(attribute.__code__.co_freevars,

1664

attribute.__closure__))

1665

["func"].cell_contents)

1100

1666

# Create a new, but exactly alike, function

1101

1667

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

1102

1668

# with the alternate D-Bus interface name

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1669

new_function = copy_function(nonmethod_func)

1670

new_function = (dbus.service.signal(

1671

alt_interface,

1672

attribute._dbus_signature)(new_function))

1112

1673

# Copy annotations, if any

1113

1674

try:

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1675

new_function._dbus_annotations = dict(

1676

attribute._dbus_annotations)

1116

1677

except AttributeError:

1117

1678

pass

1679

1118

1680

# Define a creator of a function to call both the

1119

1681

# original and alternate functions, so both the

1120

1682

# original and alternate signals gets sent when

1123

1685

"""This function is a scope container to pass

1124

1686

func1 and func2 to the "call_both" function

1125

1687

outside of its arguments"""

1688

1689

@functools.wraps(func2)

1126

1690

def call_both(*args, **kwargs):

1127

1691

"""This function will emit two D-Bus

1128

1692

signals by calling func1 and func2"""

1129

1693

func1(*args, **kwargs)

1130

1694

func2(*args, **kwargs)

1695

# Make wrapper function look like a D-Bus

1696

# signal

1697

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

1698

if name.startswith("_dbus_"):

1699

setattr(call_both, name, attr)

1700

1131

1701

return call_both

1132

1702

# Create the "call_both" function and add it to

1133

1703

# the class

1138

1708

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

1139

1709

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

1140

1710

# to the class.

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1711

attr[attrname] = (

1712

dbus.service.method(

1713

alt_interface,

1714

attribute._dbus_in_signature,

1715

attribute._dbus_out_signature)

1716

(copy_function(attribute)))

1151

1717

# Copy annotations, if any

1152

1718

try:

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1719

attr[attrname]._dbus_annotations = dict(

1720

attribute._dbus_annotations)

1155

1721

except AttributeError:

1156

1722

pass

1157

1723

# Is this a D-Bus property?

1160

1726

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

1161

1727

# property with the alternate D-Bus interface

1162

1728

# name. Add it to the class.

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1729

attr[attrname] = (dbus_service_property(

1730

alt_interface, attribute._dbus_signature,

1731

attribute._dbus_access,

1732

attribute._dbus_get_args_options

1733

["byte_arrays"])

1734

(copy_function(attribute)))

1176

1735

# Copy annotations, if any

1177

1736

try:

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1737

attr[attrname]._dbus_annotations = dict(

1738

attribute._dbus_annotations)

1180

1739

except AttributeError:

1181

1740

pass

1182

1741

# Is this a D-Bus interface?

1185

1744

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

1186

1745

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

1187

1746

# to the class.

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1747

attr[attrname] = (

1748

dbus_interface_annotations(alt_interface)

1749

(copy_function(attribute)))

1196

1750

if deprecate:

1197

1751

# Deprecate all alternate interfaces

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1752

iname = "_AlternateDBusNames_interface_annotation{}"

1199

1753

for interface_name in interface_names:

1754

1200

1755

@dbus_interface_annotations(interface_name)

1201

1756

def func(self):

1202

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

1203

"true" }

1757

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

1758

"true"}

1204

1759

# Find an unused name

1205

1760

for aname in (iname.format(i)

1206

1761

for i in itertools.count()):

1210

1765

if interface_names:

1211

1766

# Replace the class with a new subclass of it with

1212

1767

# methods, signals, etc. as created above.

1213

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

1214

(cls,), attr)

1768

if sys.version_info.major == 2:

1769

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

1770

(cls, ), attr)

1771

else:

1772

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

1773

(cls, ), attr)

1215

1774

return cls

1775

1216

1776

return wrapper

1217

1777

1218

1778

1219

1779

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

1220

"se.bsnet.fukt.Mandos"})

1780

"se.bsnet.fukt.Mandos"})

1221

1781

class ClientDBus(Client, DBusObjectWithProperties):

1222

1782

"""A Client class using D-Bus

1223

1783

1224

1784

Attributes:

1225

1785

dbus_object_path: dbus.ObjectPath

1226

1786

bus: dbus.SystemBus()

1227

1787

"""

1228

1788

1229

1789

runtime_expansions = (Client.runtime_expansions

1230

+ ("dbus_object_path",))

1231

1790

+ ("dbus_object_path", ))

1791

1792

_interface = "se.recompile.Mandos.Client"

1793

1232

1794

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

1233

1234

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

1795

1796

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

1235

1797

self.bus = bus

1236

1798

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

1237

1799

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

1238

1800

# the D-Bus

1239

client_object_name = unicode(self.name).translate(

1801

client_object_name = str(self.name).translate(

1240

1802

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

1241

1803

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

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1804

self.dbus_object_path = dbus.ObjectPath(

1805

"/clients/" + client_object_name)

1244

1806

DBusObjectWithProperties.__init__(self, self.bus,

1245

1807

self.dbus_object_path)

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1808

1809

def notifychangeproperty(transform_func, dbus_name,

1810

type_func=lambda x: x,

1811

variant_level=1,

1812

invalidate_only=False,

1813

_interface=_interface):

1250

1814

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

1251

1815

its changes to DBus.

1252

1816

1253

1817

transform_fun: Function that takes a value and a variant_level

1254

1818

and transforms it to a D-Bus type.

1255

1819

dbus_name: D-Bus name of the variable

1257

1821

to the D-Bus. Default: no transform

1258

1822

variant_level: D-Bus variant level. Default: 1

1259

1823

"""

1260

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

1824

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

1825

1261

1826

def setter(self, value):

1262

1827

if hasattr(self, "dbus_object_path"):

1263

1828

if (not hasattr(self, attrname) or

1264

1829

type_func(getattr(self, attrname, None))

1265

1830

!= type_func(value)):

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1831

if invalidate_only:

1832

self.PropertiesChanged(

1833

_interface, dbus.Dictionary(),

1834

dbus.Array((dbus_name, )))

1835

else:

1836

dbus_value = transform_func(

1837

type_func(value),

1838

variant_level=variant_level)

1839

self.PropertyChanged(dbus.String(dbus_name),

1840

dbus_value)

1841

self.PropertiesChanged(

1842

_interface,

1843

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

1844

dbus_value}),

1845

dbus.Array())

1271

1846

setattr(self, attrname, value)

1272

1847

1273

1848

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

1274

1849

1275

1850

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1276

1851

approvals_pending = notifychangeproperty(dbus.Boolean,

1277

1852

"ApprovalPending",

1278

type_func = bool)

1853

type_func=bool)

1279

1854

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

1280

1855

last_enabled = notifychangeproperty(datetime_to_dbus,

1281

1856

"LastEnabled")

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1857

checker = notifychangeproperty(

1858

dbus.Boolean, "CheckerRunning",

1859

type_func=lambda checker: checker is not None)

1285

1860

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1286

1861

"LastCheckedOK")

1287

1862

last_checker_status = notifychangeproperty(dbus.Int16,

1290

1865

datetime_to_dbus, "LastApprovalRequest")

1291

1866

approved_by_default = notifychangeproperty(dbus.Boolean,

1292

1867

"ApprovedByDefault")

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1868

approval_delay = notifychangeproperty(

1869

dbus.UInt64, "ApprovalDelay",

1870

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

1297

1871

approval_duration = notifychangeproperty(

1298

1872

dbus.UInt64, "ApprovalDuration",

1299

type_func = timedelta_to_milliseconds)

1873

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

1300

1874

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1875

timeout = notifychangeproperty(

1876

dbus.UInt64, "Timeout",

1877

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

1304

1878

extended_timeout = notifychangeproperty(

1305

1879

dbus.UInt64, "ExtendedTimeout",

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1880

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

1881

interval = notifychangeproperty(

1882

dbus.UInt64, "Interval",

1883

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

1311

1884

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

1312

1885

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

1886

invalidate_only=True)

1887

1313

1888

del notifychangeproperty

1314

1889

1315

1890

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

1316

1891

try:

1317

1892

self.remove_from_connection()

1320

1895

if hasattr(DBusObjectWithProperties, "__del__"):

1321

1896

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

1322

1897

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

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1898

1899

def checker_callback(self, source, condition,

1900

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

1901

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

1902

connection, command, *args,

1903

**kwargs)

1904

exitstatus = self.last_checker_status

1905

if exitstatus >= 0:

1330

1906

# Emit D-Bus signal

1331

1907

self.CheckerCompleted(dbus.Int16(exitstatus),

1332

dbus.Int64(condition),

1908

# This is specific to GNU libC

1909

dbus.Int64(exitstatus << 8),

1333

1910

dbus.String(command))

1334

1911

else:

1335

1912

# Emit D-Bus signal

1336

1913

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

1337

dbus.Int64(condition),

1914

dbus.Int64(

1915

# This is specific to GNU libC

1916

(exitstatus << 8)

1917

| self.last_checker_signal),

1338

1918

dbus.String(command))

1339

1340

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

1341

*args, **kwargs)

1342

1919

return ret

1920

1343

1921

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1922

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

1349

1923

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

1350

1924

# Only if new checker process was started

1351

1925

if (self.checker is not None

1353

1927

# Emit D-Bus signal

1354

1928

self.CheckerStarted(self.current_checker_command)

1355

1929

return r

1356

1930

1357

1931

def _reset_approved(self):

1358

1932

self.approved = None

1359

1933

return False

1360

1934

1361

1935

def approve(self, value=True):

1362

1936

self.approved = value

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1937

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

1938

* 1000), self._reset_approved)

1366

1939

self.send_changedstate()

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1940

1941

# D-Bus methods, signals & properties

1942

1943

# Interfaces

1944

1945

# Signals

1946

1380

1947

# CheckerCompleted - signal

1381

1948

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

1382

1949

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

1383

1950

"D-Bus signal"

1384

1951

pass

1385

1952

1386

1953

# CheckerStarted - signal

1387

1954

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

1388

1955

def CheckerStarted(self, command):

1389

1956

"D-Bus signal"

1390

1957

pass

1391

1958

1392

1959

# PropertyChanged - signal

1960

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

1393

1961

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

1394

1962

def PropertyChanged(self, property, value):

1395

1963

"D-Bus signal"

1396

1964

pass

1397

1965

1398

1966

# GotSecret - signal

1399

1967

@dbus.service.signal(_interface)

1400

1968

def GotSecret(self):

1403

1971

server to mandos-client

1404

1972

"""

1405

1973

pass

1406

1974

1407

1975

# Rejected - signal

1408

1976

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

1409

1977

def Rejected(self, reason):

1410

1978

"D-Bus signal"

1411

1979

pass

1412

1980

1413

1981

# NeedApproval - signal

1414

1982

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

1415

1983

def NeedApproval(self, timeout, default):

1416

1984

"D-Bus signal"

1417

1985

return self.need_approval()

1418

1419

## Methods

1420

1986

1987

# Methods

1988

1421

1989

# Approve - method

1422

1990

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

1423

1991

def Approve(self, value):

1424

1992

self.approve(value)

1425

1993

1426

1994

# CheckedOK - method

1427

1995

@dbus.service.method(_interface)

1428

1996

def CheckedOK(self):

1429

1997

self.checked_ok()

1430

1998

1431

1999

# Enable - method

2000

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

1432

2001

@dbus.service.method(_interface)

1433

2002

def Enable(self):

1434

2003

"D-Bus method"

1435

2004

self.enable()

1436

2005

1437

2006

# StartChecker - method

2007

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

1438

2008

@dbus.service.method(_interface)

1439

2009

def StartChecker(self):

1440

2010

"D-Bus method"

1441

2011

self.start_checker()

1442

2012

1443

2013

# Disable - method

2014

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

1444

2015

@dbus.service.method(_interface)

1445

2016

def Disable(self):

1446

2017

"D-Bus method"

1447

2018

self.disable()

1448

2019

1449

2020

# StopChecker - method

2021

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

1450

2022

@dbus.service.method(_interface)

1451

2023

def StopChecker(self):

1452

2024

self.stop_checker()

1453

1454

## Properties

1455

2025

2026

# Properties

2027

1456

2028

# ApprovalPending - property

1457

2029

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

1458

2030

def ApprovalPending_dbus_property(self):

1459

2031

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

1460

2032

1461

2033

# ApprovedByDefault - property

1462

@dbus_service_property(_interface, signature="b",

2034

@dbus_service_property(_interface,

2035

signature="b",

1463

2036

access="readwrite")

1464

2037

def ApprovedByDefault_dbus_property(self, value=None):

1465

2038

if value is None: # get

1466

2039

return dbus.Boolean(self.approved_by_default)

1467

2040

self.approved_by_default = bool(value)

1468

2041

1469

2042

# ApprovalDelay - property

1470

@dbus_service_property(_interface, signature="t",

2043

@dbus_service_property(_interface,

2044

signature="t",

1471

2045

access="readwrite")

1472

2046

def ApprovalDelay_dbus_property(self, value=None):

1473

2047

if value is None: # get

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2048

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

2049

* 1000)

1475

2050

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

1476

2051

1477

2052

# ApprovalDuration - property

1478

@dbus_service_property(_interface, signature="t",

2053

@dbus_service_property(_interface,

2054

signature="t",

1479

2055

access="readwrite")

1480

2056

def ApprovalDuration_dbus_property(self, value=None):

1481

2057

if value is None: # get

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2058

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

2059

* 1000)

1484

2060

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

1485

2061

1486

2062

# Name - property

2063

@dbus_annotations(

2064

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

1487

2065

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

1488

2066

def Name_dbus_property(self):

1489

2067

return dbus.String(self.name)

1490

2068

2069

# KeyID - property

2070

@dbus_annotations(

2071

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

2072

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

2073

def KeyID_dbus_property(self):

2074

return dbus.String(self.key_id)

2075

1491

2076

# Fingerprint - property

2077

@dbus_annotations(

2078

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

1492

2079

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

1493

2080

def Fingerprint_dbus_property(self):

1494

2081

return dbus.String(self.fingerprint)

1495

2082

1496

2083

# Host - property

1497

@dbus_service_property(_interface, signature="s",

2084

@dbus_service_property(_interface,

2085

signature="s",

1498

2086

access="readwrite")

1499

2087

def Host_dbus_property(self, value=None):

1500

2088

if value is None: # get

1501

2089

return dbus.String(self.host)

1502

self.host = unicode(value)

1503

2090

self.host = str(value)

2091

1504

2092

# Created - property

2093

@dbus_annotations(

2094

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

1505

2095

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

1506

2096

def Created_dbus_property(self):

1507

2097

return datetime_to_dbus(self.created)

1508

2098

1509

2099

# LastEnabled - property

1510

2100

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

1511

2101

def LastEnabled_dbus_property(self):

1512

2102

return datetime_to_dbus(self.last_enabled)

1513

2103

1514

2104

# Enabled - property

1515

@dbus_service_property(_interface, signature="b",

2105

@dbus_service_property(_interface,

2106

signature="b",

1516

2107

access="readwrite")

1517

2108

def Enabled_dbus_property(self, value=None):

1518

2109

if value is None: # get

1521

2112

self.enable()

1522

2113

else:

1523

2114

self.disable()

1524

2115

1525

2116

# LastCheckedOK - property

1526

@dbus_service_property(_interface, signature="s",

2117

@dbus_service_property(_interface,

2118

signature="s",

1527

2119

access="readwrite")

1528

2120

def LastCheckedOK_dbus_property(self, value=None):

1529

2121

if value is not None:

1530

2122

self.checked_ok()

1531

2123

return

1532

2124

return datetime_to_dbus(self.last_checked_ok)

1533

2125

1534

2126

# LastCheckerStatus - property

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2127

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

1537

2128

def LastCheckerStatus_dbus_property(self):

1538

2129

return dbus.Int16(self.last_checker_status)

1539

2130

1540

2131

# Expires - property

1541

2132

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

1542

2133

def Expires_dbus_property(self):

1543

2134

return datetime_to_dbus(self.expires)

1544

2135

1545

2136

# LastApprovalRequest - property

1546

2137

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

1547

2138

def LastApprovalRequest_dbus_property(self):

1548

2139

return datetime_to_dbus(self.last_approval_request)

1549

2140

1550

2141

# Timeout - property

1551

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1552

2144

access="readwrite")

1553

2145

def Timeout_dbus_property(self, value=None):

1554

2146

if value is None: # get

1555

return dbus.UInt64(self.timeout_milliseconds())

2147

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

1556

2148

old_timeout = self.timeout

1557

2149

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

1558

2150

# Reschedule disabling

1566

2158

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

1567

2159

is None):

1568

2160

return

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2161

GLib.source_remove(self.disable_initiator_tag)

2162

self.disable_initiator_tag = GLib.timeout_add(

2163

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

2164

self.disable)

2165

1575

2166

# ExtendedTimeout - property

1576

@dbus_service_property(_interface, signature="t",

2167

@dbus_service_property(_interface,

2168

signature="t",

1577

2169

access="readwrite")

1578

2170

def ExtendedTimeout_dbus_property(self, value=None):

1579

2171

if value is None: # get

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2172

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

2173

* 1000)

1581

2174

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

1582

2175

1583

2176

# Interval - property

1584

@dbus_service_property(_interface, signature="t",

2177

@dbus_service_property(_interface,

2178

signature="t",

1585

2179

access="readwrite")

1586

2180

def Interval_dbus_property(self, value=None):

1587

2181

if value is None: # get

1588

return dbus.UInt64(self.interval_milliseconds())

2182

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

1589

2183

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

1590

2184

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

1591

2185

return

1592

2186

if self.enabled:

1593

2187

# Reschedule checker run

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2188

GLib.source_remove(self.checker_initiator_tag)

2189

self.checker_initiator_tag = GLib.timeout_add(

2190

value, self.start_checker)

2191

self.start_checker() # Start one now, too

2192

1599

2193

# Checker - property

1600

@dbus_service_property(_interface, signature="s",

2194

@dbus_service_property(_interface,

2195

signature="s",

1601

2196

access="readwrite")

1602

2197

def Checker_dbus_property(self, value=None):

1603

2198

if value is None: # get

1604

2199

return dbus.String(self.checker_command)

1605

self.checker_command = unicode(value)

1606

2200

self.checker_command = str(value)

2201

1607

2202

# CheckerRunning - property

1608

@dbus_service_property(_interface, signature="b",

2203

@dbus_service_property(_interface,

2204

signature="b",

1609

2205

access="readwrite")

1610

2206

def CheckerRunning_dbus_property(self, value=None):

1611

2207

if value is None: # get

1614

2210

self.start_checker()

1615

2211

else:

1616

2212

self.stop_checker()

1617

2213

1618

2214

# ObjectPath - property

2215

@dbus_annotations(

2216

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

2217

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

1619

2218

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

1620

2219

def ObjectPath_dbus_property(self):

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2220

return self.dbus_object_path # is already a dbus.ObjectPath

2221

1623

2222

# Secret = property

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2223

@dbus_annotations(

2224

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

2225

"invalidates"})

2226

@dbus_service_property(_interface,

2227

signature="ay",

2228

access="write",

2229

byte_arrays=True)

1626

2230

def Secret_dbus_property(self, value):

1627

self.secret = str(value)

1628

2231

self.secret = bytes(value)

2232

1629

2233

del _interface

1630

2234

1631

2235

1632

class ProxyClient(object):

1633

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

2236

class ProxyClient:

2237

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

1634

2238

self._pipe = child_pipe

1635

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

2239

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

1636

2240

if not self._pipe.recv():

1637

raise KeyError()

1638

2241

raise KeyError(key_id or fpr)

2242

1639

2243

def __getattribute__(self, name):

1640

2244

if name == '_pipe':

1641

2245

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

1644

2248

if data[0] == 'data':

1645

2249

return data[1]

1646

2250

if data[0] == 'function':

2251

1647

2252

def func(*args, **kwargs):

1648

2253

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

1649

2254

return self._pipe.recv()[1]

2255

1650

2256

return func

1651

2257

1652

2258

def __setattr__(self, name, value):

1653

2259

if name == '_pipe':

1654

2260

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

1657

2263

1658

2264

class ClientHandler(socketserver.BaseRequestHandler, object):

1659

2265

"""A class to handle client connections.

1660

2266

1661

2267

Instantiated once for each connection to handle it.

1662

2268

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

1663

2269

1664

2270

def handle(self):

1665

2271

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

1666

2272

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

1667

unicode(self.client_address))

2273

str(self.client_address))

1668

2274

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

1669

2275

self.server.child_pipe.fileno())

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2276

2277

session = gnutls.ClientSession(self.request)

2278

2279

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

2280

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

2281

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

2282

# "+DHE-DSS"))

1685

2283

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

1686

2284

priority = self.server.gnutls_priority

1687

2285

if priority is None:

1688

2286

priority = "NORMAL"

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2287

gnutls.priority_set_direct(session._c_object,

2288

priority.encode("utf-8"),

2289

None)

2290

1693

2291

# Start communication using the Mandos protocol

1694

2292

# Get protocol number

1695

2293

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

1696

2294

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

1697

2295

try:

1698

2296

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

1699

raise RuntimeError

2297

raise RuntimeError(line)

1700

2298

except (ValueError, IndexError, RuntimeError) as error:

1701

2299

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

1702

2300

return

1703

2301

1704

2302

# Start GnuTLS connection

1705

2303

try:

1706

2304

session.handshake()

1707

except gnutls.errors.GNUTLSError as error:

2305

except gnutls.Error as error:

1708

2306

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

1709

2307

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

1710

2308

# established. Just abandon the request.

1711

2309

return

1712

2310

logger.debug("Handshake succeeded")

1713

2311

1714

2312

approval_required = False

1715

2313

try:

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2314

if gnutls.has_rawpk:

2315

fpr = b""

2316

try:

2317

key_id = self.key_id(

2318

self.peer_certificate(session))

2319

except (TypeError, gnutls.Error) as error:

2320

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

2321

return

2322

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

2323

2324

else:

2325

key_id = b""

2326

try:

2327

fpr = self.fingerprint(

2328

self.peer_certificate(session))

2329

except (TypeError, gnutls.Error) as error:

2330

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

2331

return

2332

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

2333

2334

try:

2335

client = ProxyClient(child_pipe, key_id, fpr,

1727

2336

self.client_address)

1728

2337

except KeyError:

1729

2338

return

1730

2339

1731

2340

if client.approval_delay:

1732

2341

delay = client.approval_delay

1733

2342

client.approvals_pending += 1

1734

2343

approval_required = True

1735

2344

1736

2345

while True:

1737

2346

if not client.enabled:

1738

2347

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

1739

client.name)

2348

client.name)

1740

2349

if self.server.use_dbus:

1741

2350

# Emit D-Bus signal

1742

2351

client.Rejected("Disabled")

1743

2352

return

1744

2353

1745

2354

if client.approved or not client.approval_delay:

1746

#We are approved or approval is disabled

2355

# We are approved or approval is disabled

1747

2356

break

1748

2357

elif client.approved is None:

1749

2358

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

1751

2360

if self.server.use_dbus:

1752

2361

# Emit D-Bus signal

1753

2362

client.NeedApproval(

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2363

client.approval_delay.total_seconds()

2364

* 1000, client.approved_by_default)

1756

2365

else:

1757

2366

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

1758

2367

client.name)

1760

2369

# Emit D-Bus signal

1761

2370

client.Rejected("Denied")

1762

2371

return

1763

1764

#wait until timeout or approved

2372

2373

# wait until timeout or approved

1765

2374

time = datetime.datetime.now()

1766

2375

client.changedstate.acquire()

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2376

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

1770

2377

client.changedstate.release()

1771

2378

time2 = datetime.datetime.now()

1772

2379

if (time2 - time) >= delay:

1782

2389

break

1783

2390

else:

1784

2391

delay -= time2 - time

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2392

2393

try:

2394

session.send(client.secret)

2395

except gnutls.Error as error:

2396

logger.warning("gnutls send failed",

2397

exc_info=error)

2398

return

2399

1799

2400

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

1800

2401

# bump the timeout using extended_timeout

1801

2402

client.bump_timeout(client.extended_timeout)

1802

2403

if self.server.use_dbus:

1803

2404

# Emit D-Bus signal

1804

2405

client.GotSecret()

1805

2406

1806

2407

finally:

1807

2408

if approval_required:

1808

2409

client.approvals_pending -= 1

1809

2410

try:

1810

2411

session.bye()

1811

except gnutls.errors.GNUTLSError as error:

2412

except gnutls.Error as error:

1812

2413

logger.warning("GnuTLS bye failed",

1813

2414

exc_info=error)

1814

2415

1815

2416

@staticmethod

1816

2417

def peer_certificate(session):

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2418

"Return the peer's certificate as a bytestring"

2419

try:

2420

cert_type = gnutls.certificate_type_get2(session._c_object,

2421

gnutls.CTYPE_PEERS)

2422

except AttributeError:

2423

cert_type = gnutls.certificate_type_get(session._c_object)

2424

if gnutls.has_rawpk:

2425

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2426

else:

2427

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2428

# If not a valid certificate type...

2429

if cert_type not in valid_cert_types:

2430

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

2431

valid_cert_types)

2432

# ...return invalid data

2433

return b""

1824

2434

list_size = ctypes.c_uint(1)

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2435

cert_list = (gnutls.certificate_get_peers

1827

2436

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

1828

2437

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

1829

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

1830

" certificate")

2438

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

1831

2439

if list_size.value == 0:

1832

2440

return None

1833

2441

cert = cert_list[0]

1834

2442

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

1835

2443

2444

@staticmethod

2445

def key_id(certificate):

2446

"Convert a certificate bytestring to a hexdigit key ID"

2447

# New GnuTLS "datum" with the public key

2448

datum = gnutls.datum_t(

2449

ctypes.cast(ctypes.c_char_p(certificate),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.c_uint(len(certificate)))

2452

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

2453

# New empty GnuTLS certificate

2454

pubkey = gnutls.pubkey_t()

2455

gnutls.pubkey_init(ctypes.byref(pubkey))

2456

# Import the raw public key into the certificate

2457

gnutls.pubkey_import(pubkey,

2458

ctypes.byref(datum),

2459

gnutls.X509_FMT_DER)

2460

# New buffer for the key ID

2461

buf = ctypes.create_string_buffer(32)

2462

buf_len = ctypes.c_size_t(len(buf))

2463

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

2464

gnutls.pubkey_get_key_id(pubkey,

2465

gnutls.KEYID_USE_SHA256,

2466

ctypes.cast(ctypes.byref(buf),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.byref(buf_len))

2469

# Deinit the certificate

2470

gnutls.pubkey_deinit(pubkey)

2471

2472

# Convert the buffer to a Python bytestring

2473

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

2474

# Convert the bytestring to hexadecimal notation

2475

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

2476

return hex_key_id

2477

1836

2478

@staticmethod

1837

2479

def fingerprint(openpgp):

1838

2480

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1839

2481

# New GnuTLS "datum" with the OpenPGP public key

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2482

datum = gnutls.datum_t(

2483

ctypes.cast(ctypes.c_char_p(openpgp),

2484

ctypes.POINTER(ctypes.c_ubyte)),

2485

ctypes.c_uint(len(openpgp)))

1845

2486

# New empty GnuTLS certificate

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2487

crt = gnutls.openpgp_crt_t()

2488

gnutls.openpgp_crt_init(ctypes.byref(crt))

1849

2489

# Import the OpenPGP public key into the certificate

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2490

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

2491

gnutls.OPENPGP_FMT_RAW)

1854

2492

# Verify the self signature in the key

1855

2493

crtverify = ctypes.c_uint()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2494

gnutls.openpgp_crt_verify_self(crt, 0,

2495

ctypes.byref(crtverify))

1859

2496

if crtverify.value != 0:

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2497

gnutls.openpgp_crt_deinit(crt)

2498

raise gnutls.CertificateSecurityError(code

2499

=crtverify.value)

1863

2500

# New buffer for the fingerprint

1864

2501

buf = ctypes.create_string_buffer(20)

1865

2502

buf_len = ctypes.c_size_t()

1866

2503

# Get the fingerprint from the certificate into the buffer

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2504

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

2505

ctypes.byref(buf_len))

1870

2506

# Deinit the certificate

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2507

gnutls.openpgp_crt_deinit(crt)

1872

2508

# Convert the buffer to a Python bytestring

1873

2509

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

1874

2510

# Convert the bytestring to hexadecimal notation

1876

2512

return hex_fpr

1877

2513

1878

2514

1879

class MultiprocessingMixIn(object):

2515

class MultiprocessingMixIn:

1880

2516

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

2517

1881

2518

def sub_process_main(self, request, address):

1882

2519

try:

1883

2520

self.finish_request(request, address)

1884

2521

except Exception:

1885

2522

self.handle_error(request, address)

1886

2523

self.close_request(request)

1887

2524

1888

2525

def process_request(self, request, address):

1889

2526

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

1890

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

1891

args = (request, address))

2527

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

2528

args=(request, address))

1892

2529

proc.start()

1893

2530

return proc

1894

2531

1895

2532

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2533

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1897

2534

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

2535

1898

2536

def process_request(self, request, client_address):

1899

2537

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

1900

2538

1901

2539

This function creates a new pipe in self.pipe

1902

2540

"""

1903

2541

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1904

2542

1905

2543

proc = MultiprocessingMixIn.process_request(self, request,

1906

2544

client_address)

1907

2545

self.child_pipe.close()

1908

2546

self.add_pipe(parent_pipe, proc)

1909

2547

1910

2548

def add_pipe(self, parent_pipe, proc):

1911

2549

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

1912

raise NotImplementedError

2550

raise NotImplementedError()

1913

2551

1914

2552

1915

2553

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1916

socketserver.TCPServer, object):

2554

socketserver.TCPServer):

1917

2555

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

1918

2556

1919

2557

Attributes:

1920

2558

enabled: Boolean; whether this server is activated yet

1921

2559

interface: None or a network interface name (string)

1922

2560

use_ipv6: Boolean; to use IPv6 or not

1923

2561

"""

2562

1924

2563

def __init__(self, server_address, RequestHandlerClass,

1925

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

2564

interface=None,

2565

use_ipv6=True,

2566

socketfd=None):

1926

2567

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

1927

2568

creating a new one with socket.socket().

1928

2569

"""

1934

2575

self.socketfd = socketfd

1935

2576

# Save the original socket.socket() function

1936

2577

self.socket_socket = socket.socket

2578

1937

2579

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

1938

#

2580

#

1939

2581

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

1940

2582

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

1941

2583

# patching socket.socket.)

1942

#

2584

#

1943

2585

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

1944

2586

@functools.wraps(socket.socket)

1945

2587

def socket_wrapper(*args, **kwargs):

1957

2599

# socket_wrapper(), if socketfd was set.

1958

2600

socketserver.TCPServer.__init__(self, server_address,

1959

2601

RequestHandlerClass)

1960

2602

1961

2603

def server_bind(self):

1962

2604

"""This overrides the normal server_bind() function

1963

2605

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

1964

2606

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

2607

global SO_BINDTODEVICE

1965

2608

if self.interface is not None:

1966

2609

if SO_BINDTODEVICE is None:

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2610

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

2611

# common enough.

2612

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

2613

SO_BINDTODEVICE = 25

2614

try:

2615

self.socket.setsockopt(

2616

socket.SOL_SOCKET, SO_BINDTODEVICE,

2617

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

2618

except socket.error as error:

2619

if error.errno == errno.EPERM:

2620

logger.error("No permission to bind to"

2621

" interface %s", self.interface)

2622

elif error.errno == errno.ENOPROTOOPT:

2623

logger.error("SO_BINDTODEVICE not available;"

2624

" cannot bind to interface %s",

2625

self.interface)

2626

elif error.errno == errno.ENODEV:

2627

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

2628

" cannot bind", self.interface)

2629

else:

2630

raise

1988

2631

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

1989

2632

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

2633

if self.server_address[1]:

2634

self.allow_reuse_address = True

1990

2635

if not self.server_address[0]:

1991

2636

if self.address_family == socket.AF_INET6:

1992

any_address = "::" # in6addr_any

2637

any_address = "::" # in6addr_any

1993

2638

else:

1994

any_address = "0.0.0.0" # INADDR_ANY

2639

any_address = "0.0.0.0" # INADDR_ANY

1995

2640

self.server_address = (any_address,

1996

2641

self.server_address[1])

1997

2642

elif not self.server_address[1]:

1998

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

1999

0)

2643

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

2000

2644

# if self.interface:

2001

2645

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

2002

2646

# 0, # port

2008

2652

2009

2653

class MandosServer(IPv6_TCPServer):

2010

2654

"""Mandos server.

2011

2655

2012

2656

Attributes:

2013

2657

clients: set of Client objects

2014

2658

gnutls_priority GnuTLS priority string

2015

2659

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

2016

2017

Assumes a gobject.MainLoop event loop.

2660

2661

Assumes a GLib.MainLoop event loop.

2018

2662

"""

2663

2019

2664

def __init__(self, server_address, RequestHandlerClass,

2020

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

2021

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

2665

interface=None,

2666

use_ipv6=True,

2667

clients=None,

2668

gnutls_priority=None,

2669

use_dbus=True,

2670

socketfd=None):

2022

2671

self.enabled = False

2023

2672

self.clients = clients

2024

2673

if self.clients is None:

2027

2676

self.gnutls_priority = gnutls_priority

2028

2677

IPv6_TCPServer.__init__(self, server_address,

2029

2678

RequestHandlerClass,

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2679

interface=interface,

2680

use_ipv6=use_ipv6,

2681

socketfd=socketfd)

2682

2033

2683

def server_activate(self):

2034

2684

if self.enabled:

2035

2685

return socketserver.TCPServer.server_activate(self)

2036

2686

2037

2687

def enable(self):

2038

2688

self.enabled = True

2039

2689

2040

2690

def add_pipe(self, parent_pipe, proc):

2041

2691

# Call "handle_ipc" for both data and EOF events

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2692

GLib.io_add_watch(

2693

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

2694

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

2695

functools.partial(self.handle_ipc,

2696

parent_pipe=parent_pipe,

2697

proc=proc))

2698

2699

def handle_ipc(self, source, condition,

2700

parent_pipe=None,

2701

proc=None,

2702

client_object=None):

2051

2703

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

2052

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

2704

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

2053

2705

# Wait for other process to exit

2054

2706

proc.join()

2055

2707

return False

2056

2708

2057

2709

# Read a request from the child

2058

2710

request = parent_pipe.recv()

2059

2711

command = request[0]

2060

2712

2061

2713

if command == 'init':

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2714

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

2715

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

2716

address = request[3]

2717

2718

for c in self.clients.values():

2719

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2720

continue

2721

if key_id and c.key_id == key_id:

2722

client = c

2723

break

2724

if fpr and c.fingerprint == fpr:

2067

2725

client = c

2068

2726

break

2069

2727

else:

2070

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

2071

"dress: %s", fpr, address)

2728

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

2729

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

2072

2730

if self.use_dbus:

2073

2731

# Emit D-Bus signal

2074

mandos_dbus_service.ClientNotFound(fpr,

2732

mandos_dbus_service.ClientNotFound(key_id or fpr,

2075

2733

address[0])

2076

2734

parent_pipe.send(False)

2077

2735

return False

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2736

2737

GLib.io_add_watch(

2738

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

2739

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

2740

functools.partial(self.handle_ipc,

2741

parent_pipe=parent_pipe,

2742

proc=proc,

2743

client_object=client))

2087

2744

parent_pipe.send(True)

2088

2745

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

2089

2746

# same fileno

2092

2749

funcname = request[1]

2093

2750

args = request[2]

2094

2751

kwargs = request[3]

2095

2752

2096

2753

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

2097

2754

funcname)(*args,

2098

**kwargs)))

2099

2755

**kwargs)))

2756

2100

2757

if command == 'getattr':

2101

2758

attrname = request[1]

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2759

if isinstance(client_object.__getattribute__(attrname),

2760

collections.abc.Callable):

2761

parent_pipe.send(('function', ))

2104

2762

else:

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2763

parent_pipe.send((

2764

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

2765

2108

2766

if command == 'setattr':

2109

2767

attrname = request[1]

2110

2768

value = request[2]

2111

2769

setattr(client_object, attrname, value)

2112

2770

2113

2771

return True

2114

2772

2115

2773

2116

2774

def rfc3339_duration_to_delta(duration):

2117

2775

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

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2776

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2783

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

2784

True

2785

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

2786

True

2787

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

2788

True

2789

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

2790

True

2133

2791

"""

2134

2792

2135

2793

# Parsing an RFC 3339 duration with regular expressions is not

2136

2794

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

2137

2795

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

2138

2796

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

2139

2797

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

2140

2798

# avoid excessive use of external libraries.

2141

2799

2142

2800

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

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2801

Token = collections.namedtuple("Token", (

2802

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

2803

# a "group" containing digits

2804

"value", # datetime.timedelta or None

2805

"followers")) # Tokens valid after this token

2152

2806

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

2153

2807

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

2154

2808

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

2155

2809

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

2156

2810

datetime.timedelta(seconds=1),

2157

frozenset((token_end,)))

2811

frozenset((token_end, )))

2158

2812

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

2159

2813

datetime.timedelta(minutes=1),

2160

2814

frozenset((token_second, token_end)))

2176

2830

frozenset((token_month, token_end)))

2177

2831

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

2178

2832

datetime.timedelta(weeks=1),

2179

frozenset((token_end,)))

2833

frozenset((token_end, )))

2180

2834

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

2181

2835

frozenset((token_year, token_month,

2182

2836

token_day, token_time,

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2837

token_week)))

2838

# Define starting values:

2839

# Value so far

2840

value = datetime.timedelta()

2186

2841

found_token = None

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2842

# Following valid tokens

2843

followers = frozenset((token_duration, ))

2844

# String left to parse

2845

s = duration

2189

2846

# Loop until end token is found

2190

2847

while found_token is not token_end:

2191

2848

# Search for any currently valid tokens

2207

2864

break

2208

2865

else:

2209

2866

# No currently valid tokens were found

2210

raise ValueError("Invalid RFC 3339 duration")

2867

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

2868

.format(duration))

2211

2869

# End token found

2212

2870

return value

2213

2871

2214

2872

2215

2873

def string_to_delta(interval):

2216

2874

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

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2875

2876

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

2877

True

2878

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

2879

True

2880

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

2881

True

2882

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

2883

True

2884

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

2885

True

2886

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

2887

True

2230

2888

"""

2231

2889

2232

2890

try:

2233

2891

return rfc3339_duration_to_delta(interval)

2234

2892

except ValueError:

2235

2893

pass

2236

2894

2237

2895

timevalue = datetime.timedelta(0)

2238

2896

for s in interval.split():

2239

2897

try:

2240

suffix = unicode(s[-1])

2898

suffix = s[-1]

2241

2899

value = int(s[:-1])

2242

2900

if suffix == "d":

2243

2901

delta = datetime.timedelta(value)

2250

2908

elif suffix == "w":

2251

2909

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

2252

2910

else:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2911

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

2912

except IndexError as e:

2256

2913

raise ValueError(*(e.args))

2257

2914

timevalue += delta

2258

2915

return timevalue

2259

2916

2260

2917

2261

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

2918

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

2262

2919

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

2263

2920

2264

2921

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

2265

2922

if os.fork():

2266

2923

sys.exit()

2274

2931

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

2275

2932

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

2276

2933

raise OSError(errno.ENODEV,

2277

"{0} not a character device"

2934

"{} not a character device"

2278

2935

.format(os.devnull))

2279

2936

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

2280

2937

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

2284

2941

2285

2942

2286

2943

def main():

2287

2944

2288

2945

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

2289

2946

# Parsing of options, both command line and config file

2290

2947

2291

2948

parser = argparse.ArgumentParser()

2292

2949

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

2293

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

2950

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

2294

2951

help="show version number and exit")

2295

2952

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

2296

2953

help="Bind to interface IF")

2329

2986

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

2330

2987

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

2331

2988

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

2332

2989

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

2990

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

2991

default=None)

2992

2333

2993

options = parser.parse_args()

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

2994

2340

2995

# Default values for config file for server-global settings

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

2996

if gnutls.has_rawpk:

2997

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

2998

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

2999

else:

3000

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

3001

":+SIGN-DSA-SHA256")

3002

server_defaults = {"interface": "",

3003

"address": "",

3004

"port": "",

3005

"debug": "False",

3006

"priority": priority,

3007

"servicename": "Mandos",

3008

"use_dbus": "True",

3009

"use_ipv6": "True",

3010

"debuglevel": "",

3011

"restore": "True",

3012

"socket": "",

3013

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

3014

"foreground": "False",

3015

"zeroconf": "True",

3016

}

3017

del priority

3018

2357

3019

# Parse config file for server-global settings

2358

server_config = configparser.SafeConfigParser(server_defaults)

3020

server_config = configparser.ConfigParser(server_defaults)

2359

3021

del server_defaults

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3022

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

3023

# Convert the ConfigParser object to a dict

2363

3024

server_settings = server_config.defaults()

2364

3025

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

2365

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

3026

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

3027

"foreground", "zeroconf"):

2366

3028

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

2367

3029

option)

2368

3030

if server_settings["port"]:

2378

3040

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

2379

3041

["socket"])

2380

3042

del server_config

2381

3043

2382

3044

# Override the settings from the config file with command line

2383

3045

# options, if set.

2384

3046

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

2385

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

2386

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

2387

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

3047

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

3048

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

3049

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

2388

3050

value = getattr(options, option)

2389

3051

if value is not None:

2390

3052

server_settings[option] = value

2391

3053

del options

2392

3054

# Force all strings to be unicode

2393

3055

for option in server_settings.keys():

2394

if type(server_settings[option]) is str:

2395

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

3056

if isinstance(server_settings[option], bytes):

3057

server_settings[option] = (server_settings[option]

3058

.decode("utf-8"))

2396

3059

# Force all boolean options to be boolean

2397

3060

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

2398

"foreground"):

3061

"foreground", "zeroconf"):

2399

3062

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

2400

3063

# Debug implies foreground

2401

3064

if server_settings["debug"]:

2402

3065

server_settings["foreground"] = True

2403

3066

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

2404

3067

2405

3068

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

2406

3069

3070

if (not server_settings["zeroconf"]

3071

and not (server_settings["port"]

3072

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

3073

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

3074

2407

3075

# For convenience

2408

3076

debug = server_settings["debug"]

2409

3077

debuglevel = server_settings["debuglevel"]

2412

3080

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

2413

3081

stored_state_file)

2414

3082

foreground = server_settings["foreground"]

2415

3083

zeroconf = server_settings["zeroconf"]

3084

2416

3085

if debug:

2417

3086

initlogger(debug, logging.DEBUG)

2418

3087

else:

2421

3090

else:

2422

3091

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

2423

3092

initlogger(debug, level)

2424

3093

2425

3094

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

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3095

syslogger.setFormatter(

3096

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

3097

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

3098

server_settings["servicename"])))

3099

2432

3100

# Parse config file with clients

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3101

client_config = configparser.ConfigParser(Client.client_defaults)

2435

3102

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

2436

3103

"clients.conf"))

2437

3104

2438

3105

global mandos_dbus_service

2439

3106

mandos_dbus_service = None

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3107

3108

socketfd = None

3109

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

3110

socketfd = server_settings["socket"]

3111

tcp_server = MandosServer(

3112

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

3113

ClientHandler,

3114

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

3115

use_ipv6=use_ipv6,

3116

gnutls_priority=server_settings["priority"],

3117

use_dbus=use_dbus,

3118

socketfd=socketfd)

2452

3119

if not foreground:

2453

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

3120

pidfilename = "/run/mandos.pid"

3121

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

3122

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

2454

3123

pidfile = None

2455

3124

try:

2456

pidfile = open(pidfilename, "w")

3125

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

2457

3126

except IOError as e:

2458

3127

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

2459

3128

exc_info=e)

2460

2461

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

3129

3130

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

3131

("mandos", "mandos"),

3132

("nobody", "nogroup")):

2462

3133

try:

2463

3134

uid = pwd.getpwnam(name).pw_uid

2464

gid = pwd.getpwnam(name).pw_gid

3135

gid = pwd.getpwnam(group).pw_gid

2465

3136

break

2466

3137

except KeyError:

2467

3138

continue

2471

3142

try:

2472

3143

os.setgid(gid)

2473

3144

os.setuid(uid)

3145

if debug:

3146

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

3147

gid))

2474

3148

except OSError as error:

3149

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

3150

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

2475

3151

if error.errno != errno.EPERM:

2476

raise error

2477

3152

raise

3153

2478

3154

if debug:

2479

3155

# Enable all possible GnuTLS debugging

2480

3156

2481

3157

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

2482

3158

# - GnuTLS manual

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3159

gnutls.global_set_log_level(11)

3160

3161

@gnutls.log_func

2486

3162

def debug_gnutls(level, string):

2487

3163

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

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3164

3165

gnutls.global_set_log_function(debug_gnutls)

3166

2492

3167

# Redirect stdin so all checkers get /dev/null

2493

3168

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

2494

3169

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

2495

3170

if null > 2:

2496

3171

os.close(null)

2497

3172

2498

3173

# Need to fork before connecting to D-Bus

2499

3174

if not foreground:

2500

3175

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

2501

3176

daemon()

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3177

3178

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

3179

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

3180

# need to inform GLib that threads will be used.

3181

GLib.threads_init()

3182

2507

3183

global main_loop

2508

3184

# From the Avahi example code

2509

3185

DBusGMainLoop(set_as_default=True)

2510

main_loop = gobject.MainLoop()

3186

main_loop = GLib.MainLoop()

2511

3187

bus = dbus.SystemBus()

2512

3188

# End of Avahi example code

2513

3189

if use_dbus:

2514

3190

try:

2515

3191

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

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3192

bus,

3193

do_not_queue=True)

3194

old_bus_name = dbus.service.BusName(

3195

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

3196

do_not_queue=True)

3197

except dbus.exceptions.DBusException as e:

2521

3198

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

2522

3199

use_dbus = False

2523

3200

server_settings["use_dbus"] = False

2524

3201

tcp_server.use_dbus = False

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3202

if zeroconf:

3203

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3204

service = AvahiServiceToSyslog(

3205

name=server_settings["servicename"],

3206

servicetype="_mandos._tcp",

3207

protocol=protocol,

3208

bus=bus)

3209

if server_settings["interface"]:

3210

service.interface = if_nametoindex(

3211

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

3212

2534

3213

global multiprocessing_manager

2535

3214

multiprocessing_manager = multiprocessing.Manager()

2536

3215

2537

3216

client_class = Client

2538

3217

if use_dbus:

2539

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

2540

3218

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

3219

2541

3220

client_settings = Client.config_parser(client_config)

2542

3221

old_client_settings = {}

2543

3222

clients_data = {}

2544

3223

2545

3224

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

2546

3225

global wnull

2547

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

3226

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

2548

3227

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

2549

3228

# mode

2550

3229

if debug or not foreground:

2551

3230

wnull.close()

2552

3231

2553

3232

# Get client data and settings from last running state.

2554

3233

if server_settings["restore"]:

2555

3234

try:

2556

3235

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

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3236

if sys.version_info.major == 2:

3237

clients_data, old_client_settings = pickle.load(

3238

stored_state)

3239

else:

3240

bytes_clients_data, bytes_old_client_settings = (

3241

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

3242

# Fix bytes to strings

3243

# clients_data

3244

# .keys()

3245

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

3246

if isinstance(key, bytes)

3247

else key): value

3248

for key, value in

3249

bytes_clients_data.items()}

3250

del bytes_clients_data

3251

for key in clients_data:

3252

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

3253

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

3254

for k, v in

3255

clients_data[key].items()}

3256

clients_data[key] = value

3257

# .client_structure

3258

value["client_structure"] = [

3259

(s.decode("utf-8")

3260

if isinstance(s, bytes)

3261

else s) for s in

3262

value["client_structure"]]

3263

# .name, .host, and .checker_command

3264

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

3265

if isinstance(value[k], bytes):

3266

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

3267

if "key_id" not in value:

3268

value["key_id"] = ""

3269

elif "fingerprint" not in value:

3270

value["fingerprint"] = ""

3271

# old_client_settings

3272

# .keys()

3273

old_client_settings = {

3274

(key.decode("utf-8")

3275

if isinstance(key, bytes)

3276

else key): value

3277

for key, value in

3278

bytes_old_client_settings.items()}

3279

del bytes_old_client_settings

3280

# .host and .checker_command

3281

for value in old_client_settings.values():

3282

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

3283

if isinstance(value[attribute], bytes):

3284

value[attribute] = (value[attribute]

3285

.decode("utf-8"))

2559

3286

os.remove(stored_state_path)

2560

3287

except IOError as e:

2561

3288

if e.errno == errno.ENOENT:

2562

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

2563

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

3289

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

3290

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

2564

3291

else:

2565

3292

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

2566

3293

exc_info=e)

2567

3294

raise

2568

3295

except EOFError as e:

2569

3296

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

2570

"EOFError:", exc_info=e)

2571

3297

"EOFError:",

3298

exc_info=e)

3299

2572

3300

with PGPEngine() as pgp:

2573

for client_name, client in clients_data.iteritems():

3301

for client_name, client in clients_data.items():

2574

3302

# Skip removed clients

2575

3303

if client_name not in client_settings:

2576

3304

continue

2577

3305

2578

3306

# Decide which value to use after restoring saved state.

2579

3307

# We have three different values: Old config file,

2580

3308

# new config file, and saved state.

2585

3313

# For each value in new config, check if it

2586

3314

# differs from the old config value (Except for

2587

3315

# the "secret" attribute)

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3316

if (name != "secret"

3317

and (value !=

3318

old_client_settings[client_name][name])):

2591

3319

client[name] = value

2592

3320

except KeyError:

2593

3321

pass

2594

3322

2595

3323

# Clients who has passed its expire date can still be

2596

# enabled if its last checker was successful. Clients

3324

# enabled if its last checker was successful. A Client

2597

3325

# whose checker succeeded before we stored its state is

2598

3326

# assumed to have successfully run all checkers during

2599

3327

# downtime.

2601

3329

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

2602

3330

if not client["last_checked_ok"]:

2603

3331

logger.warning(

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3332

"disabling client {} - Client never "

3333

"performed a successful checker".format(

3334

client_name))

2607

3335

client["enabled"] = False

2608

3336

elif client["last_checker_status"] != 0:

2609

3337

logger.warning(

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3338

"disabling client {} - Client last"

3339

" checker failed with error code"

3340

" {}".format(

3341

client_name,

3342

client["last_checker_status"]))

2614

3343

client["enabled"] = False

2615

3344

else:

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3345

client["expires"] = (

3346

datetime.datetime.utcnow()

3347

+ client["timeout"])

2619

3348

logger.debug("Last checker succeeded,"

2620

" keeping {0} enabled"

2621

.format(client_name))

3349

" keeping {} enabled".format(

3350

client_name))

2622

3351

try:

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3352

client["secret"] = pgp.decrypt(

3353

client["encrypted_secret"],

3354

client_settings[client_name]["secret"])

2627

3355

except PGPError:

2628

3356

# If decryption fails, we use secret from new settings

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3357

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

3358

client_name))

3359

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

3360

["secret"])

3361

2634

3362

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

2635

3363

for client_name in (set(old_client_settings)

2636

3364

- set(client_settings)):

2638

3366

for client_name in (set(client_settings)

2639

3367

- set(old_client_settings)):

2640

3368

clients_data[client_name] = client_settings[client_name]

2641

3369

2642

3370

# Create all client objects

2643

for client_name, client in clients_data.iteritems():

3371

for client_name, client in clients_data.items():

2644

3372

tcp_server.clients[client_name] = client_class(

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3373

name=client_name,

3374

settings=client,

3375

server_settings=server_settings)

3376

2648

3377

if not tcp_server.clients:

2649

3378

logger.warning("No clients defined")

2650

3379

2651

3380

if not foreground:

2652

3381

if pidfile is not None:

3382

pid = os.getpid()

2653

3383

try:

2654

3384

with pidfile:

2655

pid = os.getpid()

2656

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

3385

print(pid, file=pidfile)

2657

3386

except IOError:

2658

3387

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

2659

3388

pidfilename, pid)

2660

3389

del pidfile

2661

3390

del pidfilename

2662

2663

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

2664

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

2665

3391

3392

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

3393

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3394

lambda: main_loop.quit() and False)

3395

2666

3396

if use_dbus:

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3397

3398

@alternate_dbus_interfaces(

3399

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

3400

class MandosDBusService(DBusObjectWithObjectManager):

2670

3401

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

3402

2671

3403

def __init__(self):

2672

3404

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

3405

2673

3406

_interface = "se.recompile.Mandos"

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3407

2681

3408

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

2682

3409

def ClientAdded(self, objpath):

2683

3410

"D-Bus signal"

2684

3411

pass

2685

3412

2686

3413

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

2687

def ClientNotFound(self, fingerprint, address):

3414

def ClientNotFound(self, key_id, address):

2688

3415

"D-Bus signal"

2689

3416

pass

2690

3417

3418

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

3419

"true"})

2691

3420

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

2692

3421

def ClientRemoved(self, objpath, name):

2693

3422

"D-Bus signal"

2694

3423

pass

2695

3424

3425

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

3426

"true"})

2696

3427

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

2697

3428

def GetAllClients(self):

2698

3429

"D-Bus method"

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3430

return dbus.Array(c.dbus_object_path for c in

3431

tcp_server.clients.values())

3432

3433

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

3434

"true"})

2703

3435

@dbus.service.method(_interface,

2704

3436

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

2705

3437

def GetAllClientsWithProperties(self):

2706

3438

"D-Bus method"

2707

3439

return dbus.Dictionary(

2708

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

2709

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

3440

{c.dbus_object_path: c.GetAll(

3441

"se.recompile.Mandos.Client")

3442

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

2710

3443

signature="oa{sv}")

2711

3444

2712

3445

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

2713

3446

def RemoveClient(self, object_path):

2714

3447

"D-Bus method"

2715

for c in tcp_server.clients.itervalues():

3448

for c in tcp_server.clients.values():

2716

3449

if c.dbus_object_path == object_path:

2717

3450

del tcp_server.clients[c.name]

2718

3451

c.remove_from_connection()

2719

# Don't signal anything except ClientRemoved

3452

# Don't signal the disabling

2720

3453

c.disable(quiet=True)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3454

# Emit D-Bus signal for removal

3455

self.client_removed_signal(c)

2723

3456

return

2724

3457

raise KeyError(object_path)

2725

3458

2726

3459

del _interface

2727

3460

3461

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3462

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

3463

def GetManagedObjects(self):

3464

"""D-Bus method"""

3465

return dbus.Dictionary(

3466

{client.dbus_object_path:

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()})

3471

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

3472

3473

def client_added_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesAdded(

3478

client.dbus_object_path,

3479

dbus.Dictionary(

3480

{interface: client.GetAll(interface)

3481

for interface in

3482

client._get_all_interface_names()}))

3483

# Old signal

3484

self.ClientAdded(client.dbus_object_path)

3485

3486

def client_removed_signal(self, client):

3487

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

3488

if use_dbus:

3489

# New standard signal

3490

self.InterfacesRemoved(

3491

client.dbus_object_path,

3492

client._get_all_interface_names())

3493

# Old signal

3494

self.ClientRemoved(client.dbus_object_path,

3495

client.name)

3496

2728

3497

mandos_dbus_service = MandosDBusService()

2729

3498

3499

# Save modules to variables to exempt the modules from being

3500

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

3501

mp = multiprocessing

3502

wn = wnull

3503

2730

3504

def cleanup():

2731

3505

"Cleanup function; run on exit"

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3506

if zeroconf:

3507

service.cleanup()

3508

3509

mp.active_children()

3510

wn.close()

2736

3511

if not (tcp_server.clients or client_settings):

2737

3512

return

2738

3513

2739

3514

# Store client before exiting. Secrets are encrypted with key

2740

3515

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

2741

3516

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

2742

3517

clients = {}

2743

3518

with PGPEngine() as pgp:

2744

for client in tcp_server.clients.itervalues():

3519

for client in tcp_server.clients.values():

2745

3520

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

2746

3521

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

2747

3522

key)

2748

3523

client_dict = {}

2749

3524

2750

3525

# A list of attributes that can not be pickled

2751

3526

# + secret.

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3527

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

3528

"checker", "server_settings"}

3529

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

3530

.Object):

2756

3531

exclude.add(name)

2757

3532

2758

3533

client_dict["encrypted_secret"] = (client

2759

3534

.encrypted_secret)

2760

3535

for attr in client.client_structure:

2761

3536

if attr not in exclude:

2762

3537

client_dict[attr] = getattr(client, attr)

2763

3538

2764

3539

clients[client.name] = client_dict

2765

3540

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

2766

3541

2767

3542

try:

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3543

with tempfile.NamedTemporaryFile(

3544

mode='wb',

3545

suffix=".pickle",

3546

prefix='clients-',

3547

dir=os.path.dirname(stored_state_path),

3548

delete=False) as stored_state:

3549

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

3550

protocol=2)

3551

tempname = stored_state.name

2774

3552

os.rename(tempname, stored_state_path)

2775

3553

except (IOError, OSError) as e:

2776

3554

if not debug:

2779

3557

except NameError:

2780

3558

pass

2781

3559

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

2782

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

3560

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

2783

3561

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

2784

3562

else:

2785

3563

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

2786

3564

exc_info=e)

2787

raise e

2788

3565

raise

3566

2789

3567

# Delete all clients, and settings from config

2790

3568

while tcp_server.clients:

2791

3569

name, client = tcp_server.clients.popitem()

2792

3570

if use_dbus:

2793

3571

client.remove_from_connection()

2794

# Don't signal anything except ClientRemoved

3572

# Don't signal the disabling

2795

3573

client.disable(quiet=True)

3574

# Emit D-Bus signal for removal

2796

3575

if use_dbus:

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3576

mandos_dbus_service.client_removed_signal(client)

2801

3577

client_settings.clear()

2802

3578

2803

3579

atexit.register(cleanup)

2804

2805

for client in tcp_server.clients.itervalues():

3580

3581

for client in tcp_server.clients.values():

2806

3582

if use_dbus:

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3583

# Emit D-Bus signal for adding

3584

mandos_dbus_service.client_added_signal(client)

2809

3585

# Need to initiate checking of clients

2810

3586

if client.enabled:

2811

3587

client.init_checker()

2812

3588

2813

3589

tcp_server.enable()

2814

3590

tcp_server.server_activate()

2815

3591

2816

3592

# Find out what port we got

2817

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

3593

if zeroconf:

3594

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

2818

3595

if use_ipv6:

2819

3596

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

2820

3597

" flowinfo %d, scope_id %d",

2822

3599

else: # IPv4

2823

3600

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

2824

3601

*tcp_server.socket.getsockname())

2825

2826

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

2827

3602

3603

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

3604

2828

3605

try:

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3606

if zeroconf:

3607

# From the Avahi example code

3608

try:

3609

service.activate()

3610

except dbus.exceptions.DBusException as error:

3611

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

3612

cleanup()

3613

sys.exit(1)

3614

# End of Avahi example code

3615

3616

GLib.io_add_watch(

3617

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

3618

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3619

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

3620

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

3621

2843

3622

logger.debug("Starting main loop")

2844

3623

main_loop.run()

2845

3624

except AvahiError as error:

2854

3633

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

2855

3634

cleanup()

2856

3635

3636

3637

def should_only_run_tests():

3638

parser = argparse.ArgumentParser(add_help=False)

3639

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

3640

args, unknown_args = parser.parse_known_args()

3641

run_tests = args.check

3642

if run_tests:

3643

# Remove --check argument from sys.argv

3644

sys.argv[1:] = unknown_args

3645

return run_tests

3646

3647

# Add all tests from doctest strings

3648

def load_tests(loader, tests, none):

3649

import doctest

3650

tests.addTests(doctest.DocTestSuite())

3651

return tests

3652

2857

3653

if __name__ == '__main__':

2858

main()

3654

try:

3655

if should_only_run_tests():

3656

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

3657

unittest.main()

3658

else:

3659

main()

3660

finally:

3661

logging.shutdown()