/mandos/trunk : revision 1171

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -b

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

# This program is free software: you can redistribute it and/or modify

18

# it under the terms of the GNU General Public License as published by

14

15

16

#

17

# This file is part of Mandos.

18

#

19

# Mandos is free software: you can redistribute it and/or modify it

20

# under the terms of the GNU General Public License as published by

19

21

# the Free Software Foundation, either version 3 of the License, or

20

22

# (at your option) any later version.

21

23

#

22

# This program is distributed in the hope that it will be useful,

23

# but WITHOUT ANY WARRANTY; without even the implied warranty of

24

# Mandos is distributed in the hope that it will be useful, but

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

# You should have received a copy of the GNU General Public License

28

# along with this program. If not, see

29

# <http://www.gnu.org/licenses/>.

30

#

30

# along with Mandos. If not, see <http://www.gnu.org/licenses/>.

31

#

31

32

# Contact the authors at <mandos@recompile.se>.

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import unittest

72

81

73

82

import dbus

74

83

import dbus.service

75

import gobject

76

import avahi

84

import gi

85

from gi.repository import GLib

77

86

from dbus.mainloop.glib import DBusGMainLoop

78

87

import ctypes

79

88

import ctypes.util

80

89

import xml.dom.minidom

81

90

import inspect

82

91

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

95

# Show warnings by default

96

if not sys.warnoptions:

97

import warnings

98

warnings.simplefilter("default")

99

100

# Try to find the value of SO_BINDTODEVICE:

83

101

try:

102

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

103

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

84

104

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

105

except AttributeError:

86

106

try:

107

# This is where SO_BINDTODEVICE was up to and including Python

108

# 2.6, and also 3.2:

87

109

from IN import SO_BINDTODEVICE

88

110

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.5"

111

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

112

# Try running the C preprocessor:

113

try:

114

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

115

"/dev/stdin"],

116

stdin=subprocess.PIPE,

117

stdout=subprocess.PIPE)

118

stdout = cc.communicate(

119

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

120

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

121

except (OSError, ValueError, IndexError):

122

# No value found

123

SO_BINDTODEVICE = None

124

125

if sys.version_info.major == 2:

126

str = unicode

127

128

if sys.version_info < (3, 2):

129

configparser.Configparser = configparser.SafeConfigParser

130

131

version = "1.8.8"

92

132

stored_state_file = "clients.pickle"

93

133

94

134

logger = logging.getLogger()

135

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

95

136

syslogger = None

96

137

97

138

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

139

if_nametoindex = ctypes.cdll.LoadLibrary(

140

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

101

141

except (OSError, AttributeError):

142

102

143

def if_nametoindex(interface):

103

144

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

104

145

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

105

146

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

106

147

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

148

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

149

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

111

150

return interface_index

112

151

113

152

153

def copy_function(func):

154

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

155

if sys.version_info.major == 2:

156

return types.FunctionType(func.func_code,

157

func.func_globals,

158

func.func_name,

159

func.func_defaults,

160

func.func_closure)

161

else:

162

return types.FunctionType(func.__code__,

163

func.__globals__,

164

func.__name__,

165

func.__defaults__,

166

func.__closure__)

167

168

114

169

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

115

170

"""init logger and add loglevel"""

116

117

syslogger = (logging.handlers.SysLogHandler

118

(facility =

119

logging.handlers.SysLogHandler.LOG_DAEMON,

120

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

171

172

global syslogger

173

syslogger = (logging.handlers.SysLogHandler(

174

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

175

address="/dev/log"))

121

176

syslogger.setFormatter(logging.Formatter

122

177

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

123

178

' %(message)s'))

124

179

logger.addHandler(syslogger)

125

180

126

181

if debug:

127

182

console = logging.StreamHandler()

128

183

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

138

193

pass

139

194

140

195

141

class PGPEngine(object):

196

class PGPEngine:

142

197

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

198

143

199

def __init__(self):

144

200

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

201

self.gpg = "gpg"

202

try:

203

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

204

for line in output.splitlines():

205

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

206

if name == "gpg":

207

self.gpg = path

208

break

209

except OSError as e:

210

if e.errno != errno.ENOENT:

211

raise

145

212

self.gnupgargs = ['--batch',

146

'--home', self.tempdir,

213

'--homedir', self.tempdir,

147

214

'--force-mdc',

148

'--quiet',

149

'--no-use-agent']

150

215

'--quiet']

216

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

217

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

218

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

219

151

220

def __enter__(self):

152

221

return self

153

222

154

223

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

155

224

self._cleanup()

156

225

return False

157

226

158

227

def __del__(self):

159

228

self._cleanup()

160

229

161

230

def _cleanup(self):

162

231

if self.tempdir is not None:

163

232

# Delete contents of tempdir

164

233

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

165

topdown = False):

234

topdown=False):

166

235

for filename in files:

167

236

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

168

237

for dirname in dirs:

170

239

# Remove tempdir

171

240

os.rmdir(self.tempdir)

172

241

self.tempdir = None

173

242

174

243

def password_encode(self, password):

175

244

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

176

245

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

181

250

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

182

251

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

183

252

return encoded

184

253

185

254

def encrypt(self, data, password):

186

255

passphrase = self.password_encode(password)

187

with tempfile.NamedTemporaryFile(dir=self.tempdir

188

) as passfile:

256

with tempfile.NamedTemporaryFile(

257

dir=self.tempdir) as passfile:

189

258

passfile.write(passphrase)

190

259

passfile.flush()

191

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

260

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

192

261

'--passphrase-file',

193

262

passfile.name]

194

263

+ self.gnupgargs,

195

stdin = subprocess.PIPE,

196

stdout = subprocess.PIPE,

197

stderr = subprocess.PIPE)

198

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

264

stdin=subprocess.PIPE,

265

stdout=subprocess.PIPE,

266

stderr=subprocess.PIPE)

267

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

199

268

if proc.returncode != 0:

200

269

raise PGPError(err)

201

270

return ciphertext

202

271

203

272

def decrypt(self, data, password):

204

273

passphrase = self.password_encode(password)

205

with tempfile.NamedTemporaryFile(dir = self.tempdir

206

) as passfile:

274

with tempfile.NamedTemporaryFile(

275

dir=self.tempdir) as passfile:

207

276

passfile.write(passphrase)

208

277

passfile.flush()

209

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

278

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

210

279

'--passphrase-file',

211

280

passfile.name]

212

281

+ self.gnupgargs,

213

stdin = subprocess.PIPE,

214

stdout = subprocess.PIPE,

215

stderr = subprocess.PIPE)

