/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.2"

111

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

112

# Try running the C preprocessor:

113

try:

114

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

115

"/dev/stdin"],

116

stdin=subprocess.PIPE,

117

stdout=subprocess.PIPE)

118

stdout = cc.communicate(

119

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

120

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

121

except (OSError, ValueError, IndexError):

122

# No value found

123

SO_BINDTODEVICE = None

124

125

if sys.version_info.major == 2:

126

str = unicode

127

128

if sys.version_info < (3, 2):

129

configparser.Configparser = configparser.SafeConfigParser

130

131

version = "1.8.8"

92

132

stored_state_file = "clients.pickle"

93

133

94

134

logger = logging.getLogger()

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

135

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

136

syslogger = None

98

137

99

138

try:

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

139

if_nametoindex = ctypes.cdll.LoadLibrary(

140

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

103

141

except (OSError, AttributeError):

142

104

143

def if_nametoindex(interface):

105

144

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

106

145

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

107

146

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

108

147

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

148

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

149

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

113

150

return interface_index

114

151

115

152

153

def copy_function(func):

154

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

155

if sys.version_info.major == 2:

156

return types.FunctionType(func.func_code,

157

func.func_globals,

158

func.func_name,

159

func.func_defaults,

160

func.func_closure)

161

else:

162

return types.FunctionType(func.__code__,

163

func.__globals__,

164

func.__name__,

165

func.__defaults__,

166

func.__closure__)

167

168

116

169

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

117

170

"""init logger and add loglevel"""

118

171

172

global syslogger

173

syslogger = (logging.handlers.SysLogHandler(

174

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

175

address="/dev/log"))

119

176

syslogger.setFormatter(logging.Formatter

120

177

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

121

178

' %(message)s'))

122

179

logger.addHandler(syslogger)

123

180

124

181

if debug:

125

182

console = logging.StreamHandler()

126

183

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

136

193

pass

137

194

138

195

139

class PGPEngine(object):

196

class PGPEngine:

140

197

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

198

141

199

def __init__(self):

142

200

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

201

self.gpg = "gpg"

202

try:

203

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

204

for line in output.splitlines():

205

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

206

if name == "gpg":

207

self.gpg = path

208

break

209

except OSError as e:

210

if e.errno != errno.ENOENT:

211

raise

143

212

self.gnupgargs = ['--batch',

144

'--home', self.tempdir,

213

'--homedir', self.tempdir,

145

214

'--force-mdc',

146

'--quiet',

147

'--no-use-agent']

148

215

'--quiet']

216

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

217

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

218

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

219

149

220

def __enter__(self):

150

221

return self

151

222

152

223

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

153

224

self._cleanup()

154

225

return False

155

226

156

227

def __del__(self):

157

228

self._cleanup()

158

229

159

230

def _cleanup(self):

160

231

if self.tempdir is not None:

161

232

# Delete contents of tempdir

162

233

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

163

topdown = False):

234

topdown=False):

164

235

for filename in files:

165

236

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

166

237

for dirname in dirs:

168

239

# Remove tempdir

169

240

os.rmdir(self.tempdir)

170

241

self.tempdir = None

171

242

172

243

def password_encode(self, password):

173

244

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

174

245

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

179

250

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

180

251

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

181

252

return encoded

182

253

183

254

def encrypt(self, data, password):

184

255

passphrase = self.password_encode(password)

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

256

with tempfile.NamedTemporaryFile(

257

dir=self.tempdir) as passfile:

187

258

passfile.write(passphrase)

188

259

passfile.flush()

189

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

260

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

190

261

'--passphrase-file',

191

262

passfile.name]

192

263

+ self.gnupgargs,

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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)

197

268

if proc.returncode != 0:

198

269

raise PGPError(err)

199

270

return ciphertext

200

271

201

272

def decrypt(self, data, password):

202

273

passphrase = self.password_encode(password)

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

274

with tempfile.NamedTemporaryFile(

275

dir=self.tempdir) as passfile:

205

276

passfile.write(passphrase)

206

277

passfile.flush()

207

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

278

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

208

279

'--passphrase-file',

209

280

passfile.name]

210

281

+ self.gnupgargs,

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

282

stdin=subprocess.PIPE,

283

stdout=subprocess.PIPE,

284

stderr=subprocess.PIPE)

285

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

216

286

if proc.returncode != 0:

217

287

raise PGPError(err)

218

288

return decrypted_plaintext

219

289

220

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

221

317

class AvahiError(Exception):

222

318

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

223

319

self.value = value

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

320

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

321

**kwargs)

322

227

323

228

324

class AvahiServiceError(AvahiError):

229

325

pass

230

326

327

231

328

class AvahiGroupError(AvahiError):

232

329

pass

233

330

234

331

235

class AvahiService(object):

332

class AvahiService:

236

333

"""An Avahi (Zeroconf) service.

237

334

238

335

Attributes:

239

336

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

240

337

Used to optionally bind to the specified interface.

252

349

server: D-Bus Server

253

350

bus: dbus.SystemBus()

254

351

"""

255

256

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

257

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

258

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

259

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

260

364

self.interface = interface

261

365

self.name = name

262

366

self.type = servicetype

271

375

self.server = None

272

376

self.bus = bus

273

377

self.entry_group_state_changed_match = None

274

275

def rename(self):

378

379

def rename(self, remove=True):

276

380

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

277

381

if self.rename_count >= self.max_renames:

278

382

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

279

383

" after %i retries, exiting.",

280

384

self.rename_count)

281

385

raise AvahiServiceError("Too many renames")

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

386

self.name = str(

387

self.server.GetAlternativeServiceName(self.name))

388

self.rename_count += 1

284

389

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

285

390

self.name)

286

self.remove()

391

if remove:

392

self.remove()

287

393

try:

288

394

self.add()

289

395

except dbus.exceptions.DBusException as error:

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

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

295

405

def remove(self):

296

406

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

297

407

if self.entry_group_state_changed_match is not None:

299

409

self.entry_group_state_changed_match = None

300

410

if self.group is not None:

301

411

self.group.Reset()

302

412

303

413

def add(self):

304

414

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

305

415

self.remove()

322

432

dbus.UInt16(self.port),

323

433

avahi.string_array_to_txt_array(self.TXT))

324

434

self.group.Commit()

325

435

326

436

def entry_group_state_changed(self, state, error):

327

437

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

328

438

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

329

439

330

440

if state == avahi.ENTRY_GROUP_ESTABLISHED:

331

441

logger.debug("Zeroconf service established.")

332

442

elif state == avahi.ENTRY_GROUP_COLLISION:

334

444

self.rename()

335

445

elif state == avahi.ENTRY_GROUP_FAILURE:

336

446

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

337

unicode(error))

338

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

339

.format(error))

340

447

str(error))

448

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

449

341

450

def cleanup(self):

342

451

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

343

452

if self.group is not None:

348

457

pass

349

458

self.group = None

350

459

self.remove()

351

460

352

461

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

353

462

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

354

463

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

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"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

}

362

470

if state in bad_states:

363

471

if bad_states[state] is not None:

364

472

if error is None:

367

475

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

368

476

self.cleanup()

369

477

elif state == avahi.SERVER_RUNNING:

370

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)

371

490

else:

372

491

if error is None:

373

492

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

374

493

else:

375

494

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

376

495

377

496

def activate(self):

378

497

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

379

498

if self.server is None:

383

502

follow_name_owner_changes=True),

384

503

avahi.DBUS_INTERFACE_SERVER)

385

504

self.server.connect_to_signal("StateChanged",

386

self.server_state_changed)

505

self.server_state_changed)

387

506

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

388

507

389

508

390

509

class AvahiServiceToSyslog(AvahiService):

391

def rename(self):

510

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

392

511

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

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

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

398

516

return ret

399

517

400

518

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

406

407

408

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:

409

832

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

410

833

411

834

Attributes:

412

835

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

413

836

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

414

837

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

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

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

419

842

checker_command: string; External command which is run to check

420

843

if client lives. %() expansions are done at

421

844

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

422

845

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

423

checker_initiator_tag: a gobject event source tag, or None

846

checker_initiator_tag: a GLib event source tag, or None

424

847

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

425

848

client_structure: Object describing what attributes a client has

426

849

and is used for storing the client at exit

427

850

current_checker_command: string; current running checker_command

428

disable_initiator_tag: a gobject event source tag, or None

851

disable_initiator_tag: a GLib event source tag, or None

429

852

enabled: bool()

430

853

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

431

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

432

857

host: string; available for use by the checker command

433

858

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

434

859

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

436

861

last_checker_status: integer between 0 and 255 reflecting exit

437

862

status of last checker. -1 reflects crashed

438

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

439

866

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

440

867

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

441

868

D-Bus identifiers

448

875

disabled, or None

449

876

server_settings: The server_settings dict from main()

450

877

