/mandos/trunk : revision 1201

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

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

# Show warnings by default

98

if not sys.warnoptions:

99

import warnings

100

warnings.simplefilter("default")

101

102

# Try to find the value of SO_BINDTODEVICE:

83

103

try:

104

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

105

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

84

106

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

107

except AttributeError:

86

108

try:

109

# This is where SO_BINDTODEVICE was up to and including Python

110

# 2.6, and also 3.2:

87

111

from IN import SO_BINDTODEVICE

88

112

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.5"

113

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

114

# Try running the C preprocessor:

115

try:

116

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

117

"/dev/stdin"],

118

stdin=subprocess.PIPE,

119

stdout=subprocess.PIPE)

120

stdout = cc.communicate(

121

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

122

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

123

except (OSError, ValueError, IndexError):

124

# No value found

125

SO_BINDTODEVICE = None

126

127

if sys.version_info < (3, 2):

128

configparser.Configparser = configparser.SafeConfigParser

129

130

version = "1.8.9"

92

131

stored_state_file = "clients.pickle"

93

132

94

133

logger = logging.getLogger()

134

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

95

135

syslogger = None

96

136

97

137

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

138

if_nametoindex = ctypes.cdll.LoadLibrary(

139

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

101

140

except (OSError, AttributeError):

141

102

142

def if_nametoindex(interface):

103

143

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

104

144

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

105

145

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

106

146

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

147

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

148

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

111

149

return interface_index

112

150

113

151

152

def copy_function(func):

153

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

154

if sys.version_info.major == 2:

155

return types.FunctionType(func.func_code,

156

func.func_globals,

157

func.func_name,

158

func.func_defaults,

159

func.func_closure)

160

else:

161

return types.FunctionType(func.__code__,

162

func.__globals__,

163

func.__name__,

164

func.__defaults__,

165

func.__closure__)

166

167

114

168

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

115

169

"""init logger and add loglevel"""

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

170

171

global syslogger

172

syslogger = (logging.handlers.SysLogHandler(

173

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

174

address="/dev/log"))

121

175

syslogger.setFormatter(logging.Formatter

122

176

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

123

177

' %(message)s'))

124

178

logger.addHandler(syslogger)

125

179

126

180

if debug:

127

181

console = logging.StreamHandler()

128

182

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

138

192

pass

139

193

140

194

141

class PGPEngine(object):

195

class PGPEngine:

142

196

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

197

143

198

def __init__(self):

144

199

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

200

self.gpg = "gpg"

201

try:

202

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

203

for line in output.splitlines():

204

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

205

if name == b"gpg":

206

self.gpg = path

207

break

208

except OSError as e:

209

if e.errno != errno.ENOENT:

210

raise

145

211

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

212

'--homedir', self.tempdir,

147

213

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

214

'--quiet']

215

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

216

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

217

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

218

151

219

def __enter__(self):

152

220

return self

153

221

154

222

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

155

223

self._cleanup()

156

224

return False

157

225

158

226

def __del__(self):

159

227

self._cleanup()

160

228

161

229

def _cleanup(self):

162

230

if self.tempdir is not None:

163

231

# Delete contents of tempdir

164

232

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

165

topdown = False):

233

topdown=False):

166

234

for filename in files:

167

235

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

168

236

for dirname in dirs:

170

238

# Remove tempdir

171

239

os.rmdir(self.tempdir)

172

240

self.tempdir = None

173

241

174

242

def password_encode(self, password):

175

243

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

176

244

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

181

249

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

182

250

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

183

251

return encoded

184

252

185

253

def encrypt(self, data, password):

186

254

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

255

with tempfile.NamedTemporaryFile(

256

dir=self.tempdir) as passfile:

189

257

passfile.write(passphrase)

190

258

passfile.flush()

191

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

259

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

192

260

'--passphrase-file',

193

261

passfile.name]

194

262

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

263

stdin=subprocess.PIPE,

264

stdout=subprocess.PIPE,

265

stderr=subprocess.PIPE)

266

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

199

267

if proc.returncode != 0:

200

268

raise PGPError(err)

201

269

return ciphertext

202

270

203

271

def decrypt(self, data, password):

204

272

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

273

with tempfile.NamedTemporaryFile(

274

dir=self.tempdir) as passfile:

207

275

passfile.write(passphrase)

208

276

passfile.flush()

209

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

277

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

210

278

'--passphrase-file',

211

279

passfile.name]

212

280

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

281

stdin=subprocess.PIPE,

282

stdout=subprocess.PIPE,

283

stderr=subprocess.PIPE)

284

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

218

285

if proc.returncode != 0:

219

286

raise PGPError(err)

220

287

return decrypted_plaintext

221

288

222

289

290

# Pretend that we have an Avahi module

291

class avahi:

292

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

293

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

294

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

295

PROTO_INET = 0 # avahi-common/address.h

296

PROTO_INET6 = 1 # avahi-common/address.h

297

DBUS_NAME = "org.freedesktop.Avahi"

298

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

299

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

300

DBUS_PATH_SERVER = "/"

301

302

@staticmethod

303

def string_array_to_txt_array(t):

304

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

305

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

306

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

307

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

308

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

309

SERVER_INVALID = 0 # avahi-common/defs.h

310

SERVER_REGISTERING = 1 # avahi-common/defs.h

311

SERVER_RUNNING = 2 # avahi-common/defs.h

312

SERVER_COLLISION = 3 # avahi-common/defs.h

313

SERVER_FAILURE = 4 # avahi-common/defs.h

314

315

223

316

class AvahiError(Exception):

224

317

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

225

318

self.value = value

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

319

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

320

**kwargs)

321

229

322

230

323

class AvahiServiceError(AvahiError):

231

324

pass

232

325

326

233

327

class AvahiGroupError(AvahiError):

234

328

pass

235

329

236

330

237

class AvahiService(object):

331

class AvahiService:

238

332

"""An Avahi (Zeroconf) service.

239

333

240

334

Attributes:

241

335

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

242

336

Used to optionally bind to the specified interface.

254

348

server: D-Bus Server

255

349

bus: dbus.SystemBus()

256

350

"""

257

258

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

259

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

260

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

261

protocol = avahi.PROTO_UNSPEC, bus = None):

351

352

def __init__(self,

353

interface=avahi.IF_UNSPEC,

354

name=None,

355

servicetype=None,

356

port=None,

357

TXT=None,

358

domain="",

359

host="",

360

max_renames=32768,

361

protocol=avahi.PROTO_UNSPEC,

362

bus=None):

262

363

self.interface = interface

263

364

self.name = name

264

365

self.type = servicetype

273

374

self.server = None

274

375

self.bus = bus

275

376

self.entry_group_state_changed_match = None

276

277

def rename(self):

377

378

def rename(self, remove=True):

278

379

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

279

380

if self.rename_count >= self.max_renames:

280

381

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

281

382

" after %i retries, exiting.",

282

383

self.rename_count)

283

384

raise AvahiServiceError("Too many renames")

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

385

self.name = str(

386

self.server.GetAlternativeServiceName(self.name))

387

self.rename_count += 1

286

388

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

287

389

self.name)

288

self.remove()

390

if remove:

391

self.remove()

289

392

try:

290

393

self.add()

291

394

except dbus.exceptions.DBusException as error:

292

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

293

self.cleanup()

294

os._exit(1)

295

self.rename_count += 1

296

395

if (error.get_dbus_name()

396

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

397

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

398

return self.rename(remove=False)

399

else:

400

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

401

self.cleanup()

402

os._exit(1)

403

297

404

def remove(self):

298

405

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

299

406

if self.entry_group_state_changed_match is not None:

301

408

self.entry_group_state_changed_match = None

302

409

if self.group is not None:

303

410

self.group.Reset()

304

411

305

412

def add(self):

306

413

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

307

414

self.remove()

324

431

dbus.UInt16(self.port),

325

432

avahi.string_array_to_txt_array(self.TXT))

326

433

self.group.Commit()

327

434

328

435

def entry_group_state_changed(self, state, error):

329

436

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

330

437

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

331

438

332

439

if state == avahi.ENTRY_GROUP_ESTABLISHED:

333

440

logger.debug("Zeroconf service established.")

334

441

elif state == avahi.ENTRY_GROUP_COLLISION:

336

443

self.rename()

337

444

elif state == avahi.ENTRY_GROUP_FAILURE:

338

445

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

339

unicode(error))

340

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

341

.format(error))

342

446

str(error))

447

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

448

343

449

def cleanup(self):

344

450

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

345

451

if self.group is not None:

350

456

pass

351

457

self.group = None

352

458

self.remove()

353

459

354

460

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

355

461

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

356

462

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

357

bad_states = { avahi.SERVER_INVALID:

358

"Zeroconf server invalid",

359

avahi.SERVER_REGISTERING: None,

360

avahi.SERVER_COLLISION:

361

"Zeroconf server name collision",

362

avahi.SERVER_FAILURE:

363

"Zeroconf server failure" }

463

bad_states = {

464

avahi.SERVER_INVALID: "Zeroconf server invalid",

465

avahi.SERVER_REGISTERING: None,

466

avahi.SERVER_COLLISION: "Zeroconf server name collision",

467

avahi.SERVER_FAILURE: "Zeroconf server failure",

468

}

364

469

if state in bad_states:

365

470

if bad_states[state] is not None:

366

471

if error is None:

369

474

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

370

475

self.cleanup()

371

476

elif state == avahi.SERVER_RUNNING:

372

self.add()

477

try:

478

self.add()

479

except dbus.exceptions.DBusException as error:

480

if (error.get_dbus_name()

481

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

482

logger.info("Local Zeroconf service name"

483

" collision.")

484

return self.rename(remove=False)

485

else:

486

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

487

self.cleanup()

488

os._exit(1)

373

489

else:

374

490

if error is None:

375

491

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

376

492

else:

377

493

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

378

494

379

495

def activate(self):

380

496

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

381

497

if self.server is None:

385

501

follow_name_owner_changes=True),

386

502

avahi.DBUS_INTERFACE_SERVER)

387

503

self.server.connect_to_signal("StateChanged",

388

self.server_state_changed)

504

self.server_state_changed)

389

505

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

390

506

391

507

392

508

class AvahiServiceToSyslog(AvahiService):

393

def rename(self):

509

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

394

510

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

395

ret = AvahiService.rename(self)

396

syslogger.setFormatter(logging.Formatter

397

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

398

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

399

.format(self.name)))

511

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

512

syslogger.setFormatter(logging.Formatter(

513

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

514

.format(self.name)))

400

515

return ret

401

516

402

517

403

def timedelta_to_milliseconds(td):

404

"Convert a datetime.timedelta() to milliseconds"

405

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

406

+ (td.seconds * 1000)

407

+ (td.microseconds // 1000))

408

409

410

class Client(object):

518

# Pretend that we have a GnuTLS module

519

class gnutls:

520

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

521

522

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

523

if library is None:

524

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

525

_library = ctypes.cdll.LoadLibrary(library)

526

del library

527

528

# Unless otherwise indicated, the constants and types below are

529

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

530

531

# Constants

532

E_SUCCESS = 0

533

E_INTERRUPTED = -52

534

E_AGAIN = -28

535

CRT_OPENPGP = 2

536

CRT_RAWPK = 3

537

CLIENT = 2

538

SHUT_RDWR = 0

539

CRD_CERTIFICATE = 1

540

E_NO_CERTIFICATE_FOUND = -49

541

X509_FMT_DER = 0

542

NO_TICKETS = 1<<10

543

ENABLE_RAWPK = 1<<18

544

CTYPE_PEERS = 3

545

KEYID_USE_SHA256 = 1 # gnutls/x509.h

546

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

547

548

# Types

549

class session_int(ctypes.Structure):

550

_fields_ = []

551

session_t = ctypes.POINTER(session_int)

552

553

class certificate_credentials_st(ctypes.Structure):

554

_fields_ = []

555

certificate_credentials_t = ctypes.POINTER(

556

certificate_credentials_st)

557

certificate_type_t = ctypes.c_int

558

559

class datum_t(ctypes.Structure):

560

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

561

('size', ctypes.c_uint)]

562

563

class openpgp_crt_int(ctypes.Structure):

564

_fields_ = []

565

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

566

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

567

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

568

credentials_type_t = ctypes.c_int

569

transport_ptr_t = ctypes.c_void_p

570

close_request_t = ctypes.c_int

571

572

# Exceptions

573

