/mandos/release : revision 237.7.751

1

#!/usr/bin/python

2

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

3

#

1

#!/usr/bin/python3 -bI

2

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

3

#

4

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

5

#

5

#

6

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

7

# service publisher, downloaded from

8

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

9

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

10

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

11

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

12

#

12

#

13

# Everything else is

14

15

16

#

17

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

18

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

14

15

16

#

17

# This file is part of Mandos.

18

#

19

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

20

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

19

21

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

20

22

# (at your option) any later version.

21

23

#

22

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

23

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

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

24

26

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

25

27

# GNU General Public License for more details.

26

#

28

#

27

29

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

28

# along with this program. If not, see

29

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

30

#

30

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

31

#

31

32

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

32

#

33

#

33

34

35

from __future__ import (division, absolute_import, print_function,

35

36

unicode_literals)

36

37

from future_builtins import *

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

38

42

39

import SocketServer as socketserver

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

40

47

import socket

41

48

import argparse

42

49

import datetime

43

50

import errno

44

import gnutls.crypto

45

import gnutls.connection

46

import gnutls.errors

47

import gnutls.library.functions

48

import gnutls.library.constants

49

import gnutls.library.types

50

import ConfigParser as configparser

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

51

55

import sys

52

56

import re

53

57

import os

62

66

import struct

63

67

import fcntl

64

68

import functools

65

import cPickle as pickle

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

66

73

import multiprocessing

67

74

import types

68

75

import binascii

69

76

import tempfile

70

77

import itertools

71

78

import collections

79

import codecs

80

import unittest

81

import random

72

82

73

83

import dbus

74

84

import dbus.service

75

import gobject

76

import avahi

85

import gi

86

from gi.repository import GLib

77

87

from dbus.mainloop.glib import DBusGMainLoop

78

88

import ctypes

79

89

import ctypes.util

80

90

import xml.dom.minidom

81

91

import inspect

82

92

83

try:

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

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

98

try:

99

collections.abc.Callable

100

except AttributeError:

101

class abc:

102

Callable = collections.Callable

103

collections.abc = abc

104

del abc

105

106

# Show warnings by default

107

if not sys.warnoptions:

108

import warnings

109

warnings.simplefilter("default")

110

111

# Try to find the value of SO_BINDTODEVICE:

112

try:

113

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

114

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

84

115

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

85

116

except AttributeError:

86

117

try:

118

# This is where SO_BINDTODEVICE was up to and including Python

119

# 2.6, and also 3.2:

87

120

from IN import SO_BINDTODEVICE

88

121

except ImportError:

89

SO_BINDTODEVICE = None

90

91

version = "1.6.6"

122

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

123

# Try running the C preprocessor:

124

try:

125

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

126

"/dev/stdin"],

127

stdin=subprocess.PIPE,

128

stdout=subprocess.PIPE)

129

stdout = cc.communicate(

130

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

131

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

132

except (OSError, ValueError, IndexError):

133

# No value found

134

SO_BINDTODEVICE = None

135

136

if sys.version_info < (3, 2):

137

configparser.Configparser = configparser.SafeConfigParser

138

139

version = "1.8.9"

92

140

stored_state_file = "clients.pickle"

93

141

94

142

logger = logging.getLogger()

143

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

95

144

syslogger = None

96

145

97

146

try:

98

if_nametoindex = (ctypes.cdll.LoadLibrary

99

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

100

.if_nametoindex)

147

if_nametoindex = ctypes.cdll.LoadLibrary(

148

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

101

149

except (OSError, AttributeError):

150

102

151

def if_nametoindex(interface):

103

152

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

104

153

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

105

154

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

106

155

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

107

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

108

interface))

109

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

110

ifreq[16:20])[0]

156

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

157

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

111

158

return interface_index

112

159

113

160

161

def copy_function(func):

162

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

163

if sys.version_info.major == 2:

164

return types.FunctionType(func.func_code,

165

func.func_globals,

166

func.func_name,

167

func.func_defaults,

168

func.func_closure)

169

else:

170

return types.FunctionType(func.__code__,

171

func.__globals__,

172

func.__name__,

173

func.__defaults__,

174

func.__closure__)

175

176

114

177

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

115

178

"""init logger and add loglevel"""

116

179

117

180

global syslogger

118

syslogger = (logging.handlers.SysLogHandler

119

(facility =

120

logging.handlers.SysLogHandler.LOG_DAEMON,

121

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

181

syslogger = (logging.handlers.SysLogHandler(

182

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

183

address="/dev/log"))

122

184

syslogger.setFormatter(logging.Formatter

123

185

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

124

186

' %(message)s'))

125

187

logger.addHandler(syslogger)

126

188

127

189

if debug:

128

190

console = logging.StreamHandler()

129

191

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

139

201

pass

140

202

141

203

142

class PGPEngine(object):

204

class PGPEngine:

143

205

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

206

144

207

def __init__(self):

145

208

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

209

self.gpg = "gpg"

210

try:

211

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

212

for line in output.splitlines():

213

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

214

if name == b"gpg":

215

self.gpg = path

216

break

217

except OSError as e:

218

if e.errno != errno.ENOENT:

219

raise

146

220

self.gnupgargs = ['--batch',

147

'--home', self.tempdir,

221

'--homedir', self.tempdir,

148

222

'--force-mdc',

149

'--quiet',

150

'--no-use-agent']

151

223

'--quiet']

224

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

225

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

226

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

227

152

228

def __enter__(self):

153

229

return self

154

230

155

231

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

156

232

self._cleanup()

157

233

return False

158

234

159

235

def __del__(self):

160

236

self._cleanup()

161

237

162

238

def _cleanup(self):

163

239

if self.tempdir is not None:

164

240

# Delete contents of tempdir

165

241

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

166

topdown = False):

242

topdown=False):

167

243

for filename in files:

168

244

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

169

245

for dirname in dirs:

171

247

# Remove tempdir

172

248

os.rmdir(self.tempdir)

173

249

self.tempdir = None

174

250

175

251

def password_encode(self, password):

176

252

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

177

253

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

182

258

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

183

259

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

184

260

return encoded

185

261

186

262

def encrypt(self, data, password):

187

263

passphrase = self.password_encode(password)

188

with tempfile.NamedTemporaryFile(dir=self.tempdir

189

) as passfile:

264

with tempfile.NamedTemporaryFile(

265

dir=self.tempdir) as passfile:

190

266

passfile.write(passphrase)

191

267

passfile.flush()

192

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

268

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

193

269

'--passphrase-file',

194

270

passfile.name]

195

271

+ self.gnupgargs,

196

stdin = subprocess.PIPE,

197

stdout = subprocess.PIPE,

198

stderr = subprocess.PIPE)

199

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

272

stdin=subprocess.PIPE,

273

stdout=subprocess.PIPE,

274

stderr=subprocess.PIPE)

275

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

200

276

if proc.returncode != 0:

201

277

raise PGPError(err)

202

278

return ciphertext

203

279

204

280

def decrypt(self, data, password):

205

281

passphrase = self.password_encode(password)

206

with tempfile.NamedTemporaryFile(dir = self.tempdir

207

) as passfile:

282

with tempfile.NamedTemporaryFile(

283

dir=self.tempdir) as passfile:

208

284

passfile.write(passphrase)

209

285

passfile.flush()

210

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

286

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

211

287

'--passphrase-file',

212

288

passfile.name]

213

289

+ self.gnupgargs,

214

stdin = subprocess.PIPE,

215

stdout = subprocess.PIPE,

216

stderr = subprocess.PIPE)

217

decrypted_plaintext, err = proc.communicate(input

218

= data)

290

stdin=subprocess.PIPE,

291

stdout=subprocess.PIPE,

292

stderr=subprocess.PIPE)

293

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

219

294

if proc.returncode != 0:

220

295

raise PGPError(err)

221

296

return decrypted_plaintext

222

297

223

298

299

# Pretend that we have an Avahi module

300

class avahi:

301

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

302

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

303

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

304

PROTO_INET = 0 # avahi-common/address.h

305

PROTO_INET6 = 1 # avahi-common/address.h

306

DBUS_NAME = "org.freedesktop.Avahi"

307

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

308

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

309

DBUS_PATH_SERVER = "/"

310

311

@staticmethod

312

def string_array_to_txt_array(t):

313

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

314

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

315

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

316

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

317

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

318

SERVER_INVALID = 0 # avahi-common/defs.h

319

SERVER_REGISTERING = 1 # avahi-common/defs.h

320

SERVER_RUNNING = 2 # avahi-common/defs.h

321

SERVER_COLLISION = 3 # avahi-common/defs.h

322

SERVER_FAILURE = 4 # avahi-common/defs.h

323

324

224

325

class AvahiError(Exception):

225

326

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

226

327

self.value = value

227

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

228

def __unicode__(self):

229

return unicode(repr(self.value))

328

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

329

**kwargs)

330

230

331

231

332

class AvahiServiceError(AvahiError):

232

333

pass

233

334

335

234

336

class AvahiGroupError(AvahiError):

235

337

pass

236

338

237

339

238

class AvahiService(object):

340

class AvahiService:

239

341

"""An Avahi (Zeroconf) service.

240

342

241

343

Attributes:

242

344

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

243

345

Used to optionally bind to the specified interface.

255

357

server: D-Bus Server

256

358

bus: dbus.SystemBus()

257

359

"""

258

259

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

260

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

261

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

262

protocol = avahi.PROTO_UNSPEC, bus = None):

360

361

def __init__(self,

362

interface=avahi.IF_UNSPEC,

363

name=None,

364

servicetype=None,

365

port=None,

366

TXT=None,

367

domain="",

368

host="",

369

max_renames=32768,

370

protocol=avahi.PROTO_UNSPEC,

371

bus=None):

263

372

self.interface = interface

264

373

self.name = name

265

374

self.type = servicetype

274

383

self.server = None

275

384

self.bus = bus

276

385

self.entry_group_state_changed_match = None

277

278

def rename(self):

386

387

def rename(self, remove=True):

279

388

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

280

389

if self.rename_count >= self.max_renames:

281

390

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

282

391

" after %i retries, exiting.",

283

392

self.rename_count)

284

393

raise AvahiServiceError("Too many renames")

285

self.name = unicode(self.server

286

.GetAlternativeServiceName(self.name))

394

self.name = str(

395

self.server.GetAlternativeServiceName(self.name))

396

self.rename_count += 1

287

397

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

288

398

self.name)

289

self.remove()

399

if remove:

400

self.remove()

290

401

try:

291

402

self.add()

292

403

except dbus.exceptions.DBusException as error:

293

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

294

self.cleanup()

295

os._exit(1)

296

self.rename_count += 1

297

404

if (error.get_dbus_name()

405

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

406

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

407

return self.rename(remove=False)

408

else:

409

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

410

self.cleanup()

411

os._exit(1)

412

298

413

def remove(self):

299

414

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

300

415

if self.entry_group_state_changed_match is not None:

302

417

self.entry_group_state_changed_match = None

303

418

if self.group is not None:

304

419

self.group.Reset()

305

420

306

421

def add(self):

307

422

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

308

423

self.remove()

325

440

dbus.UInt16(self.port),

326

441

avahi.string_array_to_txt_array(self.TXT))

327

442

self.group.Commit()

328

443

329

444

def entry_group_state_changed(self, state, error):

330

445

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

331

446

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

332

447

333

448

if state == avahi.ENTRY_GROUP_ESTABLISHED:

334

449

logger.debug("Zeroconf service established.")

335

450

elif state == avahi.ENTRY_GROUP_COLLISION:

337

452

self.rename()

338

453

elif state == avahi.ENTRY_GROUP_FAILURE:

339

454

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

340

unicode(error))

341

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

342

.format(error))

343

455

str(error))

456

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

457

344

458

def cleanup(self):

345

459

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

346

460

if self.group is not None:

351

465

pass

352

466

self.group = None

353

467

self.remove()

354

468

355

469

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

356

470

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

357

471

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

358

bad_states = { avahi.SERVER_INVALID:

359

"Zeroconf server invalid",

360

avahi.SERVER_REGISTERING: None,

361

avahi.SERVER_COLLISION:

362

"Zeroconf server name collision",

363

avahi.SERVER_FAILURE:

364

"Zeroconf server failure" }

472

bad_states = {

473

avahi.SERVER_INVALID: "Zeroconf server invalid",

474

avahi.SERVER_REGISTERING: None,

475

avahi.SERVER_COLLISION: "Zeroconf server name collision",

476

avahi.SERVER_FAILURE: "Zeroconf server failure",

477

}

365

478

if state in bad_states:

366

479

if bad_states[state] is not None:

367

480

if error is None:

370

483

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

371

484

self.cleanup()

372

485

elif state == avahi.SERVER_RUNNING:

373

self.add()

486

try:

487

self.add()

488

except dbus.exceptions.DBusException as error:

489

if (error.get_dbus_name()

490

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

491

logger.info("Local Zeroconf service name"

492

" collision.")

493

return self.rename(remove=False)

494

else:

495

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

496

self.cleanup()

497

os._exit(1)

374

498

else:

375

499

if error is None:

376

500

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

377

501

else:

378

502

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

379

503

380

504

def activate(self):

381

505

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

382

506

if self.server is None:

386

510

follow_name_owner_changes=True),

387

511

avahi.DBUS_INTERFACE_SERVER)

388

512

self.server.connect_to_signal("StateChanged",

389

self.server_state_changed)

513

self.server_state_changed)

390

514

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

391

515

392

516

393

517

class AvahiServiceToSyslog(AvahiService):

394

def rename(self):

518

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

395

519

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

396

ret = AvahiService.rename(self)

397

syslogger.setFormatter(logging.Formatter

398

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

399

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

400

.format(self.name)))

520

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

521

syslogger.setFormatter(logging.Formatter(

522

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

523

.format(self.name)))

401

524

return ret

402

525

403

526

404

def timedelta_to_milliseconds(td):

405

"Convert a datetime.timedelta() to milliseconds"

406

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

407

+ (td.seconds * 1000)

408

+ (td.microseconds // 1000))

409

410

411

class Client(object):

527

# Pretend that we have a GnuTLS module

528

class gnutls:

529

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

530

531

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

532

if library is None:

533

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

534

_library = ctypes.cdll.LoadLibrary(library)

535

del library

536

537

# Unless otherwise indicated, the constants and types below are

538

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

539

540

# Constants

541

E_SUCCESS = 0

542

E_INTERRUPTED = -52

543

E_AGAIN = -28

544

CRT_OPENPGP = 2

545

CRT_RAWPK = 3

546

CLIENT = 2

547

SHUT_RDWR = 0

548

CRD_CERTIFICATE = 1

549

E_NO_CERTIFICATE_FOUND = -49

550

X509_FMT_DER = 0

551

NO_TICKETS = 1<<10

552

ENABLE_RAWPK = 1<<18

553

CTYPE_PEERS = 3

554

KEYID_USE_SHA256 = 1 # gnutls/x509.h

555

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

556

557

# Types

558

class session_int(ctypes.Structure):

559

_fields_ = []

560

session_t = ctypes.POINTER(session_int)

561

562

class certificate_credentials_st(ctypes.Structure):

563

_fields_ = []

564

certificate_credentials_t = ctypes.POINTER(

565

certificate_credentials_st)

566

certificate_type_t = ctypes.c_int

567

568

class datum_t(ctypes.Structure):

569

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

570

('size', ctypes.c_uint)]

571

572

class openpgp_crt_int(ctypes.Structure):

573

_fields_ = []

574

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

575

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

576

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

577

credentials_type_t = ctypes.c_int

578

transport_ptr_t = ctypes.c_void_p

579

close_request_t = ctypes.c_int

580

581

# Exceptions

582

class Error(Exception):

583

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

584

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

585

# code is passed, convert it to a string with

586

# gnutls.strerror()

587

self.code = code

588

if message is None and code is not None:

589

message = gnutls.strerror(code)

590

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

591

message, *args)

592

593