"""

451

878

452

879

runtime_expansions = ("approval_delay", "approval_duration",

453

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

880

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

454

881

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

455

882

"last_approval_request", "last_checked_ok",

456

883

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

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

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

483

896

@staticmethod

484

897

def config_parser(config):

485

898

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

492

905

for client_name in config.sections():

493

906

section = dict(config.items(client_name))

494

907

client = settings[client_name] = {}

495

908

496

909

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

497

910

# Reformat values from string types to Python types

498

911

client["approved_by_default"] = config.getboolean(

499

912

client_name, "approved_by_default")

500

913

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

501

914

"enabled")

502

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

503

921

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

504

922

.replace(" ", ""))

505

923

if "secret" in section:

506

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

924

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

925

.encode("utf-8"),

926

"base64")

507

927

elif "secfile" in section:

508

928

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

509

929

(section["secfile"])),

510

930

"rb") as secfile:

511

931

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

512

932

else:

513

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

933

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

514

934

.format(section))

515

935

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

516

936

client["extended_timeout"] = string_to_delta(

524

944

client["last_approval_request"] = None

525

945

client["last_checked_ok"] = None

526

946

client["last_checker_status"] = -2

527

947

528

948

return settings

529

530

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

949

950

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

531

951

self.name = name

532

952

if server_settings is None:

533

953

server_settings = {}

534

954

self.server_settings = server_settings

535

955

# adding all client settings

536

for setting, value in settings.iteritems():

956

for setting, value in settings.items():

537

957

setattr(self, setting, value)

538

958

539

959

if self.enabled:

540

960

if not hasattr(self, "last_enabled"):

541

961

self.last_enabled = datetime.datetime.utcnow()

545

965

else:

546

966

self.last_enabled = None

547

967

self.expires = None

548

968

549

969

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

970

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

553

971

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

554

972

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

555

973

datetime.datetime.utcnow())

556

974

557

975

# attributes specific for this server instance

558

976

self.checker = None

559

977

self.checker_initiator_tag = None

562

980

self.current_checker_command = None

563

981

self.approved = None

564

982

self.approvals_pending = 0

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

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

570

987

if not attr.startswith("_")]

571

988

self.client_structure.append("client_structure")

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

989

990

for name, t in inspect.getmembers(

991

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

577

992

if not name.startswith("_"):

578

993

self.client_structure.append(name)

579

994

580

995

# Send notice to process children that client state has changed

581

996

def send_changedstate(self):

582

997

with self.changedstate:

583

998

self.changedstate.notify_all()

584

999

585

1000

def enable(self):

586

1001

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

587

1002

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

592

1007

self.last_enabled = datetime.datetime.utcnow()

593

1008

self.init_checker()

594

1009

self.send_changedstate()

595

1010

596

1011

def disable(self, quiet=True):

597

1012

"""Disable this client."""

598

1013

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

600

1015

if not quiet:

601

1016

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

602

1017

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

603

gobject.source_remove(self.disable_initiator_tag)

1018

GLib.source_remove(self.disable_initiator_tag)

604

1019

self.disable_initiator_tag = None

605

1020

self.expires = None

606

1021

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

607

gobject.source_remove(self.checker_initiator_tag)

1022

GLib.source_remove(self.checker_initiator_tag)

608

1023

self.checker_initiator_tag = None

609

1024

self.stop_checker()

610

1025

self.enabled = False

611

1026

if not quiet:

612

1027

self.send_changedstate()

613

# 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

614

1029

return False

615

1030

616

1031

def __del__(self):

617

1032

self.disable()

618

1033

619

1034

def init_checker(self):

620

1035

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

621

1036

# and every interval from then on.

622

1037

if self.checker_initiator_tag is not None:

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

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)

627

1042

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

628

1043

if self.disable_initiator_tag is not None:

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

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)

633

1047

# Also start a new checker *right now*.

634

1048

self.start_checker()

635

636

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

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

637

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

638

1057

self.checker_callback_tag = None

639

1058

self.checker = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1059

1060

if returncode >= 0:

1061

self.last_checker_status = returncode

1062

self.last_checker_signal = None

642

1063

if self.last_checker_status == 0:

643

1064

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

644

1065

vars(self))

645

1066

self.checked_ok()

646

1067

else:

647

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

648

vars(self))

1068

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

649

1069

else:

650

1070

self.last_checker_status = -1

1071

self.last_checker_signal = -returncode

651

1072

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

652

1073

vars(self))

653

1074

return False

1075

654

1076

def checked_ok(self):

655

1077

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

656

1078

self.last_checked_ok = datetime.datetime.utcnow()

657

1079

self.last_checker_status = 0

1080

self.last_checker_signal = None

658

1081

self.bump_timeout()

659

1082

660

1083

def bump_timeout(self, timeout=None):

661

1084

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

662

1085

if timeout is None:

663

1086

timeout = self.timeout

664

1087

if self.disable_initiator_tag is not None:

665

gobject.source_remove(self.disable_initiator_tag)

1088

GLib.source_remove(self.disable_initiator_tag)

666

1089

self.disable_initiator_tag = None

667

1090

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1091

self.disable_initiator_tag = GLib.timeout_add(

1092

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

671

1093

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

672

1094

673

1095

def need_approval(self):

674

1096

self.last_approval_request = datetime.datetime.utcnow()

675

1097

676

1098

def start_checker(self):

677

1099

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

678

1100

679

1101

If a checker already exists, leave it running and do

680

1102

nothing."""

681

1103

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

686

1108

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

687

1109

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

688

1110

# should be.

689

690

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

691

try:

692

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

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

704

1116

# Start a new checker if needed

705

1117

if self.checker is None:

706

1118

# Escape attributes for the shell

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

1119

escaped_attrs = {

1120

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

1121

for attr in self.runtime_expansions}

711

1122

try:

712

1123

command = self.checker_command % escaped_attrs

713

1124

except TypeError as error:

714

1125

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

715

self.checker_command, exc_info=error)

716

return True # Try again later

1126

self.checker_command,

1127

exc_info=error)

1128

return True # Try again later

717

1129

self.current_checker_command = command

718

try:

719

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

720

command, self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

739

exc_info=error)

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

759

# 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

760

1157

return True

761

1158

762

1159

def stop_checker(self):

763

1160

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

764

1161

if self.checker_callback_tag:

765

gobject.source_remove(self.checker_callback_tag)

1162

GLib.source_remove(self.checker_callback_tag)

766

1163

self.checker_callback_tag = None

767

1164

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

768

1165

return

769

1166

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

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

1167

self.checker.terminate()

778

1168

self.checker = None

779

1169

780

1170

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1171

def dbus_service_property(dbus_interface,

1172

signature="v",

1173

access="readwrite",

1174

byte_arrays=False):

783

1175

"""Decorators for marking methods of a DBusObjectWithProperties to

784

1176

become properties on the D-Bus.

785

1177

786

1178

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

787

1179

and with one argument by "Set".

788

1180

789

1181

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

790

1182

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

791

1183

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

794

1186

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

795

1187

if byte_arrays and signature != "ay":

796

1188

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

797

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

1189

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

1190

798

1191

def decorator(func):

799

1192

func._dbus_is_property = True

800

1193

func._dbus_interface = dbus_interface

803

1196

func._dbus_name = func.__name__

804

1197

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

805

1198

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

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1199

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

807

1200

return func

1201

808

1202

return decorator

809

1203

810

1204

811

1205

def dbus_interface_annotations(dbus_interface):

812

1206

"""Decorator for marking functions returning interface annotations

813

1207

814

1208

Usage:

815

1209

816

1210

@dbus_interface_annotations("org.example.Interface")

817

1211

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

818

1212

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

819

1213

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

820

1214

"false"}

821

1215

"""

1216

822

1217

def decorator(func):

823

1218

func._dbus_is_interface = True

824

1219

func._dbus_interface = dbus_interface

825

1220

func._dbus_name = dbus_interface

826

1221

return func

1222

827

1223

return decorator

828

1224

829

1225

830

1226

def dbus_annotations(annotations):

831

1227

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

832

1228

Usage:

833

1229

1230

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

1231

"org.freedesktop.DBus.Property."

1232

"EmitsChangedSignal": "false"})

834

1233

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

835

1234

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

839

1235

def Property_dbus_property(self):

840

1236

return dbus.Boolean(False)

1237

1238

See also the DBusObjectWithAnnotations class.

841

1239

"""

1240

842

1241

def decorator(func):

843

1242

func._dbus_annotations = annotations

844

1243

return func

1244

845

1245

return decorator

846

1246

847

1247

848

1248

class DBusPropertyException(dbus.exceptions.DBusException):

849

1249

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

850

1250

"""

851

def __unicode__(self):

852

return unicode(str(self))

1251

pass

853

1252

854

1253

855

1254

class DBusPropertyAccessException(DBusPropertyException):

864

1263

pass

865

1264

866

1265

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

869

870

Classes inheriting from this can use the dbus_service_property

871

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

872

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.

873

1271

"""

874

1272

875

1273

@staticmethod

876

1274

def _is_dbus_thing(thing):

877

1275

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

878

1276

879

1277

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

880

1278

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

881

1279

"""

882

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

1280

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

883

1281

False)

884

1282

885

1283

def _get_all_dbus_things(self, thing):

886

1284

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

887

1285

"""

888

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

889

name),

1286

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

890

1287

athing.__get__(self))

891

1288

for cls in self.__class__.__mro__

892

1289

for name, athing in

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

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

896

1363

def _get_dbus_property(self, interface_name, property_name):

897

1364

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

898

1365

property with the specified name and interface.

899

1366

"""

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

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

904

1370

if (value._dbus_name == property_name

905

1371

and value._dbus_interface == interface_name):

906

1372

return value.__get__(self)

907

1373

908

1374

# No such property

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

912

913

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

914

1389

out_signature="v")

915

1390

def Get(self, interface_name, property_name):

916

1391

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

922

1397

if not hasattr(value, "variant_level"):

923

1398

return value

924

1399

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

925

1400

926

1401

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

927

1402

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

928

1403

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

935

1410

# signatures other than "ay".

936

1411

if prop._dbus_signature != "ay":

937

1412

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

938

"'ay' signature {0!r}"

1413

"'ay' signature {!r}"

939

1414

.format(prop._dbus_signature))

940

1415

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

941

1416

for byte in value))

942

1417

prop(value)

943

944

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

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

945

1421

out_signature="a{sv}")

946

1422

def GetAll(self, interface_name):

947

1423

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

948

1424

standard.

949

1425

950

1426

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

951

1427

"""

952

1428

properties = {}