class Error(Exception):

574

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

575

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

576

# code is passed, convert it to a string with

577

# gnutls.strerror()

578

self.code = code

579

if message is None and code is not None:

580

message = gnutls.strerror(code)

581

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

582

message, *args)

583

584

class CertificateSecurityError(Error):

585

pass

586

587

# Classes

588

class Credentials:

589

def __init__(self):

590

self._c_object = gnutls.certificate_credentials_t()

591

gnutls.certificate_allocate_credentials(

592

ctypes.byref(self._c_object))

593

self.type = gnutls.CRD_CERTIFICATE

594

595

def __del__(self):

596

gnutls.certificate_free_credentials(self._c_object)

597

598

class ClientSession:

599

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

600

self._c_object = gnutls.session_t()

601

gnutls_flags = gnutls.CLIENT

602

if gnutls.check_version(b"3.5.6"):

603

gnutls_flags |= gnutls.NO_TICKETS

604

if gnutls.has_rawpk:

605

gnutls_flags |= gnutls.ENABLE_RAWPK

606

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

607

del gnutls_flags

608

gnutls.set_default_priority(self._c_object)

609

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

610

gnutls.handshake_set_private_extensions(self._c_object,

611

True)

612

self.socket = socket

613

if credentials is None:

614

credentials = gnutls.Credentials()

615

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

616

ctypes.cast(credentials._c_object,

617

ctypes.c_void_p))

618

self.credentials = credentials

619

620

def __del__(self):

621

gnutls.deinit(self._c_object)

622

623

def handshake(self):

624

return gnutls.handshake(self._c_object)

625

626

def send(self, data):

627

data = bytes(data)

628

data_len = len(data)

629

while data_len > 0:

630

data_len -= gnutls.record_send(self._c_object,

631

data[-data_len:],

632

data_len)

633

634

def bye(self):

635

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

636

637

# Error handling functions

638

def _error_code(result):

639

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

640

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

641

if result >= 0:

642

return result

643

if result == gnutls.E_NO_CERTIFICATE_FOUND:

644

raise gnutls.CertificateSecurityError(code=result)

645

raise gnutls.Error(code=result)

646

647

def _retry_on_error(result, func, arguments):

648

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

649

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

650

while result < 0:

651

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

652

return _error_code(result)

653

result = func(*arguments)

654

return result

655

656

# Unless otherwise indicated, the function declarations below are

657

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

658

659

# Functions

660

priority_set_direct = _library.gnutls_priority_set_direct

661

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

662

ctypes.POINTER(ctypes.c_char_p)]

663

priority_set_direct.restype = _error_code

664

665

init = _library.gnutls_init

666

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

667

init.restype = _error_code

668

669

set_default_priority = _library.gnutls_set_default_priority

670

set_default_priority.argtypes = [session_t]

671

set_default_priority.restype = _error_code

672

673

record_send = _library.gnutls_record_send

674

record_send.argtypes = [session_t, ctypes.c_void_p,

675

ctypes.c_size_t]

676

record_send.restype = ctypes.c_ssize_t

677

record_send.errcheck = _retry_on_error

678

679

certificate_allocate_credentials = (

680

_library.gnutls_certificate_allocate_credentials)

681

certificate_allocate_credentials.argtypes = [

682

ctypes.POINTER(certificate_credentials_t)]

683

certificate_allocate_credentials.restype = _error_code

684

685

certificate_free_credentials = (

686

_library.gnutls_certificate_free_credentials)

687

certificate_free_credentials.argtypes = [

688

certificate_credentials_t]

689

certificate_free_credentials.restype = None

690

691

handshake_set_private_extensions = (

692

_library.gnutls_handshake_set_private_extensions)

693

handshake_set_private_extensions.argtypes = [session_t,

694

ctypes.c_int]

695

handshake_set_private_extensions.restype = None

696

697

credentials_set = _library.gnutls_credentials_set

698

credentials_set.argtypes = [session_t, credentials_type_t,

699

ctypes.c_void_p]

700

credentials_set.restype = _error_code

701

702

strerror = _library.gnutls_strerror

703

strerror.argtypes = [ctypes.c_int]

704

strerror.restype = ctypes.c_char_p

705

706

certificate_type_get = _library.gnutls_certificate_type_get

707

certificate_type_get.argtypes = [session_t]

708

certificate_type_get.restype = _error_code

709

710

certificate_get_peers = _library.gnutls_certificate_get_peers

711

certificate_get_peers.argtypes = [session_t,

712

ctypes.POINTER(ctypes.c_uint)]

713

certificate_get_peers.restype = ctypes.POINTER(datum_t)

714

715

global_set_log_level = _library.gnutls_global_set_log_level

716

global_set_log_level.argtypes = [ctypes.c_int]

717

global_set_log_level.restype = None

718

719

global_set_log_function = _library.gnutls_global_set_log_function

720

global_set_log_function.argtypes = [log_func]

721

global_set_log_function.restype = None

722

723

deinit = _library.gnutls_deinit

724

deinit.argtypes = [session_t]

725

deinit.restype = None

726

727

handshake = _library.gnutls_handshake

728

handshake.argtypes = [session_t]

729

handshake.restype = _error_code

730

handshake.errcheck = _retry_on_error

731

732

transport_set_ptr = _library.gnutls_transport_set_ptr

733

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

734

transport_set_ptr.restype = None

735

736

bye = _library.gnutls_bye

737

bye.argtypes = [session_t, close_request_t]

738

bye.restype = _error_code

739

bye.errcheck = _retry_on_error

740

741

check_version = _library.gnutls_check_version

742

check_version.argtypes = [ctypes.c_char_p]

743

check_version.restype = ctypes.c_char_p

744

745

_need_version = b"3.3.0"

746

if check_version(_need_version) is None:

747

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

748

.format(_need_version))

749

750

_tls_rawpk_version = b"3.6.6"

751

has_rawpk = bool(check_version(_tls_rawpk_version))

752

753

if has_rawpk:

754

# Types

755

class pubkey_st(ctypes.Structure):

756

_fields = []

757

pubkey_t = ctypes.POINTER(pubkey_st)

758

759

x509_crt_fmt_t = ctypes.c_int

760

761

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

762

pubkey_init = _library.gnutls_pubkey_init

763

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

764

pubkey_init.restype = _error_code

765

766

pubkey_import = _library.gnutls_pubkey_import

767

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

768

x509_crt_fmt_t]

769

pubkey_import.restype = _error_code

770

771

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

772

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

773

ctypes.POINTER(ctypes.c_ubyte),

774

ctypes.POINTER(ctypes.c_size_t)]

775

pubkey_get_key_id.restype = _error_code

776

777

pubkey_deinit = _library.gnutls_pubkey_deinit

778

pubkey_deinit.argtypes = [pubkey_t]

779

pubkey_deinit.restype = None

780

else:

781

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

782

783

openpgp_crt_init = _library.gnutls_openpgp_crt_init

784

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

785

openpgp_crt_init.restype = _error_code

786

787

openpgp_crt_import = _library.gnutls_openpgp_crt_import

788

openpgp_crt_import.argtypes = [openpgp_crt_t,

789

ctypes.POINTER(datum_t),

790

openpgp_crt_fmt_t]

791

openpgp_crt_import.restype = _error_code

792

793

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

794

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

795

ctypes.POINTER(ctypes.c_uint)]

796

openpgp_crt_verify_self.restype = _error_code

797

798

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

799

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

800

openpgp_crt_deinit.restype = None

801

802

openpgp_crt_get_fingerprint = (

803

_library.gnutls_openpgp_crt_get_fingerprint)

804

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

805

ctypes.c_void_p,

806

ctypes.POINTER(

807

ctypes.c_size_t)]

808

openpgp_crt_get_fingerprint.restype = _error_code

809

810

if check_version(b"3.6.4"):

811

certificate_type_get2 = _library.gnutls_certificate_type_get2

812

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

813

certificate_type_get2.restype = _error_code

814

815

# Remove non-public functions

816

del _error_code, _retry_on_error

817

818

819

def call_pipe(connection, # : multiprocessing.Connection

820

func, *args, **kwargs):

821

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

822

823

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

824

return value on the provided multiprocessing.Connection.

825

"""

826

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

827

connection.close()

828

829

830

class Client:

411

831

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

412

832

413

833

Attributes:

414

834

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

415

835

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

416

836

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

417

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

418

to see if the client lives.

419

'None' if no process is running.

420

checker_callback_tag: a gobject event source tag, or None

837

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

838

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

839

running.

840

checker_callback_tag: a GLib event source tag, or None

421

841

checker_command: string; External command which is run to check

422

842

if client lives. %() expansions are done at

423

843

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

424

844

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

425

checker_initiator_tag: a gobject event source tag, or None

845

checker_initiator_tag: a GLib event source tag, or None

426

846

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

427

847

client_structure: Object describing what attributes a client has

428

848

and is used for storing the client at exit

429

849

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

850

disable_initiator_tag: a GLib event source tag, or None

431

851

enabled: bool()

432

852

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

433

uniquely identify the client

853

uniquely identify an OpenPGP client

854

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

855

a client using raw public keys

434

856

host: string; available for use by the checker command

435

857

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

436

858

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

438

860

last_checker_status: integer between 0 and 255 reflecting exit

439

861

status of last checker. -1 reflects crashed

440

862

checker, -2 means no checker completed yet.

863

last_checker_signal: The signal which killed the last checker, if

864

last_checker_status is -1

441

865

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

442

866

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

443

867

D-Bus identifiers

450

874

disabled, or None

451

875

server_settings: The server_settings dict from main()

452

876

"""

453

877

454

878

runtime_expansions = ("approval_delay", "approval_duration",

455

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

879

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

456

880

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

457

881

"last_approval_request", "last_checked_ok",

458

882

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

459

client_defaults = { "timeout": "PT5M",

460

"extended_timeout": "PT15M",

461

"interval": "PT2M",

462

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

463

"host": "",

464

"approval_delay": "PT0S",

465

"approval_duration": "PT1S",

466

"approved_by_default": "True",

467

"enabled": "True",

468

}

469

470

def timeout_milliseconds(self):

471

"Return the 'timeout' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.timeout)

473

474

def extended_timeout_milliseconds(self):

475

"Return the 'extended_timeout' attribute in milliseconds"

476

return timedelta_to_milliseconds(self.extended_timeout)

477

478

def interval_milliseconds(self):

479

"Return the 'interval' attribute in milliseconds"

480

return timedelta_to_milliseconds(self.interval)

481

482

def approval_delay_milliseconds(self):

483

return timedelta_to_milliseconds(self.approval_delay)

484

883

client_defaults = {

884

"timeout": "PT5M",

885

"extended_timeout": "PT15M",

886

"interval": "PT2M",

887

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

888

"host": "",

889

"approval_delay": "PT0S",

890

"approval_duration": "PT1S",

891

"approved_by_default": "True",

892

"enabled": "True",

893

}

894

485

895

@staticmethod

486

896

def config_parser(config):

487

897

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

494

904

for client_name in config.sections():

495

905

section = dict(config.items(client_name))

496

906

client = settings[client_name] = {}

497

907

498

908

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

499

909

# Reformat values from string types to Python types

500

910

client["approved_by_default"] = config.getboolean(

501

911

client_name, "approved_by_default")

502

912

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

503

913

"enabled")

504

914

915

# Uppercase and remove spaces from key_id and fingerprint

916

# for later comparison purposes with return value from the

917

# key_id() and fingerprint() functions

918

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

919

.replace(" ", ""))

505

920

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

506

921

.replace(" ", ""))

507

922

if "secret" in section:

508

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

923

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

924

.encode("utf-8"),

925

"base64")

509

926

elif "secfile" in section:

510

927

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

511

928

(section["secfile"])),

512

929

"rb") as secfile:

513

930

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

514

931

else:

515

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

932

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

516

933

.format(section))

517

934

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

518

935

client["extended_timeout"] = string_to_delta(

526

943

client["last_approval_request"] = None

527

944

client["last_checked_ok"] = None

528

945

client["last_checker_status"] = -2

529

946

530

947

return settings

531

532

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

948

949

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

533

950

self.name = name

534

951

if server_settings is None:

535

952

server_settings = {}

536

953

self.server_settings = server_settings

537

954

# adding all client settings

538

for setting, value in settings.iteritems():

955

for setting, value in settings.items():

539

956

setattr(self, setting, value)

540

957

541

958

if self.enabled:

542

959

if not hasattr(self, "last_enabled"):

543

960

self.last_enabled = datetime.datetime.utcnow()

547

964

else:

548

965

self.last_enabled = None

549

966

self.expires = None

550

967

551

968

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

552

# Uppercase and remove spaces from fingerprint for later

553

# comparison purposes with return value from the fingerprint()

554

# function

969

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

555

970

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

556

971

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

557

972

datetime.datetime.utcnow())