class CertificateSecurityError(Error):

594

pass

595

596

# Classes

597

class Credentials:

598

def __init__(self):

599

self._c_object = gnutls.certificate_credentials_t()

600

gnutls.certificate_allocate_credentials(

601

ctypes.byref(self._c_object))

602

self.type = gnutls.CRD_CERTIFICATE

603

604

def __del__(self):

605

gnutls.certificate_free_credentials(self._c_object)

606

607

class ClientSession:

608

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

609

self._c_object = gnutls.session_t()

610

gnutls_flags = gnutls.CLIENT

611

if gnutls.check_version(b"3.5.6"):

612

gnutls_flags |= gnutls.NO_TICKETS

613

if gnutls.has_rawpk:

614

gnutls_flags |= gnutls.ENABLE_RAWPK

615

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

616

del gnutls_flags

617

gnutls.set_default_priority(self._c_object)

618

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

619

gnutls.handshake_set_private_extensions(self._c_object,

620

True)

621

self.socket = socket

622

if credentials is None:

623

credentials = gnutls.Credentials()

624

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

625

ctypes.cast(credentials._c_object,

626

ctypes.c_void_p))

627

self.credentials = credentials

628

629

def __del__(self):

630

gnutls.deinit(self._c_object)

631

632

def handshake(self):

633

return gnutls.handshake(self._c_object)

634

635

def send(self, data):

636

data = bytes(data)

637

data_len = len(data)

638

while data_len > 0:

639

data_len -= gnutls.record_send(self._c_object,

640

data[-data_len:],

641

data_len)

642

643

def bye(self):

644

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

645

646

# Error handling functions

647

def _error_code(result):

648

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

649

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

650

if result >= 0:

651

return result

652

if result == gnutls.E_NO_CERTIFICATE_FOUND:

653

raise gnutls.CertificateSecurityError(code=result)

654

raise gnutls.Error(code=result)

655

656

def _retry_on_error(result, func, arguments):

657

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

658

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

659

while result < 0:

660

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

661

return _error_code(result)

662

result = func(*arguments)

663

return result

664

665

# Unless otherwise indicated, the function declarations below are

666

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

667

668

# Functions

669

priority_set_direct = _library.gnutls_priority_set_direct

670

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

671

ctypes.POINTER(ctypes.c_char_p)]

672

priority_set_direct.restype = _error_code

673

674

init = _library.gnutls_init

675

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

676

init.restype = _error_code

677

678

set_default_priority = _library.gnutls_set_default_priority

679

set_default_priority.argtypes = [session_t]

680

set_default_priority.restype = _error_code

681

682

record_send = _library.gnutls_record_send

683

record_send.argtypes = [session_t, ctypes.c_void_p,

684

ctypes.c_size_t]

685

record_send.restype = ctypes.c_ssize_t

686

record_send.errcheck = _retry_on_error

687

688

certificate_allocate_credentials = (

689

_library.gnutls_certificate_allocate_credentials)

690

certificate_allocate_credentials.argtypes = [

691

ctypes.POINTER(certificate_credentials_t)]

692

certificate_allocate_credentials.restype = _error_code

693

694

certificate_free_credentials = (

695

_library.gnutls_certificate_free_credentials)

696

certificate_free_credentials.argtypes = [

697

certificate_credentials_t]

698

certificate_free_credentials.restype = None

699

700

handshake_set_private_extensions = (

701

_library.gnutls_handshake_set_private_extensions)

702

handshake_set_private_extensions.argtypes = [session_t,

703

ctypes.c_int]

704

handshake_set_private_extensions.restype = None

705

706

credentials_set = _library.gnutls_credentials_set

707

credentials_set.argtypes = [session_t, credentials_type_t,

708

ctypes.c_void_p]

709

credentials_set.restype = _error_code

710

711

strerror = _library.gnutls_strerror

712

strerror.argtypes = [ctypes.c_int]

713

strerror.restype = ctypes.c_char_p

714

715

certificate_type_get = _library.gnutls_certificate_type_get

716

certificate_type_get.argtypes = [session_t]

717

certificate_type_get.restype = _error_code

718

719

certificate_get_peers = _library.gnutls_certificate_get_peers

720

certificate_get_peers.argtypes = [session_t,

721

ctypes.POINTER(ctypes.c_uint)]

722

certificate_get_peers.restype = ctypes.POINTER(datum_t)

723

724

global_set_log_level = _library.gnutls_global_set_log_level

725

global_set_log_level.argtypes = [ctypes.c_int]

726

global_set_log_level.restype = None

727

728

global_set_log_function = _library.gnutls_global_set_log_function

729

global_set_log_function.argtypes = [log_func]

730

global_set_log_function.restype = None

731

732

deinit = _library.gnutls_deinit

733

deinit.argtypes = [session_t]

734

deinit.restype = None

735

736

handshake = _library.gnutls_handshake

737

handshake.argtypes = [session_t]

738

handshake.restype = _error_code

739

handshake.errcheck = _retry_on_error

740

741

transport_set_ptr = _library.gnutls_transport_set_ptr

742

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

743

transport_set_ptr.restype = None

744

745

bye = _library.gnutls_bye

746

bye.argtypes = [session_t, close_request_t]

747

bye.restype = _error_code

748

bye.errcheck = _retry_on_error

749

750

check_version = _library.gnutls_check_version

751

check_version.argtypes = [ctypes.c_char_p]

752

check_version.restype = ctypes.c_char_p

753

754

_need_version = b"3.3.0"

755

if check_version(_need_version) is None:

756

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

757

.format(_need_version))

758

759

_tls_rawpk_version = b"3.6.6"

760

has_rawpk = bool(check_version(_tls_rawpk_version))

761

762

if has_rawpk:

763

# Types

764

class pubkey_st(ctypes.Structure):

765

_fields = []

766

pubkey_t = ctypes.POINTER(pubkey_st)

767

768

x509_crt_fmt_t = ctypes.c_int

769

770

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

771

pubkey_init = _library.gnutls_pubkey_init

772

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

773

pubkey_init.restype = _error_code

774

775

pubkey_import = _library.gnutls_pubkey_import

776

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

777

x509_crt_fmt_t]

778

pubkey_import.restype = _error_code

779

780

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

781

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

782

ctypes.POINTER(ctypes.c_ubyte),

783

ctypes.POINTER(ctypes.c_size_t)]

784

pubkey_get_key_id.restype = _error_code

785

786

pubkey_deinit = _library.gnutls_pubkey_deinit

787

pubkey_deinit.argtypes = [pubkey_t]

788

pubkey_deinit.restype = None

789

else:

790

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

791

792

openpgp_crt_init = _library.gnutls_openpgp_crt_init

793

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

794

openpgp_crt_init.restype = _error_code

795

796

openpgp_crt_import = _library.gnutls_openpgp_crt_import

797

openpgp_crt_import.argtypes = [openpgp_crt_t,

798

ctypes.POINTER(datum_t),

799

openpgp_crt_fmt_t]

800

openpgp_crt_import.restype = _error_code

801

802

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

803

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

804

ctypes.POINTER(ctypes.c_uint)]

805

openpgp_crt_verify_self.restype = _error_code

806

807

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

808

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

809

openpgp_crt_deinit.restype = None

810

811

openpgp_crt_get_fingerprint = (

812

_library.gnutls_openpgp_crt_get_fingerprint)

813

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

814

ctypes.c_void_p,

815

ctypes.POINTER(

816

ctypes.c_size_t)]

817

openpgp_crt_get_fingerprint.restype = _error_code

818

819

if check_version(b"3.6.4"):

820

certificate_type_get2 = _library.gnutls_certificate_type_get2

821

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

822

certificate_type_get2.restype = _error_code

823

824

# Remove non-public functions

825

del _error_code, _retry_on_error

826

827

828

def call_pipe(connection, # : multiprocessing.Connection

829

func, *args, **kwargs):

830

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

831

832

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

833

return value on the provided multiprocessing.Connection.

834

"""

835

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

836

connection.close()

837

838

839

class Client:

412

840

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

413

841

414

842

Attributes:

415

843

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

416

844

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

417

845

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

418

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

419

to see if the client lives.

420

'None' if no process is running.

421

checker_callback_tag: a gobject event source tag, or None

846

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

847

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

848

running.

849

checker_callback_tag: a GLib event source tag, or None

422

850

checker_command: string; External command which is run to check

423

851

if client lives. %() expansions are done at

424

852

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

425

853

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

426

checker_initiator_tag: a gobject event source tag, or None

854

checker_initiator_tag: a GLib event source tag, or None

427

855

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

428

856

client_structure: Object describing what attributes a client has

429

857

and is used for storing the client at exit

430

858

current_checker_command: string; current running checker_command

431

disable_initiator_tag: a gobject event source tag, or None

859

disable_initiator_tag: a GLib event source tag, or None

432

860

enabled: bool()

433

861

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

434

uniquely identify the client

862

uniquely identify an OpenPGP client

863

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

864

a client using raw public keys

435

865

host: string; available for use by the checker command

436

866

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

437

867

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

439

869

last_checker_status: integer between 0 and 255 reflecting exit

440

870

status of last checker. -1 reflects crashed

441

871

checker, -2 means no checker completed yet.

872

last_checker_signal: The signal which killed the last checker, if

873

last_checker_status is -1

442

874

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

443

875

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

444

876

D-Bus identifiers

451

883

disabled, or None

452

884

server_settings: The server_settings dict from main()

453

885

"""

454

886

455

887

runtime_expansions = ("approval_delay", "approval_duration",

456

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

888

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

457

889

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

458

890

"last_approval_request", "last_checked_ok",

459

891

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

460

client_defaults = { "timeout": "PT5M",

461

"extended_timeout": "PT15M",

462

"interval": "PT2M",

463

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

464

"host": "",

465

"approval_delay": "PT0S",

466

"approval_duration": "PT1S",

467

"approved_by_default": "True",

468

"enabled": "True",

469

}

470

471

def timeout_milliseconds(self):

472

"Return the 'timeout' attribute in milliseconds"

473

return timedelta_to_milliseconds(self.timeout)

474

475

def extended_timeout_milliseconds(self):

476

"Return the 'extended_timeout' attribute in milliseconds"

477

return timedelta_to_milliseconds(self.extended_timeout)

478

479

def interval_milliseconds(self):

480

"Return the 'interval' attribute in milliseconds"

481

return timedelta_to_milliseconds(self.interval)

482

483

def approval_delay_milliseconds(self):

484

return timedelta_to_milliseconds(self.approval_delay)

485

892

client_defaults = {

893

"timeout": "PT5M",

894

"extended_timeout": "PT15M",

895

"interval": "PT2M",

896

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

897

"host": "",

898

"approval_delay": "PT0S",

899

"approval_duration": "PT1S",

900

"approved_by_default": "True",

901

"enabled": "True",

902

}

903

486

904

@staticmethod

487

905

def config_parser(config):

488

906

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

495

913

for client_name in config.sections():

496

914

section = dict(config.items(client_name))

497

915

client = settings[client_name] = {}

498

916

499

917

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

500

918

# Reformat values from string types to Python types

501

919

client["approved_by_default"] = config.getboolean(

502

920

client_name, "approved_by_default")

503

921

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

504

922

"enabled")

505

923

924

# Uppercase and remove spaces from key_id and fingerprint

925

# for later comparison purposes with return value from the

926

# key_id() and fingerprint() functions

927

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

928

.replace(" ", ""))

506

929

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

507

930

.replace(" ", ""))

508

931

if "secret" in section:

509

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

932

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

933

.encode("utf-8"),

934

"base64")

510

935

elif "secfile" in section:

511

936

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

512

937

(section["secfile"])),

513

938

"rb") as secfile:

514

939

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

515

940

else:

516

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

941

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

517

942

.format(section))

518

943

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

519

944

client["extended_timeout"] = string_to_delta(

527

952

client["last_approval_request"] = None

528

953

client["last_checked_ok"] = None

529

954

client["last_checker_status"] = -2

530

955

531

956

return settings

532

533

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

957

958

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

534

959

self.name = name

535

960

if server_settings is None:

536

961

server_settings = {}

537

962

self.server_settings = server_settings

538

963

# adding all client settings

539

for setting, value in settings.iteritems():

964

for setting, value in settings.items():

540

965

setattr(self, setting, value)

541

966

542

967

if self.enabled:

543

968

if not hasattr(self, "last_enabled"):

544

969

self.last_enabled = datetime.datetime.utcnow()

548

973

else:

549

974

self.last_enabled = None

550

975

self.expires = None

551

976

552

977

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

553

# Uppercase and remove spaces from fingerprint for later

554

# comparison purposes with return value from the fingerprint()

555

# function

978

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

556

979

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

557

980

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

558

981

datetime.datetime.utcnow())

559

982

560

983

# attributes specific for this server instance

561

984

self.checker = None

562

985

self.checker_initiator_tag = None

565

988

self.current_checker_command = None

566

989

self.approved = None

567

990

self.approvals_pending = 0

568

self.changedstate = (multiprocessing_manager

569

.Condition(multiprocessing_manager

570

.Lock()))

571

self.client_structure = [attr for attr in

572

self.__dict__.iterkeys()

991

self.changedstate = multiprocessing_manager.Condition(

992

multiprocessing_manager.Lock())

993

self.client_structure = [attr

994

for attr in self.__dict__.keys()

573

995

if not attr.startswith("_")]

574

996

self.client_structure.append("client_structure")

575

576

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

577

lambda obj:

578

isinstance(obj,

579

property)):

997

998

for name, t in inspect.getmembers(

999

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

580

1000

if not name.startswith("_"):

581

1001

self.client_structure.append(name)

582

1002

583

1003

# Send notice to process children that client state has changed

584

1004

def send_changedstate(self):

585

1005

with self.changedstate:

586

1006

self.changedstate.notify_all()

587

1007

588

1008

def enable(self):

589

1009

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

590

1010

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

595

1015

self.last_enabled = datetime.datetime.utcnow()

596

1016

self.init_checker()

597

1017

self.send_changedstate()

598

1018

599

1019

def disable(self, quiet=True):

600

1020

"""Disable this client."""

601

1021

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

603

1023

if not quiet:

604

1024

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

605

1025

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

606

gobject.source_remove(self.disable_initiator_tag)

1026

GLib.source_remove(self.disable_initiator_tag)

607

1027

self.disable_initiator_tag = None

608

1028

self.expires = None

609

1029

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

610

gobject.source_remove(self.checker_initiator_tag)

1030

GLib.source_remove(self.checker_initiator_tag)

611

1031

self.checker_initiator_tag = None

612

1032

self.stop_checker()

613

1033

self.enabled = False

614

1034

if not quiet:

615

1035

self.send_changedstate()

616

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

1036

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

617

1037

return False

618

1038

619

1039

def __del__(self):

620

1040

self.disable()

621

1041

622

1042

def init_checker(self):

623

1043

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

624

1044

# and every interval from then on.

625

1045

if self.checker_initiator_tag is not None:

626

gobject.source_remove(self.checker_initiator_tag)

627

self.checker_initiator_tag = (gobject.timeout_add

628

(self.interval_milliseconds(),

629

self.start_checker))

1046

GLib.source_remove(self.checker_initiator_tag)

1047

self.checker_initiator_tag = GLib.timeout_add(

1048

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

1049

+ 1)),

1050

self.start_checker)

630

1051

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

631

1052

if self.disable_initiator_tag is not None:

632

gobject.source_remove(self.disable_initiator_tag)

633

self.disable_initiator_tag = (gobject.timeout_add

634

(self.timeout_milliseconds(),

635

self.disable))

1053

GLib.source_remove(self.disable_initiator_tag)

1054