216

decrypted_plaintext, err = proc.communicate(input

217

= data)

282

stdin=subprocess.PIPE,

283

stdout=subprocess.PIPE,

284

stderr=subprocess.PIPE)

285

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

218

286

if proc.returncode != 0:

219

287

raise PGPError(err)

220

288

return decrypted_plaintext

221

289

222

290

291

# Pretend that we have an Avahi module

292

class avahi:

293

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

294

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

295

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

296

PROTO_INET = 0 # avahi-common/address.h

297

PROTO_INET6 = 1 # avahi-common/address.h

298

DBUS_NAME = "org.freedesktop.Avahi"

299

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

300

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

301

DBUS_PATH_SERVER = "/"

302

303

@staticmethod

304

def string_array_to_txt_array(t):

305

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

306

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

307

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

308

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

309

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

310

SERVER_INVALID = 0 # avahi-common/defs.h

311

SERVER_REGISTERING = 1 # avahi-common/defs.h

312

SERVER_RUNNING = 2 # avahi-common/defs.h

313

SERVER_COLLISION = 3 # avahi-common/defs.h

314

SERVER_FAILURE = 4 # avahi-common/defs.h

315

316

223

317

class AvahiError(Exception):

224

318

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

225

319

self.value = value

226

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

227

def __unicode__(self):

228

return unicode(repr(self.value))

320

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

321

**kwargs)

322

229

323

230

324

class AvahiServiceError(AvahiError):

231

325

pass

232

326

327

233

328

class AvahiGroupError(AvahiError):

234

329

pass

235

330

236

331

237

class AvahiService(object):

332

class AvahiService:

238

333

"""An Avahi (Zeroconf) service.

239

334

240

335

Attributes:

241

336

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

242

337

Used to optionally bind to the specified interface.

254

349

server: D-Bus Server

255

350

bus: dbus.SystemBus()

256

351

"""

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

352

353

def __init__(self,

354

interface=avahi.IF_UNSPEC,

355

name=None,

356

servicetype=None,

357

port=None,

358

TXT=None,

359

domain="",

360

host="",

361

max_renames=32768,

362

protocol=avahi.PROTO_UNSPEC,

363

bus=None):

262

364

self.interface = interface

263

365

self.name = name

264

366

self.type = servicetype

273

375

self.server = None

274

376

self.bus = bus

275

377

self.entry_group_state_changed_match = None

276

277

def rename(self):

378

379

def rename(self, remove=True):

278

380

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

279

381

if self.rename_count >= self.max_renames:

280

382

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

281

383

" after %i retries, exiting.",

282

384

self.rename_count)

283

385

raise AvahiServiceError("Too many renames")

284

self.name = unicode(self.server

285

.GetAlternativeServiceName(self.name))

386

self.name = str(

387

self.server.GetAlternativeServiceName(self.name))

388

self.rename_count += 1

286

389

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

287

390

self.name)

288

self.remove()

391

if remove:

392

self.remove()

289

393

try:

290

394

self.add()

291

395

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

396

if (error.get_dbus_name()

397

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

398

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

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

404

297

405

def remove(self):

298

406

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

299

407

if self.entry_group_state_changed_match is not None:

301

409

self.entry_group_state_changed_match = None

302

410

if self.group is not None:

303

411

self.group.Reset()

304

412

305

413

def add(self):

306

414

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

307

415

self.remove()

324

432

dbus.UInt16(self.port),

325

433

avahi.string_array_to_txt_array(self.TXT))

326

434

self.group.Commit()

327

435

328

436

def entry_group_state_changed(self, state, error):

329

437

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

330

438

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

331

439

332

440

if state == avahi.ENTRY_GROUP_ESTABLISHED:

333

441

logger.debug("Zeroconf service established.")

334

442

elif state == avahi.ENTRY_GROUP_COLLISION:

336

444

self.rename()

337

445

elif state == avahi.ENTRY_GROUP_FAILURE:

338

446

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

339

unicode(error))

340

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

341

.format(error))

342

447

str(error))

448

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

449

343

450

def cleanup(self):

344

451

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

345

452

if self.group is not None:

350

457

pass

351

458

self.group = None

352

459

self.remove()

353

460

354

461

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

355

462

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

356

463

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

464

bad_states = {

465

avahi.SERVER_INVALID: "Zeroconf server invalid",

466

avahi.SERVER_REGISTERING: None,

467

avahi.SERVER_COLLISION: "Zeroconf server name collision",

468

avahi.SERVER_FAILURE: "Zeroconf server failure",

469

}

364

470

if state in bad_states:

365

471

if bad_states[state] is not None:

366

472

if error is None:

369

475

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

370

476

self.cleanup()

371

477

elif state == avahi.SERVER_RUNNING:

372

self.add()

478

try:

479

self.add()

480

except dbus.exceptions.DBusException as error:

481

if (error.get_dbus_name()

482

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

483

logger.info("Local Zeroconf service name"

484

" collision.")

485

return self.rename(remove=False)

486

else:

487

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

488

self.cleanup()

489

os._exit(1)

373

490

else:

374

491

if error is None:

375

492

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

376

493

else:

377

494

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

378

495

379

496

def activate(self):

380

497

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

381

498

if self.server is None:

385

502

follow_name_owner_changes=True),

386

503

avahi.DBUS_INTERFACE_SERVER)

387

504

self.server.connect_to_signal("StateChanged",

388

self.server_state_changed)

505

self.server_state_changed)

389

506

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

390

507

391

508

392

509

class AvahiServiceToSyslog(AvahiService):

393

def rename(self):

510

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

394

511

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

512

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

513

syslogger.setFormatter(logging.Formatter(

514

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

515

.format(self.name)))

400

516

return ret

401

517

402

518

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

519

# Pretend that we have a GnuTLS module

520

class gnutls:

521

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

522

523

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

524

if library is None:

525

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

526

_library = ctypes.cdll.LoadLibrary(library)

527

del library

528

529

# Unless otherwise indicated, the constants and types below are

530

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

531

532

# Constants

533

E_SUCCESS = 0

534

E_INTERRUPTED = -52

535

E_AGAIN = -28

536

CRT_OPENPGP = 2

537

CRT_RAWPK = 3

538

CLIENT = 2

539

SHUT_RDWR = 0

540

CRD_CERTIFICATE = 1

541

E_NO_CERTIFICATE_FOUND = -49

542

X509_FMT_DER = 0

543

NO_TICKETS = 1<<10

544

ENABLE_RAWPK = 1<<18

545

CTYPE_PEERS = 3

546