558

973

559

974

# attributes specific for this server instance

560

975

self.checker = None

561

976

self.checker_initiator_tag = None

564

979

self.current_checker_command = None

565

980

self.approved = None

566

981

self.approvals_pending = 0

567

self.changedstate = (multiprocessing_manager

568

.Condition(multiprocessing_manager

569

.Lock()))

570

self.client_structure = [attr for attr in

571

self.__dict__.iterkeys()

982

self.changedstate = multiprocessing_manager.Condition(

983

multiprocessing_manager.Lock())

984

self.client_structure = [attr

985

for attr in self.__dict__.keys()

572

986

if not attr.startswith("_")]

573

987

self.client_structure.append("client_structure")

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

988

989

for name, t in inspect.getmembers(

990

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

579

991

if not name.startswith("_"):

580

992

self.client_structure.append(name)

581

993

582

994

# Send notice to process children that client state has changed

583

995

def send_changedstate(self):

584

996

with self.changedstate:

585

997

self.changedstate.notify_all()

586

998

587

999

def enable(self):

588

1000

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

589

1001

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

594

1006

self.last_enabled = datetime.datetime.utcnow()

595

1007

self.init_checker()

596

1008

self.send_changedstate()

597

1009

598

1010

def disable(self, quiet=True):

599

1011

"""Disable this client."""

600

1012

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

602

1014

if not quiet:

603

1015

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

604

1016

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

605

gobject.source_remove(self.disable_initiator_tag)

1017

GLib.source_remove(self.disable_initiator_tag)

606

1018

self.disable_initiator_tag = None

607

1019

self.expires = None

608

1020

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

609

gobject.source_remove(self.checker_initiator_tag)

1021

GLib.source_remove(self.checker_initiator_tag)

610

1022

self.checker_initiator_tag = None

611

1023

self.stop_checker()

612

1024

self.enabled = False

613

1025

if not quiet:

614

1026

self.send_changedstate()

615

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

1027

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

616

1028

return False

617

1029

618

1030

def __del__(self):

619

1031

self.disable()

620

1032

621

1033

def init_checker(self):

622

1034

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

623

1035

# and every interval from then on.

624

1036

if self.checker_initiator_tag is not None:

625

gobject.source_remove(self.checker_initiator_tag)

626

self.checker_initiator_tag = (gobject.timeout_add

627

(self.interval_milliseconds(),

628

self.start_checker))

1037

GLib.source_remove(self.checker_initiator_tag)

1038

self.checker_initiator_tag = GLib.timeout_add(

1039

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

1040

+ 1)),

1041

self.start_checker)

629

1042

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

630

1043

if self.disable_initiator_tag is not None:

631

gobject.source_remove(self.disable_initiator_tag)

632

self.disable_initiator_tag = (gobject.timeout_add

633

(self.timeout_milliseconds(),

634

self.disable))

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

635

1047

# Also start a new checker *right now*.

636

1048

self.start_checker()

637

638

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

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

639

1052

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

640

1058

self.checker_callback_tag = None

641

1059

self.checker = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

644

1064

if self.last_checker_status == 0:

645

1065

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

646

1066

vars(self))

647

1067

self.checked_ok()

648

1068

else:

649

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

650

vars(self))

1069

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

651

1070

else:

652

1071

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

653

1073

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

654

1074

vars(self))

655

1075

return False

1076

656

1077

def checked_ok(self):

657

1078

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

658

1079

self.last_checked_ok = datetime.datetime.utcnow()

659

1080

self.last_checker_status = 0

1081

self.last_checker_signal = None

660

1082

self.bump_timeout()

661

1083

662

1084

def bump_timeout(self, timeout=None):

663

1085

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

664

1086

if timeout is None:

665

1087

timeout = self.timeout

666

1088

if self.disable_initiator_tag is not None:

667

gobject.source_remove(self.disable_initiator_tag)

1089

GLib.source_remove(self.disable_initiator_tag)

668

1090

self.disable_initiator_tag = None

669

1091

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

673

1094

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

674

1095

675

1096

def need_approval(self):

676

1097

self.last_approval_request = datetime.datetime.utcnow()

677

1098

678

1099

def start_checker(self):

679

1100

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

680

1101

681

1102

If a checker already exists, leave it running and do

682

1103

nothing."""

683

1104

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

688

1109

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

689

1110

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

690

1111

# should be.

691

692

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

693

try:

694

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

695

except AttributeError:

696

pass

697

except OSError as error:

698

if error.errno != errno.ECHILD:

699

raise

700

else:

701

if pid:

702

logger.warning("Checker was a zombie")

703

gobject.source_remove(self.checker_callback_tag)

704

self.checker_callback(pid, status,

705

self.current_checker_command)

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

706

1117

# Start a new checker if needed

707

1118

if self.checker is None:

708

1119

# Escape attributes for the shell

709

escaped_attrs = dict(

710

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

711

for attr in

712

self.runtime_expansions)

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

713

1123

try:

714

1124

command = self.checker_command % escaped_attrs

715

1125

except TypeError as error:

716

1126

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1127

self.checker_command,

1128

exc_info=error)

1129

return True # Try again later

719

1130

self.current_checker_command = command

720

try:

721

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

722

command, self.name)

723

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

724

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

725

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

726

# always replaced by /dev/null.)

727

# The exception is when not debugging but nevertheless

728

# running in the foreground; use the previously

729

# created wnull.

730

popen_args = {}

731

if (not self.server_settings["debug"]

732

and self.server_settings["foreground"]):

733

popen_args.update({"stdout": wnull,

734

"stderr": wnull })

735

self.checker = subprocess.Popen(command,

736

close_fds=True,

737

shell=True, cwd="/",

738

**popen_args)

739

except OSError as error:

740

logger.error("Failed to start subprocess",

741

exc_info=error)

742

return True

743

self.checker_callback_tag = (gobject.child_watch_add

744

(self.checker.pid,

745

self.checker_callback,

746

data=command))

747

# The checker may have completed before the gobject

748

# watch was added. Check for this.

749

try:

750

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

751

except OSError as error:

752

if error.errno == errno.ECHILD:

753

# This should never happen

754

logger.error("Child process vanished",

755

exc_info=error)

756

return True

757

raise

758

if pid:

759

gobject.source_remove(self.checker_callback_tag)

760

self.checker_callback(pid, status, command)

761

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

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

762

1158

return True

763

1159

764

1160

def stop_checker(self):

765

1161

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

766

1162

if self.checker_callback_tag:

767

gobject.source_remove(self.checker_callback_tag)

1163

GLib.source_remove(self.checker_callback_tag)

768

1164

self.checker_callback_tag = None

769

1165

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

770

1166

return

771

1167

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

772

try:

773

self.checker.terminate()

774

#time.sleep(0.5)

775

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

776

# self.checker.kill()

777

except OSError as error:

778

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

779

raise

1168

self.checker.terminate()

780

1169

self.checker = None

781

1170

782

1171

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

785

1176

"""Decorators for marking methods of a DBusObjectWithProperties to

786

1177

become properties on the D-Bus.

787

1178

788

1179

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

789

1180

and with one argument by "Set".

790

1181

791

1182

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

792

1183

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

793

1184

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

796

1187

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

797

1188

if byte_arrays and signature != "ay":

798

1189

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

799

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

1190

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

1191

800

1192

def decorator(func):

801

1193

func._dbus_is_property = True

802

1194

func._dbus_interface = dbus_interface

805

1197

func._dbus_name = func.__name__

806

1198

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

807

1199

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

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

1201

return func

1202

810

1203

return decorator

811

1204

812

1205

813

1206

def dbus_interface_annotations(dbus_interface):

814

1207

"""Decorator for marking functions returning interface annotations

815

1208

816

1209

Usage:

817

1210

818

1211

@dbus_interface_annotations("org.example.Interface")

819

1212

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

820

1213

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

821

1214

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

822

1215

"false"}

823

1216

"""

1217

824

1218

def decorator(func):

825

1219

func._dbus_is_interface = True

826

1220

func._dbus_interface = dbus_interface

827

1221

func._dbus_name = dbus_interface

828

1222

return func

1223

829

1224

return decorator

830

1225

831

1226

832

1227

def dbus_annotations(annotations):

833

1228

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

834

1229

Usage:

835

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

836

1234

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

837

1235

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

1236

def Property_dbus_property(self):

842

1237

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

843

1240

"""

1241

844

1242

def decorator(func):

845

1243

func._dbus_annotations = annotations

846

1244

return func

1245

847

1246

return decorator

848

1247

849

1248

850

1249

class DBusPropertyException(dbus.exceptions.DBusException):

851

1250

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

852

1251

"""

853

def __unicode__(self):

854

return unicode(str(self))

1252

pass

855

1253

856

1254

857

1255

class DBusPropertyAccessException(DBusPropertyException):

866

1264

pass

867

1265

868

1266

869

class DBusObjectWithProperties(dbus.service.Object):

870

"""A D-Bus object with properties.

871

872

Classes inheriting from this can use the dbus_service_property

873

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

874

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

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

875

1272

"""

876

1273

877

1274

@staticmethod

878

1275

def _is_dbus_thing(thing):

879

1276

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

880

1277

881

1278

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

882

1279

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

883

1280

"""

884

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

1281

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

885

1282

False)

886

1283

887

1284

def _get_all_dbus_things(self, thing):

888

1285

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

889

1286

"""

890

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

891

name),

1287

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

892

1288

athing.__get__(self))

893

1289

for cls in self.__class__.__mro__

894

1290

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

898

1364

def _get_dbus_property(self, interface_name, property_name):

899

1365

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

900

1366

property with the specified name and interface.

901

1367

"""

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

906

1371

if (value._dbus_name == property_name

907

1372

and value._dbus_interface == interface_name):

908

1373

return value.__get__(self)

909

1374

910

1375

# No such property

911

raise DBusPropertyNotFound(self.dbus_object_path + ":"

912

+ interface_name + "."

913

+ property_name)

914

915

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

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

916

1390

out_signature="v")

917

1391

def Get(self, interface_name, property_name):

918

1392

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

924

1398

if not hasattr(value, "variant_level"):

925

1399

return value

926

1400

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

927

1401

928

1402

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

929

1403

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

930

1404

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

937

1411

# signatures other than "ay".

938

1412

if prop._dbus_signature != "ay":

939

1413

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

940

"'ay' signature {0!r}"

1414

"'ay' signature {!r}"

941

1415

.format(prop._dbus_signature))

942

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

943

for byte in value))

1416

value = dbus.ByteArray(bytes(value))

944

1417

prop(value)

945

946

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

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

947

1421

out_signature="a{sv}")

948

1422

def GetAll(self, interface_name):

949

1423

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

950

1424

standard.

951

1425

952

1426

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

953

1427

"""

954

1428

properties = {}

964

1438

if not hasattr(value, "variant_level"):

965

1439

properties[name] = value

966

1440

continue

967

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

968

value.variant_level+1)

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

969

1443

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

970

1444

1445

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

1446

def PropertiesChanged(self, interface_name, changed_properties,

1447

invalidated_properties):

1448

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

1449

standard.

1450

"""

1451

pass

1452

971

1453

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

972

1454

out_signature="s",

973

1455

path_keyword='object_path',

974

1456

connection_keyword='connection')

975

1457

def Introspect(self, object_path, connection):

976

1458

"""Overloading of standard D-Bus method.

977

1459

978

1460

Inserts property tags and interface annotation tags.

979

1461