self.disable_initiator_tag = GLib.timeout_add(

1055

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

636

1056

# Also start a new checker *right now*.

637

1057

self.start_checker()

638

639

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

1058

1059

def checker_callback(self, source, condition, connection,

1060

command):

640

1061

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

1062

# Read return code from connection (see call_pipe)

1063

returncode = connection.recv()

1064

connection.close()

1065

if self.checker is not None:

1066

self.checker.join()

641

1067

self.checker_callback_tag = None

642

1068

self.checker = None

643

if os.WIFEXITED(condition):

644

self.last_checker_status = os.WEXITSTATUS(condition)

1069

1070

if returncode >= 0:

1071

self.last_checker_status = returncode

1072

self.last_checker_signal = None

645

1073

if self.last_checker_status == 0:

646

1074

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

647

1075

vars(self))

648

1076

self.checked_ok()

649

1077

else:

650

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

651

vars(self))

1078

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

652

1079

else:

653

1080

self.last_checker_status = -1

1081

self.last_checker_signal = -returncode

654

1082

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

655

1083

vars(self))

656

1084

return False

1085

657

1086

def checked_ok(self):

658

1087

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

659

1088

self.last_checked_ok = datetime.datetime.utcnow()

660

1089

self.last_checker_status = 0

1090

self.last_checker_signal = None

661

1091

self.bump_timeout()

662

1092

663

1093

def bump_timeout(self, timeout=None):

664

1094

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

665

1095

if timeout is None:

666

1096

timeout = self.timeout

667

1097

if self.disable_initiator_tag is not None:

668

gobject.source_remove(self.disable_initiator_tag)

1098

GLib.source_remove(self.disable_initiator_tag)

669

1099

self.disable_initiator_tag = None

670

1100

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

671

self.disable_initiator_tag = (gobject.timeout_add

672

(timedelta_to_milliseconds

673

(timeout), self.disable))

1101

self.disable_initiator_tag = GLib.timeout_add(

1102

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

674

1103

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

675

1104

676

1105

def need_approval(self):

677

1106

self.last_approval_request = datetime.datetime.utcnow()

678

1107

679

1108

def start_checker(self):

680

1109

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

681

1110

682

1111

If a checker already exists, leave it running and do

683

1112

nothing."""

684

1113

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

689

1118

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

690

1119

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

691

1120

# should be.

692

693

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

694

try:

695

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

696

except AttributeError:

697

pass

698

except OSError as error:

699

if error.errno != errno.ECHILD:

700

raise

701

else:

702

if pid:

703

logger.warning("Checker was a zombie")

704

gobject.source_remove(self.checker_callback_tag)

705

self.checker_callback(pid, status,

706

self.current_checker_command)

1121

1122

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

1123

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

1124

self.checker.join()

1125

self.checker = None

707

1126

# Start a new checker if needed

708

1127

if self.checker is None:

709

1128

# Escape attributes for the shell

710

escaped_attrs = dict(

711

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

712

for attr in

713

self.runtime_expansions)

1129

escaped_attrs = {

1130

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

1131

for attr in self.runtime_expansions}

714

1132

try:

715

1133

command = self.checker_command % escaped_attrs

716

1134

except TypeError as error:

717

1135

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

718

self.checker_command, exc_info=error)

719

return True # Try again later

1136

self.checker_command,

1137

exc_info=error)

1138

return True # Try again later

720

1139

self.current_checker_command = command

721

try:

722

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

723

command, self.name)

724

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

725

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

726

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

727

# always replaced by /dev/null.)

728

# The exception is when not debugging but nevertheless

729

# running in the foreground; use the previously

730

# created wnull.

731

popen_args = {}

732

if (not self.server_settings["debug"]

733

and self.server_settings["foreground"]):

734

popen_args.update({"stdout": wnull,

735

"stderr": wnull })

736

self.checker = subprocess.Popen(command,

737

close_fds=True,

738

shell=True, cwd="/",

739

**popen_args)

740

except OSError as error:

741

logger.error("Failed to start subprocess",

742

exc_info=error)

743

return True

744

self.checker_callback_tag = (gobject.child_watch_add

745

(self.checker.pid,

746

self.checker_callback,

747

data=command))

748

# The checker may have completed before the gobject

749

# watch was added. Check for this.

750

try:

751

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

752

except OSError as error:

753

if error.errno == errno.ECHILD:

754

# This should never happen

755

logger.error("Child process vanished",

756

exc_info=error)

757

return True

758

raise

759

if pid:

760

gobject.source_remove(self.checker_callback_tag)

761

self.checker_callback(pid, status, command)

762

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

1140

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

1141

self.name)

1142

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

1143

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

1144

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

1145

# always replaced by /dev/null.)

1146

# The exception is when not debugging but nevertheless

1147

# running in the foreground; use the previously

1148

# created wnull.

1149

popen_args = {"close_fds": True,

1150

"shell": True,

1151

"cwd": "/"}

1152

if (not self.server_settings["debug"]

1153

and self.server_settings["foreground"]):

1154

popen_args.update({"stdout": wnull,

1155

"stderr": wnull})

1156

pipe = multiprocessing.Pipe(duplex=False)

1157

self.checker = multiprocessing.Process(

1158

target=call_pipe,

1159

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

1160

kwargs=popen_args)

1161

self.checker.start()

1162

self.checker_callback_tag = GLib.io_add_watch(

1163

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

1164

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1165

self.checker_callback, pipe[0], command)

1166

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

763

1167

return True

764

1168

765

1169

def stop_checker(self):

766

1170

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

767

1171

if self.checker_callback_tag:

768

gobject.source_remove(self.checker_callback_tag)

1172

GLib.source_remove(self.checker_callback_tag)

769

1173

self.checker_callback_tag = None

770

1174

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

771

1175

return

772

1176

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

773

try:

774

self.checker.terminate()

775

#time.sleep(0.5)

776

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

777

# self.checker.kill()

778

except OSError as error:

779

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

780

raise

1177

self.checker.terminate()

781

1178

self.checker = None

782

1179

783

1180

784

def dbus_service_property(dbus_interface, signature="v",

785

access="readwrite", byte_arrays=False):

1181

def dbus_service_property(dbus_interface,

1182

signature="v",

1183

access="readwrite",

1184

byte_arrays=False):

786

1185

"""Decorators for marking methods of a DBusObjectWithProperties to

787

1186

become properties on the D-Bus.

788

1187

789

1188

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

790

1189

and with one argument by "Set".

791

1190

792

1191

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

793

1192

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

794

1193

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

797

1196

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

798

1197

if byte_arrays and signature != "ay":

799

1198

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

800

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

1199

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

1200

801

1201

def decorator(func):

802

1202

func._dbus_is_property = True

803

1203

func._dbus_interface = dbus_interface

806

1206

func._dbus_name = func.__name__

807

1207

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

808

1208

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

809

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1209

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

810

1210

return func

1211

811

1212

return decorator

812

1213

813

1214

814

1215

def dbus_interface_annotations(dbus_interface):

815

1216

"""Decorator for marking functions returning interface annotations

816

1217

817

1218

Usage:

818

1219

819

1220

@dbus_interface_annotations("org.example.Interface")

820

1221

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

821

1222

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

822

1223

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

823

1224

"false"}

824

1225

"""

1226

825

1227

def decorator(func):

826

1228

func._dbus_is_interface = True

827

1229

func._dbus_interface = dbus_interface

828

1230

func._dbus_name = dbus_interface

829

1231

return func

1232

830

1233

return decorator

831

1234

832

1235

833

1236

def dbus_annotations(annotations):

834

1237

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

835

1238

Usage:

836

1239

1240

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

1241

"org.freedesktop.DBus.Property."

1242

"EmitsChangedSignal": "false"})

837

1243

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

838

1244

access="r")

839

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

840

"org.freedesktop.DBus.Property."

841

"EmitsChangedSignal": "false"})

842

1245

def Property_dbus_property(self):

843

1246

return dbus.Boolean(False)

1247

1248

See also the DBusObjectWithAnnotations class.

844

1249

"""

1250

845

1251

def decorator(func):

846

1252

func._dbus_annotations = annotations

847

1253

return func

1254

848

1255

return decorator

849

1256

850

1257

851

1258

class DBusPropertyException(dbus.exceptions.DBusException):

852

1259

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

853

1260

"""

854

def __unicode__(self):

855

return unicode(str(self))

1261

pass

856

1262

857

1263

858

1264

class DBusPropertyAccessException(DBusPropertyException):

867

1273

pass

868

1274

869

1275

870

class DBusObjectWithProperties(dbus.service.Object):

871

"""A D-Bus object with properties.

872

873

Classes inheriting from this can use the dbus_service_property

874

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

875

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

1276

class DBusObjectWithAnnotations(dbus.service.Object):

1277

"""A D-Bus object with annotations.

1278

1279

Classes inheriting from this can use the dbus_annotations

1280

decorator to add annotations to methods or signals.

876

1281

"""

877

1282

878

1283

@staticmethod

879

1284

def _is_dbus_thing(thing):

880

1285

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

881

1286

882

1287

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

883

1288

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

884

1289

"""

885

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

1290

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

886

1291

False)

887

1292

888

1293

def _get_all_dbus_things(self, thing):

889

1294

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

890

1295

"""

891

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

892

name),

1296

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

893

1297

athing.__get__(self))

894

1298

for cls in self.__class__.__mro__

895

1299

for name, athing in

896

inspect.getmembers(cls,

897

self._is_dbus_thing(thing)))

898

1300

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

1301

1302

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1303

out_signature="s",

1304

path_keyword='object_path',

1305

connection_keyword='connection')

1306

def Introspect(self, object_path, connection):

1307

"""Overloading of standard D-Bus method.

1308

1309

Inserts annotation tags on methods and signals.

1310

"""

1311

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

1312

connection)

1313

try:

1314

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

1315

1316

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

1317

# Add annotation tags

1318

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

1319

for tag in if_tag.getElementsByTagName(typ):

1320

annots = dict()

1321

for name, prop in (self.

1322

_get_all_dbus_things(typ)):

1323

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

1324

and prop._dbus_interface

1325

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

1326

annots.update(getattr(

1327

prop, "_dbus_annotations", {}))

1328

for name, value in annots.items():

1329

ann_tag = document.createElement(

1330

"annotation")

1331

ann_tag.setAttribute("name", name)

1332

ann_tag.setAttribute("value", value)

1333

tag.appendChild(ann_tag)

1334

# Add interface annotation tags

1335

for annotation, value in dict(

1336

itertools.chain.from_iterable(

1337

annotations().items()

1338

for name, annotations

1339

in self._get_all_dbus_things("interface")

1340

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

1341

)).items():

1342

ann_tag = document.createElement("annotation")

1343

ann_tag.setAttribute("name", annotation)

1344

ann_tag.setAttribute("value", value)

1345

if_tag.appendChild(ann_tag)

1346

# Fix argument name for the Introspect method itself

1347

if (if_tag.getAttribute("name")

1348

== dbus.INTROSPECTABLE_IFACE):

1349

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

1350

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

1351

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

1352

if (arg.getAttribute("direction")

1353

== "out"):

1354

arg.setAttribute("name",

1355

"xml_data")

1356

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

1357

document.unlink()

1358

except (AttributeError, xml.dom.DOMException,

1359

xml.parsers.expat.ExpatError) as error:

1360

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

1361

exc_info=error)

1362

return xmlstring

1363

1364

1365

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1366

"""A D-Bus object with properties.

1367

1368

Classes inheriting from this can use the dbus_service_property

1369

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

1370

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

1371

"""

1372

899

1373

def _get_dbus_property(self, interface_name, property_name):

900

1374

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

901

1375

property with the specified name and interface.

902

1376

"""

903

for cls in self.__class__.__mro__:

904

for name, value in (inspect.getmembers

905

(cls,

906

self._is_dbus_thing("property"))):

1377

for cls in self.__class__.__mro__:

1378

for name, value in inspect.getmembers(

1379

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

907

1380

if (value._dbus_name == property_name

908

1381

and value._dbus_interface == interface_name):

909

1382

return value.__get__(self)

910

1383

911

1384

# No such property

912

raise DBusPropertyNotFound(self.dbus_object_path + ":"

913

+ interface_name + "."

914

+ property_name)

915

916

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

1385

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

1386

self.dbus_object_path, interface_name, property_name))

1387

1388

@classmethod

1389

def _get_all_interface_names(cls):

1390

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

1391

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

1392

"_dbus_interface", None)

1393

for x in (inspect.getmro(cls))

1394

for attr in dir(x))

1395

if name is not None)

1396

1397

@dbus.service.method(dbus.PROPERTIES_IFACE,

1398

in_signature="ss",

917

1399

out_signature="v")

918

1400

def Get(self, interface_name, property_name):

919

1401

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

925

1407

if not hasattr(value, "variant_level"):

926

1408

return value

927

1409

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

928

1410

929

1411

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

930

1412

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

931

1413

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

938

1420

# signatures other than "ay".

939

1421

if prop._dbus_signature != "ay":

940

1422

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

941

"'ay' signature {0!r}"

1423

"'ay' signature {!r}"

942

1424

.format(prop._dbus_signature))

943

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

944

for byte in value))

1425

value = dbus.ByteArray(bytes(value))

945

1426

prop(value)

946

947

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

1427

1428

@dbus.service.method(dbus.PROPERTIES_IFACE,

1429

in_signature="s",

948

1430

out_signature="a{sv}")

949

1431

def GetAll(self, interface_name):

950

1432

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

951

1433

standard.

952

1434

953

1435

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

954

1436

"""

955

1437

properties = {}

965

1447

if not hasattr(value, "variant_level"):

966

1448

properties[name] = value

967

1449

continue

968

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

969

value.variant_level+1)

1450

properties[name] = type(value)(

1451

value, variant_level=value.variant_level + 1)

970

1452

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

971

1453

1454

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

1455

def PropertiesChanged(self, interface_name, changed_properties,

1456

invalidated_properties):

1457

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

1458

standard.

1459

"""

1460

pass

1461

972

1462

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

973

1463

out_signature="s",

974

1464

path_keyword='object_path',

975

1465

connection_keyword='connection')

976

1466

def Introspect(self, object_path, connection):

977

1467

"""Overloading of standard D-Bus method.

978

1468

979

1469

Inserts property tags and interface annotation tags.

980

1470

"""

981

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

982

connection)

1471

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1472

object_path,

1473

connection)

983

1474

try:

984

1475

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

1476

985

1477

def make_tag(document, name, prop):

986

1478

e = document.createElement("property")

987

1479

e.setAttribute("name", name)

988

1480

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

989

1481

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

990

1482

return e

1483

991

1484

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

992

1485

# Add property tags

993

1486

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

996

1489

if prop._dbus_interface

997

1490

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

998

1491

if_tag.appendChild(tag)

999

# Add annotation tags

1000

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

1001

for tag in if_tag.getElementsByTagName(typ):

1002

annots = dict()

1003

for name, prop in (self.

1004

_get_all_dbus_things(typ)):

1005

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

1006

and prop._dbus_interface

1007

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

1008

annots.update(getattr

1009

(prop,

1010

"_dbus_annotations",

1011

{}))

1012

for name, value in annots.iteritems():

1013

ann_tag = document.createElement(

1014

"annotation")

1015

ann_tag.setAttribute("name", name)

1016

ann_tag.setAttribute("value", value)

1017

tag.appendChild(ann_tag)

1018

# Add interface annotation tags

1019

for annotation, value in dict(

1020

itertools.chain.from_iterable(

1021

annotations().iteritems()

1022

for name, annotations in

1023

self._get_all_dbus_things("interface")

1024

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

1025

)).iteritems():

1026

ann_tag = document.createElement("annotation")

1027

ann_tag.setAttribute("name", annotation)

1028

ann_tag.setAttribute("value", value)

1029

if_tag.appendChild(ann_tag)

1492

# Add annotation tags for properties

1493

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

1494

annots = dict()

1495

for name, prop in self._get_all_dbus_things(

1496

"property"):

1497

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

1498

and prop._dbus_interface

1499

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

1500

annots.update(getattr(

1501

prop, "_dbus_annotations", {}))

1502

for name, value in annots.items():

1503

ann_tag = document.createElement(

1504

"annotation")

1505

ann_tag.setAttribute("name", name)