KEYID_USE_SHA256 = 1 # gnutls/x509.h

547

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

548

549

# Types

550

class session_int(ctypes.Structure):

551

_fields_ = []

552

session_t = ctypes.POINTER(session_int)

553

554

class certificate_credentials_st(ctypes.Structure):

555

_fields_ = []

556

certificate_credentials_t = ctypes.POINTER(

557

certificate_credentials_st)

558

certificate_type_t = ctypes.c_int

559

560

class datum_t(ctypes.Structure):

561

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

562

('size', ctypes.c_uint)]

563

564

class openpgp_crt_int(ctypes.Structure):

565

_fields_ = []

566

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

567

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

568

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

569

credentials_type_t = ctypes.c_int

570

transport_ptr_t = ctypes.c_void_p

571

close_request_t = ctypes.c_int

572

573

# Exceptions

574

class Error(Exception):

575

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

576

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

577

# code is passed, convert it to a string with

578

# gnutls.strerror()

579

self.code = code

580

if message is None and code is not None:

581

message = gnutls.strerror(code)

582

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

583

message, *args)

584

585

class CertificateSecurityError(Error):

586

pass

587

588

# Classes

589

class Credentials:

590

def __init__(self):

591

self._c_object = gnutls.certificate_credentials_t()

592

gnutls.certificate_allocate_credentials(

593

ctypes.byref(self._c_object))

594

self.type = gnutls.CRD_CERTIFICATE

595

596

def __del__(self):

597

gnutls.certificate_free_credentials(self._c_object)

598

599

class ClientSession:

600

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

601

self._c_object = gnutls.session_t()

602

gnutls_flags = gnutls.CLIENT

603

if gnutls.check_version(b"3.5.6"):

604

gnutls_flags |= gnutls.NO_TICKETS

605

if gnutls.has_rawpk:

606

gnutls_flags |= gnutls.ENABLE_RAWPK

607

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

608

del gnutls_flags

609

gnutls.set_default_priority(self._c_object)

610

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

611

gnutls.handshake_set_private_extensions(self._c_object,

612

True)

613

self.socket = socket

614

if credentials is None:

615

credentials = gnutls.Credentials()

616

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

617

ctypes.cast(credentials._c_object,

618

ctypes.c_void_p))

619

self.credentials = credentials

620

621

def __del__(self):

622

gnutls.deinit(self._c_object)

623

624

def handshake(self):

625

return gnutls.handshake(self._c_object)

626

627

def send(self, data):

628

data = bytes(data)

629

data_len = len(data)

630

while data_len > 0:

631

data_len -= gnutls.record_send(self._c_object,

632

data[-data_len:],

633

data_len)

634

635

def bye(self):

636

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

637

638

# Error handling functions

639

def _error_code(result):

640

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

641

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

642

if result >= 0:

643

return result

644

if result == gnutls.E_NO_CERTIFICATE_FOUND:

645

raise gnutls.CertificateSecurityError(code=result)

646

raise gnutls.Error(code=result)

647

648

def _retry_on_error(result, func, arguments):

649

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

650

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

651

while result < 0:

652

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

653

return _error_code(result)

654

result = func(*arguments)

655

return result

656

657

# Unless otherwise indicated, the function declarations below are

658

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

659

660

# Functions

661

priority_set_direct = _library.gnutls_priority_set_direct

662

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

663

ctypes.POINTER(ctypes.c_char_p)]

664

priority_set_direct.restype = _error_code

665

666

init = _library.gnutls_init

667

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

668

init.restype = _error_code

669

670

set_default_priority = _library.gnutls_set_default_priority

671

set_default_priority.argtypes = [session_t]

672

set_default_priority.restype = _error_code

673

674

record_send = _library.gnutls_record_send

675

record_send.argtypes = [session_t, ctypes.c_void_p,

676

ctypes.c_size_t]

677

record_send.restype = ctypes.c_ssize_t

678

record_send.errcheck = _retry_on_error

679

680

certificate_allocate_credentials = (

681

_library.gnutls_certificate_allocate_credentials)

682

certificate_allocate_credentials.argtypes = [

683

ctypes.POINTER(certificate_credentials_t)]

684

certificate_allocate_credentials.restype = _error_code

685

686

certificate_free_credentials = (

687

_library.gnutls_certificate_free_credentials)

688

certificate_free_credentials.argtypes = [

689

certificate_credentials_t]

690

certificate_free_credentials.restype = None

691

692

handshake_set_private_extensions = (

693

_library.gnutls_handshake_set_private_extensions)

694

handshake_set_private_extensions.argtypes = [session_t,

695

ctypes.c_int]

696

handshake_set_private_extensions.restype = None

697

698

credentials_set = _library.gnutls_credentials_set

699

credentials_set.argtypes = [session_t, credentials_type_t,

700

ctypes.c_void_p]

701

credentials_set.restype = _error_code

702

703

strerror = _library.gnutls_strerror

704

strerror.argtypes = [ctypes.c_int]

705

strerror.restype = ctypes.c_char_p

706

707

certificate_type_get = _library.gnutls_certificate_type_get

708

certificate_type_get.argtypes = [session_t]

709

certificate_type_get.restype = _error_code

710

711

certificate_get_peers = _library.gnutls_certificate_get_peers

712

certificate_get_peers.argtypes = [session_t,

713

ctypes.POINTER(ctypes.c_uint)]

714

certificate_get_peers.restype = ctypes.POINTER(datum_t)

715

716

global_set_log_level = _library.gnutls_global_set_log_level

717

global_set_log_level.argtypes = [ctypes.c_int]

718

global_set_log_level.restype = None

719

720

global_set_log_function = _library.gnutls_global_set_log_function

721

global_set_log_function.argtypes = [log_func]

722

global_set_log_function.restype = None

723

724

deinit = _library.gnutls_deinit

725

deinit.argtypes = [session_t]

726

deinit.restype = None

727

728

handshake = _library.gnutls_handshake

729

handshake.argtypes = [session_t]

730

handshake.restype = _error_code

731

handshake.errcheck = _retry_on_error

732

733

transport_set_ptr = _library.gnutls_transport_set_ptr

734

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

735

transport_set_ptr.restype = None

736

737

bye = _library.gnutls_bye

738

bye.argtypes = [session_t, close_request_t]

739

bye.restype = _error_code

740

bye.errcheck = _retry_on_error

741

742

check_version = _library.gnutls_check_version

743

check_version.argtypes = [ctypes.c_char_p]

744

check_version.restype = ctypes.c_char_p

745

746

_need_version = b"3.3.0"

747

if check_version(_need_version) is None:

748

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

749

.format(_need_version))

750

751

_tls_rawpk_version = b"3.6.6"

752

has_rawpk = bool(check_version(_tls_rawpk_version))

753

754

if has_rawpk:

755

# Types

756

class pubkey_st(ctypes.Structure):

757

_fields = []

758

pubkey_t = ctypes.POINTER(pubkey_st)

759

760

x509_crt_fmt_t = ctypes.c_int

761

762

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

763

pubkey_init = _library.gnutls_pubkey_init

764

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

765

pubkey_init.restype = _error_code

766

767

pubkey_import = _library.gnutls_pubkey_import

768

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

769

x509_crt_fmt_t]

770

pubkey_import.restype = _error_code

771

772

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

773

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

774

ctypes.POINTER(ctypes.c_ubyte),

775

ctypes.POINTER(ctypes.c_size_t)]

776

pubkey_get_key_id.restype = _error_code

777

778

pubkey_deinit = _library.gnutls_pubkey_deinit

779

pubkey_deinit.argtypes = [pubkey_t]

780

pubkey_deinit.restype = None

781

else:

782

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

783

784

openpgp_crt_init = _library.gnutls_openpgp_crt_init

785

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

786

openpgp_crt_init.restype = _error_code

787

788

openpgp_crt_import = _library.gnutls_openpgp_crt_import

789

openpgp_crt_import.argtypes = [openpgp_crt_t,

790

ctypes.POINTER(datum_t),

791

openpgp_crt_fmt_t]

792

openpgp_crt_import.restype = _error_code

793

794

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

795

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

796

ctypes.POINTER(ctypes.c_uint)]

797

openpgp_crt_verify_self.restype = _error_code

798

799

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

800

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

801

openpgp_crt_deinit.restype = None

802

803

openpgp_crt_get_fingerprint = (

804

_library.gnutls_openpgp_crt_get_fingerprint)

805

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

806

ctypes.c_void_p,

807

ctypes.POINTER(

808

ctypes.c_size_t)]

809

openpgp_crt_get_fingerprint.restype = _error_code

810

811

if check_version(b"3.6.4"):

812

certificate_type_get2 = _library.gnutls_certificate_type_get2

813

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

814

certificate_type_get2.restype = _error_code

815

816

# Remove non-public functions

817

del _error_code, _retry_on_error

818

819

820

def call_pipe(connection, # : multiprocessing.Connection

821

func, *args, **kwargs):

822

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

823

824

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

825

return value on the provided multiprocessing.Connection.

826

"""

827

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

828

connection.close()

829

830

831

class Client:

411

832

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

412

833

413

834

Attributes:

414

835

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

415

836

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

416

837

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

838

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

839

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

840

running.

841

checker_callback_tag: a GLib event source tag, or None

421

842

checker_command: string; External command which is run to check

422

843

if client lives. %() expansions are done at

423

844

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

424

845

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

425

checker_initiator_tag: a gobject event source tag, or None

846

checker_initiator_tag: a GLib event source tag, or None

426

847

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

427

848

client_structure: Object describing what attributes a client has

428

849

and is used for storing the client at exit

429

850

current_checker_command: string; current running checker_command

430

disable_initiator_tag: a gobject event source tag, or None

851

disable_initiator_tag: a GLib event source tag, or None

431

852

enabled: bool()

432

853

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

433

uniquely identify the client

854

uniquely identify an OpenPGP client

855

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

856

a client using raw public keys

434

857

host: string; available for use by the checker command

435

858

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

436

859

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

438

861

last_checker_status: integer between 0 and 255 reflecting exit

439

862

status of last checker. -1 reflects crashed

440

863

checker, -2 means no checker completed yet.

864

last_checker_signal: The signal which killed the last checker, if

865

last_checker_status is -1

441

866

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

442

867

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

443

868

D-Bus identifiers

450

875

disabled, or None

451

876

server_settings: The server_settings dict from main()

452

877

"""

453

878

454

879

runtime_expansions = ("approval_delay", "approval_duration",

455

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

880

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

456

881

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

457

882

"last_approval_request", "last_checked_ok",

458

883

"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

884

client_defaults = {

885

"timeout": "PT5M",

886

"extended_timeout": "PT15M",

887

"interval": "PT2M",

888

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

889

"host": "",

890

"approval_delay": "PT0S",

891

"approval_duration": "PT1S",

892

"approved_by_default": "True",

893

"enabled": "True",

894

}

895

485

896

@staticmethod

486

897

def config_parser(config):

487

898

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

494

905

for client_name in config.sections():

495

906

section = dict(config.items(client_name))

496

907

client = settings[client_name] = {}

497

908

498

909

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

499

910

# Reformat values from string types to Python types

500

911

client["approved_by_default"] = config.getboolean(

501

912

client_name, "approved_by_default")

502

913

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

503

914

"enabled")

504

915

916

# Uppercase and remove spaces from key_id and fingerprint

917

# for later comparison purposes with return value from the

918

# key_id() and fingerprint() functions

919

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

920

.replace(" ", ""))

505

921

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

506

922

.replace(" ", ""))

507

923

if "secret" in section:

508

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

924

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

925

.encode("utf-8"),

926

"base64")

509

927

elif "secfile" in section:

510

928

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

511

929

(section["secfile"])),

512

930

"rb") as secfile:

513

931

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

514

932

else:

515

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

933

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

516

934

.format(section))

517

935

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

518

936

client["extended_timeout"] = string_to_delta(

526

944

client["last_approval_request"] = None

527

945

client["last_checked_ok"] = None

528

946

client["last_checker_status"] = -2

529

947

530

948

return settings

531

532

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

949

950

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

533

951

self.name = name

534

952

if server_settings is None:

535

953

server_settings = {}

536

954

self.server_settings = server_settings

537

955

# adding all client settings

538

for setting, value in settings.iteritems():

956

for setting, value in settings.items():

539

957

setattr(self, setting, value)

540

958

541

959

if self.enabled:

542

960

if not hasattr(self, "last_enabled"):

543

961

self.last_enabled = datetime.datetime.utcnow()

547

965

else:

548

966

self.last_enabled = None

549

967

self.expires = None

550

968

551

969

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

970

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

555

971

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

556

972

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

557

973

datetime.datetime.utcnow())

558

974

559

975

# attributes specific for this server instance

560

976

self.checker = None

561

977

self.checker_initiator_tag = None

564

980

self.current_checker_command = None

565

981

self.approved = None

566

982

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

983

self.changedstate = multiprocessing_manager.Condition(

984

multiprocessing_manager.Lock())