"""

980

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

981

connection)

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

982

1465

try:

983

1466

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

1467

984

1468

def make_tag(document, name, prop):

985

1469

e = document.createElement("property")

986

1470

e.setAttribute("name", name)

987

1471

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

988

1472

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

989

1473

return e

1474

990

1475

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

991

1476

# Add property tags

992

1477

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

995

1480

if prop._dbus_interface

996

1481

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

997

1482

if_tag.appendChild(tag)

998

# Add annotation tags

999

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

1000

for tag in if_tag.getElementsByTagName(typ):

1001

annots = dict()

1002

for name, prop in (self.

1003

_get_all_dbus_things(typ)):

1004

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

1005

and prop._dbus_interface

1006

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

1007

annots.update(getattr

1008

(prop,

1009

"_dbus_annotations",

1010

{}))

1011

for name, value in annots.iteritems():

1012

ann_tag = document.createElement(

1013

"annotation")

1014

ann_tag.setAttribute("name", name)

1015

ann_tag.setAttribute("value", value)

1016

tag.appendChild(ann_tag)

1017

# Add interface annotation tags

1018

for annotation, value in dict(

1019

itertools.chain.from_iterable(

1020

annotations().iteritems()

1021

for name, annotations in

1022

self._get_all_dbus_things("interface")

1023

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

1024

)).iteritems():

1025

ann_tag = document.createElement("annotation")

1026

ann_tag.setAttribute("name", annotation)

1027

ann_tag.setAttribute("value", value)

1028

if_tag.appendChild(ann_tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

1029

1499

# Add the names to the return values for the

1030

1500

# "org.freedesktop.DBus.Properties" methods

1031

1501

if (if_tag.getAttribute("name")

1050

1520

return xmlstring

1051

1521

1052

1522

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1053

1594

def datetime_to_dbus(dt, variant_level=0):

1054

1595

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

1055

1596

if dt is None:

1056

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

1057

return dbus.String(dt.isoformat(),

1058

variant_level=variant_level)

1597

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

1598

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

1059

1599

1060

1600

1061

1601

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1063

1603

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

1064

1604

interface names according to the "alt_interface_names" mapping.

1065

1605

Usage:

1066

1606

1067

1607

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

1068

1608

"net.example.AlternateInterface"})

1069

1609

class SampleDBusObject(dbus.service.Object):

1070

1610

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

1071

1611

def SampleDBusMethod():

1072

1612

pass

1073

1613

1074

1614

The above "SampleDBusMethod" on "SampleDBusObject" will be

1075

1615

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

1076

1616

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

1077

1617

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

1078

1618

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

1079

1619

1080

1620

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

1081

1621

(from DBusObjectWithProperties) and interfaces (from the

1082

1622

dbus_interface_annotations decorator).

1083

1623

"""

1624

1084

1625

def wrapper(cls):

1085

1626

for orig_interface_name, alt_interface_name in (

1086

alt_interface_names.iteritems()):

1627

alt_interface_names.items()):

1087

1628

attr = {}

1088

1629

interface_names = set()

1089

1630

# Go though all attributes of the class

1091

1632

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

1092

1633

# with the wrong interface name

1093

1634

if (not hasattr(attribute, "_dbus_interface")

1094

or not attribute._dbus_interface

1095

.startswith(orig_interface_name)):

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1096

1637

continue

1097

1638

# Create an alternate D-Bus interface name based on

1098

1639

# the current name

1099

alt_interface = (attribute._dbus_interface

1100

.replace(orig_interface_name,

1101

alt_interface_name))

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1102

1642

interface_names.add(alt_interface)

1103

1643

# Is this a D-Bus signal?

1104

1644

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

1105

1645

# Extract the original non-method undecorated

1106

1646

# function by black magic

1107

nonmethod_func = (dict(

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1108

1649

zip(attribute.func_code.co_freevars,

1109

attribute.__closure__))["func"]

1110

.cell_contents)

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1111

1657

# Create a new, but exactly alike, function

1112

1658

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

1113

1659

# with the alternate D-Bus interface name

1114

new_function = (dbus.service.signal

1115

(alt_interface,

1116

attribute._dbus_signature)

1117

(types.FunctionType(

1118

nonmethod_func.func_code,

1119

nonmethod_func.func_globals,

1120

nonmethod_func.func_name,

1121

nonmethod_func.func_defaults,

1122

nonmethod_func.func_closure)))

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

1123

1664

# Copy annotations, if any

1124

1665

try:

1125

new_function._dbus_annotations = (

1126

dict(attribute._dbus_annotations))

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1127

1668

except AttributeError:

1128

1669

pass

1670

1129

1671

# Define a creator of a function to call both the

1130

1672

# original and alternate functions, so both the

1131

1673

# original and alternate signals gets sent when

1134

1676

"""This function is a scope container to pass

1135

1677

func1 and func2 to the "call_both" function

1136

1678

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1137

1681

def call_both(*args, **kwargs):

1138

1682

"""This function will emit two D-Bus

1139

1683

signals by calling func1 and func2"""

1140

1684

func1(*args, **kwargs)

1141

1685

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1142

1692

return call_both

1143

1693

# Create the "call_both" function and add it to

1144

1694

# the class

1149

1699

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

1150

1700

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

1151

1701

# to the class.

1152

attr[attrname] = (dbus.service.method

1153

(alt_interface,

1154

attribute._dbus_in_signature,

1155

attribute._dbus_out_signature)

1156

(types.FunctionType

1157

(attribute.func_code,

1158

attribute.func_globals,

1159

attribute.func_name,

1160

attribute.func_defaults,

1161

attribute.func_closure)))

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

1162

1708

# Copy annotations, if any

1163

1709

try:

1164

attr[attrname]._dbus_annotations = (

1165

dict(attribute._dbus_annotations))

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1166

1712

except AttributeError:

1167

1713

pass

1168

1714

# Is this a D-Bus property?

1171

1717

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

1172

1718

# property with the alternate D-Bus interface

1173

1719

# name. Add it to the class.

1174

attr[attrname] = (dbus_service_property

1175

(alt_interface,

1176

attribute._dbus_signature,

1177

attribute._dbus_access,

1178

attribute

1179

._dbus_get_args_options

1180

["byte_arrays"])

1181

(types.FunctionType

1182

(attribute.func_code,

1183

attribute.func_globals,

1184

attribute.func_name,

1185

attribute.func_defaults,

1186

attribute.func_closure)))

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

1187

1726

# Copy annotations, if any

1188

1727

try:

1189

attr[attrname]._dbus_annotations = (

1190

dict(attribute._dbus_annotations))

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1191

1730

except AttributeError:

1192

1731

pass

1193

1732

# Is this a D-Bus interface?

1196

1735

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

1197

1736

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

1198

1737

# to the class.

1199

attr[attrname] = (dbus_interface_annotations

1200

(alt_interface)

1201

(types.FunctionType

1202

(attribute.func_code,

1203

attribute.func_globals,

1204

attribute.func_name,

1205

attribute.func_defaults,

1206

attribute.func_closure)))

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1207

1741

if deprecate:

1208

1742

# Deprecate all alternate interfaces

1209

iname="_AlternateDBusNames_interface_annotation{0}"

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1210

1744

for interface_name in interface_names:

1745

1211

1746

@dbus_interface_annotations(interface_name)

1212

1747

def func(self):

1213

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

1214

"true" }

1748

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

1749

"true"}

1215

1750

# Find an unused name

1216

1751

for aname in (iname.format(i)

1217

1752

for i in itertools.count()):

1221

1756

if interface_names:

1222

1757

# Replace the class with a new subclass of it with

1223

1758

# methods, signals, etc. as created above.

1224

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

1225

(cls,), attr)

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1226

1765

return cls

1766

1227

1767

return wrapper

1228

1768

1229

1769

1230

1770

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

1231

"se.bsnet.fukt.Mandos"})

1771

"se.bsnet.fukt.Mandos"})

1232

1772

class ClientDBus(Client, DBusObjectWithProperties):

1233

1773

"""A Client class using D-Bus

1234

1774

1235

1775

Attributes:

1236

1776

dbus_object_path: dbus.ObjectPath

1237

1777

bus: dbus.SystemBus()

1238

1778

"""

1239

1779

1240

1780

runtime_expansions = (Client.runtime_expansions

1241

+ ("dbus_object_path",))

1242

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1243

1785

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

1244

1245

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

1786

1787

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

1246

1788

self.bus = bus

1247

1789

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

1248

1790

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

1249

1791

# the D-Bus

1250

client_object_name = unicode(self.name).translate(

1792

client_object_name = str(self.name).translate(

1251

1793

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

1252

1794

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

1253

self.dbus_object_path = (dbus.ObjectPath

1254

("/clients/" + client_object_name))

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1255

1797

DBusObjectWithProperties.__init__(self, self.bus,

1256

1798

self.dbus_object_path)

1257

1258

def notifychangeproperty(transform_func,

1259

dbus_name, type_func=lambda x: x,

1260

variant_level=1):

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1804

_interface=_interface):

1261

1805

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

1262

1806

its changes to DBus.

1263

1807

1264

1808

transform_fun: Function that takes a value and a variant_level

1265

1809

and transforms it to a D-Bus type.

1266

1810

dbus_name: D-Bus name of the variable

1268

1812

to the D-Bus. Default: no transform

1269

1813

variant_level: D-Bus variant level. Default: 1

1270

1814

"""

1271

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

1815

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

1816

1272

1817

def setter(self, value):

1273

1818

if hasattr(self, "dbus_object_path"):

1274

1819

if (not hasattr(self, attrname) or

1275

1820

type_func(getattr(self, attrname, None))

1276

1821

!= type_func(value)):

1277

dbus_value = transform_func(type_func(value),

1278

variant_level

1279

=variant_level)

1280

self.PropertyChanged(dbus.String(dbus_name),

1281

dbus_value)

1822

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1826

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1830

self.PropertyChanged(dbus.String(dbus_name),

1831

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1282

1837

setattr(self, attrname, value)

1283

1838

1284

1839

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

1285

1840

1286

1841

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1287

1842

approvals_pending = notifychangeproperty(dbus.Boolean,

1288

1843

"ApprovalPending",

1289

type_func = bool)

1844

type_func=bool)

1290

1845

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

1291

1846

last_enabled = notifychangeproperty(datetime_to_dbus,

1292

1847

"LastEnabled")

1293

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

1294

type_func = lambda checker:

1295

checker is not None)

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1296

1851

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1297

1852

"LastCheckedOK")

1298

1853

last_checker_status = notifychangeproperty(dbus.Int16,

1301

1856

datetime_to_dbus, "LastApprovalRequest")

1302

1857

approved_by_default = notifychangeproperty(dbus.Boolean,

1303

1858

"ApprovedByDefault")

1304

approval_delay = notifychangeproperty(dbus.UInt64,

1305

"ApprovalDelay",

1306

type_func =

1307

timedelta_to_milliseconds)

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1308

1862

approval_duration = notifychangeproperty(

1309

1863

dbus.UInt64, "ApprovalDuration",

1310

type_func = timedelta_to_milliseconds)

1864

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

1311

1865

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

1312

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

1313

type_func =

1314

timedelta_to_milliseconds)

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1315

1869

extended_timeout = notifychangeproperty(

1316

1870

dbus.UInt64, "ExtendedTimeout",

1317

type_func = timedelta_to_milliseconds)

1318

interval = notifychangeproperty(dbus.UInt64,

1319

"Interval",

1320

type_func =

1321

timedelta_to_milliseconds)

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

1322

1875

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

1323

1876

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

1877

invalidate_only=True)

1878

1324

1879

del notifychangeproperty

1325

1880

1326

1881

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

1327

1882

try:

1328

1883

self.remove_from_connection()

1331

1886

if hasattr(DBusObjectWithProperties, "__del__"):

1332

1887

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

1333

1888

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

1334

1335

def checker_callback(self, pid, condition, command,

1336

*args, **kwargs):

1337

self.checker_callback_tag = None

1338

self.checker = None

1339

if os.WIFEXITED(condition):

1340

exitstatus = os.WEXITSTATUS(condition)

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

1341

1897

# Emit D-Bus signal

1342

1898

self.CheckerCompleted(dbus.Int16(exitstatus),

1343

dbus.Int64(condition),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1344

1901

dbus.String(command))

1345

1902

else:

1346

1903

# Emit D-Bus signal

1347

1904

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

1348

dbus.Int64(condition),

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1349

1909

dbus.String(command))

1350

1351

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

1352

*args, **kwargs)

1353

1910

return ret

1911

1354

1912

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

1355

1913

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

1356

1914

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

1360

1918

# Emit D-Bus signal

1361

1919

self.CheckerStarted(self.current_checker_command)

1362

1920

return r

1363

1921

1364

1922

def _reset_approved(self):

1365

1923

self.approved = None

1366

1924

return False

1367

1925

1368

1926

def approve(self, value=True):

1369

1927

self.approved = value

1370