962

1438

if not hasattr(value, "variant_level"):

963

1439

properties[name] = value

964

1440

continue

965

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

966

value.variant_level+1)

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

967

1443

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

968

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

969

1453

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

970

1454

out_signature="s",

971

1455

path_keyword='object_path',

972

1456

connection_keyword='connection')

973

1457

def Introspect(self, object_path, connection):

974

1458

"""Overloading of standard D-Bus method.

975

1459

976

1460

Inserts property tags and interface annotation tags.

977

1461

"""

978

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

979

connection)

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

980

1465

try:

981

1466

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

1467

982

1468

def make_tag(document, name, prop):

983

1469

e = document.createElement("property")

984

1470

e.setAttribute("name", name)

985

1471

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

986

1472

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

987

1473

return e

1474

988

1475

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

989

1476

# Add property tags

990

1477

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

993

1480

if prop._dbus_interface

994

1481

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

995

1482

if_tag.appendChild(tag)

996

# Add annotation tags

997

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

998

for tag in if_tag.getElementsByTagName(typ):

999

annots = dict()

1000

for name, prop in (self.

1001

_get_all_dbus_things(typ)):

1002

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

1003

and prop._dbus_interface

1004

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

1005

annots.update(getattr

1006

(prop,

1007

"_dbus_annotations",

1008

{}))

1009

for name, value in annots.iteritems():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

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)

1027

1499

# Add the names to the return values for the

1028

1500

# "org.freedesktop.DBus.Properties" methods

1029

1501

if (if_tag.getAttribute("name")

1048

1520

return xmlstring

1049

1521

1050

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

1051

1594

def datetime_to_dbus(dt, variant_level=0):

1052

1595

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

1053

1596

if dt is None:

1054

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

1055

return dbus.String(dt.isoformat(),

1056

variant_level=variant_level)

1597

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

1598

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

1057

1599

1058

1600

1059

1601

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1061

1603

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

1062

1604

interface names according to the "alt_interface_names" mapping.

1063

1605

Usage:

1064

1606

1065

1607

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

1066

1608

"net.example.AlternateInterface"})

1067

1609

class SampleDBusObject(dbus.service.Object):

1068

1610

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

1069

1611

def SampleDBusMethod():

1070

1612

pass

1071

1613

1072

1614

The above "SampleDBusMethod" on "SampleDBusObject" will be

1073

1615

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

1074

1616

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

1075

1617

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

1076

1618

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

1077

1619

1078

1620

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

1079

1621

(from DBusObjectWithProperties) and interfaces (from the

1080

1622

dbus_interface_annotations decorator).

1081

1623

"""

1624

1082

1625

def wrapper(cls):

1083

1626

for orig_interface_name, alt_interface_name in (

1084

alt_interface_names.iteritems()):

1627

alt_interface_names.items()):

1085

1628

attr = {}

1086

1629

interface_names = set()

1087

1630

# Go though all attributes of the class

1089

1632

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

1090

1633

# with the wrong interface name

1091

1634

if (not hasattr(attribute, "_dbus_interface")

1092

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1094

1637

continue

1095

1638

# Create an alternate D-Bus interface name based on

1096

1639

# the current name

1097

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1100

1642

interface_names.add(alt_interface)

1101

1643

# Is this a D-Bus signal?

1102

1644

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

1103

1645

# Extract the original non-method undecorated

1104

1646

# function by black magic

1105

nonmethod_func = (dict(

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1106

1649

zip(attribute.func_code.co_freevars,

1107

attribute.__closure__))["func"]

1108

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

1109

1657

# Create a new, but exactly alike, function

1110

1658

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

1111

1659

# with the alternate D-Bus interface name

1112

new_function = (dbus.service.signal

1113

(alt_interface,

1114

attribute._dbus_signature)

1115

(types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

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

1121

1664

# Copy annotations, if any

1122

1665

try:

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1125

1668

except AttributeError:

1126

1669

pass

1670

1127

1671

# Define a creator of a function to call both the

1128

1672

# original and alternate functions, so both the

1129

1673

# original and alternate signals gets sent when

1132

1676

"""This function is a scope container to pass

1133

1677

func1 and func2 to the "call_both" function

1134

1678

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1135

1681

def call_both(*args, **kwargs):

1136

1682

"""This function will emit two D-Bus

1137

1683

signals by calling func1 and func2"""

1138

1684

func1(*args, **kwargs)

1139

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

1140

1692

return call_both

1141

1693

# Create the "call_both" function and add it to

1142

1694

# the class

1147

1699

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

1148

1700

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

1149

1701

# to the class.

1150

attr[attrname] = (dbus.service.method

1151

(alt_interface,

1152

attribute._dbus_in_signature,

1153

attribute._dbus_out_signature)

1154

(types.FunctionType

1155

(attribute.func_code,

1156

attribute.func_globals,

1157

attribute.func_name,

1158

attribute.func_defaults,

1159

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

1160

1708

# Copy annotations, if any

1161

1709

try:

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1164

1712

except AttributeError:

1165

1713

pass

1166

1714

# Is this a D-Bus property?

1169

1717

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

1170

1718

# property with the alternate D-Bus interface

1171

1719

# name. Add it to the class.

1172

attr[attrname] = (dbus_service_property

1173

(alt_interface,

1174

attribute._dbus_signature,

1175

attribute._dbus_access,

1176

attribute

1177

._dbus_get_args_options

1178

["byte_arrays"])

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

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

1185

1726

# Copy annotations, if any

1186

1727

try:

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1189

1730

except AttributeError:

1190

1731

pass

1191

1732

# Is this a D-Bus interface?

1194

1735

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

1195

1736

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

1196

1737

# to the class.

1197

attr[attrname] = (dbus_interface_annotations

1198

(alt_interface)

1199

(types.FunctionType

1200

(attribute.func_code,

1201

attribute.func_globals,

1202

attribute.func_name,

1203

attribute.func_defaults,

1204

attribute.func_closure)))

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1205

1741

if deprecate:

1206

1742

# Deprecate all alternate interfaces

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1208

1744

for interface_name in interface_names:

1745

1209

1746

@dbus_interface_annotations(interface_name)

1210

1747

def func(self):

1211

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

1212

"true" }

1748

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

1749

"true"}

1213

1750

# Find an unused name

1214

1751

for aname in (iname.format(i)

1215

1752

for i in itertools.count()):

1219

1756

if interface_names:

1220

1757

# Replace the class with a new subclass of it with

1221

1758

# methods, signals, etc. as created above.

1222

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

1223

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

1224

1765

return cls

1766

1225

1767

return wrapper

1226

1768

1227

1769

1228

1770

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

1229

"se.bsnet.fukt.Mandos"})

1771

"se.bsnet.fukt.Mandos"})

1230

1772

class ClientDBus(Client, DBusObjectWithProperties):

1231

1773

"""A Client class using D-Bus

1232

1774

1233

1775

Attributes:

1234

1776

dbus_object_path: dbus.ObjectPath

1235

1777

bus: dbus.SystemBus()

1236

1778

"""

1237

1779

1238

1780

runtime_expansions = (Client.runtime_expansions

1239

+ ("dbus_object_path",))

1240

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1241

1785

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

1242

1243

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

1786

1787

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

1244

1788

self.bus = bus

1245

1789

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

1246

1790

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

1247

1791

# the D-Bus

1248