1506

ann_tag.setAttribute("value", value)

1507

tag.appendChild(ann_tag)

1030

1508

# Add the names to the return values for the

1031

1509

# "org.freedesktop.DBus.Properties" methods

1032

1510

if (if_tag.getAttribute("name")

1051

1529

return xmlstring

1052

1530

1053

1531

1532

try:

1533

dbus.OBJECT_MANAGER_IFACE

1534

except AttributeError:

1535

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

1536

1537

1538

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1539

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

1540

1541

Classes inheriting from this exposes the standard

1542

GetManagedObjects call and the InterfacesAdded and

1543

InterfacesRemoved signals on the standard

1544

"org.freedesktop.DBus.ObjectManager" interface.

1545

1546

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

1547

manually.

1548

"""

1549

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1550

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

1551

def GetManagedObjects(self):

1552

"""This function must be overridden"""

1553

raise NotImplementedError()

1554

1555

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1556

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

1557

def InterfacesAdded(self, object_path, interfaces_and_properties):

1558

pass

1559

1560

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

1561

def InterfacesRemoved(self, object_path, interfaces):

1562

pass

1563

1564

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1565

out_signature="s",

1566

path_keyword='object_path',

1567

connection_keyword='connection')

1568

def Introspect(self, object_path, connection):

1569

"""Overloading of standard D-Bus method.

1570

1571

Override return argument name of GetManagedObjects to be

1572

"objpath_interfaces_and_properties"

1573

"""

1574

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1575

object_path,

1576

connection)

1577

try:

1578

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

1579

1580

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

1581

# Fix argument name for the GetManagedObjects method

1582

if (if_tag.getAttribute("name")

1583

== dbus.OBJECT_MANAGER_IFACE):

1584

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

1585

if (cn.getAttribute("name")

1586

== "GetManagedObjects"):

1587

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

1588

if (arg.getAttribute("direction")

1589

== "out"):

1590

arg.setAttribute(

1591

"name",

1592

"objpath_interfaces"

1593

"_and_properties")

1594

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

1595

document.unlink()

1596

except (AttributeError, xml.dom.DOMException,

1597

xml.parsers.expat.ExpatError) as error:

1598

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

1599

exc_info=error)

1600

return xmlstring

1601

1602

1054

1603

def datetime_to_dbus(dt, variant_level=0):

1055

1604

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

1056

1605

if dt is None:

1057

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

1058

return dbus.String(dt.isoformat(),

1059

variant_level=variant_level)

1606

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

1607

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

1060

1608

1061

1609

1062

1610

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1064

1612

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

1065

1613

interface names according to the "alt_interface_names" mapping.

1066

1614

Usage:

1067

1615

1068

1616

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

1069

1617

"net.example.AlternateInterface"})

1070

1618

class SampleDBusObject(dbus.service.Object):

1071

1619

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

1072

1620

def SampleDBusMethod():

1073

1621

pass

1074

1622

1075

1623

The above "SampleDBusMethod" on "SampleDBusObject" will be

1076

1624

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

1077

1625

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

1078

1626

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

1079

1627

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

1080

1628

1081

1629

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

1082

1630

(from DBusObjectWithProperties) and interfaces (from the

1083

1631

dbus_interface_annotations decorator).

1084

1632

"""

1633

1085

1634

def wrapper(cls):

1086

1635

for orig_interface_name, alt_interface_name in (

1087

alt_interface_names.iteritems()):

1636

alt_interface_names.items()):

1088

1637

attr = {}

1089

1638

interface_names = set()

1090

1639

# Go though all attributes of the class

1092

1641

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

1093

1642

# with the wrong interface name

1094

1643

if (not hasattr(attribute, "_dbus_interface")

1095

or not attribute._dbus_interface

1096

.startswith(orig_interface_name)):

1644

or not attribute._dbus_interface.startswith(

1645

orig_interface_name)):

1097

1646

continue

1098

1647

# Create an alternate D-Bus interface name based on

1099

1648

# the current name

1100

alt_interface = (attribute._dbus_interface

1101

.replace(orig_interface_name,

1102

alt_interface_name))

1649

alt_interface = attribute._dbus_interface.replace(

1650

orig_interface_name, alt_interface_name)

1103

1651

interface_names.add(alt_interface)

1104

1652

# Is this a D-Bus signal?

1105

1653

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

1106

1654

# Extract the original non-method undecorated

1107

1655

# function by black magic

1108

nonmethod_func = (dict(

1656

if sys.version_info.major == 2:

1657

nonmethod_func = (dict(

1109

1658

zip(attribute.func_code.co_freevars,

1110

attribute.__closure__))["func"]

1111

.cell_contents)

1659

attribute.__closure__))

1660

["func"].cell_contents)

1661

else:

1662

nonmethod_func = (dict(

1663

zip(attribute.__code__.co_freevars,

1664

attribute.__closure__))

1665

["func"].cell_contents)

1112

1666

# Create a new, but exactly alike, function

1113

1667

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

1114

1668

# with the alternate D-Bus interface name

1115

new_function = (dbus.service.signal

1116

(alt_interface,

1117

attribute._dbus_signature)

1118

(types.FunctionType(

1119

nonmethod_func.func_code,

1120

nonmethod_func.func_globals,

1121

nonmethod_func.func_name,

1122

nonmethod_func.func_defaults,

1123

nonmethod_func.func_closure)))

1669

new_function = copy_function(nonmethod_func)

1670

new_function = (dbus.service.signal(

1671

alt_interface,

1672

attribute._dbus_signature)(new_function))

1124

1673

# Copy annotations, if any

1125

1674

try:

1126

new_function._dbus_annotations = (

1127

dict(attribute._dbus_annotations))

1675

new_function._dbus_annotations = dict(

1676

attribute._dbus_annotations)

1128

1677

except AttributeError:

1129

1678

pass

1679

1130

1680

# Define a creator of a function to call both the

1131

1681

# original and alternate functions, so both the

1132

1682

# original and alternate signals gets sent when

1135

1685

"""This function is a scope container to pass

1136

1686

func1 and func2 to the "call_both" function

1137

1687

outside of its arguments"""

1688

1689

@functools.wraps(func2)

1138

1690

def call_both(*args, **kwargs):

1139

1691

"""This function will emit two D-Bus

1140

1692

signals by calling func1 and func2"""

1141

1693

func1(*args, **kwargs)

1142

1694

func2(*args, **kwargs)

1695

# Make wrapper function look like a D-Bus

1696

# signal

1697

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

1698

if name.startswith("_dbus_"):

1699

setattr(call_both, name, attr)

1700

1143

1701

return call_both

1144

1702

# Create the "call_both" function and add it to

1145

1703

# the class

1150

1708

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

1151

1709

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

1152

1710

# to the class.

1153

attr[attrname] = (dbus.service.method

1154

(alt_interface,

1155

attribute._dbus_in_signature,

1156

attribute._dbus_out_signature)

1157

(types.FunctionType

1158

(attribute.func_code,

1159

attribute.func_globals,

1160

attribute.func_name,

1161

attribute.func_defaults,

1162

attribute.func_closure)))

1711

attr[attrname] = (

1712

dbus.service.method(

1713

alt_interface,

1714

attribute._dbus_in_signature,

1715

attribute._dbus_out_signature)

1716

(copy_function(attribute)))

1163

1717

# Copy annotations, if any

1164

1718

try:

1165

attr[attrname]._dbus_annotations = (

1166

dict(attribute._dbus_annotations))

1719

attr[attrname]._dbus_annotations = dict(

1720

attribute._dbus_annotations)

1167

1721

except AttributeError:

1168

1722

pass

1169

1723

# Is this a D-Bus property?

1172

1726

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

1173

1727

# property with the alternate D-Bus interface

1174

1728

# name. Add it to the class.

1175

attr[attrname] = (dbus_service_property

1176

(alt_interface,

1177

attribute._dbus_signature,

1178

attribute._dbus_access,

1179

attribute

1180

._dbus_get_args_options

1181

["byte_arrays"])

1182

(types.FunctionType

1183

(attribute.func_code,

1184

attribute.func_globals,

1185

attribute.func_name,

1186

attribute.func_defaults,

1187

attribute.func_closure)))

1729

attr[attrname] = (dbus_service_property(

1730

alt_interface, attribute._dbus_signature,

1731

attribute._dbus_access,

1732

attribute._dbus_get_args_options

1733

["byte_arrays"])

1734

(copy_function(attribute)))

1188

1735

# Copy annotations, if any

1189

1736

try:

1190

attr[attrname]._dbus_annotations = (

1191

dict(attribute._dbus_annotations))

1737

attr[attrname]._dbus_annotations = dict(

1738

attribute._dbus_annotations)

1192

1739

except AttributeError:

1193

1740

pass

1194

1741

# Is this a D-Bus interface?

1197

1744

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

1198

1745

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

1199

1746

# to the class.

1200

attr[attrname] = (dbus_interface_annotations

1201

(alt_interface)

1202

(types.FunctionType

1203

(attribute.func_code,

1204

attribute.func_globals,

1205

attribute.func_name,

1206

attribute.func_defaults,

1207

attribute.func_closure)))

1747

attr[attrname] = (

1748

dbus_interface_annotations(alt_interface)

1749

(copy_function(attribute)))

1208

1750

if deprecate:

1209

1751

# Deprecate all alternate interfaces

1210

iname="_AlternateDBusNames_interface_annotation{0}"

1752

iname = "_AlternateDBusNames_interface_annotation{}"

1211

1753

for interface_name in interface_names:

1754

1212

1755

@dbus_interface_annotations(interface_name)

1213

1756

def func(self):

1214

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

1215

"true" }

1757

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

1758

"true"}

1216

1759

# Find an unused name

1217

1760

for aname in (iname.format(i)

1218

1761

for i in itertools.count()):

1222

1765

if interface_names:

1223

1766

# Replace the class with a new subclass of it with

1224

1767

# methods, signals, etc. as created above.

1225

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

1226

(cls,), attr)

1768

if sys.version_info.major == 2:

1769

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

1770

(cls, ), attr)

1771

else:

1772

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

1773

(cls, ), attr)

1227

1774

return cls

1775

1228

1776

return wrapper

1229

1777

1230

1778

1231

1779

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

1232

"se.bsnet.fukt.Mandos"})

1780

"se.bsnet.fukt.Mandos"})

1233

1781

class ClientDBus(Client, DBusObjectWithProperties):

1234

1782

"""A Client class using D-Bus

1235

1783

1236

1784

Attributes:

1237

1785

dbus_object_path: dbus.ObjectPath

1238

1786

bus: dbus.SystemBus()

1239

1787

"""

1240

1788

1241

1789

runtime_expansions = (Client.runtime_expansions

1242

+ ("dbus_object_path",))

1243

1790

+ ("dbus_object_path", ))

1791

1792

_interface = "se.recompile.Mandos.Client"

1793

1244

1794

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

1245

1246

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

1795

1796

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

1247

1797

self.bus = bus

1248

1798

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

1249

1799

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

1250

1800

# the D-Bus

1251