gobject.timeout_add(timedelta_to_milliseconds

1371

(self.approval_duration),

1372

self._reset_approved)

1928

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

1929

* 1000), self._reset_approved)

1373

1930

self.send_changedstate()

1374

1375

## D-Bus methods, signals & properties

1376

_interface = "se.recompile.Mandos.Client"

1377

1378

## Interfaces

1379

1380

@dbus_interface_annotations(_interface)

1381

def _foo(self):

1382

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

1383

"false"}

1384

1385

## Signals

1386

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1387

1938

# CheckerCompleted - signal

1388

1939

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

1389

1940

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

1390

1941

"D-Bus signal"

1391

1942

pass

1392

1943

1393

1944

# CheckerStarted - signal

1394

1945

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

1395

1946

def CheckerStarted(self, command):

1396

1947

"D-Bus signal"

1397

1948

pass

1398

1949

1399

1950

# PropertyChanged - signal

1951

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

1400

1952

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

1401

1953

def PropertyChanged(self, property, value):

1402

1954

"D-Bus signal"

1403

1955

pass

1404

1956

1405

1957

# GotSecret - signal

1406

1958

@dbus.service.signal(_interface)

1407

1959

def GotSecret(self):

1410

1962

server to mandos-client

1411

1963

"""

1412

1964

pass

1413

1965

1414

1966

# Rejected - signal

1415

1967

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

1416

1968

def Rejected(self, reason):

1417

1969

"D-Bus signal"

1418

1970

pass

1419

1971

1420

1972

# NeedApproval - signal

1421

1973

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

1422

1974

def NeedApproval(self, timeout, default):

1423

1975

"D-Bus signal"

1424

1976

return self.need_approval()

1425

1426

## Methods

1427

1977

1978

# Methods

1979

1428

1980

# Approve - method

1429

1981

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

1430

1982

def Approve(self, value):

1431

1983

self.approve(value)

1432

1984

1433

1985

# CheckedOK - method

1434

1986

@dbus.service.method(_interface)

1435

1987

def CheckedOK(self):

1436

1988

self.checked_ok()

1437

1989

1438

1990

# Enable - method

1991

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

1439

1992

@dbus.service.method(_interface)

1440

1993

def Enable(self):

1441

1994

"D-Bus method"

1442

1995

self.enable()

1443

1996

1444

1997

# StartChecker - method

1998

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

1445

1999

@dbus.service.method(_interface)

1446

2000

def StartChecker(self):

1447

2001

"D-Bus method"

1448

2002

self.start_checker()

1449

2003

1450

2004

# Disable - method

2005

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

1451

2006

@dbus.service.method(_interface)

1452

2007

def Disable(self):

1453

2008

"D-Bus method"

1454

2009

self.disable()

1455

2010

1456

2011

# StopChecker - method

2012

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

1457

2013

@dbus.service.method(_interface)

1458

2014

def StopChecker(self):

1459

2015

self.stop_checker()

1460

1461

## Properties

1462

2016

2017

# Properties

2018

1463

2019

# ApprovalPending - property

1464

2020

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

1465

2021

def ApprovalPending_dbus_property(self):

1466

2022

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

1467

2023

1468

2024

# ApprovedByDefault - property

1469

@dbus_service_property(_interface, signature="b",

2025

@dbus_service_property(_interface,

2026

signature="b",

1470

2027

access="readwrite")

1471

2028

def ApprovedByDefault_dbus_property(self, value=None):

1472

2029

if value is None: # get

1473

2030

return dbus.Boolean(self.approved_by_default)

1474

2031

self.approved_by_default = bool(value)

1475

2032

1476

2033

# ApprovalDelay - property

1477

@dbus_service_property(_interface, signature="t",

2034

@dbus_service_property(_interface,

2035

signature="t",

1478

2036

access="readwrite")

1479

2037

def ApprovalDelay_dbus_property(self, value=None):

1480

2038

if value is None: # get

1481

return dbus.UInt64(self.approval_delay_milliseconds())

2039

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

2040

* 1000)

1482

2041

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

1483

2042

1484

2043

# ApprovalDuration - property

1485

@dbus_service_property(_interface, signature="t",

2044

@dbus_service_property(_interface,

2045

signature="t",

1486

2046

access="readwrite")

1487

2047

def ApprovalDuration_dbus_property(self, value=None):

1488

2048

if value is None: # get

1489

return dbus.UInt64(timedelta_to_milliseconds(

1490

self.approval_duration))

2049

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

2050

* 1000)

1491

2051

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

1492

2052

1493

2053

# Name - property

2054

@dbus_annotations(

2055

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

1494

2056

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

1495

2057

def Name_dbus_property(self):

1496

2058

return dbus.String(self.name)

1497

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1498

2067

# Fingerprint - property

2068

@dbus_annotations(

2069

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

1499

2070

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

1500

2071

def Fingerprint_dbus_property(self):

1501

2072

return dbus.String(self.fingerprint)

1502

2073

1503

2074

# Host - property

1504

@dbus_service_property(_interface, signature="s",

2075

@dbus_service_property(_interface,

2076

signature="s",

1505

2077

access="readwrite")

1506

2078

def Host_dbus_property(self, value=None):

1507

2079

if value is None: # get

1508

2080

return dbus.String(self.host)

1509

self.host = unicode(value)

1510

2081

self.host = str(value)

2082

1511

2083

# Created - property

2084

@dbus_annotations(

2085

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

1512

2086

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

1513

2087

def Created_dbus_property(self):

1514

2088

return datetime_to_dbus(self.created)

1515

2089

1516

2090

# LastEnabled - property

1517

2091

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

1518

2092

def LastEnabled_dbus_property(self):

1519

2093

return datetime_to_dbus(self.last_enabled)

1520

2094

1521

2095

# Enabled - property

1522

@dbus_service_property(_interface, signature="b",

2096

@dbus_service_property(_interface,

2097

signature="b",

1523

2098

access="readwrite")

1524

2099

def Enabled_dbus_property(self, value=None):

1525

2100

if value is None: # get

1528

2103

self.enable()

1529

2104

else:

1530

2105

self.disable()

1531

2106

1532

2107

# LastCheckedOK - property

1533

@dbus_service_property(_interface, signature="s",

2108

@dbus_service_property(_interface,

2109

signature="s",

1534

2110

access="readwrite")

1535

2111

def LastCheckedOK_dbus_property(self, value=None):

1536

2112

if value is not None:

1537

2113

self.checked_ok()

1538

2114

return

1539

2115

return datetime_to_dbus(self.last_checked_ok)

1540

2116

1541

2117

# LastCheckerStatus - property

1542

@dbus_service_property(_interface, signature="n",

1543

access="read")

2118

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

1544

2119

def LastCheckerStatus_dbus_property(self):

1545

2120

return dbus.Int16(self.last_checker_status)

1546

2121

1547

2122

# Expires - property

1548

2123

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

1549

2124

def Expires_dbus_property(self):

1550

2125

return datetime_to_dbus(self.expires)

1551

2126

1552

2127

# LastApprovalRequest - property

1553

2128

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

1554

2129

def LastApprovalRequest_dbus_property(self):

1555

2130

return datetime_to_dbus(self.last_approval_request)

1556

2131

1557

2132

# Timeout - property

1558

@dbus_service_property(_interface, signature="t",

2133

@dbus_service_property(_interface,

2134

signature="t",

1559

2135

access="readwrite")

1560

2136

def Timeout_dbus_property(self, value=None):

1561

2137

if value is None: # get

1562

return dbus.UInt64(self.timeout_milliseconds())

2138

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

1563

2139

old_timeout = self.timeout

1564

2140

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

1565

2141

# Reschedule disabling

1573

2149

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

1574

2150

is None):

1575

2151

return

1576

gobject.source_remove(self.disable_initiator_tag)

1577

self.disable_initiator_tag = (

1578

gobject.timeout_add(

1579

timedelta_to_milliseconds(self.expires - now),

1580

self.disable))

1581

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

1582

2157

# ExtendedTimeout - property

1583

@dbus_service_property(_interface, signature="t",

2158

@dbus_service_property(_interface,

2159

signature="t",

1584

2160

access="readwrite")

1585

2161

def ExtendedTimeout_dbus_property(self, value=None):

1586

2162

if value is None: # get

1587

return dbus.UInt64(self.extended_timeout_milliseconds())

2163

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

2164

* 1000)

1588

2165

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

1589

2166

1590

2167

# Interval - property

1591

@dbus_service_property(_interface, signature="t",

2168

@dbus_service_property(_interface,

2169

signature="t",

1592

2170

access="readwrite")

1593

2171

def Interval_dbus_property(self, value=None):

1594

2172

if value is None: # get

1595

return dbus.UInt64(self.interval_milliseconds())

2173

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

1596

2174

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

1597

2175

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

1598

2176

return

1599

2177

if self.enabled:

1600

2178

# Reschedule checker run

1601

gobject.source_remove(self.checker_initiator_tag)

1602

self.checker_initiator_tag = (gobject.timeout_add

1603

(value, self.start_checker))

1604

self.start_checker() # Start one now, too

1605

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

1606

2184

# Checker - property

1607

@dbus_service_property(_interface, signature="s",

2185

@dbus_service_property(_interface,

2186

signature="s",

1608

2187

access="readwrite")

1609

2188

def Checker_dbus_property(self, value=None):

1610

2189

if value is None: # get

1611

2190

return dbus.String(self.checker_command)

1612

self.checker_command = unicode(value)

1613

2191

self.checker_command = str(value)

2192

1614

2193

# CheckerRunning - property

1615

@dbus_service_property(_interface, signature="b",

2194

@dbus_service_property(_interface,

2195

signature="b",

1616

2196

access="readwrite")

1617

2197

def CheckerRunning_dbus_property(self, value=None):

1618

2198

if value is None: # get

1621

2201

self.start_checker()

1622

2202

else:

1623

2203

self.stop_checker()

1624

2204

1625

2205

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

1626

2209

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

1627

2210

def ObjectPath_dbus_property(self):

1628

return self.dbus_object_path # is already a dbus.ObjectPath

1629

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1630

2213

# Secret = property

1631

@dbus_service_property(_interface, signature="ay",

1632

access="write", byte_arrays=True)

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1633

2221

def Secret_dbus_property(self, value):

1634

self.secret = str(value)

1635

2222

self.secret = bytes(value)

2223

1636

2224

del _interface

1637

2225

1638

2226

1639

class ProxyClient(object):

1640

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

2227

class ProxyClient:

2228

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

1641

2229

self._pipe = child_pipe

1642

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

2230

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

1643

2231

if not self._pipe.recv():

1644

raise KeyError()

1645

2232

raise KeyError(key_id or fpr)

2233

1646

2234

def __getattribute__(self, name):

1647

2235

if name == '_pipe':

1648

2236

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

1651

2239

if data[0] == 'data':

1652

2240

return data[1]

1653

2241

if data[0] == 'function':

2242

1654

2243

def func(*args, **kwargs):

1655

2244

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

1656

2245

return self._pipe.recv()[1]

2246

1657

2247

return func

1658

2248

1659

2249

def __setattr__(self, name, value):

1660

2250

if name == '_pipe':

1661

2251

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

1664

2254

1665

2255

class ClientHandler(socketserver.BaseRequestHandler, object):

1666

2256

"""A class to handle client connections.

1667

2257

1668

2258

Instantiated once for each connection to handle it.

1669

2259

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

1670

2260

1671

2261

def handle(self):

1672

2262

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

1673

2263

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

1674

unicode(self.client_address))

2264

str(self.client_address))

1675

2265

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

1676

2266

self.server.child_pipe.fileno())

1677

1678

session = (gnutls.connection

1679

.ClientSession(self.request,

1680

gnutls.connection

1681

.X509Credentials()))

1682

1683

# Note: gnutls.connection.X509Credentials is really a

1684

# generic GnuTLS certificate credentials object so long as

1685

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

1686

# here despite using OpenPGP certificates.

1687

1688

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

1689

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

1690

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

1691

# "+DHE-DSS"))

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

1692

2274

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

1693

2275

priority = self.server.gnutls_priority

1694

2276

if priority is None:

1695

2277

priority = "NORMAL"

1696

(gnutls.library.functions

1697

.gnutls_priority_set_direct(session._c_object,

1698

priority, None))

1699

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1700

2282

# Start communication using the Mandos protocol

1701

2283

# Get protocol number

1702

2284

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

1707