client_object_name = unicode(self.name).translate(

1792

client_object_name = str(self.name).translate(

1249

1793

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

1250

1794

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

1251

self.dbus_object_path = (dbus.ObjectPath

1252

("/clients/" + client_object_name))

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1253

1797

DBusObjectWithProperties.__init__(self, self.bus,

1254

1798

self.dbus_object_path)

1255

1256

def notifychangeproperty(transform_func,

1257

dbus_name, type_func=lambda x: x,

1258

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

1259

1805

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

1260

1806

its changes to DBus.

1261

1807

1262

1808

transform_fun: Function that takes a value and a variant_level

1263

1809

and transforms it to a D-Bus type.

1264

1810

dbus_name: D-Bus name of the variable

1266

1812

to the D-Bus. Default: no transform

1267

1813

variant_level: D-Bus variant level. Default: 1

1268

1814

"""

1269

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

1815

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

1816

1270

1817

def setter(self, value):

1271

1818

if hasattr(self, "dbus_object_path"):

1272

1819

if (not hasattr(self, attrname) or

1273

1820

type_func(getattr(self, attrname, None))

1274

1821

!= type_func(value)):

1275

dbus_value = transform_func(type_func(value),

1276

variant_level

1277

=variant_level)

1278

self.PropertyChanged(dbus.String(dbus_name),

1279

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

1280

1837

setattr(self, attrname, value)

1281

1838

1282

1839

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

1283

1840

1284

1841

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1285

1842

approvals_pending = notifychangeproperty(dbus.Boolean,

1286

1843

"ApprovalPending",

1287

type_func = bool)

1844

type_func=bool)

1288

1845

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

1289

1846

last_enabled = notifychangeproperty(datetime_to_dbus,

1290

1847

"LastEnabled")

1291

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

1292

type_func = lambda checker:

1293

checker is not None)

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1294

1851

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1295

1852

"LastCheckedOK")

1296

1853

last_checker_status = notifychangeproperty(dbus.Int16,

1299

1856

datetime_to_dbus, "LastApprovalRequest")

1300

1857

approved_by_default = notifychangeproperty(dbus.Boolean,

1301

1858

"ApprovedByDefault")

1302

approval_delay = notifychangeproperty(dbus.UInt64,

1303

"ApprovalDelay",

1304

type_func =

1305

timedelta_to_milliseconds)

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1306

1862

approval_duration = notifychangeproperty(

1307

1863

dbus.UInt64, "ApprovalDuration",

1308

type_func = timedelta_to_milliseconds)

1864

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

1309

1865

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

1310

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

1311

type_func =

1312

timedelta_to_milliseconds)

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1313

1869

extended_timeout = notifychangeproperty(

1314

1870

dbus.UInt64, "ExtendedTimeout",

1315

type_func = timedelta_to_milliseconds)

1316

interval = notifychangeproperty(dbus.UInt64,

1317

"Interval",

1318

type_func =

1319

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)

1320

1875

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

1321

1876

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

1877

invalidate_only=True)

1878

1322

1879

del notifychangeproperty

1323

1880

1324

1881

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

1325

1882

try:

1326

1883

self.remove_from_connection()

1329

1886

if hasattr(DBusObjectWithProperties, "__del__"):

1330

1887

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

1331

1888

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

1332

1333

def checker_callback(self, pid, condition, command,

1334

*args, **kwargs):

1335

self.checker_callback_tag = None

1336

self.checker = None

1337

if os.WIFEXITED(condition):

1338

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:

1339

1897

# Emit D-Bus signal

1340

1898

self.CheckerCompleted(dbus.Int16(exitstatus),

1341

dbus.Int64(condition),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1342

1901

dbus.String(command))

1343

1902

else:

1344

1903

# Emit D-Bus signal

1345

1904

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

1346

dbus.Int64(condition),

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1347

1909

dbus.String(command))

1348

1349

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

1350

*args, **kwargs)

1351

1910

return ret

1911

1352

1912

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

1353

old_checker = self.checker

1354

if self.checker is not None:

1355

old_checker_pid = self.checker.pid

1356

else:

1357

old_checker_pid = None

1913

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

1358

1914

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

1359

1915

# Only if new checker process was started

1360

1916

if (self.checker is not None

1362

1918

# Emit D-Bus signal

1363

1919

self.CheckerStarted(self.current_checker_command)

1364

1920

return r

1365

1921

1366

1922

def _reset_approved(self):

1367

1923

self.approved = None

1368

1924

return False

1369

1925

1370

1926

def approve(self, value=True):

1371

1927

self.approved = value

1372

gobject.timeout_add(timedelta_to_milliseconds

1373

(self.approval_duration),

1374

self._reset_approved)

1928

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

1929

* 1000), self._reset_approved)

1375

1930

self.send_changedstate()

1376

1377

## D-Bus methods, signals & properties

1378

_interface = "se.recompile.Mandos.Client"

1379

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

## Signals

1388

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1389

1938

# CheckerCompleted - signal

1390

1939

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

1391

1940

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

1392

1941

"D-Bus signal"

1393

1942

pass

1394

1943

1395

1944

# CheckerStarted - signal

1396

1945

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

1397

1946

def CheckerStarted(self, command):

1398

1947

"D-Bus signal"

1399

1948

pass

1400

1949

1401

1950

# PropertyChanged - signal

1951

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

1402

1952

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

1403

1953

def PropertyChanged(self, property, value):

1404

1954

"D-Bus signal"

1405

1955

pass

1406

1956

1407

1957

# GotSecret - signal

1408

1958

@dbus.service.signal(_interface)

1409

1959

def GotSecret(self):

1412

1962

server to mandos-client

1413

1963

"""

1414

1964

pass

1415

1965

1416

1966

# Rejected - signal

1417

1967

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

1418

1968

def Rejected(self, reason):

1419

1969

"D-Bus signal"

1420

1970

pass

1421

1971

1422

1972

# NeedApproval - signal

1423

1973

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

1424

1974

def NeedApproval(self, timeout, default):

1425

1975

"D-Bus signal"

1426

1976

return self.need_approval()

1427

1428

## Methods

1429

1977

1978

# Methods

1979

1430

1980

# Approve - method

1431

1981

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

1432

1982

def Approve(self, value):

1433

1983

self.approve(value)

1434

1984

1435

1985

# CheckedOK - method

1436

1986

@dbus.service.method(_interface)

1437

1987

def CheckedOK(self):

1438

1988

self.checked_ok()

1439

1989

1440

1990

# Enable - method

1991

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

1441

1992

@dbus.service.method(_interface)

1442

1993

def Enable(self):

1443

1994

"D-Bus method"

1444

1995

self.enable()

1445

1996

1446

1997

# StartChecker - method

1998

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

1447

1999

@dbus.service.method(_interface)

1448

2000

def StartChecker(self):

1449

2001

"D-Bus method"

1450

2002

self.start_checker()

1451

2003

1452

2004

# Disable - method

2005

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

1453

2006

@dbus.service.method(_interface)

1454

2007

def Disable(self):

1455

2008

"D-Bus method"

1456

2009

self.disable()

1457

2010

1458

2011

# StopChecker - method

2012

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

1459

2013

@dbus.service.method(_interface)

1460

2014

def StopChecker(self):

1461

2015

self.stop_checker()

1462

1463

## Properties

1464

2016

2017

# Properties

2018

1465

2019

# ApprovalPending - property

1466

2020

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

1467

2021

def ApprovalPending_dbus_property(self):

1468

2022

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

1469

2023

1470

2024

# ApprovedByDefault - property

1471

@dbus_service_property(_interface, signature="b",

2025

@dbus_service_property(_interface,

2026

signature="b",

1472

2027

access="readwrite")

1473

2028

def ApprovedByDefault_dbus_property(self, value=None):

1474

2029

if value is None: # get

1475

2030

return dbus.Boolean(self.approved_by_default)

1476

2031

self.approved_by_default = bool(value)

1477

2032

1478

2033

# ApprovalDelay - property

1479

@dbus_service_property(_interface, signature="t",

2034

@dbus_service_property(_interface,

2035

signature="t",

1480

2036

access="readwrite")

1481

2037

def ApprovalDelay_dbus_property(self, value=None):

1482

2038

if value is None: # get

1483

return dbus.UInt64(self.approval_delay_milliseconds())

2039

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

2040

* 1000)

1484

2041

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

1485

2042

1486

2043

# ApprovalDuration - property

1487

@dbus_service_property(_interface, signature="t",

2044

@dbus_service_property(_interface,

2045

signature="t",

1488

2046

access="readwrite")

1489

2047

def ApprovalDuration_dbus_property(self, value=None):

1490

2048

if value is None: # get

1491

return dbus.UInt64(timedelta_to_milliseconds(

1492

self.approval_duration))

2049

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

2050

* 1000)

1493

2051

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

1494

2052

1495

2053

# Name - property

2054

@dbus_annotations(

2055

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

1496

2056

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

1497

2057

def Name_dbus_property(self):

1498

2058

return dbus.String(self.name)

1499

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

1500

2067

# Fingerprint - property

2068

@dbus_annotations(

2069

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

1501

2070

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

1502

2071

def Fingerprint_dbus_property(self):

1503

2072

return dbus.String(self.fingerprint)

1504

2073

1505

2074

# Host - property

1506

@dbus_service_property(_interface, signature="s",

2075

@dbus_service_property(_interface,

2076

signature="s",

1507

2077

access="readwrite")

1508

2078

def Host_dbus_property(self, value=None):

1509

2079

if value is None: # get

1510

2080

return dbus.String(self.host)

1511

self.host = unicode(value)

1512

2081

self.host = str(value)

2082

1513

2083

# Created - property

2084

@dbus_annotations(

2085

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

1514

2086

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

1515

2087

def Created_dbus_property(self):

1516

2088

return datetime_to_dbus(self.created)

1517

2089

1518

2090

# LastEnabled - property

1519

2091

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

1520

2092

def LastEnabled_dbus_property(self):

1521

2093

return datetime_to_dbus(self.last_enabled)

1522

2094

1523

2095

# Enabled - property

1524

@dbus_service_property(_interface, signature="b",

2096

@dbus_service_property(_interface,

2097

signature="b",

1525

2098

access="readwrite")

1526

2099

def Enabled_dbus_property(self, value=None):

1527

2100

if value is None: # get

1530

2103

self.enable()

1531

2104

else:

1532

2105

self.disable()

1533

2106

1534

2107

# LastCheckedOK - property

1535

@dbus_service_property(_interface, signature="s",

2108

@dbus_service_property(_interface,

2109

signature="s",

1536

2110

access="readwrite")

1537

2111

def LastCheckedOK_dbus_property(self, value=None):

1538

2112

if value is not None:

1539

2113

self.checked_ok()

1540

2114

return

1541

2115

return datetime_to_dbus(self.last_checked_ok)

1542

2116

1543

2117

# LastCheckerStatus - property

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

2118

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

1546

2119

def LastCheckerStatus_dbus_property(self):

1547

2120

return dbus.Int16(self.last_checker_status)

1548

2121

1549

2122

# Expires - property

1550

2123

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

1551

2124

def Expires_dbus_property(self):

1552

2125

return datetime_to_dbus(self.expires)

1553

2126

1554

2127

# LastApprovalRequest - property

1555

2128

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

1556

2129

def LastApprovalRequest_dbus_property(self):

1557

2130

return datetime_to_dbus(self.last_approval_request)

1558

2131

1559

2132

# Timeout - property

1560

@dbus_service_property(_interface, signature="t",

2133

@dbus_service_property(_interface,

2134

signature="t",

1561

2135

access="readwrite")

1562

2136

def Timeout_dbus_property(self, value=None):

1563

2137

if value is None: # get

1564

return dbus.UInt64(self.timeout_milliseconds())

2138

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

1565

2139

old_timeout = self.timeout

1566

2140

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

1567

2141

# Reschedule disabling

1575

2149

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

1576

2150

is None):

1577

2151

return

1578

gobject.source_remove(self.disable_initiator_tag)

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1583

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

1584

2157

# ExtendedTimeout - property

1585

@dbus_service_property(_interface, signature="t",

2158

@dbus_service_property(_interface,

2159

signature="t",

1586

2160

access="readwrite")

1587

2161

def ExtendedTimeout_dbus_property(self, value=None):

1588

2162

if value is None: # get

1589

return dbus.UInt64(self.extended_timeout_milliseconds())

2163

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

2164

* 1000)

1590

2165

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

1591

2166

1592

2167

# Interval - property

1593

@dbus_service_property(_interface, signature="t",

2168

@dbus_service_property(_interface,

2169

signature="t",

1594

2170

access="readwrite")

1595

2171

def Interval_dbus_property(self, value=None):

1596

2172

if value is None: # get

1597

return dbus.UInt64(self.interval_milliseconds())

2173

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

1598

2174

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

1599

2175

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

1600

2176

return

1601

2177

if self.enabled:

1602

2178

# Reschedule checker run

1603

gobject.source_remove(self.checker_initiator_tag)

1604

self.checker_initiator_tag = (gobject.timeout_add

1605

(value, self.start_checker))

1606

self.start_checker() # Start one now, too

1607

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

1608

2184

# Checker - property

1609

@dbus_service_property(_interface, signature="s",

2185

@dbus_service_property(_interface,

2186

signature="s",

1610

2187

access="readwrite")

1611

2188

def Checker_dbus_property(self, value=None):

1612

2189

if value is None: # get

1613

2190

return dbus.String(self.checker_command)

1614

self.checker_command = unicode(value)

1615

2191

self.checker_command = str(value)

2192

1616

2193

# CheckerRunning - property

1617

@dbus_service_property(_interface, signature="b",

2194

@dbus_service_property(_interface,

2195

signature="b",

1618

2196

access="readwrite")

1619

2197

def CheckerRunning_dbus_property(self, value=None):

1620

2198

if value is None: # get

1623

2201

self.start_checker()

1624

2202

else:

1625

2203

self.stop_checker()

1626

2204

1627

2205

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

1628

2209

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

1629

2210

def ObjectPath_dbus_property(self):

1630

return self.dbus_object_path # is already a dbus.ObjectPath

1631

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1632

2213

# Secret = property

1633

@dbus_service_property(_interface, signature="ay",

1634

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)

1635

2221

def Secret_dbus_property(self, value):

1636

self.secret = str(value)

1637

2222

self.secret = bytes(value)

2223

1638

2224

del _interface

1639

2225

1640

2226

1641

class ProxyClient(object):

1642

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

2227

class ProxyClient:

2228

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

1643

2229

self._pipe = child_pipe

1644

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

2230

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

1645

2231

if not self._pipe.recv():

1646

raise KeyError()

1647

2232

raise KeyError(key_id or fpr)

2233

1648

2234

def __getattribute__(self, name):

1649

2235

if name == '_pipe':

1650

2236

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

1653

2239

if data[0] == 'data':

1654

2240

return data[1]

1655

2241

if data[0] == 'function':

2242

1656

2243

def func(*args, **kwargs):

1657

2244

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

1658

2245

return self._pipe.recv()[1]

2246

1659

2247

return func

1660

2248

1661

2249

def __setattr__(self, name, value):

1662

2250

if name == '_pipe':

1663

2251

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

1666

2254

1667

2255

class ClientHandler(socketserver.BaseRequestHandler, object):

1668

2256

"""A class to handle client connections.

1669

2257

1670

2258

Instantiated once for each connection to handle it.

1671

2259

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

1672

2260

1673

2261

def handle(self):

1674

2262

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

1675

2263

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

1676

unicode(self.client_address))

2264

str(self.client_address))

1677

2265

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

1678

2266

self.server.child_pipe.fileno())

1679

1680

session = (gnutls.connection

1681

.ClientSession(self.request,

1682

gnutls.connection

1683

.X509Credentials()))

1684

1685

# Note: gnutls.connection.X509Credentials is really a

1686

# generic GnuTLS certificate credentials object so long as

1687

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

1688

# here despite using OpenPGP certificates.

1689

1690

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

1691

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

1692

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

1693

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

1694

2274

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

1695

2275

priority = self.server.gnutls_priority

1696

2276

if priority is None:

1697

2277

priority = "NORMAL"

1698

(gnutls.library.functions

1699

.gnutls_priority_set_direct(session._c_object,

1700

priority, None))

1701

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1702

2282

# Start communication using the Mandos protocol

1703

2283

# Get protocol number

1704

2284

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

1709

2289

except (ValueError, IndexError, RuntimeError) as error:

1710

2290

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

1711

2291

return

1712

2292

1713

2293

# Start GnuTLS connection

1714

2294

try:

1715

2295

session.handshake()

1716

except gnutls.errors.GNUTLSError as error:

2296

except gnutls.Error as error:

1717

2297

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

1718

2298

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

1719

2299

# established. Just abandon the request.

1720

2300

return

1721

2301

logger.debug("Handshake succeeded")

1722

2302

1723

2303

approval_required = False

1724

2304

try:

1725

try:

1726

fpr = self.fingerprint(self.peer_certificate

1727

(session))

1728

except (TypeError,

1729

gnutls.errors.GNUTLSError) as error:

1730

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

1731

return

1732

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

1733

1734

try:

1735

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,

1736

2327

self.client_address)

1737

2328

except KeyError:

1738

2329

return

1739

2330

1740

2331

if client.approval_delay:

1741

2332

delay = client.approval_delay

1742

2333

client.approvals_pending += 1

1743

2334

approval_required = True

1744

2335

1745

2336

while True:

1746

2337

if not client.enabled:

1747

2338

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

1748

client.name)

2339

client.name)

1749

2340

if self.server.use_dbus:

1750

2341

# Emit D-Bus signal

1751

2342

client.Rejected("Disabled")

1752

2343

return

1753

2344

1754

2345

if client.approved or not client.approval_delay:

1755

#We are approved or approval is disabled

2346

# We are approved or approval is disabled

1756

2347

break

1757

2348

elif client.approved is None:

1758

2349

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

1760

2351

if self.server.use_dbus:

1761

2352

# Emit D-Bus signal

1762

2353

client.NeedApproval(

1763

client.approval_delay_milliseconds(),

1764

client.approved_by_default)

2354

client.approval_delay.total_seconds()

2355

* 1000, client.approved_by_default)

1765

2356

else:

1766

2357

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

1767

2358

client.name)

1769

2360

# Emit D-Bus signal

1770

2361

client.Rejected("Denied")

1771

2362

return

1772

1773

#wait until timeout or approved

2363

2364

# wait until timeout or approved

1774

2365

time = datetime.datetime.now()

1775

2366

client.changedstate.acquire()

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

2367

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

1779

2368

client.changedstate.release()

1780

2369

time2 = datetime.datetime.now()

1781

2370

if (time2 - time) >= delay:

1791

2380

break

1792

2381

else:

1793

2382

delay -= time2 - time

1794

1795

sent_size = 0

1796

while sent_size < len(client.secret):

1797

try:

1798

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

1799

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1802

return

1803

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

1804

sent, len(client.secret)

1805

- (sent_size + sent))

1806

sent_size += sent

1807

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

1808

2391

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

1809

2392

# bump the timeout using extended_timeout

1810

2393

client.bump_timeout(client.extended_timeout)

1811

2394

if self.server.use_dbus:

1812

2395

# Emit D-Bus signal

1813

2396

client.GotSecret()

1814

2397

1815

2398

finally:

1816

2399

if approval_required:

1817

2400

client.approvals_pending -= 1

1818

2401

try:

1819

2402

session.bye()

1820

except gnutls.errors.GNUTLSError as error:

2403

except gnutls.Error as error:

1821

2404

logger.warning("GnuTLS bye failed",

1822

2405

exc_info=error)

1823

2406

1824

2407

@staticmethod

1825

2408

def peer_certificate(session):

1826

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

1827

# If not an OpenPGP certificate...

1828

if (gnutls.library.functions

1829

.gnutls_certificate_type_get(session._c_object)

1830

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1831

# ...do the normal thing

1832

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

1833

2425

list_size = ctypes.c_uint(1)

1834

cert_list = (gnutls.library.functions

1835

.gnutls_certificate_get_peers

2426

cert_list = (gnutls.certificate_get_peers

1836

2427

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

1837

2428

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

1838

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

1839

" certificate")

2429

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

1840

2430

if list_size.value == 0:

1841

2431

return None

1842

2432

cert = cert_list[0]

1843

2433

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

1844

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

1845

2469

@staticmethod

1846

2470

def fingerprint(openpgp):

1847

2471

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1848

2472

# New GnuTLS "datum" with the OpenPGP public key

1849

datum = (gnutls.library.types

1850

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

1851

ctypes.POINTER

1852

(ctypes.c_ubyte)),

1853

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

1854

2477

# New empty GnuTLS certificate

1855

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1858

2480

# Import the OpenPGP public key into the certificate

1859

(gnutls.library.functions

1860

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

1861

gnutls.library.constants

1862

.GNUTLS_OPENPGP_FMT_RAW))

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1863

2483

# Verify the self signature in the key

1864

2484

crtverify = ctypes.c_uint()

1865

(gnutls.library.functions

1866

.gnutls_openpgp_crt_verify_self(crt, 0,

1867

ctypes.byref(crtverify)))

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1868

2487

if crtverify.value != 0:

1869

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1870

raise (gnutls.errors.CertificateSecurityError

1871

("Verify failed"))

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1872

2491

# New buffer for the fingerprint

1873

2492

buf = ctypes.create_string_buffer(20)

1874

2493

buf_len = ctypes.c_size_t()

1875

2494

# Get the fingerprint from the certificate into the buffer

1876

(gnutls.library.functions

1877

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

1878

ctypes.byref(buf_len)))

2495

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

2496

ctypes.byref(buf_len))

1879

2497

# Deinit the certificate

1880

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2498

gnutls.openpgp_crt_deinit(crt)

1881

2499

# Convert the buffer to a Python bytestring

1882

2500

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

1883

2501

# Convert the bytestring to hexadecimal notation

1885

2503

return hex_fpr

1886

2504

1887

2505

1888

class MultiprocessingMixIn(object):

2506

class MultiprocessingMixIn:

1889

2507

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

2508

1890

2509

def sub_process_main(self, request, address):

1891

2510

try:

1892

2511

self.finish_request(request, address)

1893

2512

except Exception:

1894

2513

self.handle_error(request, address)

1895

2514

self.close_request(request)

1896

2515

1897

2516

def process_request(self, request, address):

1898

2517

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

1899

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

1900

args = (request, address))

2518

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

2519

args=(request, address))

1901

2520

proc.start()

1902

2521

return proc

1903

2522

1904

2523

1905

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1906

2525

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

2526

1907

2527

def process_request(self, request, client_address):

1908

2528

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

1909

2529

1910

2530

This function creates a new pipe in self.pipe

1911

2531

"""

1912

2532

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1913

2533

1914

2534

proc = MultiprocessingMixIn.process_request(self, request,

1915

2535

client_address)

1916

2536

self.child_pipe.close()

1917

2537

self.add_pipe(parent_pipe, proc)

1918

2538

1919

2539

def add_pipe(self, parent_pipe, proc):

1920

2540

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

1921

2541

raise NotImplementedError()

1922

2542

1923

2543

1924

2544

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1925

socketserver.TCPServer, object):

2545

socketserver.TCPServer):

1926

2546

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

1927

2547

1928

2548

Attributes:

1929

2549

enabled: Boolean; whether this server is activated yet

1930

2550

interface: None or a network interface name (string)

1931

2551

use_ipv6: Boolean; to use IPv6 or not

1932

2552

"""

2553

1933

2554

def __init__(self, server_address, RequestHandlerClass,

1934

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

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1935

2558

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

1936

2559

creating a new one with socket.socket().

1937

2560

"""

1943

2566

self.socketfd = socketfd

1944

2567

# Save the original socket.socket() function

1945

2568

self.socket_socket = socket.socket

2569

1946

2570

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

1947

#

2571

#

1948

2572

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

1949

2573

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

1950

2574

# patching socket.socket.)

1951

#

2575

#

1952

2576

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

1953

2577

@functools.wraps(socket.socket)

1954

2578

def socket_wrapper(*args, **kwargs):

1966

2590

# socket_wrapper(), if socketfd was set.

1967

2591

socketserver.TCPServer.__init__(self, server_address,

1968

2592

RequestHandlerClass)

1969

2593

1970

2594

def server_bind(self):

1971

2595

"""This overrides the normal server_bind() function

1972

2596

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

1973

2597

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

2598

global SO_BINDTODEVICE

1974

2599

if self.interface is not None:

1975

2600

if SO_BINDTODEVICE is None:

1976

logger.error("SO_BINDTODEVICE does not exist;"

1977

" cannot bind to interface %s",

1978

self.interface)

1979

else:

1980

try:

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1982

SO_BINDTODEVICE,

1983

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

1984

except socket.error as error:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1989

logger.error("SO_BINDTODEVICE not available;"

1990

" cannot bind to interface %s",

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

else:

1996

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

1997

2622

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

1998

2623

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

1999

2626

if not self.server_address[0]:

2000

2627

if self.address_family == socket.AF_INET6:

2001

any_address = "::" # in6addr_any

2628

any_address = "::" # in6addr_any

2002

2629

else:

2003

any_address = "0.0.0.0" # INADDR_ANY

2630

any_address = "0.0.0.0" # INADDR_ANY

2004

2631

self.server_address = (any_address,

2005

2632

self.server_address[1])

2006

2633

elif not self.server_address[1]:

2007

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

2008

0)

2634

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

2009

2635

# if self.interface:

2010

2636

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

2011

2637

# 0, # port

2017

2643

2018

2644

class MandosServer(IPv6_TCPServer):

2019

2645

"""Mandos server.

2020

2646

2021

2647

Attributes:

2022

2648

clients: set of Client objects

2023

2649

gnutls_priority GnuTLS priority string

2024

2650

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

2025

2026

Assumes a gobject.MainLoop event loop.

2651

2652

Assumes a GLib.MainLoop event loop.

2027

2653

"""

2654

2028

2655

def __init__(self, server_address, RequestHandlerClass,

2029

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

2030

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

2031

2662

self.enabled = False

2032

2663

self.clients = clients

2033

2664

if self.clients is None:

2036

2667

self.gnutls_priority = gnutls_priority

2037

2668

IPv6_TCPServer.__init__(self, server_address,

2038

2669

RequestHandlerClass,

2039

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2042

2674

def server_activate(self):

2043

2675

if self.enabled:

2044

2676

return socketserver.TCPServer.server_activate(self)

2045

2677

2046

2678

def enable(self):

2047

2679

self.enabled = True

2048

2680

2049

2681

def add_pipe(self, parent_pipe, proc):

2050

2682

# Call "handle_ipc" for both data and EOF events

2051

gobject.io_add_watch(parent_pipe.fileno(),

2052

gobject.IO_IN | gobject.IO_HUP,

2053

functools.partial(self.handle_ipc,

2054

parent_pipe =

2055

parent_pipe,

2056

proc = proc))

2057

2058

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

2059

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

2060

2694

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

2061

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

2695

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

2062

2696

# Wait for other process to exit

2063

2697

proc.join()

2064

2698

return False

2065

2699

2066

2700

# Read a request from the child

2067

2701

request = parent_pipe.recv()

2068

2702

command = request[0]

2069

2703

2070

2704

if command == 'init':

2071

fpr = request[1]

2072

address = request[2]

2073

2074

for c in self.clients.itervalues():

2075

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:

2076

2716

client = c

2077

2717

break

2078

2718

else:

2079

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

2080

"dress: %s", fpr, address)

2719

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

2720

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

2081

2721

if self.use_dbus:

2082

2722

# Emit D-Bus signal

2083

mandos_dbus_service.ClientNotFound(fpr,

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2084

2724

address[0])

2085

2725

parent_pipe.send(False)

2086

2726

return False

2087

2088

gobject.io_add_watch(parent_pipe.fileno(),

2089

gobject.IO_IN | gobject.IO_HUP,

2090

functools.partial(self.handle_ipc,

2091

parent_pipe =

2092

parent_pipe,

2093

proc = proc,

2094

client_object =

2095

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

2096

2735

parent_pipe.send(True)

2097

2736

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

2098

2737

# same fileno

2101

2740

funcname = request[1]

2102

2741

args = request[2]

2103

2742

kwargs = request[3]

2104

2743

2105

2744

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

2106

2745

funcname)(*args,

2107

**kwargs)))

2108

2746

**kwargs)))

2747

2109

2748

if command == 'getattr':

2110

2749

attrname = request[1]

2111

if callable(client_object.__getattribute__(attrname)):

2112

parent_pipe.send(('function',))

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2113

2753

else:

2114

parent_pipe.send(('data', client_object

2115

.__getattribute__(attrname)))

2116

2754

parent_pipe.send((

2755

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

2756

2117

2757

if command == 'setattr':

2118

2758

attrname = request[1]

2119

2759

value = request[2]

2120

2760

setattr(client_object, attrname, value)

2121

2761

2122

2762

return True

2123

2763

2124

2764

2125

2765

def rfc3339_duration_to_delta(duration):

2126

2766

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

2127

2128

>>> rfc3339_duration_to_delta("P7D")

2129

datetime.timedelta(7)

2130

>>> rfc3339_duration_to_delta("PT60S")

2131

datetime.timedelta(0, 60)

2132

>>> rfc3339_duration_to_delta("PT60M")

2133

datetime.timedelta(0, 3600)

2134

>>> rfc3339_duration_to_delta("PT24H")

2135

datetime.timedelta(1)

2136

>>> rfc3339_duration_to_delta("P1W")

2137

datetime.timedelta(7)

2138

>>> rfc3339_duration_to_delta("PT5M30S")

2139

datetime.timedelta(0, 330)

2140

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

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

2142

2782

"""

2143

2783

2144

2784

# Parsing an RFC 3339 duration with regular expressions is not

2145

2785

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

2146

2786

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

2147

2787

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

2148

2788

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

2149

2789

# avoid excessive use of external libraries.

2150

2790

2151

2791

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

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# 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

2161

2797

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

2162

2798

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

2163

2799

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

2164

2800

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

2165

2801

datetime.timedelta(seconds=1),

2166

frozenset((token_end,)))

2802

frozenset((token_end, )))

2167

2803

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

2168

2804

datetime.timedelta(minutes=1),

2169

2805

frozenset((token_second, token_end)))

2185

2821

frozenset((token_month, token_end)))

2186

2822

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

2187

2823

datetime.timedelta(weeks=1),

2188

frozenset((token_end,)))

2824

frozenset((token_end, )))

2189

2825

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

2190

2826

frozenset((token_year, token_month,

2191

2827

token_day, token_time,

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2828

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2195

2832

found_token = None

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2198

2837

# Loop until end token is found

2199

2838

while found_token is not token_end:

2200

2839

# Search for any currently valid tokens

2216

2855

break

2217

2856

else:

2218

2857

# No currently valid tokens were found

2219

raise ValueError("Invalid RFC 3339 duration")

2858

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

2859

.format(duration))

2220

2860

# End token found

2221

2861

return value

2222

2862

2223

2863

2224

2864

def string_to_delta(interval):

2225

2865

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

2226

2227

>>> string_to_delta('7d')

2228

datetime.timedelta(7)

2229

>>> string_to_delta('60s')

2230

datetime.timedelta(0, 60)

2231

>>> string_to_delta('60m')

2232

datetime.timedelta(0, 3600)

2233

>>> string_to_delta('24h')

2234

datetime.timedelta(1)

2235

>>> string_to_delta('1w')

2236

datetime.timedelta(7)

2237

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

2238

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

2239

2879

"""

2240

2880

2241

2881

try:

2242

2882

return rfc3339_duration_to_delta(interval)

2243

2883

except ValueError:

2244

2884

pass

2245

2885

2246

2886

timevalue = datetime.timedelta(0)

2247

2887

for s in interval.split():

2248

2888

try:

2249

suffix = unicode(s[-1])

2889

suffix = s[-1]

2250

2890

value = int(s[:-1])

2251

2891

if suffix == "d":

2252

2892

delta = datetime.timedelta(value)

2259

2899

elif suffix == "w":

2260

2900

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

2261

2901

else:

2262

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

2263

.format(suffix))

2902

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

2264

2903

except IndexError as e:

2265

2904

raise ValueError(*(e.args))

2266

2905

timevalue += delta

2267

2906

return timevalue

2268

2907

2269

2908

2270

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

2909

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

2271

2910

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

2272

2911

2273

2912

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

2274

2913

if os.fork():

2275

2914

sys.exit()

2283

2922

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

2284

2923

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

2285

2924

raise OSError(errno.ENODEV,

2286

"{0} not a character device"

2925

"{} not a character device"

2287

2926

.format(os.devnull))

2288

2927

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

2289

2928

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

2293

2932

2294

2933

2295

2934

def main():

2296

2935

2297

2936

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

2298

2937

# Parsing of options, both command line and config file

2299

2938

2300

2939

parser = argparse.ArgumentParser()

2301

2940

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

2302

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

2941

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

2303

2942

help="show version number and exit")

2304

2943

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

2305

2944

help="Bind to interface IF")

2338

2977

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

2339

2978

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

2340

2979

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

2341

2980

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

2981

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

2982

default=None)

2983

2342

2984

options = parser.parse_args()

2343

2344

if options.check:

2345

import doctest

2346

doctest.testmod()

2347

sys.exit()

2348

2985

2349

2986

# Default values for config file for server-global settings

2350

server_defaults = { "interface": "",

2351

"address": "",

2352

"port": "",

2353

"debug": "False",

2354

"priority":

2355

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

2356

"servicename": "Mandos",

2357

"use_dbus": "True",

2358

"use_ipv6": "True",

2359

"debuglevel": "",

2360

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2364

}

2365

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

2366

3010

# Parse config file for server-global settings

2367

server_config = configparser.SafeConfigParser(server_defaults)

3011

server_config = configparser.ConfigParser(server_defaults)

2368

3012

del server_defaults

2369

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

2370

"mandos.conf"))

2371

# 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

2372

3015

server_settings = server_config.defaults()

2373

3016

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

2374

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

3017

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

3018

"foreground", "zeroconf"):

2375

3019

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

2376

3020

option)

2377

3021

if server_settings["port"]:

2387

3031

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

2388

3032

["socket"])

2389

3033

del server_config

2390

3034

2391

3035

# Override the settings from the config file with command line

2392

3036

# options, if set.

2393

3037

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

2394

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

2395

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

2396

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

3038

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

3039

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

3040

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

2397

3041

value = getattr(options, option)

2398

3042

if value is not None:

2399

3043

server_settings[option] = value

2400

3044

del options

2401

3045

# Force all strings to be unicode

2402

3046

for option in server_settings.keys():

2403

if type(server_settings[option]) is str:

2404

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

2405

3050

# Force all boolean options to be boolean

2406

3051

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

2407

"foreground"):

3052

"foreground", "zeroconf"):

2408

3053

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

2409

3054

# Debug implies foreground

2410

3055

if server_settings["debug"]:

2411

3056

server_settings["foreground"] = True

2412

3057

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

2413

3058

2414

3059

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

2415

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

2416

3066

# For convenience

2417

3067

debug = server_settings["debug"]

2418

3068

debuglevel = server_settings["debuglevel"]

2421

3071

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

2422

3072

stored_state_file)

2423

3073

foreground = server_settings["foreground"]

2424

3074

zeroconf = server_settings["zeroconf"]

3075

2425

3076

if debug:

2426

3077

initlogger(debug, logging.DEBUG)

2427

3078

else:

2430

3081

else:

2431

3082

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

2432

3083

initlogger(debug, level)

2433

3084

2434

3085

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

2435

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2440

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2441

3091

# Parse config file with clients

2442

client_config = configparser.SafeConfigParser(Client

2443

.client_defaults)

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2444

3093

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

2445

3094

"clients.conf"))

2446

3095

2447

3096

global mandos_dbus_service

2448

3097

mandos_dbus_service = None

2449

2450

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

2451

server_settings["port"]),

2452

ClientHandler,

2453

interface=(server_settings["interface"]

2454

or None),

2455

use_ipv6=use_ipv6,

2456

gnutls_priority=

2457

server_settings["priority"],

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

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)

2461

3110

if not foreground:

2462

3111

pidfilename = "/run/mandos.pid"

2463

3112

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

2464

3113

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

2465

3114

pidfile = None

2466

3115

try:

2467

pidfile = open(pidfilename, "w")

3116

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

2468

3117

except IOError as e:

2469

3118

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

2470

3119

exc_info=e)

2471

2472

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

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2473

3124

try:

2474

3125

uid = pwd.getpwnam(name).pw_uid

2475

gid = pwd.getpwnam(name).pw_gid

3126

gid = pwd.getpwnam(group).pw_gid

2476

3127

break

2477

3128

except KeyError:

2478

3129

continue

2482

3133

try:

2483

3134

os.setgid(gid)

2484

3135

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

2485

3139

except OSError as error:

3140

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

3141

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

2486

3142

if error.errno != errno.EPERM:

2487

3143

raise

2488

3144

2489

3145

if debug:

2490

3146

# Enable all possible GnuTLS debugging

2491

3147

2492

3148

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

2493

3149

# - GnuTLS manual

2494

gnutls.library.functions.gnutls_global_set_log_level(11)

2495

2496

@gnutls.library.types.gnutls_log_func

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2497

3153

def debug_gnutls(level, string):

2498

3154

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

2499

2500

(gnutls.library.functions

2501

.gnutls_global_set_log_function(debug_gnutls))

2502

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2503

3158

# Redirect stdin so all checkers get /dev/null

2504

3159

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

2505

3160

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

2506

3161

if null > 2:

2507

3162

os.close(null)

2508

3163

2509

3164

# Need to fork before connecting to D-Bus

2510

3165

if not foreground:

2511

3166

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

2512

3167

daemon()

2513

2514

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

2515

# need to inform gobject that threads will be used.

2516

gobject.threads_init()

2517

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

2518

3174

global main_loop

2519

3175

# From the Avahi example code

2520

3176

DBusGMainLoop(set_as_default=True)

2521

main_loop = gobject.MainLoop()

3177

main_loop = GLib.MainLoop()

2522

3178

bus = dbus.SystemBus()

2523

3179

# End of Avahi example code

2524

3180

if use_dbus:

2525

3181

try:

2526

3182

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

2527

bus, do_not_queue=True)

2528

old_bus_name = (dbus.service.BusName

2529

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

2530

do_not_queue=True))

2531

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:

2532

3189

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

2533

3190

use_dbus = False

2534

3191

server_settings["use_dbus"] = False

2535

3192

tcp_server.use_dbus = False

2536

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2537

service = AvahiServiceToSyslog(name =

2538

server_settings["servicename"],

2539

servicetype = "_mandos._tcp",

2540

protocol = protocol, bus = bus)

2541

if server_settings["interface"]:

2542

service.interface = (if_nametoindex

2543

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

2544

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

2545

3204

global multiprocessing_manager

2546

3205

multiprocessing_manager = multiprocessing.Manager()

2547

3206

2548

3207

client_class = Client

2549

3208

if use_dbus:

2550

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

2551

3209

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

3210

2552

3211

client_settings = Client.config_parser(client_config)

2553

3212

old_client_settings = {}

2554

3213

clients_data = {}

2555

3214

2556

3215

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

2557

3216

global wnull

2558

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

3217

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

2559

3218

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

2560

3219

# mode

2561

3220

if debug or not foreground:

2562

3221

wnull.close()

2563

3222

2564

3223

# Get client data and settings from last running state.

2565

3224

if server_settings["restore"]:

2566

3225

try:

2567

3226

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

2568

clients_data, old_client_settings = (pickle.load

2569

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

2570

3276

os.remove(stored_state_path)

2571

3277

except IOError as e:

2572

3278

if e.errno == errno.ENOENT:

2573

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

2574

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

3279

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

3280

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

2575

3281

else:

2576

3282

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

2577

3283

exc_info=e)

2578

3284

raise

2579

3285

except EOFError as e:

2580

3286

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

2581

"EOFError:", exc_info=e)

2582

3287

"EOFError:",

3288

exc_info=e)

3289

2583

3290

with PGPEngine() as pgp:

2584

for client_name, client in clients_data.iteritems():

3291

for client_name, client in clients_data.items():

2585

3292

# Skip removed clients

2586

3293

if client_name not in client_settings:

2587

3294

continue

2588

3295

2589

3296

# Decide which value to use after restoring saved state.

2590

3297

# We have three different values: Old config file,

2591

3298

# new config file, and saved state.

2596

3303

# For each value in new config, check if it

2597

3304

# differs from the old config value (Except for

2598

3305

# the "secret" attribute)

2599

if (name != "secret" and

2600

value != old_client_settings[client_name]

2601

[name]):

3306

if (name != "secret"

3307

and (value !=

3308

old_client_settings[client_name][name])):

2602

3309

client[name] = value

2603

3310

except KeyError:

2604

3311

pass

2605

3312

2606

3313

# Clients who has passed its expire date can still be

2607

# enabled if its last checker was successful. Clients

3314

# enabled if its last checker was successful. A Client

2608

3315

# whose checker succeeded before we stored its state is

2609

3316

# assumed to have successfully run all checkers during

2610

3317

# downtime.

2612

3319

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

2613

3320

if not client["last_checked_ok"]:

2614

3321

logger.warning(

2615

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

3322

"disabling client {} - Client never "

3323

"performed a successful checker".format(

3324

client_name))

2618

3325

client["enabled"] = False

2619

3326

elif client["last_checker_status"] != 0:

2620

3327

logger.warning(

2621

"disabling client {0} - Client "

2622

"last checker failed with error code {1}"

2623

.format(client_name,

2624

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

2625

3333

client["enabled"] = False

2626

3334

else:

2627

client["expires"] = (datetime.datetime

2628

.utcnow()

2629

+ client["timeout"])

3335

client["expires"] = (

3336

datetime.datetime.utcnow()

3337

+ client["timeout"])

2630

3338

logger.debug("Last checker succeeded,"

2631

" keeping {0} enabled"

2632

.format(client_name))

3339

" keeping {} enabled".format(

3340

client_name))

2633

3341

try:

2634

client["secret"] = (

2635

pgp.decrypt(client["encrypted_secret"],

2636

client_settings[client_name]

2637

["secret"]))

3342

client["secret"] = pgp.decrypt(

3343

client["encrypted_secret"],

3344

client_settings[client_name]["secret"])

2638

3345

except PGPError:

2639

3346

# If decryption fails, we use secret from new settings

2640

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

2641

.format(client_name))

2642

client["secret"] = (

2643

client_settings[client_name]["secret"])

2644

3347

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

3348

client_name))

3349

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

3350

["secret"])

3351

2645

3352

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

2646

3353

for client_name in (set(old_client_settings)

2647

3354

- set(client_settings)):

2649

3356

for client_name in (set(client_settings)

2650

3357

- set(old_client_settings)):

2651

3358

clients_data[client_name] = client_settings[client_name]

2652

3359

2653

3360

# Create all client objects

2654

for client_name, client in clients_data.iteritems():

3361

for client_name, client in clients_data.items():

2655

3362

tcp_server.clients[client_name] = client_class(

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2658

3363

name=client_name,

3364

settings=client,

3365

server_settings=server_settings)

3366

2659

3367

if not tcp_server.clients:

2660

3368

logger.warning("No clients defined")

2661

3369

2662

3370

if not foreground:

2663

3371

if pidfile is not None:

3372

pid = os.getpid()

2664

3373

try:

2665

3374

with pidfile:

2666

pid = os.getpid()

2667

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

3375

print(pid, file=pidfile)

2668

3376

except IOError:

2669

3377

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

2670

3378

pidfilename, pid)

2671

3379

del pidfile

2672

3380

del pidfilename

2673

2674

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

2675

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

2676

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

2677

3386

if use_dbus:

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

3387

3388

@alternate_dbus_interfaces(

3389

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

3390

class MandosDBusService(DBusObjectWithObjectManager):

2681

3391

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

3392

2682

3393

def __init__(self):

2683

3394

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

3395

2684

3396

_interface = "se.recompile.Mandos"

2685

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

3397

2692

3398

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

2693

3399

def ClientAdded(self, objpath):

2694

3400

"D-Bus signal"

2695

3401

pass

2696

3402

2697

3403

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

2698

def ClientNotFound(self, fingerprint, address):

3404

def ClientNotFound(self, key_id, address):

2699

3405

"D-Bus signal"

2700

3406

pass

2701

3407

3408

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

3409

"true"})

2702

3410

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

2703

3411

def ClientRemoved(self, objpath, name):

2704

3412

"D-Bus signal"

2705

3413

pass

2706

3414

3415

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

3416

"true"})

2707

3417

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

2708

3418

def GetAllClients(self):

2709

3419

"D-Bus method"

2710

return dbus.Array(c.dbus_object_path

2711

for c in

2712

tcp_server.clients.itervalues())

2713

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

2714

3425

@dbus.service.method(_interface,

2715

3426

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

2716

3427

def GetAllClientsWithProperties(self):

2717

3428

"D-Bus method"

2718

3429

return dbus.Dictionary(

2719

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

2720

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

2721

3433

signature="oa{sv}")

2722

3434

2723

3435

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

2724

3436

def RemoveClient(self, object_path):

2725

3437

"D-Bus method"

2726

for c in tcp_server.clients.itervalues():

3438

for c in tcp_server.clients.values():

2727

3439

if c.dbus_object_path == object_path:

2728

3440

del tcp_server.clients[c.name]

2729

3441

c.remove_from_connection()

2730

# Don't signal anything except ClientRemoved

3442

# Don't signal the disabling

2731

3443

c.disable(quiet=True)

2732

# Emit D-Bus signal

2733

self.ClientRemoved(object_path, c.name)

3444

# Emit D-Bus signal for removal

3445

self.client_removed_signal(c)

2734

3446

return

2735

3447

raise KeyError(object_path)

2736

3448

2737

3449

del _interface

2738

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

2739

3487

mandos_dbus_service = MandosDBusService()

2740

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

2741

3494

def cleanup():

2742

3495

"Cleanup function; run on exit"

2743

service.cleanup()

2744

2745

multiprocessing.active_children()

2746

wnull.close()

3496

if zeroconf:

3497

service.cleanup()

3498

3499

mp.active_children()

3500

wn.close()

2747

3501

if not (tcp_server.clients or client_settings):

2748

3502

return

2749

3503

2750

3504

# Store client before exiting. Secrets are encrypted with key

2751

3505

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

2752

3506

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

2753

3507

clients = {}

2754

3508

with PGPEngine() as pgp:

2755

for client in tcp_server.clients.itervalues():

3509

for client in tcp_server.clients.values():

2756

3510

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

2757

3511

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

2758

3512

key)

2759

3513

client_dict = {}

2760

3514

2761

3515

# A list of attributes that can not be pickled

2762

3516

# + secret.

2763

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

2764

"checker", "server_settings"))

2765

for name, typ in (inspect.getmembers

2766

(dbus.service.Object)):

3517

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

3518

"checker", "server_settings"}

3519

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

3520

.Object):

2767

3521

exclude.add(name)

2768

3522

2769

3523

client_dict["encrypted_secret"] = (client

2770

3524

.encrypted_secret)

2771

3525

for attr in client.client_structure:

2772

3526

if attr not in exclude:

2773

3527

client_dict[attr] = getattr(client, attr)

2774

3528

2775

3529

clients[client.name] = client_dict

2776

3530

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

2777

3531

2778

3532

try:

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2783

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

2784

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

2785

3542

os.rename(tempname, stored_state_path)

2786

3543

except (IOError, OSError) as e:

2787

3544

if not debug:

2790

3547

except NameError:

2791

3548

pass

2792

3549

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

2793

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

3550

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

2794

3551

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

2795

3552

else:

2796

3553

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

2797

3554

exc_info=e)

2798

3555

raise

2799

3556

2800

3557

# Delete all clients, and settings from config

2801

3558

while tcp_server.clients:

2802

3559

name, client = tcp_server.clients.popitem()

2803

3560

if use_dbus:

2804

3561

client.remove_from_connection()

2805

# Don't signal anything except ClientRemoved

3562

# Don't signal the disabling

2806

3563

client.disable(quiet=True)

3564

# Emit D-Bus signal for removal

2807

3565

if use_dbus:

2808

# Emit D-Bus signal

2809

mandos_dbus_service.ClientRemoved(client

2810

.dbus_object_path,

2811

client.name)

3566

mandos_dbus_service.client_removed_signal(client)

2812

3567

client_settings.clear()

2813

3568

2814

3569

atexit.register(cleanup)

2815

2816

for client in tcp_server.clients.itervalues():

3570

3571

for client in tcp_server.clients.values():

2817

3572

if use_dbus:

2818

# Emit D-Bus signal

2819

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3573

# Emit D-Bus signal for adding

3574

mandos_dbus_service.client_added_signal(client)

2820

3575

# Need to initiate checking of clients

2821

3576

if client.enabled:

2822

3577

client.init_checker()

2823

3578

2824

3579

tcp_server.enable()

2825

3580

tcp_server.server_activate()

2826

3581

2827

3582

# Find out what port we got

2828

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

3583

if zeroconf:

3584

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

2829

3585

if use_ipv6:

2830

3586

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

2831

3587

" flowinfo %d, scope_id %d",

2833

3589

else: # IPv4

2834

3590

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

2835

3591

*tcp_server.socket.getsockname())

2836

2837

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

2838

3592

3593

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

3594

2839

3595

try:

2840

# From the Avahi example code

2841

try:

2842

service.activate()

2843

except dbus.exceptions.DBusException as error:

2844

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

2845

cleanup()

2846

sys.exit(1)

2847

# End of Avahi example code

2848

2849

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

2850

lambda *args, **kwargs:

2851

(tcp_server.handle_request

2852

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

2853

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

2854

3612

logger.debug("Starting main loop")

2855

3613

main_loop.run()

2856

3614

except AvahiError as error:

2865

3623

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

2866

3624

cleanup()

2867

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

2868

3643

if __name__ == '__main__':

2869

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