client_object_name = unicode(self.name).translate(

1801

client_object_name = str(self.name).translate(

1252

1802

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

1253

1803

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

1254

self.dbus_object_path = (dbus.ObjectPath

1255

("/clients/" + client_object_name))

1804

self.dbus_object_path = dbus.ObjectPath(

1805

"/clients/" + client_object_name)

1256

1806

DBusObjectWithProperties.__init__(self, self.bus,

1257

1807

self.dbus_object_path)

1258

1259

def notifychangeproperty(transform_func,

1260

dbus_name, type_func=lambda x: x,

1261

variant_level=1):

1808

1809

def notifychangeproperty(transform_func, dbus_name,

1810

type_func=lambda x: x,

1811

variant_level=1,

1812

invalidate_only=False,

1813

_interface=_interface):

1262

1814

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

1263

1815

its changes to DBus.

1264

1816

1265

1817

transform_fun: Function that takes a value and a variant_level

1266

1818

and transforms it to a D-Bus type.

1267

1819

dbus_name: D-Bus name of the variable

1269

1821

to the D-Bus. Default: no transform

1270

1822

variant_level: D-Bus variant level. Default: 1

1271

1823

"""

1272

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

1824

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

1825

1273

1826

def setter(self, value):

1274

1827

if hasattr(self, "dbus_object_path"):

1275

1828

if (not hasattr(self, attrname) or

1276

1829

type_func(getattr(self, attrname, None))

1277

1830

!= type_func(value)):

1278

dbus_value = transform_func(type_func(value),

1279

variant_level

1280

=variant_level)

1281

self.PropertyChanged(dbus.String(dbus_name),

1282

dbus_value)

1831

if invalidate_only:

1832

self.PropertiesChanged(

1833

_interface, dbus.Dictionary(),

1834

dbus.Array((dbus_name, )))

1835

else:

1836

dbus_value = transform_func(

1837

type_func(value),

1838

variant_level=variant_level)

1839

self.PropertyChanged(dbus.String(dbus_name),

1840

dbus_value)

1841

self.PropertiesChanged(

1842

_interface,

1843

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

1844

dbus_value}),

1845

dbus.Array())

1283

1846

setattr(self, attrname, value)

1284

1847

1285

1848

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

1286

1849

1287

1850

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1288

1851

approvals_pending = notifychangeproperty(dbus.Boolean,

1289

1852

"ApprovalPending",

1290

type_func = bool)

1853

type_func=bool)

1291

1854

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

1292

1855

last_enabled = notifychangeproperty(datetime_to_dbus,

1293

1856

"LastEnabled")

1294

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

1295

type_func = lambda checker:

1296

checker is not None)

1857

checker = notifychangeproperty(

1858

dbus.Boolean, "CheckerRunning",

1859

type_func=lambda checker: checker is not None)

1297

1860

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1298

1861

"LastCheckedOK")

1299

1862

last_checker_status = notifychangeproperty(dbus.Int16,

1302

1865

datetime_to_dbus, "LastApprovalRequest")

1303

1866

approved_by_default = notifychangeproperty(dbus.Boolean,

1304

1867

"ApprovedByDefault")

1305

approval_delay = notifychangeproperty(dbus.UInt64,

1306

"ApprovalDelay",

1307

type_func =

1308

timedelta_to_milliseconds)

1868

approval_delay = notifychangeproperty(

1869

dbus.UInt64, "ApprovalDelay",

1870

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

1309

1871

approval_duration = notifychangeproperty(

1310

1872

dbus.UInt64, "ApprovalDuration",

1311

type_func = timedelta_to_milliseconds)

1873

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

1312

1874

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

1313

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

1314

type_func =

1315

timedelta_to_milliseconds)

1875

timeout = notifychangeproperty(

1876

dbus.UInt64, "Timeout",

1877

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

1316

1878

extended_timeout = notifychangeproperty(

1317

1879

dbus.UInt64, "ExtendedTimeout",

1318

type_func = timedelta_to_milliseconds)

1319

interval = notifychangeproperty(dbus.UInt64,

1320

"Interval",

1321

type_func =

1322

timedelta_to_milliseconds)

1880

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

1881

interval = notifychangeproperty(

1882

dbus.UInt64, "Interval",

1883

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

1323

1884

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

1324

1885

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

1886

invalidate_only=True)

1887

1325

1888

del notifychangeproperty

1326

1889

1327

1890

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

1328

1891

try:

1329

1892

self.remove_from_connection()

1332

1895

if hasattr(DBusObjectWithProperties, "__del__"):

1333

1896

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

1334

1897

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

1335

1336

def checker_callback(self, pid, condition, command,

1337

*args, **kwargs):

1338

self.checker_callback_tag = None

1339

self.checker = None

1340

if os.WIFEXITED(condition):

1341

exitstatus = os.WEXITSTATUS(condition)

1898

1899

def checker_callback(self, source, condition,

1900

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

1901

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

1902

connection, command, *args,

1903

**kwargs)

1904

exitstatus = self.last_checker_status

1905

if exitstatus >= 0:

1342

1906

# Emit D-Bus signal

1343

1907

self.CheckerCompleted(dbus.Int16(exitstatus),

1344

dbus.Int64(condition),

1908

# This is specific to GNU libC

1909

dbus.Int64(exitstatus << 8),

1345

1910

dbus.String(command))

1346

1911

else:

1347

1912

# Emit D-Bus signal

1348

1913

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

1349

dbus.Int64(condition),

1914

dbus.Int64(

1915

# This is specific to GNU libC

1916

(exitstatus << 8)

1917

| self.last_checker_signal),

1350

1918

dbus.String(command))

1351

1352

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

1353

*args, **kwargs)

1354

1919

return ret

1920

1355

1921

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

1356

1922

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

1357

1923

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

1361

1927

# Emit D-Bus signal

1362

1928

self.CheckerStarted(self.current_checker_command)

1363

1929

return r

1364

1930

1365

1931

def _reset_approved(self):

1366

1932

self.approved = None

1367

1933

return False

1368

1934

1369

1935

def approve(self, value=True):

1370

1936

self.approved = value

1371

gobject.timeout_add(timedelta_to_milliseconds

1372

(self.approval_duration),

1373

self._reset_approved)

1937

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

1938

* 1000), self._reset_approved)

1374

1939

self.send_changedstate()

1375

1376

## D-Bus methods, signals & properties

1377

_interface = "se.recompile.Mandos.Client"

1378

1379

## Interfaces

1380

1381

@dbus_interface_annotations(_interface)

1382

def _foo(self):

1383

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

1384

"false"}

1385

1386

## Signals

1387

1940

1941

# D-Bus methods, signals & properties

1942

1943

# Interfaces

1944

1945

# Signals

1946

1388

1947

# CheckerCompleted - signal

1389

1948

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

1390

1949

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

1391

1950

"D-Bus signal"

1392

1951

pass

1393

1952

1394

1953

# CheckerStarted - signal

1395

1954

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

1396

1955

def CheckerStarted(self, command):

1397

1956

"D-Bus signal"

1398

1957

pass

1399

1958

1400

1959

# PropertyChanged - signal

1960

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

1401

1961

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

1402

1962

def PropertyChanged(self, property, value):

1403

1963

"D-Bus signal"

1404

1964

pass

1405

1965

1406

1966

# GotSecret - signal

1407

1967

@dbus.service.signal(_interface)

1408

1968

def GotSecret(self):

1411

1971

server to mandos-client

1412

1972

"""

1413

1973

pass

1414

1974

1415

1975

# Rejected - signal

1416

1976

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

1417

1977

def Rejected(self, reason):

1418

1978

"D-Bus signal"

1419

1979

pass

1420

1980

1421

1981

# NeedApproval - signal

1422

1982

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

1423

1983

def NeedApproval(self, timeout, default):

1424

1984

"D-Bus signal"

1425

1985

return self.need_approval()

1426

1427

## Methods

1428

1986

1987

# Methods

1988

1429

1989

# Approve - method

1430

1990

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

1431

1991

def Approve(self, value):

1432

1992

self.approve(value)

1433

1993

1434

1994

# CheckedOK - method

1435

1995

@dbus.service.method(_interface)

1436

1996

def CheckedOK(self):

1437

1997

self.checked_ok()

1438

1998

1439

1999

# Enable - method

2000

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

1440

2001

@dbus.service.method(_interface)

1441

2002

def Enable(self):

1442

2003

"D-Bus method"

1443

2004

self.enable()

1444

2005

1445

2006

# StartChecker - method

2007

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

1446

2008

@dbus.service.method(_interface)

1447

2009

def StartChecker(self):

1448

2010

"D-Bus method"

1449

2011

self.start_checker()

1450

2012

1451

2013

# Disable - method

2014

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

1452

2015

@dbus.service.method(_interface)

1453

2016

def Disable(self):

1454

2017

"D-Bus method"

1455

2018

self.disable()

1456

2019

1457

2020

# StopChecker - method

2021

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

1458

2022

@dbus.service.method(_interface)

1459

2023

def StopChecker(self):

1460

2024

self.stop_checker()

1461

1462

## Properties

1463

2025

2026

# Properties

2027

1464

2028

# ApprovalPending - property

1465

2029

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

1466

2030

def ApprovalPending_dbus_property(self):

1467

2031

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

1468

2032

1469

2033

# ApprovedByDefault - property

1470

@dbus_service_property(_interface, signature="b",

2034

@dbus_service_property(_interface,

2035

signature="b",

1471

2036

access="readwrite")

1472

2037

def ApprovedByDefault_dbus_property(self, value=None):

1473

2038

if value is None: # get

1474

2039

return dbus.Boolean(self.approved_by_default)

1475

2040

self.approved_by_default = bool(value)

1476

2041

1477

2042

# ApprovalDelay - property

1478

@dbus_service_property(_interface, signature="t",

2043

@dbus_service_property(_interface,

2044

signature="t",

1479

2045

access="readwrite")

1480

2046

def ApprovalDelay_dbus_property(self, value=None):

1481

2047

if value is None: # get

1482

return dbus.UInt64(self.approval_delay_milliseconds())

2048

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

2049

* 1000)

1483

2050

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

1484

2051

1485

2052

# ApprovalDuration - property

1486

@dbus_service_property(_interface, signature="t",

2053

@dbus_service_property(_interface,

2054

signature="t",

1487

2055

access="readwrite")

1488

2056

def ApprovalDuration_dbus_property(self, value=None):

1489

2057

if value is None: # get

1490

return dbus.UInt64(timedelta_to_milliseconds(

1491

self.approval_duration))

2058

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

2059

* 1000)

1492

2060

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

1493

2061

1494

2062

# Name - property

2063

@dbus_annotations(

2064

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

1495

2065

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

1496

2066

def Name_dbus_property(self):

1497

2067

return dbus.String(self.name)

1498

2068

2069

# KeyID - property

2070

@dbus_annotations(

2071

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

2072

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

2073

def KeyID_dbus_property(self):

2074

return dbus.String(self.key_id)

2075

1499

2076

# Fingerprint - property

2077

@dbus_annotations(

2078

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

1500

2079

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

1501

2080

def Fingerprint_dbus_property(self):

1502

2081

return dbus.String(self.fingerprint)

1503

2082

1504

2083

# Host - property

1505

@dbus_service_property(_interface, signature="s",

2084

@dbus_service_property(_interface,

2085

signature="s",

1506

2086

access="readwrite")

1507

2087

def Host_dbus_property(self, value=None):

1508

2088

if value is None: # get

1509

2089

return dbus.String(self.host)

1510

self.host = unicode(value)

1511

2090

self.host = str(value)

2091

1512

2092

# Created - property

2093

@dbus_annotations(

2094

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

1513

2095

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

1514

2096

def Created_dbus_property(self):

1515

2097

return datetime_to_dbus(self.created)

1516

2098

1517

2099

# LastEnabled - property

1518

2100

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

1519

2101

def LastEnabled_dbus_property(self):

1520

2102

return datetime_to_dbus(self.last_enabled)

1521

2103

1522

2104

# Enabled - property

1523

@dbus_service_property(_interface, signature="b",

2105

@dbus_service_property(_interface,

2106

signature="b",

1524

2107

access="readwrite")

1525

2108

def Enabled_dbus_property(self, value=None):

1526

2109

if value is None: # get

1529

2112

self.enable()

1530

2113

else:

1531

2114

self.disable()

1532

2115

1533

2116

# LastCheckedOK - property

1534

@dbus_service_property(_interface, signature="s",

2117

@dbus_service_property(_interface,

2118

signature="s",

1535

2119

access="readwrite")

1536

2120

def LastCheckedOK_dbus_property(self, value=None):

1537

2121

if value is not None:

1538

2122

self.checked_ok()

1539

2123

return

1540

2124

return datetime_to_dbus(self.last_checked_ok)

1541

2125

1542

2126

# LastCheckerStatus - property

1543

@dbus_service_property(_interface, signature="n",

1544

access="read")

2127

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

1545

2128

def LastCheckerStatus_dbus_property(self):

1546

2129

return dbus.Int16(self.last_checker_status)

1547

2130

1548

2131

# Expires - property

1549

2132

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

1550

2133

def Expires_dbus_property(self):

1551

2134

return datetime_to_dbus(self.expires)

1552

2135

1553

2136

# LastApprovalRequest - property

1554

2137

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

1555

2138

def LastApprovalRequest_dbus_property(self):

1556

2139

return datetime_to_dbus(self.last_approval_request)

1557

2140

1558

2141

# Timeout - property

1559

@dbus_service_property(_interface, signature="t",

2142

@dbus_service_property(_interface,

2143

signature="t",

1560

2144

access="readwrite")

1561

2145

def Timeout_dbus_property(self, value=None):

1562

2146

if value is None: # get

1563

return dbus.UInt64(self.timeout_milliseconds())

2147

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

1564

2148

old_timeout = self.timeout

1565

2149

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

1566

2150

# Reschedule disabling

1574

2158

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

1575

2159

is None):

1576

2160

return

1577

gobject.source_remove(self.disable_initiator_tag)

1578

self.disable_initiator_tag = (

1579

gobject.timeout_add(

1580

timedelta_to_milliseconds(self.expires - now),

1581

self.disable))

1582

2161

GLib.source_remove(self.disable_initiator_tag)

2162

self.disable_initiator_tag = GLib.timeout_add(

2163

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

2164

self.disable)

2165

1583

2166

# ExtendedTimeout - property

1584

@dbus_service_property(_interface, signature="t",

2167

@dbus_service_property(_interface,

2168

signature="t",

1585

2169

access="readwrite")

1586

2170

def ExtendedTimeout_dbus_property(self, value=None):

1587

2171

if value is None: # get

1588

return dbus.UInt64(self.extended_timeout_milliseconds())

2172

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

2173

* 1000)

1589

2174

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

1590

2175

1591

2176

# Interval - property

1592

@dbus_service_property(_interface, signature="t",

2177

@dbus_service_property(_interface,

2178

signature="t",

1593

2179

access="readwrite")

1594

2180

def Interval_dbus_property(self, value=None):

1595

2181

if value is None: # get

1596

return dbus.UInt64(self.interval_milliseconds())

2182

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

1597

2183

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

1598

2184

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

1599

2185

return

1600

2186

if self.enabled:

1601

2187

# Reschedule checker run

1602

gobject.source_remove(self.checker_initiator_tag)

1603

self.checker_initiator_tag = (gobject.timeout_add

1604

(value, self.start_checker))

1605

self.start_checker() # Start one now, too

1606

2188

GLib.source_remove(self.checker_initiator_tag)

2189

self.checker_initiator_tag = GLib.timeout_add(

2190

value, self.start_checker)

2191

self.start_checker() # Start one now, too

2192

1607

2193

# Checker - property

1608

@dbus_service_property(_interface, signature="s",

2194

@dbus_service_property(_interface,

2195

signature="s",

1609

2196

access="readwrite")

1610

2197

def Checker_dbus_property(self, value=None):

1611

2198

if value is None: # get

1612

2199

return dbus.String(self.checker_command)

1613

self.checker_command = unicode(value)

1614

2200

self.checker_command = str(value)

2201

1615

2202

# CheckerRunning - property

1616

@dbus_service_property(_interface, signature="b",

2203

@dbus_service_property(_interface,

2204

signature="b",

1617

2205

access="readwrite")

1618

2206

def CheckerRunning_dbus_property(self, value=None):

1619

2207

if value is None: # get

1622

2210

self.start_checker()

1623

2211

else:

1624

2212

self.stop_checker()

1625

2213

1626

2214

# ObjectPath - property

2215

@dbus_annotations(

2216

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

2217

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

1627

2218

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

1628

2219

def ObjectPath_dbus_property(self):

1629

return self.dbus_object_path # is already a dbus.ObjectPath

1630

2220

return self.dbus_object_path # is already a dbus.ObjectPath

2221

1631

2222

# Secret = property

1632

@dbus_service_property(_interface, signature="ay",

1633

access="write", byte_arrays=True)

2223

@dbus_annotations(

2224

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

2225

"invalidates"})

2226

@dbus_service_property(_interface,

2227

signature="ay",

2228

access="write",

2229

byte_arrays=True)

1634

2230

def Secret_dbus_property(self, value):

1635

self.secret = str(value)

1636

2231

self.secret = bytes(value)

2232

1637

2233

del _interface

1638

2234

1639

2235

1640

class ProxyClient(object):

1641

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

2236

class ProxyClient:

2237

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

1642

2238

self._pipe = child_pipe

1643

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

2239

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

1644

2240

if not self._pipe.recv():

1645

raise KeyError()

1646

2241

raise KeyError(key_id or fpr)

2242

1647

2243

def __getattribute__(self, name):

1648

2244

if name == '_pipe':

1649

2245

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

1652

2248

if data[0] == 'data':

1653

2249

return data[1]

1654

2250

if data[0] == 'function':

2251

1655

2252

def func(*args, **kwargs):

1656

2253

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

1657

2254

return self._pipe.recv()[1]

2255

1658

2256

return func

1659

2257

1660

2258

def __setattr__(self, name, value):

1661

2259

if name == '_pipe':

1662

2260

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

1665

2263

1666

2264

class ClientHandler(socketserver.BaseRequestHandler, object):

1667

2265

"""A class to handle client connections.

1668

2266

1669

2267

Instantiated once for each connection to handle it.

1670

2268

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

1671

2269

1672

2270

def handle(self):

1673

2271

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

1674

2272

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

1675

unicode(self.client_address))

2273

str(self.client_address))

1676

2274

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

1677

2275

self.server.child_pipe.fileno())

1678

1679

session = (gnutls.connection

1680

.ClientSession(self.request,

1681

gnutls.connection

1682

.X509Credentials()))

1683

1684

# Note: gnutls.connection.X509Credentials is really a

1685

# generic GnuTLS certificate credentials object so long as

1686

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

1687

# here despite using OpenPGP certificates.

1688

1689

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

1690

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

1691

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

1692

# "+DHE-DSS"))

2276

2277

session = gnutls.ClientSession(self.request)

2278

2279

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

2280

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

2281

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

2282

# "+DHE-DSS"))

1693

2283

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

1694

2284

priority = self.server.gnutls_priority

1695

2285

if priority is None:

1696

2286

priority = "NORMAL"

1697

(gnutls.library.functions

1698

.gnutls_priority_set_direct(session._c_object,

1699

priority, None))

1700

2287

gnutls.priority_set_direct(session._c_object,

2288

priority.encode("utf-8"),

2289

None)

2290

1701

2291

# Start communication using the Mandos protocol

1702

2292

# Get protocol number

1703

2293

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

1708

2298

except (ValueError, IndexError, RuntimeError) as error:

1709

2299

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

1710

2300

return

1711

2301

1712

2302

# Start GnuTLS connection

1713

2303

try:

1714

2304

session.handshake()

1715

except gnutls.errors.GNUTLSError as error:

2305

except gnutls.Error as error:

1716

2306

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

1717

2307

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

1718

2308

# established. Just abandon the request.

1719

2309

return

1720

2310

logger.debug("Handshake succeeded")

1721

2311

1722

2312

approval_required = False

1723

2313

try:

1724

try:

1725

fpr = self.fingerprint(self.peer_certificate

1726

(session))

1727

except (TypeError,

1728

gnutls.errors.GNUTLSError) as error:

1729

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

1730

return

1731

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

1732

1733

try:

1734

client = ProxyClient(child_pipe, fpr,

2314

if gnutls.has_rawpk:

2315

fpr = b""

2316

try:

2317

key_id = self.key_id(

2318

self.peer_certificate(session))

2319

except (TypeError, gnutls.Error) as error:

2320

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

2321

return

2322

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

2323

2324

else:

2325

key_id = b""

2326

try:

2327

fpr = self.fingerprint(

2328

self.peer_certificate(session))

2329

except (TypeError, gnutls.Error) as error:

2330

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

2331

return

2332

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

2333

2334

try:

2335

client = ProxyClient(child_pipe, key_id, fpr,

1735

2336

self.client_address)

1736

2337

except KeyError:

1737

2338

return

1738

2339

1739

2340

if client.approval_delay:

1740

2341

delay = client.approval_delay

1741

2342

client.approvals_pending += 1

1742

2343

approval_required = True

1743

2344

1744

2345

while True:

1745

2346

if not client.enabled:

1746

2347

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

1747

client.name)

2348

client.name)

1748

2349

if self.server.use_dbus:

1749

2350

# Emit D-Bus signal

1750

2351

client.Rejected("Disabled")

1751

2352

return

1752

2353

1753

2354

if client.approved or not client.approval_delay:

1754

#We are approved or approval is disabled

2355

# We are approved or approval is disabled

1755

2356

break

1756

2357

elif client.approved is None:

1757

2358

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

1759

2360

if self.server.use_dbus:

1760

2361

# Emit D-Bus signal

1761

2362

client.NeedApproval(

1762

client.approval_delay_milliseconds(),

1763

client.approved_by_default)

2363

client.approval_delay.total_seconds()

2364

* 1000, client.approved_by_default)

1764

2365

else:

1765

2366

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

1766

2367

client.name)

1768

2369

# Emit D-Bus signal

1769

2370

client.Rejected("Denied")

1770

2371

return

1771

1772

#wait until timeout or approved

2372

2373

# wait until timeout or approved

1773

2374

time = datetime.datetime.now()

1774

2375

client.changedstate.acquire()

1775

client.changedstate.wait(

1776

float(timedelta_to_milliseconds(delay)

1777

/ 1000))

2376

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

1778

2377

client.changedstate.release()

1779

2378

time2 = datetime.datetime.now()

1780

2379

if (time2 - time) >= delay:

1790

2389

break

1791

2390

else:

1792

2391

delay -= time2 - time

1793

1794

sent_size = 0

1795

while sent_size < len(client.secret):

1796

try:

1797

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

1798

except gnutls.errors.GNUTLSError as error:

1799

logger.warning("gnutls send failed",

1800

exc_info=error)

1801

return

1802

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

1803

sent, len(client.secret)

1804

- (sent_size + sent))

1805

sent_size += sent

1806

2392

2393

try:

2394

session.send(client.secret)

2395

except gnutls.Error as error:

2396

logger.warning("gnutls send failed",

2397

exc_info=error)

2398

return

2399

1807

2400

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

1808

2401

# bump the timeout using extended_timeout

1809

2402

client.bump_timeout(client.extended_timeout)

1810

2403

if self.server.use_dbus:

1811

2404

# Emit D-Bus signal

1812

2405

client.GotSecret()

1813

2406

1814

2407

finally:

1815

2408

if approval_required:

1816

2409

client.approvals_pending -= 1

1817

2410

try:

1818

2411

session.bye()

1819

except gnutls.errors.GNUTLSError as error:

2412

except gnutls.Error as error:

1820

2413

logger.warning("GnuTLS bye failed",

1821

2414

exc_info=error)

1822

2415

1823

2416

@staticmethod

1824

2417

def peer_certificate(session):

1825

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

1826

# If not an OpenPGP certificate...

1827

if (gnutls.library.functions

1828

.gnutls_certificate_type_get(session._c_object)

1829

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1830

# ...do the normal thing

1831

return session.peer_certificate

2418

"Return the peer's certificate as a bytestring"

2419

try:

2420

cert_type = gnutls.certificate_type_get2(session._c_object,

2421

gnutls.CTYPE_PEERS)

2422

except AttributeError:

2423

cert_type = gnutls.certificate_type_get(session._c_object)

2424

if gnutls.has_rawpk:

2425

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2426

else:

2427

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2428

# If not a valid certificate type...

2429

if cert_type not in valid_cert_types:

2430

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

2431

valid_cert_types)

2432

# ...return invalid data

2433

return b""

1832

2434

list_size = ctypes.c_uint(1)

1833

cert_list = (gnutls.library.functions

1834

.gnutls_certificate_get_peers

2435

cert_list = (gnutls.certificate_get_peers

1835

2436

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

1836

2437

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

1837

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

1838

" certificate")

2438

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

1839

2439

if list_size.value == 0:

1840

2440

return None

1841

2441

cert = cert_list[0]

1842

2442

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

1843

2443

2444

@staticmethod

2445

def key_id(certificate):

2446

"Convert a certificate bytestring to a hexdigit key ID"

2447

# New GnuTLS "datum" with the public key

2448

datum = gnutls.datum_t(

2449

ctypes.cast(ctypes.c_char_p(certificate),

2450

ctypes.POINTER(ctypes.c_ubyte)),

2451

ctypes.c_uint(len(certificate)))

2452

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

2453

# New empty GnuTLS certificate

2454

pubkey = gnutls.pubkey_t()

2455

gnutls.pubkey_init(ctypes.byref(pubkey))

2456

# Import the raw public key into the certificate

2457

gnutls.pubkey_import(pubkey,

2458

ctypes.byref(datum),

2459

gnutls.X509_FMT_DER)

2460

# New buffer for the key ID

2461

buf = ctypes.create_string_buffer(32)

2462

buf_len = ctypes.c_size_t(len(buf))

2463

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

2464

gnutls.pubkey_get_key_id(pubkey,

2465

gnutls.KEYID_USE_SHA256,

2466

ctypes.cast(ctypes.byref(buf),

2467

ctypes.POINTER(ctypes.c_ubyte)),

2468

ctypes.byref(buf_len))

2469

# Deinit the certificate

2470

gnutls.pubkey_deinit(pubkey)

2471

2472

# Convert the buffer to a Python bytestring

2473

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

2474

# Convert the bytestring to hexadecimal notation

2475

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

2476

return hex_key_id

2477

1844

2478

@staticmethod

1845

2479

def fingerprint(openpgp):

1846

2480

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

1847

2481

# New GnuTLS "datum" with the OpenPGP public key

1848

datum = (gnutls.library.types

1849

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

1850

ctypes.POINTER

1851

(ctypes.c_ubyte)),

1852

ctypes.c_uint(len(openpgp))))

2482

datum = gnutls.datum_t(

2483

ctypes.cast(ctypes.c_char_p(openpgp),

2484

ctypes.POINTER(ctypes.c_ubyte)),

2485

ctypes.c_uint(len(openpgp)))

1853

2486

# New empty GnuTLS certificate

1854

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1855

(gnutls.library.functions

1856

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2487

crt = gnutls.openpgp_crt_t()

2488

gnutls.openpgp_crt_init(ctypes.byref(crt))

1857

2489

# Import the OpenPGP public key into the certificate

1858

(gnutls.library.functions

1859

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

1860

gnutls.library.constants

1861

.GNUTLS_OPENPGP_FMT_RAW))

2490

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

2491

gnutls.OPENPGP_FMT_RAW)

1862

2492

# Verify the self signature in the key

1863

2493

crtverify = ctypes.c_uint()

1864

(gnutls.library.functions

1865

.gnutls_openpgp_crt_verify_self(crt, 0,

1866

ctypes.byref(crtverify)))

2494

gnutls.openpgp_crt_verify_self(crt, 0,

2495

ctypes.byref(crtverify))

1867

2496

if crtverify.value != 0:

1868

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1869

raise (gnutls.errors.CertificateSecurityError

1870

("Verify failed"))

2497

gnutls.openpgp_crt_deinit(crt)

2498

raise gnutls.CertificateSecurityError(code

2499

=crtverify.value)

1871

2500

# New buffer for the fingerprint

1872

2501

buf = ctypes.create_string_buffer(20)

1873

2502

buf_len = ctypes.c_size_t()

1874

2503

# Get the fingerprint from the certificate into the buffer

1875

(gnutls.library.functions

1876

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

1877

ctypes.byref(buf_len)))

2504

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

2505

ctypes.byref(buf_len))

1878

2506

# Deinit the certificate

1879

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2507

gnutls.openpgp_crt_deinit(crt)

1880

2508

# Convert the buffer to a Python bytestring

1881

2509

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

1882

2510

# Convert the bytestring to hexadecimal notation

1884

2512

return hex_fpr

1885

2513

1886

2514

1887

class MultiprocessingMixIn(object):

2515

class MultiprocessingMixIn:

1888

2516

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

2517

1889

2518

def sub_process_main(self, request, address):

1890

2519

try:

1891

2520

self.finish_request(request, address)

1892

2521

except Exception:

1893

2522

self.handle_error(request, address)

1894

2523

self.close_request(request)

1895

2524

1896

2525

def process_request(self, request, address):

1897

2526

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

1898

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

1899

args = (request, address))

2527

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

2528

args=(request, address))

1900

2529

proc.start()

1901

2530

return proc

1902

2531

1903

2532

1904

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2533

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1905

2534

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

2535

1906

2536

def process_request(self, request, client_address):

1907

2537

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

1908

2538

1909

2539

This function creates a new pipe in self.pipe

1910

2540

"""

1911

2541

parent_pipe, self.child_pipe = multiprocessing.Pipe()

1912

2542

1913

2543

proc = MultiprocessingMixIn.process_request(self, request,

1914

2544

client_address)

1915

2545

self.child_pipe.close()

1916

2546

self.add_pipe(parent_pipe, proc)

1917

2547

1918

2548

def add_pipe(self, parent_pipe, proc):

1919

2549

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

1920

2550

raise NotImplementedError()

1921

2551

1922

2552

1923

2553

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

1924

socketserver.TCPServer, object):

2554

socketserver.TCPServer):

1925

2555

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

1926

2556

1927

2557

Attributes:

1928

2558

enabled: Boolean; whether this server is activated yet

1929

2559

interface: None or a network interface name (string)

1930

2560

use_ipv6: Boolean; to use IPv6 or not

1931

2561

"""

2562

1932

2563

def __init__(self, server_address, RequestHandlerClass,

1933

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

2564

interface=None,

2565

use_ipv6=True,

2566

socketfd=None):

1934

2567

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

1935

2568

creating a new one with socket.socket().

1936

2569

"""

1942

2575

self.socketfd = socketfd

1943

2576

# Save the original socket.socket() function

1944

2577

self.socket_socket = socket.socket

2578

1945

2579

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

1946

#

2580

#

1947

2581

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

1948

2582

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

1949

2583

# patching socket.socket.)

1950

#

2584

#

1951

2585

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

1952

2586

@functools.wraps(socket.socket)

1953

2587

def socket_wrapper(*args, **kwargs):

1965

2599

# socket_wrapper(), if socketfd was set.

1966

2600

socketserver.TCPServer.__init__(self, server_address,

1967

2601

RequestHandlerClass)

1968

2602

1969

2603

def server_bind(self):

1970

2604

"""This overrides the normal server_bind() function

1971

2605

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

1972

2606

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

2607

global SO_BINDTODEVICE

1973

2608

if self.interface is not None:

1974

2609

if SO_BINDTODEVICE is None:

1975

logger.error("SO_BINDTODEVICE does not exist;"

1976

" cannot bind to interface %s",

1977

self.interface)

1978

else:

1979

try:

1980

self.socket.setsockopt(socket.SOL_SOCKET,

1981

SO_BINDTODEVICE,

1982

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

1983

except socket.error as error:

1984

if error.errno == errno.EPERM:

1985

logger.error("No permission to bind to"

1986

" interface %s", self.interface)

1987

elif error.errno == errno.ENOPROTOOPT:

1988

logger.error("SO_BINDTODEVICE not available;"

1989

" cannot bind to interface %s",

1990

self.interface)

1991

elif error.errno == errno.ENODEV:

1992

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

1993

" cannot bind", self.interface)

1994

else:

1995

raise

2610

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

2611

# common enough.

2612

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

2613

SO_BINDTODEVICE = 25

2614

try:

2615

self.socket.setsockopt(

2616

socket.SOL_SOCKET, SO_BINDTODEVICE,

2617

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

2618

except socket.error as error:

2619

if error.errno == errno.EPERM:

2620

logger.error("No permission to bind to"

2621

" interface %s", self.interface)

2622

elif error.errno == errno.ENOPROTOOPT:

2623

logger.error("SO_BINDTODEVICE not available;"

2624

" cannot bind to interface %s",

2625

self.interface)

2626

elif error.errno == errno.ENODEV:

2627

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

2628

" cannot bind", self.interface)

2629

else:

2630

raise

1996

2631

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

1997

2632

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

2633

if self.server_address[1]:

2634

self.allow_reuse_address = True

1998

2635

if not self.server_address[0]:

1999

2636

if self.address_family == socket.AF_INET6:

2000

any_address = "::" # in6addr_any

2637

any_address = "::" # in6addr_any

2001

2638

else:

2002

any_address = "0.0.0.0" # INADDR_ANY

2639

any_address = "0.0.0.0" # INADDR_ANY

2003

2640

self.server_address = (any_address,

2004

2641

self.server_address[1])

2005

2642

elif not self.server_address[1]:

2006

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

2007

0)

2643

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

2008

2644

# if self.interface:

2009

2645

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

2010

2646

# 0, # port

2016

2652

2017

2653

class MandosServer(IPv6_TCPServer):

2018

2654

"""Mandos server.

2019

2655

2020

2656

Attributes:

2021

2657

clients: set of Client objects

2022

2658

gnutls_priority GnuTLS priority string

2023

2659

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

2024

2025

Assumes a gobject.MainLoop event loop.

2660

2661

Assumes a GLib.MainLoop event loop.

2026

2662

"""

2663

2027

2664

def __init__(self, server_address, RequestHandlerClass,

2028

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

2029

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

2665

interface=None,

2666

use_ipv6=True,

2667

clients=None,

2668

gnutls_priority=None,

2669

use_dbus=True,

2670

socketfd=None):

2030

2671

self.enabled = False

2031

2672

self.clients = clients

2032

2673

if self.clients is None:

2035

2676

self.gnutls_priority = gnutls_priority

2036

2677

IPv6_TCPServer.__init__(self, server_address,

2037

2678

RequestHandlerClass,

2038

interface = interface,

2039

use_ipv6 = use_ipv6,

2040

socketfd = socketfd)

2679

interface=interface,

2680

use_ipv6=use_ipv6,

2681

socketfd=socketfd)

2682

2041

2683

def server_activate(self):

2042

2684

if self.enabled:

2043

2685

return socketserver.TCPServer.server_activate(self)

2044

2686

2045

2687

def enable(self):

2046

2688

self.enabled = True

2047

2689

2048

2690

def add_pipe(self, parent_pipe, proc):

2049

2691

# Call "handle_ipc" for both data and EOF events

2050

gobject.io_add_watch(parent_pipe.fileno(),

2051

gobject.IO_IN | gobject.IO_HUP,

2052

functools.partial(self.handle_ipc,

2053

parent_pipe =

2054

parent_pipe,

2055

proc = proc))

2056

2057

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

2058

proc = None, client_object=None):

2692

GLib.io_add_watch(

2693

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

2694

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

2695

functools.partial(self.handle_ipc,

2696

parent_pipe=parent_pipe,

2697

proc=proc))

2698

2699

def handle_ipc(self, source, condition,

2700

parent_pipe=None,

2701

proc=None,

2702

client_object=None):

2059

2703

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

2060

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

2704

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

2061

2705

# Wait for other process to exit

2062

2706

proc.join()

2063

2707

return False

2064

2708

2065

2709

# Read a request from the child

2066

2710

request = parent_pipe.recv()

2067

2711

command = request[0]

2068

2712

2069

2713

if command == 'init':

2070

fpr = request[1]

2071

address = request[2]

2072

2073

for c in self.clients.itervalues():

2074

if c.fingerprint == fpr:

2714

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

2715

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

2716

address = request[3]

2717

2718

for c in self.clients.values():

2719

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2720

continue

2721

if key_id and c.key_id == key_id:

2722

client = c

2723

break

2724

if fpr and c.fingerprint == fpr:

2075

2725

client = c

2076

2726

break

2077

2727

else:

2078

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

2079

"dress: %s", fpr, address)

2728

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

2729

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

2080

2730

if self.use_dbus:

2081

2731

# Emit D-Bus signal

2082

mandos_dbus_service.ClientNotFound(fpr,

2732

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

2733

address[0])

2084

2734

parent_pipe.send(False)

2085

2735

return False

2086

2087

gobject.io_add_watch(parent_pipe.fileno(),

2088

gobject.IO_IN | gobject.IO_HUP,

2089

functools.partial(self.handle_ipc,

2090

parent_pipe =

2091

parent_pipe,

2092

proc = proc,

2093

client_object =

2094

client))

2736

2737

GLib.io_add_watch(

2738

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

2739

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

2740

functools.partial(self.handle_ipc,

2741

parent_pipe=parent_pipe,

2742

proc=proc,

2743

client_object=client))

2095

2744

parent_pipe.send(True)

2096

2745

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

2097

2746

# same fileno

2100

2749

funcname = request[1]

2101

2750

args = request[2]

2102

2751

kwargs = request[3]

2103

2752

2104

2753

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

2105

2754

funcname)(*args,

2106

**kwargs)))

2107

2755

**kwargs)))

2756

2108

2757

if command == 'getattr':

2109

2758

attrname = request[1]

2110

if callable(client_object.__getattribute__(attrname)):

2111

parent_pipe.send(('function',))

2759

if isinstance(client_object.__getattribute__(attrname),

2760

collections.abc.Callable):

2761

parent_pipe.send(('function', ))

2112

2762

else:

2113

parent_pipe.send(('data', client_object

2114

.__getattribute__(attrname)))

2115

2763

parent_pipe.send((

2764

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

2765

2116

2766

if command == 'setattr':

2117

2767

attrname = request[1]

2118

2768

value = request[2]

2119

2769

setattr(client_object, attrname, value)

2120

2770

2121

2771

return True

2122

2772

2123

2773

2124

2774

def rfc3339_duration_to_delta(duration):

2125

2775

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

2126

2127

>>> rfc3339_duration_to_delta("P7D")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT60S")

2130

datetime.timedelta(0, 60)

2131

>>> rfc3339_duration_to_delta("PT60M")

2132

datetime.timedelta(0, 3600)

2133

>>> rfc3339_duration_to_delta("PT24H")

2134

datetime.timedelta(1)

2135

>>> rfc3339_duration_to_delta("P1W")

2136

datetime.timedelta(7)

2137

>>> rfc3339_duration_to_delta("PT5M30S")

2138

datetime.timedelta(0, 330)

2139

>>> rfc3339_duration_to_delta("P1DT3M20S")

2140

datetime.timedelta(1, 200)

2776

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2783

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

2784

True

2785

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

2786

True

2787

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

2788

True

2789

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

2790

True

2141

2791

"""

2142

2792

2143

2793

# Parsing an RFC 3339 duration with regular expressions is not

2144

2794

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

2145

2795

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

2146

2796

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

2147

2797

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

2148

2798

# avoid excessive use of external libraries.

2149

2799

2150

2800

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

2151

Token = collections.namedtuple("Token",

2152

("regexp", # To match token; if

2153

# "value" is not None,

2154

# must have a "group"

2155

# containing digits

2156

"value", # datetime.timedelta or

2157

# None

2158

"followers")) # Tokens valid after

2159

# this token

2801

Token = collections.namedtuple("Token", (

2802

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

2803

# a "group" containing digits

2804

"value", # datetime.timedelta or None

2805

"followers")) # Tokens valid after this token

2160

2806

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

2161

2807

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

2162

2808

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

2163

2809

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

2164

2810

datetime.timedelta(seconds=1),

2165

frozenset((token_end,)))

2811

frozenset((token_end, )))

2166

2812

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

2167

2813

datetime.timedelta(minutes=1),

2168

2814

frozenset((token_second, token_end)))

2184

2830

frozenset((token_month, token_end)))

2185

2831

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

2186

2832

datetime.timedelta(weeks=1),

2187

frozenset((token_end,)))

2833

frozenset((token_end, )))

2188

2834

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

2189

2835

frozenset((token_year, token_month,

2190

2836

token_day, token_time,

2191

token_week))),

2192

# Define starting values

2193

value = datetime.timedelta() # Value so far

2837

token_week)))

2838

# Define starting values:

2839

# Value so far

2840

value = datetime.timedelta()

2194

2841

found_token = None

2195

followers = frozenset(token_duration,) # Following valid tokens

2196

s = duration # String left to parse

2842

# Following valid tokens

2843

followers = frozenset((token_duration, ))

2844

# String left to parse

2845

s = duration

2197

2846

# Loop until end token is found

2198

2847

while found_token is not token_end:

2199

2848

# Search for any currently valid tokens

2215

2864

break

2216

2865

else:

2217

2866

# No currently valid tokens were found

2218

raise ValueError("Invalid RFC 3339 duration")

2867

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

2868

.format(duration))