2289

except (ValueError, IndexError, RuntimeError) as error:

1708

2290

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

1709

2291

return

1710

2292

1711

2293

# Start GnuTLS connection

1712

2294

try:

1713

2295

session.handshake()

1714

except gnutls.errors.GNUTLSError as error:

2296

except gnutls.Error as error:

1715

2297

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

1716

2298

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

1717

2299

# established. Just abandon the request.

1718

2300

return

1719

2301

logger.debug("Handshake succeeded")

1720

2302

1721

2303

approval_required = False

1722

2304

try:

1723

try:

1724

fpr = self.fingerprint(self.peer_certificate

1725

(session))

1726

except (TypeError,

1727

gnutls.errors.GNUTLSError) as error:

1728

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

1729

return

1730

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

1731

1732

try:

1733

client = ProxyClient(child_pipe, fpr,

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

1734

2327

self.client_address)

1735

2328

except KeyError:

1736

2329

return

1737

2330

1738

2331

if client.approval_delay:

1739

2332

delay = client.approval_delay

1740

2333

client.approvals_pending += 1

1741

2334

approval_required = True

1742

2335

1743

2336

while True:

1744

2337

if not client.enabled:

1745

2338

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

1746

client.name)

2339

client.name)

1747

2340

if self.server.use_dbus:

1748

2341

# Emit D-Bus signal

1749

2342

client.Rejected("Disabled")

1750

2343

return

1751

2344

1752

2345

if client.approved or not client.approval_delay:

1753

#We are approved or approval is disabled

2346

# We are approved or approval is disabled

1754

2347

break

1755

2348

elif client.approved is None:

1756

2349

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

1758

2351

if self.server.use_dbus:

1759

2352

# Emit D-Bus signal

1760

2353

client.NeedApproval(

1761

client.approval_delay_milliseconds(),

1762

client.approved_by_default)

2354

client.approval_delay.total_seconds()

2355

* 1000, client.approved_by_default)

1763

2356

else:

1764

2357

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

1765

2358

client.name)

1767

2360

# Emit D-Bus signal

1768

2361

client.Rejected("Denied")

1769

2362

return

1770

1771

#wait until timeout or approved

2363

2364

# wait until timeout or approved

1772

2365

time = datetime.datetime.now()

1773

2366

client.changedstate.acquire()

1774

client.changedstate.wait(

1775

float(timedelta_to_milliseconds(delay)

1776

/ 1000))

2367

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

1777

2368

client.changedstate.release()

1778

2369

time2 = datetime.datetime.now()

1779

2370

if (time2 - time) >= delay:

1789

2380

break

1790

2381

else:

1791

2382

delay -= time2 - time

1792

1793

sent_size = 0

1794

while sent_size < len(client.secret):

1795

try:

1796

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

1797

except gnutls.errors.GNUTLSError as error:

1798

logger.warning("gnutls send failed",

1799

exc_info=error)

1800

return

1801

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

1802

sent, len(client.secret)

1803

- (sent_size + sent))

1804

sent_size += sent

1805

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

1806

2391

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

1807

2392

# bump the timeout using extended_timeout

1808

2393

client.bump_timeout(client.extended_timeout)

1809

2394

if self.server.use_dbus:

1810

2395

# Emit D-Bus signal

1811

2396

client.GotSecret()

1812

2397

1813

2398

finally:

1814

2399

if approval_required:

1815

2400

client.approvals_pending -= 1

1816

2401

try:

1817

2402

session.bye()

1818

except gnutls.errors.GNUTLSError as error:

2403

except gnutls.Error as error:

1819

2404

logger.warning("GnuTLS bye failed",

1820

2405

exc_info=error)

1821

2406

1822

2407

@staticmethod

1823

2408

def peer_certificate(session):

1824

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

1825

# If not an OpenPGP certificate...

1826

if (gnutls.library.functions

1827

.gnutls_certificate_type_get(session._c_object)

1828

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1829

# ...do the normal thing

1830

return session.peer_certificate

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

1831

2425

list_size = ctypes.c_uint(1)

1832

cert_list = (gnutls.library.functions

1833

.gnutls_certificate_get_peers

2426

cert_list = (gnutls.certificate_get_peers

1834

2427

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

1835

2428

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

1836

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

1837

" certificate")

2429

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

1838

2430

if list_size.value == 0:

1839

2431

return None

1840

2432

cert = cert_list[0]

1841

2433

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

1842

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1843

2469

@staticmethod

1844

2470

def fingerprint(openpgp):

1845

2471

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1846

2472

# New GnuTLS "datum" with the OpenPGP public key

1847

datum = (gnutls.library.types

1848

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

1849

ctypes.POINTER

1850

(ctypes.c_ubyte)),

1851

ctypes.c_uint(len(openpgp))))

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

1852

2477

# New empty GnuTLS certificate

1853

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1854

(gnutls.library.functions

1855

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1856

2480

# Import the OpenPGP public key into the certificate

1857

(gnutls.library.functions

1858

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

1859

gnutls.library.constants

1860

.GNUTLS_OPENPGP_FMT_RAW))

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1861

2483

# Verify the self signature in the key

1862

2484

crtverify = ctypes.c_uint()

1863

(gnutls.library.functions

1864

.gnutls_openpgp_crt_verify_self(crt, 0,

1865

ctypes.byref(crtverify)))

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1866

2487

if crtverify.value != 0:

1867

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1868

raise (gnutls.errors.CertificateSecurityError

1869

("Verify failed"))

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1870

2491

# New buffer for the fingerprint

1871

2492

buf = ctypes.create_string_buffer(20)

1872

2493

buf_len = ctypes.c_size_t()

1873

2494

# Get the fingerprint from the certificate into the buffer

1874

(gnutls.library.functions

1875

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

1876

ctypes.byref(buf_len)))

2495

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

2496

ctypes.byref(buf_len))

1877

2497

# Deinit the certificate

1878

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2498

gnutls.openpgp_crt_deinit(crt)

1879

2499

# Convert the buffer to a Python bytestring

1880

2500

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

1881

2501

# Convert the bytestring to hexadecimal notation

1883

2503

return hex_fpr

1884

2504

1885

2505

1886

class MultiprocessingMixIn(object):

2506

class MultiprocessingMixIn:

1887

2507

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

2508

1888

2509

def sub_process_main(self, request, address):

1889

2510

try:

1890

2511

self.finish_request(request, address)

1891

2512

except Exception:

1892

2513

self.handle_error(request, address)

1893

2514

self.close_request(request)

1894

2515

1895

2516

def process_request(self, request, address):

1896

2517

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

1897

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

1898

args = (request, address))

2518

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

2519

args=(request, address))

1899

2520

proc.start()

1900

2521

return proc

1901

2522

1902

2523

1903

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1904

2525

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

2526

1905

2527

def process_request(self, request, client_address):

1906

2528

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

1907

2529

1908

2530

This function creates a new pipe in self.pipe

1909

2531

"""

1910

2532

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1911

2533

1912

2534

proc = MultiprocessingMixIn.process_request(self, request,

1913

2535

client_address)

1914

2536

self.child_pipe.close()

1915

2537

self.add_pipe(parent_pipe, proc)

1916

2538

1917

2539

def add_pipe(self, parent_pipe, proc):

1918

2540

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

1919

2541

raise NotImplementedError()

1920

2542

1921

2543

1922

2544

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1923

socketserver.TCPServer, object):

2545

socketserver.TCPServer):

1924

2546

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

1925

2547

1926

2548

Attributes:

1927

2549

enabled: Boolean; whether this server is activated yet

1928

2550

interface: None or a network interface name (string)

1929

2551

use_ipv6: Boolean; to use IPv6 or not

1930

2552

"""

2553

1931

2554

def __init__(self, server_address, RequestHandlerClass,

1932

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

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1933

2558

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

1934

2559

creating a new one with socket.socket().

1935

2560

"""

1941

2566

self.socketfd = socketfd

1942

2567

# Save the original socket.socket() function

1943

2568

self.socket_socket = socket.socket

2569

1944

2570

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

1945

#

2571

#

1946

2572

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

1947

2573

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

1948

2574

# patching socket.socket.)

1949

#

2575

#

1950

2576

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

1951

2577

@functools.wraps(socket.socket)

1952

2578

def socket_wrapper(*args, **kwargs):

1964

2590

# socket_wrapper(), if socketfd was set.

1965

2591

socketserver.TCPServer.__init__(self, server_address,

1966

2592

RequestHandlerClass)

1967

2593

1968

2594

def server_bind(self):

1969

2595

"""This overrides the normal server_bind() function

1970

2596

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

1971

2597

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

2598

global SO_BINDTODEVICE

1972

2599

if self.interface is not None:

1973

2600

if SO_BINDTODEVICE is None:

1974

logger.error("SO_BINDTODEVICE does not exist;"

1975

" cannot bind to interface %s",

1976

self.interface)

1977

else:

1978

try:

1979

self.socket.setsockopt(socket.SOL_SOCKET,

1980

SO_BINDTODEVICE,

1981

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

1982

except socket.error as error:

1983

if error.errno == errno.EPERM:

1984

logger.error("No permission to bind to"

1985

" interface %s", self.interface)

1986

elif error.errno == errno.ENOPROTOOPT:

1987

logger.error("SO_BINDTODEVICE not available;"

1988

" cannot bind to interface %s",

1989

self.interface)

1990

elif error.errno == errno.ENODEV:

1991

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

1992

" cannot bind", self.interface)

1993

else:

1994

raise

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

1995

2622

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

1996

2623

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

1997

2626

if not self.server_address[0]:

1998

2627

if self.address_family == socket.AF_INET6:

1999

any_address = "::" # in6addr_any

2628

any_address = "::" # in6addr_any

2000

2629

else:

2001

any_address = "0.0.0.0" # INADDR_ANY

2630

any_address = "0.0.0.0" # INADDR_ANY

2002

2631

self.server_address = (any_address,

2003

2632

self.server_address[1])

2004

2633

elif not self.server_address[1]:

2005

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

2006

0)

2634

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

2007

2635

# if self.interface:

2008

2636

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

2009

2637

# 0, # port

2015

2643

2016

2644

class MandosServer(IPv6_TCPServer):

2017

2645

"""Mandos server.

2018

2646

2019

2647

Attributes:

2020

2648

clients: set of Client objects

2021

2649

gnutls_priority GnuTLS priority string

2022

2650

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

2023

2024

Assumes a gobject.MainLoop event loop.

2651

2652

Assumes a GLib.MainLoop event loop.

2025

2653

"""

2654

2026

2655

def __init__(self, server_address, RequestHandlerClass,

2027

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

2028

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

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2029

2662

self.enabled = False

2030

2663

self.clients = clients

2031

2664

if self.clients is None:

2034

2667

self.gnutls_priority = gnutls_priority

2035

2668

IPv6_TCPServer.__init__(self, server_address,

2036

2669

RequestHandlerClass,

2037

interface = interface,

2038

use_ipv6 = use_ipv6,

2039

socketfd = socketfd)

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2040

2674

def server_activate(self):

2041

2675

if self.enabled:

2042

2676

return socketserver.TCPServer.server_activate(self)

2043

2677

2044

2678

def enable(self):

2045

2679

self.enabled = True

2046

2680

2047

2681

def add_pipe(self, parent_pipe, proc):

2048

2682

# Call "handle_ipc" for both data and EOF events

2049

gobject.io_add_watch(parent_pipe.fileno(),

2050

gobject.IO_IN | gobject.IO_HUP,

2051

functools.partial(self.handle_ipc,

2052

parent_pipe =

2053

parent_pipe,

2054

proc = proc))

2055

2056

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

2057

proc = None, client_object=None):

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

2058

2694

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

2059

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

2695

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

2060

2696

# Wait for other process to exit

2061

2697

proc.join()

2062

2698

return False

2063

2699

2064

2700

# Read a request from the child

2065

2701

request = parent_pipe.recv()

2066

2702

command = request[0]

2067

2703

2068

2704

if command == 'init':

2069

fpr = request[1]

2070

address = request[2]

2071

2072

for c in self.clients.itervalues():

2073

if c.fingerprint == fpr:

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2074

2716

client = c

2075

2717

break

2076

2718

else:

2077

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

2078

"dress: %s", fpr, address)

2719

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

2720

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

2079

2721

if self.use_dbus:

2080

2722

# Emit D-Bus signal

2081