985

self.client_structure = [attr

986

for attr in self.__dict__.keys()

572

987

if not attr.startswith("_")]

573

988

self.client_structure.append("client_structure")

574

575

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

576

lambda obj:

577

isinstance(obj,

578

property)):

989

990

for name, t in inspect.getmembers(

991

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

579

992

if not name.startswith("_"):

580

993

self.client_structure.append(name)

581

994

582

995

# Send notice to process children that client state has changed

583

996

def send_changedstate(self):

584

997

with self.changedstate:

585

998

self.changedstate.notify_all()

586

999

587

1000

def enable(self):

588

1001

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

589

1002

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

594

1007

self.last_enabled = datetime.datetime.utcnow()

595

1008

self.init_checker()

596

1009

self.send_changedstate()

597

1010

598

1011

def disable(self, quiet=True):

599

1012

"""Disable this client."""

600

1013

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

602

1015

if not quiet:

603

1016

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

604

1017

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

605

gobject.source_remove(self.disable_initiator_tag)

1018

GLib.source_remove(self.disable_initiator_tag)

606

1019

self.disable_initiator_tag = None

607

1020

self.expires = None

608

1021

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

609

gobject.source_remove(self.checker_initiator_tag)

1022

GLib.source_remove(self.checker_initiator_tag)

610

1023

self.checker_initiator_tag = None

611

1024

self.stop_checker()

612

1025

self.enabled = False

613

1026

if not quiet:

614

1027

self.send_changedstate()

615

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

1028

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

616

1029

return False

617

1030

618

1031

def __del__(self):

619

1032

self.disable()

620

1033

621

1034

def init_checker(self):

622

1035

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

623

1036

# and every interval from then on.

624

1037

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

1038

GLib.source_remove(self.checker_initiator_tag)

1039

self.checker_initiator_tag = GLib.timeout_add(

1040

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

1041

self.start_checker)

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

self.checker.join()

640

1057

self.checker_callback_tag = None

641

1058

self.checker = None

642

if os.WIFEXITED(condition):

643

self.last_checker_status = os.WEXITSTATUS(condition)

1059

1060

if returncode >= 0:

1061

self.last_checker_status = returncode

1062

self.last_checker_signal = None

644

1063

if self.last_checker_status == 0:

645

1064

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

646

1065

vars(self))

647

1066

self.checked_ok()

648

1067

else:

649

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

650

vars(self))

1068

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

651

1069

else:

652

1070

self.last_checker_status = -1

1071

self.last_checker_signal = -returncode

653

1072

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

654

1073

vars(self))

655

1074

return False

1075

656

1076

def checked_ok(self):

657

1077

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

658

1078

self.last_checked_ok = datetime.datetime.utcnow()

659

1079

self.last_checker_status = 0

1080

self.last_checker_signal = None

660

1081

self.bump_timeout()

661

1082

662

1083

def bump_timeout(self, timeout=None):

663

1084

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

664

1085

if timeout is None:

665

1086

timeout = self.timeout

666

1087

if self.disable_initiator_tag is not None:

667

gobject.source_remove(self.disable_initiator_tag)

1088

GLib.source_remove(self.disable_initiator_tag)

668

1089

self.disable_initiator_tag = None

669

1090

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

670

self.disable_initiator_tag = (gobject.timeout_add

671

(timedelta_to_milliseconds

672

(timeout), self.disable))

1091

self.disable_initiator_tag = GLib.timeout_add(

1092

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

673

1093

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

674

1094

675

1095

def need_approval(self):

676

1096

self.last_approval_request = datetime.datetime.utcnow()

677

1097

678

1098

def start_checker(self):

679

1099

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

680

1100

681

1101

If a checker already exists, leave it running and do

682

1102

nothing."""

683

1103

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

688

1108

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

689

1109

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

690

1110

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

1111

1112

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

1113

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

1114

self.checker.join()

1115

self.checker = None

706

1116

# Start a new checker if needed

707

1117

if self.checker is None:

708

1118

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

1119

escaped_attrs = {

1120

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

1121

for attr in self.runtime_expansions}

713

1122

try:

714

1123

command = self.checker_command % escaped_attrs

715

1124

except TypeError as error:

716

1125

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

717

self.checker_command, exc_info=error)

718

return True # Try again later

1126

self.checker_command,

1127

exc_info=error)

1128

return True # Try again later

719

1129

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

1130

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

1131

self.name)

1132

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

1133

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

1134

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

1135

# always replaced by /dev/null.)

1136

# The exception is when not debugging but nevertheless

1137

# running in the foreground; use the previously

1138

# created wnull.

1139

popen_args = {"close_fds": True,

1140

"shell": True,

1141

"cwd": "/"}

1142

if (not self.server_settings["debug"]

1143

and self.server_settings["foreground"]):

1144

popen_args.update({"stdout": wnull,

1145

"stderr": wnull})

1146

pipe = multiprocessing.Pipe(duplex=False)

1147

self.checker = multiprocessing.Process(

1148

target=call_pipe,

1149

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

1150

kwargs=popen_args)

1151

self.checker.start()

1152

self.checker_callback_tag = GLib.io_add_watch(

1153

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

1154

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1155

self.checker_callback, pipe[0], command)

1156

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

762

1157

return True

763

1158

764

1159

def stop_checker(self):

765

1160

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

766

1161

if self.checker_callback_tag:

767

gobject.source_remove(self.checker_callback_tag)

1162

GLib.source_remove(self.checker_callback_tag)

768

1163

self.checker_callback_tag = None

769

1164

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

770

1165

return

771

1166

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

1167

self.checker.terminate()

780

1168

self.checker = None

781

1169

782

1170

783

def dbus_service_property(dbus_interface, signature="v",

784

access="readwrite", byte_arrays=False):

1171

def dbus_service_property(dbus_interface,

1172

signature="v",

1173

access="readwrite",

1174

byte_arrays=False):

785

1175

"""Decorators for marking methods of a DBusObjectWithProperties to

786

1176

become properties on the D-Bus.

787

1177

788

1178

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

789

1179

and with one argument by "Set".

790

1180

791

1181

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

792

1182

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

793

1183

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

796

1186

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

797

1187

if byte_arrays and signature != "ay":

798

1188

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

799

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

1189

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

1190

800

1191

def decorator(func):

801

1192

func._dbus_is_property = True

802

1193

func._dbus_interface = dbus_interface

805

1196

func._dbus_name = func.__name__

806

1197

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

807

1198

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

808

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1199

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

809

1200

return func

1201

810

1202

return decorator

811

1203

812

1204

813

1205

def dbus_interface_annotations(dbus_interface):

814

1206

"""Decorator for marking functions returning interface annotations

815

1207

816

1208

Usage:

817

1209

818

1210

@dbus_interface_annotations("org.example.Interface")

819

1211

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

820

1212

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

821

1213

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

822

1214

"false"}

823

1215

"""

1216

824

1217

def decorator(func):

825

1218

func._dbus_is_interface = True

826

1219

func._dbus_interface = dbus_interface

827

1220

func._dbus_name = dbus_interface

828

1221

return func

1222

829

1223

return decorator

830

1224

831

1225

832

1226

def dbus_annotations(annotations):

833

1227

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

834

1228

Usage:

835

1229

1230

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

1231

"org.freedesktop.DBus.Property."

1232

"EmitsChangedSignal": "false"})