2219

2869

# End token found

2220

2870

return value

2221

2871

2222

2872

2223

2873

def string_to_delta(interval):

2224

2874

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

2225

2226

>>> string_to_delta('7d')

2227

datetime.timedelta(7)

2228

>>> string_to_delta('60s')

2229

datetime.timedelta(0, 60)

2230

>>> string_to_delta('60m')

2231

datetime.timedelta(0, 3600)

2232

>>> string_to_delta('24h')

2233

datetime.timedelta(1)

2234

>>> string_to_delta('1w')

2235

datetime.timedelta(7)

2236

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

2237

datetime.timedelta(0, 330)

2875

2876

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

2877

True

2878

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

2879

True

2880

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

2881

True

2882

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

2883

True

2884

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

2885

True

2886

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

2887

True

2238

2888

"""

2239

2889

2240

2890

try:

2241

2891

return rfc3339_duration_to_delta(interval)

2242

2892

except ValueError:

2243

2893

pass

2244

2894

2245

2895

timevalue = datetime.timedelta(0)

2246

2896

for s in interval.split():

2247

2897

try:

2248

suffix = unicode(s[-1])

2898

suffix = s[-1]

2249

2899

value = int(s[:-1])

2250

2900

if suffix == "d":

2251

2901

delta = datetime.timedelta(value)

2258

2908

elif suffix == "w":

2259

2909

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

2260

2910

else:

2261

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

2262

.format(suffix))

2911

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

2263

2912

except IndexError as e:

2264

2913

raise ValueError(*(e.args))

2265

2914

timevalue += delta

2266

2915

return timevalue

2267

2916

2268

2917

2269

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

2918

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

2270

2919

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

2271

2920

2272

2921

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

2273

2922

if os.fork():

2274

2923

sys.exit()

2282

2931

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

2283

2932

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

2284

2933

raise OSError(errno.ENODEV,

2285

"{0} not a character device"

2934

"{} not a character device"

2286

2935

.format(os.devnull))

2287

2936

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

2288

2937

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

2292

2941

2293

2942

2294

2943

def main():

2295

2944

2296

2945

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

2297

2946

# Parsing of options, both command line and config file

2298

2947

2299

2948

parser = argparse.ArgumentParser()

2300

2949

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

2301

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

2950

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

2302

2951

help="show version number and exit")

2303

2952

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

2304

2953

help="Bind to interface IF")

2340

2989

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

2341

2990

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

2342

2991

default=None)

2343

2992

2344

2993

options = parser.parse_args()

2345

2346

if options.check:

2347

import doctest

2348

fail_count, test_count = doctest.testmod()

2349

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

2350

2994

2351

2995

# Default values for config file for server-global settings

2352

server_defaults = { "interface": "",

2353

"address": "",

2354

"port": "",

2355

"debug": "False",

2356

"priority":

2357

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

2358

"servicename": "Mandos",

2359

"use_dbus": "True",

2360

"use_ipv6": "True",

2361

"debuglevel": "",

2362

"restore": "True",

2363

"socket": "",

2364

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

2365

"foreground": "False",

2366

"zeroconf": "True",

2367

}

2368

2996

if gnutls.has_rawpk:

2997

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

2998

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

2999

else:

3000

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

3001

":+SIGN-DSA-SHA256")

3002

server_defaults = {"interface": "",

3003

"address": "",

3004

"port": "",

3005

"debug": "False",

3006

"priority": priority,

3007

"servicename": "Mandos",

3008

"use_dbus": "True",

3009

"use_ipv6": "True",

3010

"debuglevel": "",

3011

"restore": "True",

3012

"socket": "",

3013

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

3014

"foreground": "False",

3015

"zeroconf": "True",

3016

}

3017

del priority

3018

2369

3019

# Parse config file for server-global settings

2370

server_config = configparser.SafeConfigParser(server_defaults)

3020

server_config = configparser.ConfigParser(server_defaults)

2371

3021

del server_defaults

2372

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

2373

"mandos.conf"))

2374

# Convert the SafeConfigParser object to a dict

3022

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

3023

# Convert the ConfigParser object to a dict

2375

3024

server_settings = server_config.defaults()

2376

3025

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

2377

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

3026

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

3027

"foreground", "zeroconf"):

2378

3028

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

2379

3029

option)

2380

3030

if server_settings["port"]:

2390

3040

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

2391

3041

["socket"])

2392

3042

del server_config

2393

3043

2394

3044

# Override the settings from the config file with command line

2395

3045

# options, if set.

2396

3046

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

2397

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

2398

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

2399

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

3047

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

3048

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

3049

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

2400

3050

value = getattr(options, option)

2401

3051

if value is not None:

2402

3052

server_settings[option] = value

2403

3053

del options

2404

3054

# Force all strings to be unicode

2405

3055

for option in server_settings.keys():

2406

if type(server_settings[option]) is str:

2407

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

3056

if isinstance(server_settings[option], bytes):

3057

server_settings[option] = (server_settings[option]

3058

.decode("utf-8"))

2408

3059

# Force all boolean options to be boolean

2409

3060

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

2410

3061

"foreground", "zeroconf"):

2413

3064

if server_settings["debug"]:

2414

3065

server_settings["foreground"] = True

2415

3066

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

2416

3067

2417

3068

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

2418

2419

if (not server_settings["zeroconf"] and

2420

not (server_settings["port"]

2421

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

2422

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

2423

" Zeroconf")

2424

3069

3070

if (not server_settings["zeroconf"]

3071

and not (server_settings["port"]

3072

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

3073

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

3074

2425

3075

# For convenience

2426

3076

debug = server_settings["debug"]

2427

3077

debuglevel = server_settings["debuglevel"]

2431

3081

stored_state_file)

2432

3082

foreground = server_settings["foreground"]

2433

3083

zeroconf = server_settings["zeroconf"]

2434

3084

2435

3085

if debug:

2436

3086

initlogger(debug, logging.DEBUG)

2437

3087

else:

2440

3090

else:

2441

3091

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

2442

3092

initlogger(debug, level)

2443

3093

2444

3094

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

2445

syslogger.setFormatter(logging.Formatter

2446

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

2447

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

2448

.format(server_settings

2449

["servicename"])))

2450

3095

syslogger.setFormatter(

3096

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

3097

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

3098

server_settings["servicename"])))

3099

2451

3100

# Parse config file with clients

2452

client_config = configparser.SafeConfigParser(Client

2453

.client_defaults)

3101

client_config = configparser.ConfigParser(Client.client_defaults)

2454

3102

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

2455

3103

"clients.conf"))

2456

3104

2457

3105

global mandos_dbus_service

2458

3106

mandos_dbus_service = None

2459

3107

2460

3108

socketfd = None

2461

3109

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

2462

3110

socketfd = server_settings["socket"]

2463

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

2464

server_settings["port"]),

2465

ClientHandler,

2466

interface=(server_settings["interface"]

2467

or None),

2468

use_ipv6=use_ipv6,

2469

gnutls_priority=

2470

server_settings["priority"],

2471

use_dbus=use_dbus,

2472

socketfd=socketfd)

3111

tcp_server = MandosServer(

3112

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

3113

ClientHandler,

3114

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

3115

use_ipv6=use_ipv6,

3116

gnutls_priority=server_settings["priority"],

3117

use_dbus=use_dbus,

3118

socketfd=socketfd)

2473

3119

if not foreground:

2474

3120

pidfilename = "/run/mandos.pid"

2475

3121

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

2476

3122

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

2477

3123

pidfile = None

2478

3124

try:

2479

pidfile = open(pidfilename, "w")

3125

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

2480

3126

except IOError as e:

2481

3127

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

2482

3128

exc_info=e)

2483

2484

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

3129

3130

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

3131

("mandos", "mandos"),

3132

("nobody", "nogroup")):

2485

3133

try:

2486

3134

uid = pwd.getpwnam(name).pw_uid

2487

gid = pwd.getpwnam(name).pw_gid

3135

gid = pwd.getpwnam(group).pw_gid

2488

3136

break

2489

3137

except KeyError:

2490

3138

continue

2494

3142

try:

2495

3143

os.setgid(gid)

2496

3144

os.setuid(uid)

3145

if debug:

3146

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

3147

gid))

2497

3148

except OSError as error:

3149

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

3150

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

2498

3151

if error.errno != errno.EPERM:

2499

3152

raise

2500

3153

2501

3154

if debug:

2502

3155

# Enable all possible GnuTLS debugging

2503

3156

2504

3157

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

2505

3158

# - GnuTLS manual

2506

gnutls.library.functions.gnutls_global_set_log_level(11)

2507

2508

@gnutls.library.types.gnutls_log_func

3159

gnutls.global_set_log_level(11)

3160

3161

@gnutls.log_func

2509

3162

def debug_gnutls(level, string):

2510

3163

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

2511

2512

(gnutls.library.functions

2513

.gnutls_global_set_log_function(debug_gnutls))

2514

3164

3165

gnutls.global_set_log_function(debug_gnutls)

3166

2515

3167

# Redirect stdin so all checkers get /dev/null

2516

3168

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

2517

3169

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

2518

3170

if null > 2:

2519

3171

os.close(null)

2520

3172

2521

3173

# Need to fork before connecting to D-Bus

2522

3174

if not foreground:

2523

3175

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

2524

3176

daemon()

2525

2526

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

2527

# need to inform gobject that threads will be used.

2528

gobject.threads_init()

2529

3177

3178

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

3179

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

3180

# need to inform GLib that threads will be used.

3181

GLib.threads_init()

3182

2530

3183

global main_loop

2531

3184

# From the Avahi example code

2532

3185

DBusGMainLoop(set_as_default=True)

2533

main_loop = gobject.MainLoop()

3186

main_loop = GLib.MainLoop()

2534

3187

bus = dbus.SystemBus()

2535

3188

# End of Avahi example code

2536

3189

if use_dbus:

2537

3190

try:

2538

3191

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

2539

bus, do_not_queue=True)

2540

old_bus_name = (dbus.service.BusName

2541

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

2542

do_not_queue=True))

2543

except dbus.exceptions.NameExistsException as e:

3192

bus,

3193

do_not_queue=True)

3194

old_bus_name = dbus.service.BusName(

3195

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

3196

do_not_queue=True)

3197

except dbus.exceptions.DBusException as e:

2544

3198

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

2545

3199

use_dbus = False

2546

3200

server_settings["use_dbus"] = False

2547

3201

tcp_server.use_dbus = False

2548

3202

if zeroconf:

2549

3203

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2550

service = AvahiServiceToSyslog(name =

2551

server_settings["servicename"],

2552

servicetype = "_mandos._tcp",

2553

protocol = protocol, bus = bus)

3204

service = AvahiServiceToSyslog(

3205

name=server_settings["servicename"],

3206

servicetype="_mandos._tcp",

3207

protocol=protocol,

3208

bus=bus)

2554

3209

if server_settings["interface"]:

2555

service.interface = (if_nametoindex

2556

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

2557

3210

service.interface = if_nametoindex(

3211

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

3212

2558

3213

global multiprocessing_manager

2559

3214

multiprocessing_manager = multiprocessing.Manager()

2560

3215

2561

3216

client_class = Client

2562

3217

if use_dbus:

2563

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

2564

3218

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

3219

2565

3220

client_settings = Client.config_parser(client_config)

2566

3221

old_client_settings = {}

2567

3222

clients_data = {}

2568

3223

2569

3224

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

2570

3225

global wnull

2571

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

3226

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

2572

3227

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

2573

3228

# mode

2574

3229

if debug or not foreground:

2575

3230

wnull.close()

2576

3231

2577

3232

# Get client data and settings from last running state.

2578

3233

if server_settings["restore"]:

2579

3234

try:

2580

3235

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

2581

clients_data, old_client_settings = (pickle.load

2582

(stored_state))

3236

if sys.version_info.major == 2:

3237

clients_data, old_client_settings = pickle.load(

3238

stored_state)

3239

else:

3240

bytes_clients_data, bytes_old_client_settings = (

3241

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

3242

# Fix bytes to strings

3243

# clients_data

3244

# .keys()

3245

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

3246

if isinstance(key, bytes)

3247

else key): value

3248

for key, value in

3249

bytes_clients_data.items()}

3250

del bytes_clients_data

3251

for key in clients_data:

3252

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

3253

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

3254

for k, v in

3255

clients_data[key].items()}

3256

clients_data[key] = value

3257

# .client_structure

3258

value["client_structure"] = [

3259

(s.decode("utf-8")

3260

if isinstance(s, bytes)

3261

else s) for s in

3262

value["client_structure"]]

3263

# .name, .host, and .checker_command

3264

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

3265

if isinstance(value[k], bytes):

3266

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

3267

if "key_id" not in value:

3268

value["key_id"] = ""

3269

elif "fingerprint" not in value:

3270

value["fingerprint"] = ""

3271

# old_client_settings

3272

# .keys()

3273

old_client_settings = {

3274

(key.decode("utf-8")

3275

if isinstance(key, bytes)

3276

else key): value

3277

for key, value in

3278

bytes_old_client_settings.items()}

3279

del bytes_old_client_settings

3280

# .host and .checker_command

3281

for value in old_client_settings.values():

3282

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

3283

if isinstance(value[attribute], bytes):

3284

value[attribute] = (value[attribute]

3285

.decode("utf-8"))

2583

3286

os.remove(stored_state_path)

2584

3287

except IOError as e:

2585

3288

if e.errno == errno.ENOENT:

2586

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

2587

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

3289

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

3290

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

2588

3291

else:

2589

3292

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

2590

3293

exc_info=e)

2591

3294

raise

2592

3295

except EOFError as e:

2593

3296

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

2594

"EOFError:", exc_info=e)

2595

3297

"EOFError:",

3298

exc_info=e)

3299

2596

3300

with PGPEngine() as pgp:

2597

for client_name, client in clients_data.iteritems():

3301

for client_name, client in clients_data.items():

2598

3302

# Skip removed clients

2599

3303

if client_name not in client_settings:

2600

3304

continue

2601

3305

2602

3306

# Decide which value to use after restoring saved state.

2603

3307

# We have three different values: Old config file,

2604

3308

# new config file, and saved state.

2609

3313

# For each value in new config, check if it

2610

3314

# differs from the old config value (Except for

2611

3315

# the "secret" attribute)

2612

if (name != "secret" and

2613

value != old_client_settings[client_name]

2614

[name]):

3316

if (name != "secret"

3317

and (value !=

3318

old_client_settings[client_name][name])):

2615

3319

client[name] = value

2616

3320

except KeyError:

2617

3321

pass

2618

3322

2619

3323

# Clients who has passed its expire date can still be

2620

# enabled if its last checker was successful. Clients

3324

# enabled if its last checker was successful. A Client

2621

3325

# whose checker succeeded before we stored its state is

2622

3326

# assumed to have successfully run all checkers during

2623

3327

# downtime.

2625

3329

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

2626

3330

if not client["last_checked_ok"]:

2627

3331

logger.warning(

2628

"disabling client {0} - Client never "

2629

"performed a successful checker"

2630

.format(client_name))

3332

"disabling client {} - Client never "

3333

"performed a successful checker".format(

3334

client_name))

2631

3335

client["enabled"] = False

2632

3336

elif client["last_checker_status"] != 0:

2633

3337

logger.warning(

2634

"disabling client {0} - Client "

2635

"last checker failed with error code {1}"

2636

.format(client_name,

2637

client["last_checker_status"]))

3338

"disabling client {} - Client last"

3339

" checker failed with error code"

3340

" {}".format(

3341

client_name,

3342

client["last_checker_status"]))

2638

3343

client["enabled"] = False

2639

3344

else:

2640

client["expires"] = (datetime.datetime

2641

.utcnow()

2642

+ client["timeout"])

3345

client["expires"] = (

3346

datetime.datetime.utcnow()

3347

+ client["timeout"])

2643

3348

logger.debug("Last checker succeeded,"

2644

" keeping {0} enabled"

2645

.format(client_name))

3349

" keeping {} enabled".format(

3350

client_name))

2646

3351

try:

2647

client["secret"] = (

2648

pgp.decrypt(client["encrypted_secret"],

2649

client_settings[client_name]

2650

["secret"]))

3352

client["secret"] = pgp.decrypt(

3353

client["encrypted_secret"],

3354

client_settings[client_name]["secret"])

2651

3355

except PGPError:

2652

3356

# If decryption fails, we use secret from new settings

2653

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

2654

.format(client_name))

2655

client["secret"] = (

2656

client_settings[client_name]["secret"])

2657

3357

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

3358

client_name))

3359

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

3360

["secret"])

3361

2658

3362

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

2659

3363

for client_name in (set(old_client_settings)

2660

3364

- set(client_settings)):

2662

3366

for client_name in (set(client_settings)

2663

3367

- set(old_client_settings)):

2664

3368

clients_data[client_name] = client_settings[client_name]

2665

3369

2666

3370

# Create all client objects

2667

for client_name, client in clients_data.iteritems():

3371

for client_name, client in clients_data.items():

2668

3372

tcp_server.clients[client_name] = client_class(

2669

name = client_name, settings = client,

2670

server_settings = server_settings)

2671

3373

name=client_name,

3374

settings=client,

3375

server_settings=server_settings)

3376

2672

3377

if not tcp_server.clients:

2673

3378

logger.warning("No clients defined")

2674

3379

2675

3380

if not foreground:

2676

3381

if pidfile is not None:

3382

pid = os.getpid()

2677

3383

try:

2678

3384

with pidfile:

2679

pid = os.getpid()

2680

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

3385

print(pid, file=pidfile)

2681

3386

except IOError:

2682

3387

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

2683

3388

pidfilename, pid)

2684

3389

del pidfile

2685

3390

del pidfilename

2686

2687

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

2688

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

2689

3391

3392

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

3393

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3394

lambda: main_loop.quit() and False)

3395

2690

3396

if use_dbus:

2691

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

2692

"se.bsnet.fukt.Mandos"})

2693

class MandosDBusService(DBusObjectWithProperties):

3397

3398

@alternate_dbus_interfaces(

3399

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

3400

class MandosDBusService(DBusObjectWithObjectManager):

2694

3401

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

3402

2695

3403

def __init__(self):

2696

3404

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

3405

2697

3406

_interface = "se.recompile.Mandos"

2698

2699

@dbus_interface_annotations(_interface)

2700

def _foo(self):

2701

return { "org.freedesktop.DBus.Property"

2702

".EmitsChangedSignal":

2703

"false"}

2704

3407

2705

3408

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

2706

3409

def ClientAdded(self, objpath):

2707

3410

"D-Bus signal"

2708

3411

pass

2709

3412

2710

3413

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

2711

def ClientNotFound(self, fingerprint, address):

3414

def ClientNotFound(self, key_id, address):

2712

3415

"D-Bus signal"

2713

3416

pass

2714

3417

3418

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

3419

"true"})

2715

3420

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

2716

3421

def ClientRemoved(self, objpath, name):

2717

3422

"D-Bus signal"

2718

3423

pass

2719

3424

3425

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

3426

"true"})

2720

3427

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

2721

3428

def GetAllClients(self):

2722

3429

"D-Bus method"

2723

return dbus.Array(c.dbus_object_path

2724

for c in

2725

tcp_server.clients.itervalues())

2726

3430

return dbus.Array(c.dbus_object_path for c in

3431

tcp_server.clients.values())

3432

3433

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

3434

"true"})

2727

3435

@dbus.service.method(_interface,

2728

3436

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

2729

3437

def GetAllClientsWithProperties(self):

2730

3438

"D-Bus method"

2731

3439

return dbus.Dictionary(

2732

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

2733

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

3440

{c.dbus_object_path: c.GetAll(

3441

"se.recompile.Mandos.Client")

3442

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

2734

3443

signature="oa{sv}")

2735

3444

2736

3445

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

2737

3446

def RemoveClient(self, object_path):

2738

3447

"D-Bus method"

2739

for c in tcp_server.clients.itervalues():

3448

for c in tcp_server.clients.values():

2740

3449

if c.dbus_object_path == object_path:

2741

3450

del tcp_server.clients[c.name]

2742

3451

c.remove_from_connection()

2743

# Don't signal anything except ClientRemoved

3452

# Don't signal the disabling

2744

3453

c.disable(quiet=True)

2745

# Emit D-Bus signal

2746

self.ClientRemoved(object_path, c.name)

3454

# Emit D-Bus signal for removal

3455

self.client_removed_signal(c)

2747

3456

return

2748

3457

raise KeyError(object_path)

2749

3458

2750

3459

del _interface

2751

3460

3461

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3462

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

3463

def GetManagedObjects(self):

3464

"""D-Bus method"""

3465

return dbus.Dictionary(

3466

{client.dbus_object_path:

3467

dbus.Dictionary(

3468

{interface: client.GetAll(interface)

3469

for interface in

3470

client._get_all_interface_names()})

3471

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

3472

3473

def client_added_signal(self, client):

3474

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

3475

if use_dbus:

3476

# New standard signal

3477

self.InterfacesAdded(

3478

client.dbus_object_path,

3479

dbus.Dictionary(

3480

{interface: client.GetAll(interface)

3481

for interface in

3482

client._get_all_interface_names()}))

3483

# Old signal

3484

self.ClientAdded(client.dbus_object_path)

3485

3486

def client_removed_signal(self, client):

3487

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

3488

if use_dbus:

3489

# New standard signal

3490

self.InterfacesRemoved(

3491

client.dbus_object_path,

3492

client._get_all_interface_names())

3493

# Old signal

3494

self.ClientRemoved(client.dbus_object_path,

3495

client.name)

3496

2752

3497

mandos_dbus_service = MandosDBusService()

2753

3498

3499

# Save modules to variables to exempt the modules from being

3500

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

3501

mp = multiprocessing

3502

wn = wnull

3503

2754

3504

def cleanup():

2755

3505

"Cleanup function; run on exit"

2756

3506

if zeroconf:

2757

3507

service.cleanup()

2758

2759

multiprocessing.active_children()

2760

wnull.close()

3508

3509

mp.active_children()

3510

wn.close()

2761

3511

if not (tcp_server.clients or client_settings):

2762

3512

return

2763

3513

2764

3514

# Store client before exiting. Secrets are encrypted with key

2765

3515

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

2766

3516

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

2767

3517

clients = {}

2768

3518

with PGPEngine() as pgp:

2769

for client in tcp_server.clients.itervalues():

3519

for client in tcp_server.clients.values():

2770

3520

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

2771

3521

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

2772

3522

key)

2773

3523

client_dict = {}

2774

3524

2775

3525

# A list of attributes that can not be pickled

2776

3526

# + secret.

2777

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

2778

"checker", "server_settings"))

2779

for name, typ in (inspect.getmembers

2780

(dbus.service.Object)):

3527

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

3528

"checker", "server_settings"}

3529

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

3530

.Object):

2781

3531

exclude.add(name)

2782

3532

2783

3533

client_dict["encrypted_secret"] = (client

2784

3534

.encrypted_secret)

2785

3535

for attr in client.client_structure:

2786

3536

if attr not in exclude:

2787

3537

client_dict[attr] = getattr(client, attr)

2788

3538

2789

3539

clients[client.name] = client_dict

2790

3540

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

2791

3541

2792

3542

try:

2793

with (tempfile.NamedTemporaryFile

2794

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

2795

dir=os.path.dirname(stored_state_path),

2796

delete=False)) as stored_state:

2797

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

2798

tempname=stored_state.name

3543

with tempfile.NamedTemporaryFile(

3544

mode='wb',

3545

suffix=".pickle",

3546

prefix='clients-',

3547

dir=os.path.dirname(stored_state_path),

3548

delete=False) as stored_state:

3549

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

3550

protocol=2)

3551

tempname = stored_state.name

2799

3552

os.rename(tempname, stored_state_path)

2800

3553

except (IOError, OSError) as e:

2801

3554

if not debug:

2804

3557

except NameError:

2805

3558

pass

2806

3559

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

2807

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

3560

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

2808

3561

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

2809

3562

else:

2810

3563

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

2811

3564

exc_info=e)

2812

3565

raise

2813

3566

2814

3567

# Delete all clients, and settings from config

2815

3568

while tcp_server.clients:

2816

3569

name, client = tcp_server.clients.popitem()

2817

3570

if use_dbus:

2818

3571

client.remove_from_connection()

2819

# Don't signal anything except ClientRemoved

3572

# Don't signal the disabling

2820

3573

client.disable(quiet=True)

3574

# Emit D-Bus signal for removal

2821

3575

if use_dbus:

2822

# Emit D-Bus signal

2823

mandos_dbus_service.ClientRemoved(client

2824

.dbus_object_path,

2825

client.name)

3576

mandos_dbus_service.client_removed_signal(client)

2826

3577

client_settings.clear()

2827

3578

2828

3579

atexit.register(cleanup)

2829

2830

for client in tcp_server.clients.itervalues():

3580

3581

for client in tcp_server.clients.values():

2831

3582

if use_dbus:

2832

# Emit D-Bus signal

2833

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3583

# Emit D-Bus signal for adding

3584

mandos_dbus_service.client_added_signal(client)

2834

3585

# Need to initiate checking of clients

2835

3586

if client.enabled:

2836

3587

client.init_checker()

2837

3588

2838

3589

tcp_server.enable()

2839

3590

tcp_server.server_activate()

2840

3591

2841

3592

# Find out what port we got

2842

3593

if zeroconf:

2843

3594

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

2848

3599

else: # IPv4

2849

3600

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

2850

3601

*tcp_server.socket.getsockname())

2851

2852

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

2853

3602

3603

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

3604

2854

3605

try:

2855

3606

if zeroconf:

2856

3607

# From the Avahi example code

2861

3612

cleanup()

2862

3613

sys.exit(1)

2863

3614

# End of Avahi example code

2864

2865

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

2866

lambda *args, **kwargs:

2867

(tcp_server.handle_request

2868

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

2869

3615

3616

GLib.io_add_watch(

3617

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

3618

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3619

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

3620

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

3621

2870

3622

logger.debug("Starting main loop")

2871

3623

main_loop.run()

2872

3624

except AvahiError as error:

2881

3633

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

2882

3634

cleanup()

2883

3635

3636

3637

def should_only_run_tests():

3638

parser = argparse.ArgumentParser(add_help=False)

3639

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

3640

args, unknown_args = parser.parse_known_args()

3641

run_tests = args.check

3642

if run_tests:

3643

# Remove --check argument from sys.argv

3644

sys.argv[1:] = unknown_args

3645

return run_tests

3646

3647

# Add all tests from doctest strings

3648

def load_tests(loader, tests, none):

3649

import doctest

3650

tests.addTests(doctest.DocTestSuite())

3651

return tests

3652

2884

3653

if __name__ == '__main__':

2885

main()

3654

try:

3655

if should_only_run_tests():

3656

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

3657

unittest.main()

3658

else:

3659

main()

3660

finally:

3661

logging.shutdown()