mandos_dbus_service.ClientNotFound(fpr,

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2082

2724

address[0])

2083

2725

parent_pipe.send(False)

2084

2726

return False

2085

2086

gobject.io_add_watch(parent_pipe.fileno(),

2087

gobject.IO_IN | gobject.IO_HUP,

2088

functools.partial(self.handle_ipc,

2089

parent_pipe =

2090

parent_pipe,

2091

proc = proc,

2092

client_object =

2093

client))

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

2094

2735

parent_pipe.send(True)

2095

2736

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

2096

2737

# same fileno

2099

2740

funcname = request[1]

2100

2741

args = request[2]

2101

2742

kwargs = request[3]

2102

2743

2103

2744

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

2104

2745

funcname)(*args,

2105

**kwargs)))

2106

2746

**kwargs)))

2747

2107

2748

if command == 'getattr':

2108

2749

attrname = request[1]

2109

if callable(client_object.__getattribute__(attrname)):

2110

parent_pipe.send(('function',))

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2111

2753

else:

2112

parent_pipe.send(('data', client_object

2113

.__getattribute__(attrname)))

2114

2754

parent_pipe.send((

2755

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

2756

2115

2757

if command == 'setattr':

2116

2758

attrname = request[1]

2117

2759

value = request[2]

2118

2760

setattr(client_object, attrname, value)

2119

2761

2120

2762

return True

2121

2763

2122

2764

2123

2765

def rfc3339_duration_to_delta(duration):

2124

2766

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

2125

2126

>>> rfc3339_duration_to_delta("P7D")

2127

datetime.timedelta(7)

2128

>>> rfc3339_duration_to_delta("PT60S")

2129

datetime.timedelta(0, 60)

2130

>>> rfc3339_duration_to_delta("PT60M")

2131

datetime.timedelta(0, 3600)

2132

>>> rfc3339_duration_to_delta("PT24H")

2133

datetime.timedelta(1)

2134

>>> rfc3339_duration_to_delta("P1W")

2135

datetime.timedelta(7)

2136

>>> rfc3339_duration_to_delta("PT5M30S")

2137

datetime.timedelta(0, 330)

2138

>>> rfc3339_duration_to_delta("P1DT3M20S")

2139

datetime.timedelta(1, 200)

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

2140

2782

"""

2141

2783

2142

2784

# Parsing an RFC 3339 duration with regular expressions is not

2143

2785

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

2144

2786

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

2145

2787

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

2146

2788

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

2147

2789

# avoid excessive use of external libraries.

2148

2790

2149

2791

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

2150

Token = collections.namedtuple("Token",

2151

("regexp", # To match token; if

2152

# "value" is not None,

2153

# must have a "group"

2154

# containing digits

2155

"value", # datetime.timedelta or

2156

# None

2157

"followers")) # Tokens valid after

2158

# this token

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

2159

2797

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

2160

2798

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

2161

2799

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

2162

2800

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

2163

2801

datetime.timedelta(seconds=1),

2164

frozenset((token_end,)))

2802

frozenset((token_end, )))

2165

2803

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

2166

2804

datetime.timedelta(minutes=1),

2167

2805

frozenset((token_second, token_end)))

2183

2821

frozenset((token_month, token_end)))

2184

2822

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

2185

2823

datetime.timedelta(weeks=1),

2186

frozenset((token_end,)))

2824

frozenset((token_end, )))

2187

2825

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

2188

2826

frozenset((token_year, token_month,

2189

2827

token_day, token_time,

2190

token_week))),

2191

# Define starting values

2192

value = datetime.timedelta() # Value so far

2828

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2193

2832

found_token = None

2194

followers = frozenset(token_duration,) # Following valid tokens

2195

s = duration # String left to parse

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2196

2837

# Loop until end token is found

2197

2838

while found_token is not token_end:

2198

2839

# Search for any currently valid tokens

2214

2855

break

2215

2856

else:

2216

2857

# No currently valid tokens were found

2217

raise ValueError("Invalid RFC 3339 duration")

2858

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

2859

.format(duration))

2218

2860

# End token found

2219

2861

return value

2220

2862

2221

2863

2222

2864

def string_to_delta(interval):

2223

2865

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

2224

2225

>>> string_to_delta('7d')

2226

datetime.timedelta(7)

2227

>>> string_to_delta('60s')

2228

datetime.timedelta(0, 60)

2229

>>> string_to_delta('60m')

2230

datetime.timedelta(0, 3600)

2231

>>> string_to_delta('24h')

2232

datetime.timedelta(1)

2233

>>> string_to_delta('1w')

2234

datetime.timedelta(7)

2235

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

2236

datetime.timedelta(0, 330)

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

2237

2879

"""

2238

2880

2239

2881

try:

2240

2882

return rfc3339_duration_to_delta(interval)

2241

2883

except ValueError:

2242

2884

pass

2243

2885

2244

2886

timevalue = datetime.timedelta(0)

2245

2887

for s in interval.split():

2246

2888

try:

2247

suffix = unicode(s[-1])

2889

suffix = s[-1]

2248

2890

value = int(s[:-1])

2249

2891

if suffix == "d":

2250

2892

delta = datetime.timedelta(value)

2257

2899

elif suffix == "w":

2258

2900

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

2259

2901

else:

2260

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

2261

.format(suffix))

2902

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

2262

2903

except IndexError as e:

2263

2904

raise ValueError(*(e.args))

2264

2905

timevalue += delta

2265

2906

return timevalue

2266

2907

2267

2908

2268

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

2909

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

2269

2910

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

2270

2911

2271

2912

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

2272

2913

if os.fork():

2273

2914

sys.exit()

2281

2922

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

2282

2923

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

2283

2924

raise OSError(errno.ENODEV,

2284

"{0} not a character device"

2925

"{} not a character device"

2285

2926

.format(os.devnull))

2286

2927

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

2287

2928

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

2291

2932

2292

2933

2293

2934

def main():

2294

2935

2295

2936

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

2296

2937

# Parsing of options, both command line and config file

2297

2938

2298

2939

parser = argparse.ArgumentParser()

2299

2940

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

2300

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

2941

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

2301

2942

help="show version number and exit")

2302

2943

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

2303

2944

help="Bind to interface IF")

2336

2977

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

2337

2978

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

2338

2979

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

2339

2980

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

2981

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

2982

default=None)

2983

2340

2984

options = parser.parse_args()

2341

2342

if options.check:

2343

import doctest

2344

fail_count, test_count = doctest.testmod()

2345

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

2346

2985

2347

2986

# Default values for config file for server-global settings

2348

server_defaults = { "interface": "",

2349

"address": "",

2350

"port": "",

2351

"debug": "False",

2352

"priority":

2353

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

2354

"servicename": "Mandos",

2355

"use_dbus": "True",

2356

"use_ipv6": "True",

2357

"debuglevel": "",

2358

"restore": "True",

2359

"socket": "",

2360

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

2361

"foreground": "False",

2362

}

2363

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

2364

3010

# Parse config file for server-global settings

2365

server_config = configparser.SafeConfigParser(server_defaults)

3011

server_config = configparser.ConfigParser(server_defaults)

2366

3012

del server_defaults

2367

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

2368

"mandos.conf"))

2369

# Convert the SafeConfigParser object to a dict

3013

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

3014

# Convert the ConfigParser object to a dict

2370

3015

server_settings = server_config.defaults()

2371

3016

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

2372

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

3017

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

3018

"foreground", "zeroconf"):

2373

3019

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

2374

3020

option)

2375

3021

if server_settings["port"]:

2385

3031

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

2386

3032

["socket"])

2387

3033

del server_config

2388

3034

2389

3035

# Override the settings from the config file with command line

2390

3036

# options, if set.

2391

3037

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

2392

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

2393

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

2394

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

3038

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

3039

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

3040

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

2395

3041

value = getattr(options, option)

2396

3042

if value is not None:

2397

3043

server_settings[option] = value

2398

3044

del options

2399

3045

# Force all strings to be unicode

2400

3046

for option in server_settings.keys():

2401

if type(server_settings[option]) is str:

2402

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

3047

if isinstance(server_settings[option], bytes):

3048

server_settings[option] = (server_settings[option]

3049

.decode("utf-8"))

2403

3050

# Force all boolean options to be boolean

2404

3051

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

2405

"foreground"):

3052

"foreground", "zeroconf"):

2406

3053

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

2407

3054

# Debug implies foreground

2408

3055

if server_settings["debug"]:

2409

3056

server_settings["foreground"] = True

2410

3057

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

2411

3058

2412

3059

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

2413

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

2414

3066

# For convenience

2415

3067

debug = server_settings["debug"]

2416

3068

debuglevel = server_settings["debuglevel"]

2419

3071

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

2420

3072

stored_state_file)

2421

3073

foreground = server_settings["foreground"]

2422

3074

zeroconf = server_settings["zeroconf"]

3075

2423

3076

if debug:

2424

3077

initlogger(debug, logging.DEBUG)

2425

3078

else:

2428

3081

else:

2429

3082

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

2430

3083

initlogger(debug, level)

2431

3084

2432

3085

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

2433

syslogger.setFormatter(logging.Formatter

2434

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

2435

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

2436

.format(server_settings

2437

["servicename"])))

2438

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2439

3091

# Parse config file with clients

2440

client_config = configparser.SafeConfigParser(Client

2441

.client_defaults)

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2442

3093

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

2443

3094

"clients.conf"))

2444

3095

2445

3096

global mandos_dbus_service

2446

3097

mandos_dbus_service = None

2447

2448

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

2449

server_settings["port"]),

2450

ClientHandler,

2451

interface=(server_settings["interface"]

2452

or None),

2453

use_ipv6=use_ipv6,

2454

gnutls_priority=

2455

server_settings["priority"],

2456

use_dbus=use_dbus,

2457

socketfd=(server_settings["socket"]

2458

or None))

3098

3099

socketfd = None

3100

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

3101

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

2459

3110

if not foreground:

2460

3111

pidfilename = "/run/mandos.pid"

2461

3112

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

2462

3113

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

2463

3114

pidfile = None

2464

3115

try:

2465

pidfile = open(pidfilename, "w")

3116

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

2466

3117

except IOError as e:

2467

3118

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

2468

3119

exc_info=e)

2469

2470

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

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2471

3124

try:

2472

3125

uid = pwd.getpwnam(name).pw_uid

2473

gid = pwd.getpwnam(name).pw_gid

3126

gid = pwd.getpwnam(group).pw_gid

2474

3127

break

2475

3128

except KeyError:

2476

3129

continue

2480

3133

try:

2481

3134

os.setgid(gid)

2482

3135

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

2483

3139

except OSError as error:

3140

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

3141

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

2484

3142

if error.errno != errno.EPERM:

2485

3143

raise

2486

3144

2487

3145

if debug:

2488

3146

# Enable all possible GnuTLS debugging

2489

3147

2490

3148

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

2491

3149

# - GnuTLS manual

2492

gnutls.library.functions.gnutls_global_set_log_level(11)

2493

2494

@gnutls.library.types.gnutls_log_func

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2495

3153

def debug_gnutls(level, string):

2496

3154

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

2497

2498

(gnutls.library.functions

2499

.gnutls_global_set_log_function(debug_gnutls))

2500

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2501

3158

# Redirect stdin so all checkers get /dev/null

2502

3159

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

2503

3160

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

2504

3161

if null > 2:

2505

3162

os.close(null)

2506

3163

2507

3164

# Need to fork before connecting to D-Bus

2508

3165

if not foreground:

2509

3166

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

2510

3167

daemon()

2511

2512

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

2513

# need to inform gobject that threads will be used.

2514

gobject.threads_init()

2515

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

2516

3174

global main_loop

2517

3175

# From the Avahi example code

2518

3176

DBusGMainLoop(set_as_default=True)

2519

main_loop = gobject.MainLoop()

3177

main_loop = GLib.MainLoop()

2520

3178

bus = dbus.SystemBus()

2521

3179

# End of Avahi example code

2522

3180

if use_dbus:

2523

3181

try:

2524

3182

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

2525

bus, do_not_queue=True)

2526

old_bus_name = (dbus.service.BusName

2527

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

2528

do_not_queue=True))

2529

except dbus.exceptions.NameExistsException as e:

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

2530

3189

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

2531

3190

use_dbus = False

2532

3191

server_settings["use_dbus"] = False

2533

3192

tcp_server.use_dbus = False

2534

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2535