836

1233

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

837

1234

access="r")

838

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

839

"org.freedesktop.DBus.Property."

840

"EmitsChangedSignal": "false"})

841

1235

def Property_dbus_property(self):

842

1236

return dbus.Boolean(False)

1237

1238

See also the DBusObjectWithAnnotations class.

843

1239

"""

1240

844

1241

def decorator(func):

845

1242

func._dbus_annotations = annotations

846

1243

return func

1244

847

1245

return decorator

848

1246

849

1247

850

1248

class DBusPropertyException(dbus.exceptions.DBusException):

851

1249

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

852

1250

"""

853

def __unicode__(self):

854

return unicode(str(self))

1251

pass

855

1252

856

1253

857

1254

class DBusPropertyAccessException(DBusPropertyException):

866

1263

pass

867

1264

868

1265

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.

1266

class DBusObjectWithAnnotations(dbus.service.Object):

1267

"""A D-Bus object with annotations.

1268

1269

Classes inheriting from this can use the dbus_annotations

1270

decorator to add annotations to methods or signals.

875

1271

"""

876

1272

877

1273

@staticmethod

878

1274

def _is_dbus_thing(thing):

879

1275

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

880

1276

881

1277

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

882

1278

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

883

1279

"""

884

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

1280

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

885

1281

False)

886

1282

887

1283

def _get_all_dbus_things(self, thing):

888

1284

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

889

1285

"""

890

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

891

name),

1286

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

892

1287

athing.__get__(self))

893

1288

for cls in self.__class__.__mro__

894

1289

for name, athing in

895

inspect.getmembers(cls,

896

self._is_dbus_thing(thing)))

897

1290

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

1291

1292

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1293

out_signature="s",

1294

path_keyword='object_path',

1295

connection_keyword='connection')

1296

def Introspect(self, object_path, connection):

1297

"""Overloading of standard D-Bus method.

1298

1299

Inserts annotation tags on methods and signals.

1300

"""

1301

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

1302

connection)

1303

try:

1304

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

1305

1306

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

1307

# Add annotation tags

1308

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

1309

for tag in if_tag.getElementsByTagName(typ):

1310

annots = dict()

1311

for name, prop in (self.

1312

_get_all_dbus_things(typ)):

1313

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

1314

and prop._dbus_interface

1315

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

1316

annots.update(getattr(

1317

prop, "_dbus_annotations", {}))

1318

for name, value in annots.items():

1319

ann_tag = document.createElement(

1320

"annotation")

1321

ann_tag.setAttribute("name", name)

1322

ann_tag.setAttribute("value", value)

1323

tag.appendChild(ann_tag)

1324

# Add interface annotation tags

1325

for annotation, value in dict(

1326

itertools.chain.from_iterable(

1327

annotations().items()

1328

for name, annotations

1329

in self._get_all_dbus_things("interface")

1330

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

1331

)).items():

1332

ann_tag = document.createElement("annotation")

1333

ann_tag.setAttribute("name", annotation)

1334

ann_tag.setAttribute("value", value)

1335

if_tag.appendChild(ann_tag)

1336

# Fix argument name for the Introspect method itself

1337

if (if_tag.getAttribute("name")

1338

== dbus.INTROSPECTABLE_IFACE):

1339

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

1340

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

1341

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

1342

if (arg.getAttribute("direction")

1343

== "out"):

1344

arg.setAttribute("name",

1345

"xml_data")

1346

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

1347

document.unlink()

1348

except (AttributeError, xml.dom.DOMException,

1349

xml.parsers.expat.ExpatError) as error:

1350

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

1351

exc_info=error)

1352

return xmlstring

1353

1354

1355

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1356

"""A D-Bus object with properties.

1357

1358

Classes inheriting from this can use the dbus_service_property

1359

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

1360

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

1361

"""

1362

898

1363

def _get_dbus_property(self, interface_name, property_name):

899

1364

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

900

1365

property with the specified name and interface.

901

1366

"""

902

for cls in self.__class__.__mro__:

903

for name, value in (inspect.getmembers

904

(cls,

905

self._is_dbus_thing("property"))):

1367

for cls in self.__class__.__mro__:

1368

for name, value in inspect.getmembers(

1369

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

906

1370

if (value._dbus_name == property_name

907

1371

and value._dbus_interface == interface_name):

908

1372

return value.__get__(self)

909

1373

910

1374

# 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",

1375

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

1376

self.dbus_object_path, interface_name, property_name))

1377

1378

@classmethod

1379

def _get_all_interface_names(cls):

1380

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

1381

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

1382

"_dbus_interface", None)

1383

for x in (inspect.getmro(cls))

1384

for attr in dir(x))

1385

if name is not None)

1386

1387

@dbus.service.method(dbus.PROPERTIES_IFACE,

1388

in_signature="ss",

916

1389

out_signature="v")

917

1390

def Get(self, interface_name, property_name):

918

1391

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

924

1397

if not hasattr(value, "variant_level"):

925

1398

return value

926

1399

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

927

1400

928

1401

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

929

1402

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

930

1403

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

937

1410

# signatures other than "ay".

938

1411

if prop._dbus_signature != "ay":

939

1412

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

940

"'ay' signature {0!r}"

1413

"'ay' signature {!r}"

941

1414

.format(prop._dbus_signature))

942

1415

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

943

1416

for byte in 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

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host

3272

for value in old_client_settings.values():

3273

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

3274

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

3275

.decode("utf-8"))

2568

3276

os.remove(stored_state_path)

2569

3277

except IOError as e:

2570

3278

if e.errno == errno.ENOENT:

2571

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

2572

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

3279

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

3280

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

2573

3281

else:

2574

3282

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

2575

3283

exc_info=e)

2576

3284

raise

2577

3285

except EOFError as e:

2578

3286

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

2579

"EOFError:", exc_info=e)

2580

3287

"EOFError:",

3288

exc_info=e)

3289

2581

3290

with PGPEngine() as pgp:

2582

for client_name, client in clients_data.iteritems():

3291

for client_name, client in clients_data.items():

2583

3292

# Skip removed clients

2584

3293

if client_name not in client_settings:

2585

3294

continue

2586

3295

2587

3296

# Decide which value to use after restoring saved state.

2588

3297

# We have three different values: Old config file,

2589

3298

# new config file, and saved state.

2594

3303

# For each value in new config, check if it

2595

3304

# differs from the old config value (Except for

2596

3305

# the "secret" attribute)

2597

if (name != "secret" and

2598

value != old_client_settings[client_name]

2599

[name]):

3306

if (name != "secret"

3307

and (value !=

3308

old_client_settings[client_name][name])):

2600

3309

client[name] = value

2601

3310

except KeyError:

2602

3311

pass

2603

3312

2604

3313

# Clients who has passed its expire date can still be

2605

# enabled if its last checker was successful. Clients

3314

# enabled if its last checker was successful. A Client

2606

3315

# whose checker succeeded before we stored its state is

2607

3316

# assumed to have successfully run all checkers during

2608

3317

# downtime.

2610

3319

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

2611

3320

if not client["last_checked_ok"]:

2612

3321

logger.warning(

2613

"disabling client {0} - Client never "

2614

"performed a successful checker"

2615

.format(client_name))

3322

"disabling client {} - Client never "

3323

"performed a successful checker".format(

3324

client_name))

2616

3325

client["enabled"] = False

2617

3326

elif client["last_checker_status"] != 0:

2618

3327

logger.warning(

2619

"disabling client {0} - Client "

2620

"last checker failed with error code {1}"

2621

.format(client_name,

2622

client["last_checker_status"]))

3328

"disabling client {} - Client last"

3329

" checker failed with error code"

3330

" {}".format(

3331

client_name,

3332

client["last_checker_status"]))

2623

3333

client["enabled"] = False

2624

3334

else:

2625

client["expires"] = (datetime.datetime

2626

.utcnow()

2627

+ client["timeout"])

3335

client["expires"] = (

3336

datetime.datetime.utcnow()

3337

+ client["timeout"])

2628

3338

logger.debug("Last checker succeeded,"

2629

" keeping {0} enabled"

2630

.format(client_name))

3339

" keeping {} enabled".format(

3340

client_name))

2631

3341

try:

2632

client["secret"] = (

2633

pgp.decrypt(client["encrypted_secret"],

2634

client_settings[client_name]

2635

["secret"]))

3342

client["secret"] = pgp.decrypt(

3343

client["encrypted_secret"],

3344

client_settings[client_name]["secret"])

2636

3345

except PGPError:

2637

3346

# 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

3347

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

3348

client_name))

3349

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

3350

["secret"])

3351

2643

3352

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

2644

3353

for client_name in (set(old_client_settings)

2645

3354

- set(client_settings)):

2647

3356

for client_name in (set(client_settings)

2648

3357

- set(old_client_settings)):

2649

3358

clients_data[client_name] = client_settings[client_name]

2650

3359

2651

3360

# Create all client objects

2652

for client_name, client in clients_data.iteritems():

3361

for client_name, client in clients_data.items():

2653

3362

tcp_server.clients[client_name] = client_class(

2654

name = client_name, settings = client,

2655

server_settings = server_settings)

2656

3363

name=client_name,

3364

settings=client,

3365

server_settings=server_settings)

3366

2657

3367

if not tcp_server.clients:

2658

3368

logger.warning("No clients defined")

2659

3369

2660

3370

if not foreground:

2661

3371

if pidfile is not None:

3372

pid = os.getpid()

2662

3373

try:

2663

3374

with pidfile:

2664

pid = os.getpid()

2665

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

3375

print(pid, file=pidfile)

2666

3376

except IOError:

2667

3377

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

2668

3378

pidfilename, pid)

2669

3379

del pidfile

2670

3380

del pidfilename

2671

2672

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

2673

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

2674

3381

3382

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

3383

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3384

lambda: main_loop.quit() and False)

3385

2675

3386

if use_dbus:

2676

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

2677

"se.bsnet.fukt.Mandos"})

2678

class MandosDBusService(DBusObjectWithProperties):

3387

3388

@alternate_dbus_interfaces(

3389

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

3390

class MandosDBusService(DBusObjectWithObjectManager):

2679

3391

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

3392

2680

3393

def __init__(self):

2681

3394

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

3395

2682

3396

_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

3397

2690

3398

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

2691

3399

def ClientAdded(self, objpath):

2692

3400

"D-Bus signal"

2693

3401

pass

2694

3402

2695

3403

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

2696

def ClientNotFound(self, fingerprint, address):

3404

def ClientNotFound(self, key_id, address):

2697

3405

"D-Bus signal"

2698

3406

pass

2699

3407

3408

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

3409

"true"})

2700

3410

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

2701

3411

def ClientRemoved(self, objpath, name):

2702

3412

"D-Bus signal"

2703

3413

pass

2704

3414

3415

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

3416

"true"})

2705

3417

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

2706

3418

def GetAllClients(self):

2707

3419

"D-Bus method"

2708

return dbus.Array(c.dbus_object_path

2709

for c in

2710

tcp_server.clients.itervalues())

2711

3420

return dbus.Array(c.dbus_object_path for c in

3421

tcp_server.clients.values())

3422

3423

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

3424

"true"})

2712

3425

@dbus.service.method(_interface,

2713

3426

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

2714

3427

def GetAllClientsWithProperties(self):

2715

3428

"D-Bus method"

2716

3429

return dbus.Dictionary(

2717

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

2718

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

3430

{c.dbus_object_path: c.GetAll(

3431

"se.recompile.Mandos.Client")

3432

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

2719

3433

signature="oa{sv}")

2720

3434

2721

3435

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

2722

3436

def RemoveClient(self, object_path):

2723

3437

"D-Bus method"

2724

for c in tcp_server.clients.itervalues():

3438

for c in tcp_server.clients.values():

2725

3439

if c.dbus_object_path == object_path:

2726

3440

del tcp_server.clients[c.name]

2727

3441

c.remove_from_connection()

2728

# Don't signal anything except ClientRemoved

3442

# Don't signal the disabling

2729

3443

c.disable(quiet=True)

2730

# Emit D-Bus signal

2731

self.ClientRemoved(object_path, c.name)

3444

# Emit D-Bus signal for removal

3445

self.client_removed_signal(c)

2732

3446

return

2733

3447

raise KeyError(object_path)

2734

3448

2735

3449

del _interface

2736

3450

3451

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3452

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

3453

def GetManagedObjects(self):

3454

"""D-Bus method"""

3455

return dbus.Dictionary(

3456

{client.dbus_object_path:

3457

dbus.Dictionary(

3458

{interface: client.GetAll(interface)

3459

for interface in

3460

client._get_all_interface_names()})

3461

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

3462

3463

def client_added_signal(self, client):

3464

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

3465

if use_dbus:

3466

# New standard signal

3467

self.InterfacesAdded(

3468

client.dbus_object_path,

3469

dbus.Dictionary(

3470

{interface: client.GetAll(interface)

3471

for interface in

3472

client._get_all_interface_names()}))

3473

# Old signal

3474

self.ClientAdded(client.dbus_object_path)

3475

3476

def client_removed_signal(self, client):

3477

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

3478

if use_dbus:

3479

# New standard signal

3480

self.InterfacesRemoved(

3481

client.dbus_object_path,

3482

client._get_all_interface_names())

3483

# Old signal

3484

self.ClientRemoved(client.dbus_object_path,

3485

client.name)

3486

2737

3487

mandos_dbus_service = MandosDBusService()

2738

3488

3489

# Save modules to variables to exempt the modules from being

3490

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

3491

mp = multiprocessing

3492

wn = wnull

3493

2739

3494

def cleanup():

2740

3495

"Cleanup function; run on exit"

2741

service.cleanup()

2742

2743

multiprocessing.active_children()

2744

wnull.close()

3496

if zeroconf:

3497

service.cleanup()

3498

3499

mp.active_children()

3500

wn.close()

2745

3501

if not (tcp_server.clients or client_settings):

2746

3502

return

2747

3503

2748

3504

# Store client before exiting. Secrets are encrypted with key

2749

3505

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

2750

3506

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

2751

3507

clients = {}

2752

3508

with PGPEngine() as pgp:

2753

for client in tcp_server.clients.itervalues():

3509

for client in tcp_server.clients.values():

2754

3510

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

2755

3511

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

2756

3512

key)

2757

3513

client_dict = {}

2758

3514

2759

3515

# A list of attributes that can not be pickled

2760

3516

# + secret.

2761

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

2762

"checker", "server_settings"))

2763

for name, typ in (inspect.getmembers

2764

(dbus.service.Object)):

3517

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

3518

"checker", "server_settings"}

3519

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

3520

.Object):

2765

3521

exclude.add(name)

2766

3522

2767

3523

client_dict["encrypted_secret"] = (client

2768

3524

.encrypted_secret)

2769

3525

for attr in client.client_structure:

2770

3526

if attr not in exclude:

2771

3527

client_dict[attr] = getattr(client, attr)

2772

3528

2773

3529

clients[client.name] = client_dict

2774

3530

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

2775

3531

2776

3532

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

3533

with tempfile.NamedTemporaryFile(

3534

mode='wb',

3535

suffix=".pickle",

3536

prefix='clients-',

3537

dir=os.path.dirname(stored_state_path),

3538

delete=False) as stored_state:

3539

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

3540

protocol=2)

3541

tempname = stored_state.name

2783

3542

os.rename(tempname, stored_state_path)

2784

3543

except (IOError, OSError) as e:

2785

3544

if not debug:

2788

3547

except NameError:

2789

3548

pass

2790

3549

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

2791

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

3550

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

2792

3551

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

2793

3552

else:

2794

3553

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

2795

3554

exc_info=e)

2796

3555

raise

2797

3556

2798

3557

# Delete all clients, and settings from config

2799

3558

while tcp_server.clients:

2800

3559

name, client = tcp_server.clients.popitem()

2801

3560

if use_dbus:

2802

3561

client.remove_from_connection()

2803

# Don't signal anything except ClientRemoved

3562

# Don't signal the disabling

2804

3563

client.disable(quiet=True)

3564

# Emit D-Bus signal for removal

2805

3565

if use_dbus:

2806

# Emit D-Bus signal

2807

mandos_dbus_service.ClientRemoved(client

2808

.dbus_object_path,

2809

client.name)

3566

mandos_dbus_service.client_removed_signal(client)

2810

3567

client_settings.clear()

2811

3568

2812

3569

atexit.register(cleanup)

2813

2814

for client in tcp_server.clients.itervalues():

3570

3571

for client in tcp_server.clients.values():

2815

3572

if use_dbus:

2816

# Emit D-Bus signal

2817

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3573

# Emit D-Bus signal for adding

3574

mandos_dbus_service.client_added_signal(client)

2818

3575

# Need to initiate checking of clients

2819

3576

if client.enabled:

2820

3577

client.init_checker()

2821

3578

2822

3579

tcp_server.enable()

2823

3580

tcp_server.server_activate()

2824

3581

2825

3582

# Find out what port we got

2826

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

3583

if zeroconf:

3584

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

2827

3585

if use_ipv6:

2828

3586

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

2829

3587

" flowinfo %d, scope_id %d",

2831

3589

else: # IPv4

2832

3590

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

2833

3591

*tcp_server.socket.getsockname())

2834

2835

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

2836

3592

3593

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

3594

2837

3595

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

3596

if zeroconf:

3597

# From the Avahi example code

3598

try:

3599

service.activate()

3600

except dbus.exceptions.DBusException as error:

3601

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

3602

cleanup()

3603

sys.exit(1)

3604

# End of Avahi example code

3605

3606

GLib.io_add_watch(

3607

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

3608

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3609

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

3610

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

3611

2852

3612

logger.debug("Starting main loop")

2853

3613

main_loop.run()

2854

3614

except AvahiError as error:

2863

3623

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

2864

3624

cleanup()

2865

3625

3626

3627

def should_only_run_tests():

3628

parser = argparse.ArgumentParser(add_help=False)

3629

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

3630

args, unknown_args = parser.parse_known_args()

3631

run_tests = args.check

3632

if run_tests:

3633

# Remove --check argument from sys.argv

3634

sys.argv[1:] = unknown_args

3635

return run_tests

3636

3637

# Add all tests from doctest strings

3638

def load_tests(loader, tests, none):

3639

import doctest

3640

tests.addTests(doctest.DocTestSuite())

3641

return tests

3642

2866

3643

if __name__ == '__main__':

2867

main()

3644

try:

3645

if should_only_run_tests():

3646

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

3647

unittest.main()

3648

else:

3649

main()

3650

finally:

3651

logging.shutdown()