service = AvahiServiceToSyslog(name =

2536

server_settings["servicename"],

2537

servicetype = "_mandos._tcp",

2538

protocol = protocol, bus = bus)

2539

if server_settings["interface"]:

2540

service.interface = (if_nametoindex

2541

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

2542

3193

if zeroconf:

3194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

3200

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

2543

3204

global multiprocessing_manager

2544

3205

multiprocessing_manager = multiprocessing.Manager()

2545

3206

2546

3207

client_class = Client

2547

3208

if use_dbus:

2548

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

2549

3209

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

3210

2550

3211

client_settings = Client.config_parser(client_config)

2551

3212

old_client_settings = {}

2552

3213

clients_data = {}

2553

3214

2554

3215

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

2555

3216

global wnull

2556

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

3217

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

2557

3218

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

2558

3219

# mode

2559

3220

if debug or not foreground:

2560

3221

wnull.close()

2561

3222

2562

3223

# Get client data and settings from last running state.

2563

3224

if server_settings["restore"]:

2564

3225

try:

2565

3226

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

2566

clients_data, old_client_settings = (pickle.load

2567

(stored_state))

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name, .host, and .checker_command

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host and .checker_command

3272

for value in old_client_settings.values():

3273

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

3274

if isinstance(value[attribute], bytes):

3275

value[attribute] = (value[attribute]

3276

.decode("utf-8"))

2568

3277

os.remove(stored_state_path)

2569

3278

except IOError as e:

2570

3279

if e.errno == errno.ENOENT:

2571

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

2572

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

3280

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

3281

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

2573

3282

else:

2574

3283

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

2575

3284

exc_info=e)

2576

3285

raise

2577

3286

except EOFError as e:

2578

3287

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

2579

"EOFError:", exc_info=e)

2580

3288

"EOFError:",

3289

exc_info=e)

3290

2581

3291

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

3292

for client_name, client in clients_data.items():

2583

3293

# Skip removed clients

2584

3294

if client_name not in client_settings:

2585

3295

continue

2586

3296

2587

3297

# Decide which value to use after restoring saved state.

2588

3298

# We have three different values: Old config file,

2589

3299

# new config file, and saved state.

2594

3304

# For each value in new config, check if it

2595

3305

# differs from the old config value (Except for

2596

3306

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2600

3310

client[name] = value

2601

3311

except KeyError:

2602

3312

pass

2603

3313

2604

3314

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

3315

# enabled if its last checker was successful. A Client

2606

3316

# whose checker succeeded before we stored its state is

2607

3317

# assumed to have successfully run all checkers during

2608

3318

# downtime.

2610

3320

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

2611

3321

if not client["last_checked_ok"]:

2612

3322

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3323

"disabling client {} - Client never "

3324

"performed a successful checker".format(

3325

client_name))

2616

3326

client["enabled"] = False

2617

3327

elif client["last_checker_status"] != 0:

2618

3328

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3329

"disabling client {} - Client last"

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

client["last_checker_status"]))

2623

3334

client["enabled"] = False

2624

3335

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2628

3339

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3340

" keeping {} enabled".format(

3341

client_name))

2631

3342

try:

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2636

3346

except PGPError:

2637

3347

# If decryption fails, we use secret from new settings

2638

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

2639

.format(client_name))

2640

client["secret"] = (

2641

client_settings[client_name]["secret"])

2642

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2643

3353

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

2644

3354

for client_name in (set(old_client_settings)

2645

3355

- set(client_settings)):

2647

3357

for client_name in (set(client_settings)

2648

3358

- set(old_client_settings)):

2649

3359

clients_data[client_name] = client_settings[client_name]

2650

3360

2651

3361

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

3362

for client_name, client in clients_data.items():

2653

3363

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2657

3368

if not tcp_server.clients:

2658

3369

logger.warning("No clients defined")

2659

3370

2660

3371

if not foreground:

2661

3372

if pidfile is not None:

3373

pid = os.getpid()

2662

3374

try:

2663

3375

with pidfile:

2664

pid = os.getpid()

2665

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

3376

print(pid, file=pidfile)

2666

3377

except IOError:

2667

3378

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

2668

3379

pidfilename, pid)

2669

3380

del pidfile

2670

3381

del pidfilename

2671

2672

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

2673

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

2674

3382

3383

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

3384

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3385

lambda: main_loop.quit() and False)

3386

2675

3387

if use_dbus:

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2679

3392

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

3393

2680

3394

def __init__(self):

2681

3395

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

3396

2682

3397

_interface = "se.recompile.Mandos"

2683

2684

@dbus_interface_annotations(_interface)

2685

def _foo(self):

2686

return { "org.freedesktop.DBus.Property"

2687

".EmitsChangedSignal":

2688

"false"}

2689

3398

2690

3399

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

2691

3400

def ClientAdded(self, objpath):

2692

3401

"D-Bus signal"

2693

3402

pass

2694

3403

2695

3404

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

2696

def ClientNotFound(self, fingerprint, address):

3405

def ClientNotFound(self, key_id, address):

2697

3406

"D-Bus signal"

2698

3407

pass

2699

3408

3409

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

3410

"true"})

2700

3411

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

2701

3412

def ClientRemoved(self, objpath, name):

2702

3413

"D-Bus signal"

2703

3414

pass

2704

3415

3416

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

3417

"true"})

2705

3418

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

2706

3419

def GetAllClients(self):

2707

3420

"D-Bus method"

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3421

return dbus.Array(c.dbus_object_path for c in

3422

tcp_server.clients.values())

3423

3424

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

3425

"true"})

2712

3426

@dbus.service.method(_interface,

2713

3427

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

2714

3428

def GetAllClientsWithProperties(self):

2715

3429

"D-Bus method"

2716

3430

return dbus.Dictionary(

2717

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

2718

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

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2719

3434

signature="oa{sv}")

2720

3435

2721

3436

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

2722

3437

def RemoveClient(self, object_path):

2723

3438

"D-Bus method"

2724

for c in tcp_server.clients.itervalues():

3439

for c in tcp_server.clients.values():

2725

3440

if c.dbus_object_path == object_path:

2726

3441

del tcp_server.clients[c.name]

2727

3442

c.remove_from_connection()

2728

# Don't signal anything except ClientRemoved

3443

# Don't signal the disabling

2729

3444

c.disable(quiet=True)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2732

3447

return

2733

3448

raise KeyError(object_path)

2734

3449

2735

3450

del _interface

2736

3451

3452

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3453

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

3454

def GetManagedObjects(self):

3455

"""D-Bus method"""

3456

return dbus.Dictionary(

3457

{client.dbus_object_path:

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()})

3462

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

3463

3464

def client_added_signal(self, client):

3465

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

3466

if use_dbus:

3467

# New standard signal

3468

self.InterfacesAdded(

3469

client.dbus_object_path,

3470

dbus.Dictionary(

3471

{interface: client.GetAll(interface)

3472

for interface in

3473

client._get_all_interface_names()}))

3474

# Old signal

3475

self.ClientAdded(client.dbus_object_path)

3476

3477

def client_removed_signal(self, client):

3478

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

3479

if use_dbus:

3480

# New standard signal

3481

self.InterfacesRemoved(

3482

client.dbus_object_path,

3483

client._get_all_interface_names())

3484

# Old signal

3485

self.ClientRemoved(client.dbus_object_path,

3486

client.name)

3487

2737

3488

mandos_dbus_service = MandosDBusService()

2738

3489

3490

# Save modules to variables to exempt the modules from being

3491

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

3492

mp = multiprocessing

3493

wn = wnull

3494

2739

3495

def cleanup():

2740

3496

"Cleanup function; run on exit"

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3497

if zeroconf:

3498

service.cleanup()

3499

3500

mp.active_children()

3501

wn.close()

2745

3502

if not (tcp_server.clients or client_settings):

2746

3503

return

2747

3504

2748

3505

# Store client before exiting. Secrets are encrypted with key

2749

3506

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

2750

3507

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

2751

3508

clients = {}

2752

3509

with PGPEngine() as pgp:

2753

for client in tcp_server.clients.itervalues():

3510

for client in tcp_server.clients.values():

2754

3511

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

2755

3512

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

2756

3513

key)

2757

3514

client_dict = {}

2758

3515

2759

3516

# A list of attributes that can not be pickled

2760

3517

# + secret.

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2765

3522

exclude.add(name)

2766

3523

2767

3524

client_dict["encrypted_secret"] = (client

2768

3525

.encrypted_secret)

2769

3526

for attr in client.client_structure:

2770

3527

if attr not in exclude:

2771

3528

client_dict[attr] = getattr(client, attr)

2772

3529

2773

3530

clients[client.name] = client_dict

2774

3531

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

2775

3532

2776

3533

try:

2777

with (tempfile.NamedTemporaryFile

2778

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

2779

dir=os.path.dirname(stored_state_path),

2780

delete=False)) as stored_state:

2781

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

2782

tempname=stored_state.name

3534

with tempfile.NamedTemporaryFile(

3535

mode='wb',

3536

suffix=".pickle",

3537

prefix='clients-',

3538

dir=os.path.dirname(stored_state_path),

3539

delete=False) as stored_state:

3540

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

3541

protocol=2)

3542

tempname = stored_state.name

2783

3543

os.rename(tempname, stored_state_path)

2784

3544

except (IOError, OSError) as e:

2785

3545

if not debug:

2788

3548

except NameError:

2789

3549

pass

2790

3550

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

2791

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

3551

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

2792

3552

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

2793

3553

else:

2794

3554

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

2795

3555

exc_info=e)

2796

3556

raise

2797

3557

2798

3558

# Delete all clients, and settings from config

2799

3559

while tcp_server.clients:

2800

3560

name, client = tcp_server.clients.popitem()

2801

3561

if use_dbus:

2802

3562

client.remove_from_connection()

2803

# Don't signal anything except ClientRemoved

3563

# Don't signal the disabling

2804

3564

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

2805

3566

if use_dbus:

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3567

mandos_dbus_service.client_removed_signal(client)

2810

3568

client_settings.clear()

2811

3569

2812

3570

atexit.register(cleanup)

2813

2814

for client in tcp_server.clients.itervalues():

3571

3572

for client in tcp_server.clients.values():

2815

3573

if use_dbus:

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2818

3576

# Need to initiate checking of clients

2819

3577

if client.enabled:

2820

3578

client.init_checker()

2821

3579

2822

3580

tcp_server.enable()

2823

3581

tcp_server.server_activate()

2824

3582

2825

3583

# Find out what port we got

2826

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

3584

if zeroconf:

3585

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

2827

3586

if use_ipv6:

2828

3587

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

2829

3588

" flowinfo %d, scope_id %d",

2831

3590

else: # IPv4

2832

3591

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

2833

3592

*tcp_server.socket.getsockname())

2834

2835

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

2836

3593

3594

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

3595

2837

3596

try:

2838

# From the Avahi example code

2839

try:

2840

service.activate()

2841

except dbus.exceptions.DBusException as error:

2842

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

2843

cleanup()

2844

sys.exit(1)

2845

# End of Avahi example code

2846

2847

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

2848

lambda *args, **kwargs:

2849

(tcp_server.handle_request

2850

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

2851

3597

if zeroconf:

3598

# From the Avahi example code

3599

try:

3600

service.activate()

3601

except dbus.exceptions.DBusException as error:

3602

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

3603

cleanup()

3604

sys.exit(1)

3605

# End of Avahi example code

3606

3607

GLib.io_add_watch(

3608

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

3609

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3610

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

3611

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

3612

2852

3613

logger.debug("Starting main loop")

2853

3614

main_loop.run()

2854

3615

except AvahiError as error:

2863

3624

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

2864

3625

cleanup()

2865

3626

3627

3628

def should_only_run_tests():

3629

parser = argparse.ArgumentParser(add_help=False)

3630

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

3631

args, unknown_args = parser.parse_known_args()

3632

run_tests = args.check

3633

if run_tests:

3634

# Remove --check argument from sys.argv

3635

sys.argv[1:] = unknown_args

3636

return run_tests

3637

3638

# Add all tests from doctest strings

3639

def load_tests(loader, tests, none):

3640

import doctest

3641

tests.addTests(doctest.DocTestSuite())

3642

return tests

3643

2866

3644

if __name__ == '__main__':

2867

main()

3645

try:

3646

if should_only_run_tests():

3647

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

3648

unittest.main()

3649

else:

3650

main()

3651

finally:

3652

logging.shutdown()