/mandos/release : revision 237.7.174

1

#!/usr/bin/python3 -b

2

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

3

#

1

#!/usr/bin/python

2

# -*- mode: python; 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 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

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

21

19

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

22

20

# (at your option) any later version.

23

21

#

24

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

25

# WITHOUT ANY WARRANTY; without even the implied warranty of

22

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

23

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

26

24

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

27

25

# GNU General Public License for more details.

28

#

26

#

29

27

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

30

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

31

#

28

# along with this program. If not, see

29

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

30

#

32

31

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

33

#

32

#

34

33

35

34

from __future__ import (division, absolute_import, print_function,

36

35

unicode_literals)

37

36

38

try:

39

from future_builtins import *

40

except ImportError:

41

pass

37

from future_builtins import *

42

38

43

try:

44

import SocketServer as socketserver

45

except ImportError:

46

import socketserver

39

import SocketServer as socketserver

47

40

import socket

48

41

import argparse

49

42

import datetime

50

43

import errno

51

try:

52

import ConfigParser as configparser

53

except ImportError:

54

import configparser

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

55

51

import sys

56

52

import re

57

53

import os

66

62

import struct

67

63

import fcntl

68

64

import functools

69

try:

70

import cPickle as pickle

71

except ImportError:

72

import pickle

65

import cPickle as pickle

73

66

import multiprocessing

74

67

import types

75

68

import binascii

76

69

import tempfile

77

70

import itertools

78

71

import collections

79

import codecs

80

import unittest

81

72

82

73

import dbus

83

74

import dbus.service

84

import gi

85

from gi.repository import GLib

75

import gobject

76

import avahi

86

77

from dbus.mainloop.glib import DBusGMainLoop

87

78

import ctypes

88

79

import ctypes.util

89

80

import xml.dom.minidom

90

81

import inspect

91

82

92

if sys.version_info.major == 2:

93

__metaclass__ = type

94

95

# Show warnings by default

96

if not sys.warnoptions:

97

import warnings

98

warnings.simplefilter("default")

99

100

# Try to find the value of SO_BINDTODEVICE:

101

83

try:

102

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

103

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

104

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

105

85

except AttributeError:

106

86

try:

107

# This is where SO_BINDTODEVICE was up to and including Python

108

# 2.6, and also 3.2:

109

87

from IN import SO_BINDTODEVICE

110

88

except ImportError:

111

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

112

# Try running the C preprocessor:

113

try:

114

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

115

"/dev/stdin"],

116

stdin=subprocess.PIPE,

117

stdout=subprocess.PIPE)

118

stdout = cc.communicate(

119

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

120

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

121

except (OSError, ValueError, IndexError):

122

# No value found

123

SO_BINDTODEVICE = None

124

125

if sys.version_info.major == 2:

126

str = unicode

127

128

if sys.version_info < (3, 2):

129

configparser.Configparser = configparser.SafeConfigParser

130

131

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.1"

132

92

stored_state_file = "clients.pickle"

133

93

134

94

logger = logging.getLogger()

135

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

136

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

137

98

138

99

try:

139

if_nametoindex = ctypes.cdll.LoadLibrary(

140

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

141

103

except (OSError, AttributeError):

142

143

104

def if_nametoindex(interface):

144

105

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

145

106

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

146

107

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

147

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

148

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

149

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

109

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

110

interface))

111

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

112

ifreq[16:20])[0]

150

113

return interface_index

151

114

152

115

153

def copy_function(func):

154

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

155

if sys.version_info.major == 2:

156

return types.FunctionType(func.func_code,

157

func.func_globals,

158

func.func_name,

159

func.func_defaults,

160

func.func_closure)

161

else:

162

return types.FunctionType(func.__code__,

163

func.__globals__,

164

func.__name__,

165

func.__defaults__,

166

func.__closure__)

167

168

169

116

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

170

117

"""init logger and add loglevel"""

171

172

global syslogger

173

syslogger = (logging.handlers.SysLogHandler(

174

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

175

address="/dev/log"))

118

176

119

syslogger.setFormatter(logging.Formatter

177

120

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

178

121

' %(message)s'))

179

122

logger.addHandler(syslogger)

180

123

181

124

if debug:

182

125

console = logging.StreamHandler()

183

126

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

193

136

pass

194

137

195

138

196

class PGPEngine:

139

class PGPEngine(object):

197

140

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

198

199

141

def __init__(self):

200

142

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

201

self.gpg = "gpg"

202

try:

203

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

204

for line in output.splitlines():

205

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

206

if name == b"gpg":

207

self.gpg = path

208

break

209

except OSError as e:

210

if e.errno != errno.ENOENT:

211

raise

212

143

self.gnupgargs = ['--batch',

213

'--homedir', self.tempdir,

144

'--home', self.tempdir,

214

145

'--force-mdc',

215

'--quiet']

216

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

217

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

218

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

219

146

'--quiet',

147

'--no-use-agent']

148

220

149

def __enter__(self):

221

150

return self

222

151

223

152

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

224

153

self._cleanup()

225

154

return False

226

155

227

156

def __del__(self):

228

157

self._cleanup()

229

158

230

159

def _cleanup(self):

231

160

if self.tempdir is not None:

232

161

# Delete contents of tempdir

233

162

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

234

topdown=False):

163

topdown = False):

235

164

for filename in files:

236

165

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

237

166

for dirname in dirs:

239

168

# Remove tempdir

240

169

os.rmdir(self.tempdir)

241

170

self.tempdir = None

242

171

243

172

def password_encode(self, password):

244

173

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

245

174

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

246

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

247

if len(encoded) > 2048:

248

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

249

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

250

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

251

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

252

return encoded

253

175

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

176

254

177

def encrypt(self, data, password):

255

178

passphrase = self.password_encode(password)

256

with tempfile.NamedTemporaryFile(

257

dir=self.tempdir) as passfile:

179

with tempfile.NamedTemporaryFile(dir=self.tempdir

180

) as passfile:

258

181

passfile.write(passphrase)

259

182

passfile.flush()

260

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

183

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

261

184

'--passphrase-file',

262

185

passfile.name]

263

186

+ self.gnupgargs,

264

stdin=subprocess.PIPE,

265

stdout=subprocess.PIPE,

266

stderr=subprocess.PIPE)

267

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

187

stdin = subprocess.PIPE,

188

stdout = subprocess.PIPE,

189

stderr = subprocess.PIPE)

190

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

268

191

if proc.returncode != 0:

269

192

raise PGPError(err)

270

193

return ciphertext

271

194

272

195

def decrypt(self, data, password):

273

196

passphrase = self.password_encode(password)

274

with tempfile.NamedTemporaryFile(

275

dir=self.tempdir) as passfile:

197

with tempfile.NamedTemporaryFile(dir = self.tempdir

198

) as passfile:

276

199

passfile.write(passphrase)

277

200

passfile.flush()

278

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

201

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

279

202

'--passphrase-file',

280

203

passfile.name]

281

204

+ self.gnupgargs,

282

stdin=subprocess.PIPE,

283

stdout=subprocess.PIPE,

284

stderr=subprocess.PIPE)

285

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

205

stdin = subprocess.PIPE,

206

stdout = subprocess.PIPE,

207

stderr = subprocess.PIPE)

208

decrypted_plaintext, err = proc.communicate(input

209

= data)

286

210

if proc.returncode != 0:

287

211

raise PGPError(err)

288

212

return decrypted_plaintext

289

213

290

214

291

# Pretend that we have an Avahi module

292

class avahi:

293

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

294

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

295

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

296

PROTO_INET = 0 # avahi-common/address.h

297

PROTO_INET6 = 1 # avahi-common/address.h

298

DBUS_NAME = "org.freedesktop.Avahi"

299

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

300

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

301

DBUS_PATH_SERVER = "/"

302

303

@staticmethod

304

def string_array_to_txt_array(t):

305

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

306

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

307

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

308

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

309

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

310

SERVER_INVALID = 0 # avahi-common/defs.h

311

SERVER_REGISTERING = 1 # avahi-common/defs.h

312

SERVER_RUNNING = 2 # avahi-common/defs.h

313

SERVER_COLLISION = 3 # avahi-common/defs.h

314

SERVER_FAILURE = 4 # avahi-common/defs.h

315

316

317

215

class AvahiError(Exception):

318

216

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

319

217

self.value = value

320

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

321

**kwargs)

322

218

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

219

def __unicode__(self):

220

return unicode(repr(self.value))

323

221

324

222

class AvahiServiceError(AvahiError):

325

223

pass

326

224

327

328

225

class AvahiGroupError(AvahiError):

329

226

pass

330

227

331

228

332

class AvahiService:

229

class AvahiService(object):

333

230

"""An Avahi (Zeroconf) service.

334

231

335

232

Attributes:

336

233

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

337

234

Used to optionally bind to the specified interface.

349

246

server: D-Bus Server

350

247

bus: dbus.SystemBus()

351

248

"""

352

353

def __init__(self,

354

interface=avahi.IF_UNSPEC,

355

name=None,

356

servicetype=None,

357

port=None,

358

TXT=None,

359

domain="",

360

host="",

361

max_renames=32768,

362

protocol=avahi.PROTO_UNSPEC,

363

bus=None):

249

250

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

251

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

252

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

253

protocol = avahi.PROTO_UNSPEC, bus = None):

364

254

self.interface = interface

365

255

self.name = name

366

256

self.type = servicetype

375

265

self.server = None

376

266

self.bus = bus

377

267

self.entry_group_state_changed_match = None

378

379

def rename(self, remove=True):

268

269

def rename(self):

380

270

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

381

271

if self.rename_count >= self.max_renames:

382

272

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

383

273

" after %i retries, exiting.",

384

274

self.rename_count)

385

275

raise AvahiServiceError("Too many renames")

386

self.name = str(

387

self.server.GetAlternativeServiceName(self.name))

388

self.rename_count += 1

276

self.name = unicode(self.server

277

.GetAlternativeServiceName(self.name))

389

278

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

390

279

self.name)

391

if remove:

392

self.remove()

280

self.remove()

393

281

try:

394

282

self.add()

395

283

except dbus.exceptions.DBusException as error:

396

if (error.get_dbus_name()

397

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

398

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

399

return self.rename(remove=False)

400

else:

401

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

402

self.cleanup()

403

os._exit(1)

404

284

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

285

self.cleanup()

286

os._exit(1)

287

self.rename_count += 1

288

405

289

def remove(self):

406

290

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

407

291

if self.entry_group_state_changed_match is not None:

409

293

self.entry_group_state_changed_match = None

410

294

if self.group is not None:

411

295

self.group.Reset()

412

296

413

297

def add(self):

414

298

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

415

299

self.remove()

432

316

dbus.UInt16(self.port),

433

317

avahi.string_array_to_txt_array(self.TXT))

434

318

self.group.Commit()

435

319

436

320

def entry_group_state_changed(self, state, error):

437

321

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

438

322

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

439

323

440

324

if state == avahi.ENTRY_GROUP_ESTABLISHED:

441

325

logger.debug("Zeroconf service established.")

442

326

elif state == avahi.ENTRY_GROUP_COLLISION:

444

328

self.rename()

445

329

elif state == avahi.ENTRY_GROUP_FAILURE:

446

330

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

447

str(error))

448

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

449

331

unicode(error))

332

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

333

.format(error))

334

450

335

def cleanup(self):

451

336

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

452

337

if self.group is not None:

457

342

pass

458

343

self.group = None

459

344

self.remove()

460

345

461

346

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

462

347

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

463

348

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

464

bad_states = {

465

avahi.SERVER_INVALID: "Zeroconf server invalid",

466

avahi.SERVER_REGISTERING: None,

467

avahi.SERVER_COLLISION: "Zeroconf server name collision",

468

avahi.SERVER_FAILURE: "Zeroconf server failure",

469

}

349

bad_states = { avahi.SERVER_INVALID:

350

"Zeroconf server invalid",

351

avahi.SERVER_REGISTERING: None,

352

avahi.SERVER_COLLISION:

353

"Zeroconf server name collision",

354

avahi.SERVER_FAILURE:

355

"Zeroconf server failure" }

470

356

if state in bad_states:

471

357

if bad_states[state] is not None:

472

358

if error is None:

475

361

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

476

362

self.cleanup()

477

363

elif state == avahi.SERVER_RUNNING:

478

try:

479

self.add()

480

except dbus.exceptions.DBusException as error:

481

if (error.get_dbus_name()

482

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

483

logger.info("Local Zeroconf service name"

484

" collision.")

485

return self.rename(remove=False)

486

else:

487

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

488

self.cleanup()

489

os._exit(1)

364

self.add()

490

365

else:

491

366

if error is None:

492

367

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

493

368

else:

494

369

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

495

370

496

371

def activate(self):

497

372

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

498

373

if self.server is None:

502

377

follow_name_owner_changes=True),

503

378

avahi.DBUS_INTERFACE_SERVER)

504

379

self.server.connect_to_signal("StateChanged",

505

self.server_state_changed)

380

self.server_state_changed)

506

381

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

507

382

508

383

509

384

class AvahiServiceToSyslog(AvahiService):

510

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

385

def rename(self):

511

386

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

512

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

513

syslogger.setFormatter(logging.Formatter(

514

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

515

.format(self.name)))

387

ret = AvahiService.rename(self)

388

syslogger.setFormatter(logging.Formatter

389

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

390

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

391

.format(self.name)))

516

392

return ret

517

393

518

394

519

# Pretend that we have a GnuTLS module

520

class gnutls:

521

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

522

523

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

524

if library is None:

525

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

526

_library = ctypes.cdll.LoadLibrary(library)

527

del library

528

529

# Unless otherwise indicated, the constants and types below are

530

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

531

532

# Constants

533

E_SUCCESS = 0

534

E_INTERRUPTED = -52

535

E_AGAIN = -28

536

CRT_OPENPGP = 2

537

CRT_RAWPK = 3

538

CLIENT = 2

539

SHUT_RDWR = 0

540

CRD_CERTIFICATE = 1

541

E_NO_CERTIFICATE_FOUND = -49

542

X509_FMT_DER = 0

543

NO_TICKETS = 1<<10

544

ENABLE_RAWPK = 1<<18

545

CTYPE_PEERS = 3

546

KEYID_USE_SHA256 = 1 # gnutls/x509.h

547

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

548

549

# Types

550

class session_int(ctypes.Structure):

551

_fields_ = []

552

session_t = ctypes.POINTER(session_int)

553

554

class certificate_credentials_st(ctypes.Structure):

555

_fields_ = []

556

certificate_credentials_t = ctypes.POINTER(

557

certificate_credentials_st)

558

certificate_type_t = ctypes.c_int

559

560

class datum_t(ctypes.Structure):

561

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

562

('size', ctypes.c_uint)]

563

564

class openpgp_crt_int(ctypes.Structure):

565

_fields_ = []

566

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

567

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

568

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

569

credentials_type_t = ctypes.c_int

570

transport_ptr_t = ctypes.c_void_p

571

close_request_t = ctypes.c_int

572

573

# Exceptions

574

class Error(Exception):

575

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

576

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

577

# code is passed, convert it to a string with

578

# gnutls.strerror()

579

self.code = code

580

if message is None and code is not None:

581

message = gnutls.strerror(code)

582

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

583

message, *args)

584

585

class CertificateSecurityError(Error):

586

pass

587

588

# Classes

589

class Credentials:

590

def __init__(self):

591

self._c_object = gnutls.certificate_credentials_t()

592

gnutls.certificate_allocate_credentials(

593

ctypes.byref(self._c_object))

594

self.type = gnutls.CRD_CERTIFICATE

595

596

def __del__(self):

597

gnutls.certificate_free_credentials(self._c_object)

598

599

class ClientSession:

600

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

601

self._c_object = gnutls.session_t()

602

gnutls_flags = gnutls.CLIENT

603

if gnutls.check_version(b"3.5.6"):

604

gnutls_flags |= gnutls.NO_TICKETS

605

if gnutls.has_rawpk:

606

gnutls_flags |= gnutls.ENABLE_RAWPK

607

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

608

del gnutls_flags

609

gnutls.set_default_priority(self._c_object)

610

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

611

gnutls.handshake_set_private_extensions(self._c_object,

612

True)

613

self.socket = socket

614

if credentials is None:

615

credentials = gnutls.Credentials()

616

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

617

ctypes.cast(credentials._c_object,

618

ctypes.c_void_p))

619

self.credentials = credentials

620

621

def __del__(self):

622

gnutls.deinit(self._c_object)

623

624

def handshake(self):

625

return gnutls.handshake(self._c_object)

626

627

def send(self, data):

628

data = bytes(data)

629

data_len = len(data)

630

while data_len > 0:

631

data_len -= gnutls.record_send(self._c_object,

632

data[-data_len:],

633

data_len)

634

635

def bye(self):

636

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

637

638

# Error handling functions

639

def _error_code(result):

640

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

641

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

642

if result >= 0:

643

return result

644

if result == gnutls.E_NO_CERTIFICATE_FOUND:

645

raise gnutls.CertificateSecurityError(code=result)

646

raise gnutls.Error(code=result)

647

648

def _retry_on_error(result, func, arguments):

649

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

650

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

651

while result < 0:

652

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

653

return _error_code(result)

654

result = func(*arguments)

655

return result

656

657

# Unless otherwise indicated, the function declarations below are

658

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

659

660

# Functions

661

priority_set_direct = _library.gnutls_priority_set_direct

662

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

663

ctypes.POINTER(ctypes.c_char_p)]

664

priority_set_direct.restype = _error_code

665

666

init = _library.gnutls_init

667

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

668

init.restype = _error_code

669

670

set_default_priority = _library.gnutls_set_default_priority

671

set_default_priority.argtypes = [session_t]

672

set_default_priority.restype = _error_code

673

674

record_send = _library.gnutls_record_send

675

record_send.argtypes = [session_t, ctypes.c_void_p,

676

ctypes.c_size_t]

677

record_send.restype = ctypes.c_ssize_t

678

record_send.errcheck = _retry_on_error

679

680

certificate_allocate_credentials = (

681

_library.gnutls_certificate_allocate_credentials)

682

certificate_allocate_credentials.argtypes = [

683

ctypes.POINTER(certificate_credentials_t)]

684

certificate_allocate_credentials.restype = _error_code

685

686

certificate_free_credentials = (

687

_library.gnutls_certificate_free_credentials)

688

certificate_free_credentials.argtypes = [

689

certificate_credentials_t]

690

certificate_free_credentials.restype = None

691

692

handshake_set_private_extensions = (

693

_library.gnutls_handshake_set_private_extensions)

694

handshake_set_private_extensions.argtypes = [session_t,

695

ctypes.c_int]

696

handshake_set_private_extensions.restype = None

697

698

credentials_set = _library.gnutls_credentials_set

699

credentials_set.argtypes = [session_t, credentials_type_t,

700

ctypes.c_void_p]

701

credentials_set.restype = _error_code

702

703

strerror = _library.gnutls_strerror

704

strerror.argtypes = [ctypes.c_int]

705

strerror.restype = ctypes.c_char_p

706

707

certificate_type_get = _library.gnutls_certificate_type_get

708

certificate_type_get.argtypes = [session_t]

709

certificate_type_get.restype = _error_code

710

711

certificate_get_peers = _library.gnutls_certificate_get_peers

712

certificate_get_peers.argtypes = [session_t,

713

ctypes.POINTER(ctypes.c_uint)]

714

certificate_get_peers.restype = ctypes.POINTER(datum_t)

715

716

global_set_log_level = _library.gnutls_global_set_log_level

717

global_set_log_level.argtypes = [ctypes.c_int]

718

global_set_log_level.restype = None

719

720

global_set_log_function = _library.gnutls_global_set_log_function

721

global_set_log_function.argtypes = [log_func]

722

global_set_log_function.restype = None

723

724

deinit = _library.gnutls_deinit

725

deinit.argtypes = [session_t]

726

deinit.restype = None

727

728

handshake = _library.gnutls_handshake

729

handshake.argtypes = [session_t]

730

handshake.restype = _error_code

731

handshake.errcheck = _retry_on_error

732

733

transport_set_ptr = _library.gnutls_transport_set_ptr

734

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

735

transport_set_ptr.restype = None

736

737

bye = _library.gnutls_bye

738

bye.argtypes = [session_t, close_request_t]

739

bye.restype = _error_code

740

bye.errcheck = _retry_on_error

741

742

check_version = _library.gnutls_check_version

743

check_version.argtypes = [ctypes.c_char_p]

744

check_version.restype = ctypes.c_char_p

745

746

_need_version = b"3.3.0"

747

if check_version(_need_version) is None:

748

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

749

.format(_need_version))

750

751

_tls_rawpk_version = b"3.6.6"

752

has_rawpk = bool(check_version(_tls_rawpk_version))

753

754

if has_rawpk:

755

# Types

756

class pubkey_st(ctypes.Structure):

757

_fields = []

758

pubkey_t = ctypes.POINTER(pubkey_st)

759

760

x509_crt_fmt_t = ctypes.c_int

761

762

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

763

pubkey_init = _library.gnutls_pubkey_init

764

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

765

pubkey_init.restype = _error_code

766

767

pubkey_import = _library.gnutls_pubkey_import

768

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

769

x509_crt_fmt_t]

770

pubkey_import.restype = _error_code

771

772

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

773

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

774

ctypes.POINTER(ctypes.c_ubyte),

775

ctypes.POINTER(ctypes.c_size_t)]

776

pubkey_get_key_id.restype = _error_code

777

778

pubkey_deinit = _library.gnutls_pubkey_deinit

779

pubkey_deinit.argtypes = [pubkey_t]

780

pubkey_deinit.restype = None

781

else:

782

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

783

784

openpgp_crt_init = _library.gnutls_openpgp_crt_init

785

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

786

openpgp_crt_init.restype = _error_code

787

788

openpgp_crt_import = _library.gnutls_openpgp_crt_import

789

openpgp_crt_import.argtypes = [openpgp_crt_t,

790

ctypes.POINTER(datum_t),

791

openpgp_crt_fmt_t]

792

openpgp_crt_import.restype = _error_code

793

794

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

795

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

796

ctypes.POINTER(ctypes.c_uint)]

797

openpgp_crt_verify_self.restype = _error_code

798

799

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

800

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

801

openpgp_crt_deinit.restype = None

802

803

openpgp_crt_get_fingerprint = (

804

_library.gnutls_openpgp_crt_get_fingerprint)

805

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

806

ctypes.c_void_p,

807

ctypes.POINTER(

808

ctypes.c_size_t)]

809

openpgp_crt_get_fingerprint.restype = _error_code

810

811

if check_version(b"3.6.4"):

812

certificate_type_get2 = _library.gnutls_certificate_type_get2

813

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

814

certificate_type_get2.restype = _error_code

815

816

# Remove non-public functions

817

del _error_code, _retry_on_error

818

819

820

def call_pipe(connection, # : multiprocessing.Connection

821

func, *args, **kwargs):

822

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

823

824

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

825

return value on the provided multiprocessing.Connection.

826

"""

827

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

828

connection.close()

829

830

831

class Client:

395

def timedelta_to_milliseconds(td):

396

"Convert a datetime.timedelta() to milliseconds"

397

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

398

+ (td.seconds * 1000)

399

+ (td.microseconds // 1000))

400

401

402

class Client(object):

832

403

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

833

404

834

405

Attributes:

835

406

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

836

407

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

837

408

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

838

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

839

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

840

running.

841

checker_callback_tag: a GLib event source tag, or None

409

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

410

to see if the client lives.

411

'None' if no process is running.

412

checker_callback_tag: a gobject event source tag, or None

842

413

checker_command: string; External command which is run to check

843

414

if client lives. %() expansions are done at

844

415

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

845

416

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

846

checker_initiator_tag: a GLib event source tag, or None

417

checker_initiator_tag: a gobject event source tag, or None

847

418

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

848

419

client_structure: Object describing what attributes a client has

849

420

and is used for storing the client at exit

850

421

current_checker_command: string; current running checker_command

851

disable_initiator_tag: a GLib event source tag, or None

422

disable_initiator_tag: a gobject event source tag, or None

852

423

enabled: bool()

853

424

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

854

uniquely identify an OpenPGP client

855

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

856

a client using raw public keys

425

uniquely identify the client

857

426

host: string; available for use by the checker command

858

427

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

859

428

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

861

430

last_checker_status: integer between 0 and 255 reflecting exit

862

431

status of last checker. -1 reflects crashed

863

432

checker, -2 means no checker completed yet.

864

last_checker_signal: The signal which killed the last checker, if

865

last_checker_status is -1

866

433

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

867

434

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

868

435

D-Bus identifiers

875

442

disabled, or None

876

443

server_settings: The server_settings dict from main()

877

444

"""

878

445

879

446

runtime_expansions = ("approval_delay", "approval_duration",

880

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

447

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

881

448

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

882

449

"last_approval_request", "last_checked_ok",

883

450

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

884

client_defaults = {

885

"timeout": "PT5M",

886

"extended_timeout": "PT15M",

887

"interval": "PT2M",

888

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

889

"host": "",

890

"approval_delay": "PT0S",

891

"approval_duration": "PT1S",

892

"approved_by_default": "True",

893

"enabled": "True",

894

}

895

451

client_defaults = { "timeout": "PT5M",

452

"extended_timeout": "PT15M",

453

"interval": "PT2M",

454

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

455

"host": "",

456

"approval_delay": "PT0S",

457

"approval_duration": "PT1S",

458

"approved_by_default": "True",

459

"enabled": "True",

460

}

461

462

def timeout_milliseconds(self):

463

"Return the 'timeout' attribute in milliseconds"

464

return timedelta_to_milliseconds(self.timeout)

465

466

def extended_timeout_milliseconds(self):

467

"Return the 'extended_timeout' attribute in milliseconds"

468

return timedelta_to_milliseconds(self.extended_timeout)

469

470

def interval_milliseconds(self):

471

"Return the 'interval' attribute in milliseconds"

472

return timedelta_to_milliseconds(self.interval)

473

474

def approval_delay_milliseconds(self):

475

return timedelta_to_milliseconds(self.approval_delay)

476

896

477

@staticmethod

897

478

def config_parser(config):

898

479

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

905

486

for client_name in config.sections():

906

487

section = dict(config.items(client_name))

907

488

client = settings[client_name] = {}

908

489

909

490

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

910

491

# Reformat values from string types to Python types

911

492

client["approved_by_default"] = config.getboolean(

912

493

client_name, "approved_by_default")

913

494

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

914

495

"enabled")

915

916

# Uppercase and remove spaces from key_id and fingerprint

917

# for later comparison purposes with return value from the

918

# key_id() and fingerprint() functions

919

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

920

.replace(" ", ""))

496

921

497

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

922

498

.replace(" ", ""))

923

499

if "secret" in section:

924

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

925

.encode("utf-8"),

926

"base64")

500

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

927

501

elif "secfile" in section:

928

502

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

929

503

(section["secfile"])),

930

504

"rb") as secfile:

931

505

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

932

506

else:

933

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

507

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

934

508

.format(section))

935

509

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

936

510

client["extended_timeout"] = string_to_delta(

944

518

client["last_approval_request"] = None

945

519

client["last_checked_ok"] = None

946

520

client["last_checker_status"] = -2

947

521

948

522

return settings

949

950

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

523

524

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

951

525

self.name = name

952

526

if server_settings is None:

953

527

server_settings = {}

954

528

self.server_settings = server_settings

955

529

# adding all client settings

956

for setting, value in settings.items():

530

for setting, value in settings.iteritems():

957

531

setattr(self, setting, value)

958

532

959

533

if self.enabled:

960

534

if not hasattr(self, "last_enabled"):

961

535

self.last_enabled = datetime.datetime.utcnow()

965

539

else:

966

540

self.last_enabled = None

967

541

self.expires = None

968

542

969

543

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

970

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

544

# Uppercase and remove spaces from fingerprint for later

545

# comparison purposes with return value from the fingerprint()

546

# function

971

547

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

972

548

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

973

549

datetime.datetime.utcnow())

974

550

975

551

# attributes specific for this server instance

976

552

self.checker = None

977

553

self.checker_initiator_tag = None

980

556

self.current_checker_command = None

981

557

self.approved = None

982

558

self.approvals_pending = 0

983

self.changedstate = multiprocessing_manager.Condition(

984

multiprocessing_manager.Lock())

985

self.client_structure = [attr

986

for attr in self.__dict__.keys()

559

self.changedstate = (multiprocessing_manager

560

.Condition(multiprocessing_manager

561

.Lock()))

562

self.client_structure = [attr for attr in

563

self.__dict__.iterkeys()

987

564

if not attr.startswith("_")]

988

565

self.client_structure.append("client_structure")

989

990

for name, t in inspect.getmembers(

991

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

566

567

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

568

lambda obj:

569

isinstance(obj,

570

property)):

992

571

if not name.startswith("_"):

993

572

self.client_structure.append(name)

994

573

995

574

# Send notice to process children that client state has changed

996

575

def send_changedstate(self):

997

576

with self.changedstate:

998

577

self.changedstate.notify_all()

999

578

1000

579

def enable(self):

1001

580

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

1002

581

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

1007

586

self.last_enabled = datetime.datetime.utcnow()

1008

587

self.init_checker()

1009

588

self.send_changedstate()

1010

589

1011

590

def disable(self, quiet=True):

1012

591

"""Disable this client."""

1013

592

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

1015

594

if not quiet:

1016

595

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

1017

596

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

1018

GLib.source_remove(self.disable_initiator_tag)

597

gobject.source_remove(self.disable_initiator_tag)

1019

598

self.disable_initiator_tag = None

1020

599

self.expires = None

1021

600

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

1022

GLib.source_remove(self.checker_initiator_tag)

601

gobject.source_remove(self.checker_initiator_tag)

1023

602

self.checker_initiator_tag = None

1024

603

self.stop_checker()

1025

604

self.enabled = False

1026

605

if not quiet:

1027

606

self.send_changedstate()

1028

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

607

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

1029

608

return False

1030

609

1031

610

def __del__(self):

1032

611

self.disable()

1033

612

1034

613

def init_checker(self):

1035

614

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

1036

615

# and every interval from then on.

1037

616

if self.checker_initiator_tag is not None:

1038

GLib.source_remove(self.checker_initiator_tag)

1039

self.checker_initiator_tag = GLib.timeout_add(

1040

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

1041

self.start_checker)

617

gobject.source_remove(self.checker_initiator_tag)

618

self.checker_initiator_tag = (gobject.timeout_add

619

(self.interval_milliseconds(),

620

self.start_checker))

1042

621

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

1043

622

if self.disable_initiator_tag is not None:

1044

GLib.source_remove(self.disable_initiator_tag)

1045

self.disable_initiator_tag = GLib.timeout_add(

1046

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

623

gobject.source_remove(self.disable_initiator_tag)

624

self.disable_initiator_tag = (gobject.timeout_add

625

(self.timeout_milliseconds(),

626

self.disable))

1047

627

# Also start a new checker *right now*.

1048

628

self.start_checker()

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

629

630

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

1052

631

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

1053

# Read return code from connection (see call_pipe)

1054

returncode = connection.recv()

1055

connection.close()

1056

if self.checker is not None:

1057

self.checker.join()

1058

632

self.checker_callback_tag = None

1059

633

self.checker = None

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

634

if os.WIFEXITED(condition):

635

self.last_checker_status = os.WEXITSTATUS(condition)

1064

636

if self.last_checker_status == 0:

1065

637

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

1066

638

vars(self))

1067

639

self.checked_ok()

1068

640

else:

1069

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

641

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

642

vars(self))

1070

643

else:

1071

644

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

1073

645

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

1074

646

vars(self))

1075

return False

1076

647

1077

648

def checked_ok(self):

1078

649

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

1079

650

self.last_checked_ok = datetime.datetime.utcnow()

1080

651

self.last_checker_status = 0

1081

self.last_checker_signal = None

1082

652

self.bump_timeout()

1083

653

1084

654

def bump_timeout(self, timeout=None):

1085

655

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

1086

656

if timeout is None:

1087

657

timeout = self.timeout

1088

658

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

659

gobject.source_remove(self.disable_initiator_tag)

1090

660

self.disable_initiator_tag = None

1091

661

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

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

662

self.disable_initiator_tag = (gobject.timeout_add

663

(timedelta_to_milliseconds

664

(timeout), self.disable))

1094

665

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

1095

666

1096

667

def need_approval(self):

1097

668

self.last_approval_request = datetime.datetime.utcnow()

1098

669

1099

670

def start_checker(self):

1100

671

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

1101

672

1102

673

If a checker already exists, leave it running and do

1103

674

nothing."""

1104

675

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

1109

680

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

1110

681

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

1111

682

# should be.

1112

1113

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

1114

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

1115

self.checker.join()

1116

self.checker = None

683

684

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

685

try:

686

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

687

except (AttributeError, OSError) as error:

688

if (isinstance(error, OSError)

689

and error.errno != errno.ECHILD):

690

raise error

691

else:

692

if pid:

693

logger.warning("Checker was a zombie")

694

gobject.source_remove(self.checker_callback_tag)

695

self.checker_callback(pid, status,

696

self.current_checker_command)

1117

697

# Start a new checker if needed

1118

698

if self.checker is None:

1119

699

# Escape attributes for the shell

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

700

escaped_attrs = dict(

701

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

702

for attr in

703

self.runtime_expansions)

1123

704

try:

1124

705

command = self.checker_command % escaped_attrs

1125

706

except TypeError as error:

1126

707

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

1127

self.checker_command,

708

self.checker_command, exc_info=error)

709

return True # Try again later

710

self.current_checker_command = command

711

try:

712

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

713

command, self.name)

714

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

715

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

716

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

717

# always replaced by /dev/null.)

718

# The exception is when not debugging but nevertheless

719

# running in the foreground; use the previously

720

# created wnull.

721

popen_args = {}

722

if (not self.server_settings["debug"]

723

and self.server_settings["foreground"]):

724

popen_args.update({"stdout": wnull,

725

"stderr": wnull })

726

self.checker = subprocess.Popen(command,

727

close_fds=True,

728

shell=True, cwd="/",

729

**popen_args)

730

except OSError as error:

731

logger.error("Failed to start subprocess",

1128

732

exc_info=error)

1129

return True # Try again later

1130

self.current_checker_command = command

1131

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

1132

self.name)

1133

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

1134

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

1135

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

1136

# always replaced by /dev/null.)

1137

# The exception is when not debugging but nevertheless

1138

# running in the foreground; use the previously

1139

# created wnull.

1140

popen_args = {"close_fds": True,

1141

"shell": True,

1142

"cwd": "/"}

1143

if (not self.server_settings["debug"]

1144

and self.server_settings["foreground"]):

1145

popen_args.update({"stdout": wnull,

1146

"stderr": wnull})

1147

pipe = multiprocessing.Pipe(duplex=False)

1148

self.checker = multiprocessing.Process(

1149

target=call_pipe,

1150

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

1151

kwargs=popen_args)

1152

self.checker.start()

1153

self.checker_callback_tag = GLib.io_add_watch(

1154

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

1155

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

1156

self.checker_callback, pipe[0], command)

1157

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

733

return True

734

self.checker_callback_tag = (gobject.child_watch_add

735

(self.checker.pid,

736

self.checker_callback,

737

data=command))

738

# The checker may have completed before the gobject

739

# watch was added. Check for this.

740

try:

741

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

742

except OSError as error:

743

if error.errno == errno.ECHILD:

744

# This should never happen

745

logger.error("Child process vanished",

746

exc_info=error)

747

return True

748

raise

749

if pid:

750

gobject.source_remove(self.checker_callback_tag)

751

self.checker_callback(pid, status, command)

752

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

1158

753

return True

1159

754

1160

755

def stop_checker(self):

1161

756

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

1162

757

if self.checker_callback_tag:

1163

GLib.source_remove(self.checker_callback_tag)

758

gobject.source_remove(self.checker_callback_tag)

1164

759

self.checker_callback_tag = None

1165

760

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

1166

761

return

1167

762

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

1168

self.checker.terminate()

763

try:

764

self.checker.terminate()

765

#time.sleep(0.5)

766

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

767

# self.checker.kill()

768

except OSError as error:

769

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

770

raise

1169

771

self.checker = None

1170

772

1171

773

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

774

def dbus_service_property(dbus_interface, signature="v",

775

access="readwrite", byte_arrays=False):

1176

776

"""Decorators for marking methods of a DBusObjectWithProperties to

1177

777

become properties on the D-Bus.

1178

778

1179

779

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

1180

780

and with one argument by "Set".

1181

781

1182

782

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

1183

783

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

1184

784

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

1187

787

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

1188

788

if byte_arrays and signature != "ay":

1189

789

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

1190

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

1191

790

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

1192

791

def decorator(func):

1193

792

func._dbus_is_property = True

1194

793

func._dbus_interface = dbus_interface

1197

796

func._dbus_name = func.__name__

1198

797

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

1199

798

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

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

799

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1201

800

return func

1202

1203

801

return decorator

1204

802

1205

803

1206

804

def dbus_interface_annotations(dbus_interface):

1207

805

"""Decorator for marking functions returning interface annotations

1208

806

1209

807

Usage:

1210

808

1211

809

@dbus_interface_annotations("org.example.Interface")

1212

810

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

1213

811

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

1214

812

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

1215

813

"false"}

1216

814

"""

1217

1218

815

def decorator(func):

1219

816

func._dbus_is_interface = True

1220

817

func._dbus_interface = dbus_interface

1221

818

func._dbus_name = dbus_interface

1222

819

return func

1223

1224

820

return decorator

1225

821

1226

822

1227

823

def dbus_annotations(annotations):

1228

824

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

1229

825

Usage:

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

826

1234

827

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

1235

828

access="r")

829

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

830

"org.freedesktop.DBus.Property."

831

"EmitsChangedSignal": "false"})

1236

832

def Property_dbus_property(self):

1237

833

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

1240

834

"""

1241

1242

835

def decorator(func):

1243

836

func._dbus_annotations = annotations

1244

837

return func

1245

1246

838

return decorator

1247

839

1248

840

1249

841

class DBusPropertyException(dbus.exceptions.DBusException):

1250

842

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

1251

843

"""

1252

pass

844

def __unicode__(self):

845

return unicode(str(self))

1253

846

1254

847

1255

848

class DBusPropertyAccessException(DBusPropertyException):

1264

857

pass

1265

858

1266

859

1267

class DBusObjectWithAnnotations(dbus.service.Object):

1268

"""A D-Bus object with annotations.

1269

1270

Classes inheriting from this can use the dbus_annotations

1271

decorator to add annotations to methods or signals.

860

class DBusObjectWithProperties(dbus.service.Object):

861

"""A D-Bus object with properties.

862

863

Classes inheriting from this can use the dbus_service_property

864

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

865

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

1272

866

"""

1273

867

1274

868

@staticmethod

1275

869

def _is_dbus_thing(thing):

1276

870

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

1277

871

1278

872

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

1279

873

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

1280

874

"""

1281

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

875

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

1282

876

False)

1283

877

1284

878

def _get_all_dbus_things(self, thing):

1285

879

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

1286

880

"""

1287

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

881

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

882

name),

1288

883

athing.__get__(self))

1289

884

for cls in self.__class__.__mro__

1290

885

for name, athing in

1291

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

1292

1293

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1294

out_signature="s",

1295

path_keyword='object_path',

1296

connection_keyword='connection')

1297

def Introspect(self, object_path, connection):

1298

"""Overloading of standard D-Bus method.

1299

1300

Inserts annotation tags on methods and signals.

1301

"""

1302

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

1303

connection)

1304

try:

1305

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

1306

1307

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

1308

# Add annotation tags

1309

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

1310

for tag in if_tag.getElementsByTagName(typ):

1311

annots = dict()

1312

for name, prop in (self.

1313

_get_all_dbus_things(typ)):

1314

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

1315

and prop._dbus_interface

1316

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

1317

annots.update(getattr(

1318

prop, "_dbus_annotations", {}))

1319

for name, value in annots.items():

1320

ann_tag = document.createElement(

1321

"annotation")

1322

ann_tag.setAttribute("name", name)

1323

ann_tag.setAttribute("value", value)

1324

tag.appendChild(ann_tag)

1325

# Add interface annotation tags

1326

for annotation, value in dict(

1327

itertools.chain.from_iterable(

1328

annotations().items()

1329

for name, annotations

1330

in self._get_all_dbus_things("interface")

1331

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

1332

)).items():

1333

ann_tag = document.createElement("annotation")

1334

ann_tag.setAttribute("name", annotation)

1335

ann_tag.setAttribute("value", value)

1336

if_tag.appendChild(ann_tag)

1337

# Fix argument name for the Introspect method itself

1338

if (if_tag.getAttribute("name")

1339

== dbus.INTROSPECTABLE_IFACE):

1340

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

1341

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

1342

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

1343

if (arg.getAttribute("direction")

1344

== "out"):

1345

arg.setAttribute("name",

1346

"xml_data")

1347

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

1348

document.unlink()

1349

except (AttributeError, xml.dom.DOMException,

1350

xml.parsers.expat.ExpatError) as error:

1351

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

1352

exc_info=error)

1353

return xmlstring

1354

1355

1356

class DBusObjectWithProperties(DBusObjectWithAnnotations):

1357

"""A D-Bus object with properties.

1358

1359

Classes inheriting from this can use the dbus_service_property

1360

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

1361

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

1362

"""

1363

886

inspect.getmembers(cls,

887

self._is_dbus_thing(thing)))

888

1364

889

def _get_dbus_property(self, interface_name, property_name):

1365

890

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

1366

891

property with the specified name and interface.

1367

892

"""

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

893

for cls in self.__class__.__mro__:

894

for name, value in (inspect.getmembers

895

(cls,

896

self._is_dbus_thing("property"))):

1371

897

if (value._dbus_name == property_name

1372

898

and value._dbus_interface == interface_name):

1373

899

return value.__get__(self)

1374

900

1375

901

# No such property

1376

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

1377

self.dbus_object_path, interface_name, property_name))

1378

1379

@classmethod

1380

def _get_all_interface_names(cls):

1381

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

1382

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

1383

"_dbus_interface", None)

1384

for x in (inspect.getmro(cls))

1385

for attr in dir(x))

1386

if name is not None)

1387

1388

@dbus.service.method(dbus.PROPERTIES_IFACE,

1389

in_signature="ss",

902

raise DBusPropertyNotFound(self.dbus_object_path + ":"

903

+ interface_name + "."

904

+ property_name)

905

906

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

1390

907

out_signature="v")

1391

908

def Get(self, interface_name, property_name):

1392

909

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

1398

915

if not hasattr(value, "variant_level"):

1399

916

return value

1400

917

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

1401

918

1402

919

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

1403

920

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

1404

921

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

1410

927

# The byte_arrays option is not supported yet on

1411

928

# signatures other than "ay".

1412

929

if prop._dbus_signature != "ay":

1413

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

1414

"'ay' signature {!r}"

1415

.format(prop._dbus_signature))

930

raise ValueError

1416

931

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

1417

932

for byte in value))

1418

933

prop(value)

1419

1420

@dbus.service.method(dbus.PROPERTIES_IFACE,

1421

in_signature="s",

934

935

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

1422

936

out_signature="a{sv}")

1423

937

def GetAll(self, interface_name):

1424

938

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

1425

939

standard.

1426

940

1427

941

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

1428

942

"""

1429

943

properties = {}

1439

953

if not hasattr(value, "variant_level"):

1440

954

properties[name] = value

1441

955

continue

1442

properties[name] = type(value)(

1443

value, variant_level=value.variant_level + 1)

956

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

957

value.variant_level+1)

1444

958

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

1445

1446

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

1447

def PropertiesChanged(self, interface_name, changed_properties,

1448

invalidated_properties):

1449

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

1450

standard.

1451

"""

1452

pass

1453

959

1454

960

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1455

961

out_signature="s",

1456

962

path_keyword='object_path',

1457

963

connection_keyword='connection')

1458

964

def Introspect(self, object_path, connection):

1459

965

"""Overloading of standard D-Bus method.

1460

966

1461

967

Inserts property tags and interface annotation tags.

1462

968

"""

1463

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1464

object_path,

1465

connection)

969

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

970

connection)

1466

971

try:

1467

972

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

1468

1469

973

def make_tag(document, name, prop):

1470

974

e = document.createElement("property")

1471

975

e.setAttribute("name", name)

1472

976

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

1473

977

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

1474

978

return e

1475

1476

979

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

1477

980

# Add property tags

1478

981

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

1481

984

if prop._dbus_interface

1482

985

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

1483

986

if_tag.appendChild(tag)

1484

# Add annotation tags for properties

1485

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

1486

annots = dict()

1487

for name, prop in self._get_all_dbus_things(

1488

"property"):

1489

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

1490

and prop._dbus_interface

1491

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

1492

annots.update(getattr(

1493

prop, "_dbus_annotations", {}))

1494

for name, value in annots.items():

1495

ann_tag = document.createElement(

1496

"annotation")

1497

ann_tag.setAttribute("name", name)

1498

ann_tag.setAttribute("value", value)

1499

tag.appendChild(ann_tag)

987

# Add annotation tags

988

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

989

for tag in if_tag.getElementsByTagName(typ):

990

annots = dict()

991

for name, prop in (self.

992

_get_all_dbus_things(typ)):

993

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

994

and prop._dbus_interface

995

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

996

annots.update(getattr

997

(prop,

998

"_dbus_annotations",

999

{}))

1000

for name, value in annots.iteritems():

1001

ann_tag = document.createElement(

1002

"annotation")

1003

ann_tag.setAttribute("name", name)

1004

ann_tag.setAttribute("value", value)

1005

tag.appendChild(ann_tag)

1006

# Add interface annotation tags

1007

for annotation, value in dict(

1008

itertools.chain.from_iterable(

1009

annotations().iteritems()

1010

for name, annotations in

1011

self._get_all_dbus_things("interface")

1012

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

1013

)).iteritems():

1014

ann_tag = document.createElement("annotation")

1015

ann_tag.setAttribute("name", annotation)

1016

ann_tag.setAttribute("value", value)

1017

if_tag.appendChild(ann_tag)

1500

1018

# Add the names to the return values for the

1501

1019

# "org.freedesktop.DBus.Properties" methods

1502

1020

if (if_tag.getAttribute("name")

1521

1039

return xmlstring

1522

1040

1523

1041

1524

try:

1525

dbus.OBJECT_MANAGER_IFACE

1526

except AttributeError:

1527

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

1528

1529

1530

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1531

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

1532

1533

Classes inheriting from this exposes the standard

1534

GetManagedObjects call and the InterfacesAdded and

1535

InterfacesRemoved signals on the standard

1536

"org.freedesktop.DBus.ObjectManager" interface.

1537

1538

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

1539

manually.

1540

"""

1541

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1542

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

1543

def GetManagedObjects(self):

1544

"""This function must be overridden"""

1545

raise NotImplementedError()

1546

1547

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1548

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

1549

def InterfacesAdded(self, object_path, interfaces_and_properties):

1550

pass

1551

1552

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

1553

def InterfacesRemoved(self, object_path, interfaces):

1554

pass

1555

1556

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1557

out_signature="s",

1558

path_keyword='object_path',

1559

connection_keyword='connection')

1560

def Introspect(self, object_path, connection):

1561

"""Overloading of standard D-Bus method.

1562

1563

Override return argument name of GetManagedObjects to be

1564

"objpath_interfaces_and_properties"

1565

"""

1566

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1567

object_path,

1568

connection)

1569

try:

1570

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

1571

1572

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

1573

# Fix argument name for the GetManagedObjects method

1574

if (if_tag.getAttribute("name")

1575

== dbus.OBJECT_MANAGER_IFACE):

1576

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

1577

if (cn.getAttribute("name")

1578

== "GetManagedObjects"):

1579

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

1580

if (arg.getAttribute("direction")

1581

== "out"):

1582

arg.setAttribute(

1583

"name",

1584

"objpath_interfaces"

1585

"_and_properties")

1586

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

1587

document.unlink()

1588

except (AttributeError, xml.dom.DOMException,

1589

xml.parsers.expat.ExpatError) as error:

1590

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

1591

exc_info=error)

1592

return xmlstring

1593

1594

1595

1042

def datetime_to_dbus(dt, variant_level=0):

1596

1043

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

1597

1044

if dt is None:

1598

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

1599

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

1045

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

1046

return dbus.String(dt.isoformat(),

1047

variant_level=variant_level)

1600

1048

1601

1049

1602

1050

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1604

1052

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

1605

1053

interface names according to the "alt_interface_names" mapping.

1606

1054

Usage:

1607

1055

1608

1056

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

1609

1057

"net.example.AlternateInterface"})

1610

1058

class SampleDBusObject(dbus.service.Object):

1611

1059

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

1612

1060

def SampleDBusMethod():

1613

1061

pass

1614

1062

1615

1063

The above "SampleDBusMethod" on "SampleDBusObject" will be

1616

1064

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

1617

1065

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

1618

1066

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

1619

1067

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

1620

1068

1621

1069

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

1622

1070

(from DBusObjectWithProperties) and interfaces (from the

1623

1071

dbus_interface_annotations decorator).

1624

1072

"""

1625

1626

1073

def wrapper(cls):

1627

1074

for orig_interface_name, alt_interface_name in (

1628

alt_interface_names.items()):

1075

alt_interface_names.iteritems()):

1629

1076

attr = {}

1630

1077

interface_names = set()

1631

1078

# Go though all attributes of the class

1633

1080

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

1634

1081

# with the wrong interface name

1635

1082

if (not hasattr(attribute, "_dbus_interface")

1636

or not attribute._dbus_interface.startswith(

1637

orig_interface_name)):

1083

or not attribute._dbus_interface

1084

.startswith(orig_interface_name)):

1638

1085

continue

1639

1086

# Create an alternate D-Bus interface name based on

1640

1087

# the current name

1641

alt_interface = attribute._dbus_interface.replace(

1642

orig_interface_name, alt_interface_name)

1088

alt_interface = (attribute._dbus_interface

1089

.replace(orig_interface_name,

1090

alt_interface_name))

1643

1091

interface_names.add(alt_interface)

1644

1092

# Is this a D-Bus signal?

1645

1093

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

1646

1094

# Extract the original non-method undecorated

1647

1095

# function by black magic

1648

if sys.version_info.major == 2:

1649

nonmethod_func = (dict(

1096

nonmethod_func = (dict(

1650

1097

zip(attribute.func_code.co_freevars,

1651

attribute.__closure__))

1652

["func"].cell_contents)

1653

else:

1654

nonmethod_func = (dict(

1655

zip(attribute.__code__.co_freevars,

1656

attribute.__closure__))

1657

["func"].cell_contents)

1098

attribute.__closure__))["func"]

1099

.cell_contents)

1658

1100

# Create a new, but exactly alike, function

1659

1101

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

1660

1102

# with the alternate D-Bus interface name

1661

new_function = copy_function(nonmethod_func)

1662

new_function = (dbus.service.signal(

1663

alt_interface,

1664

attribute._dbus_signature)(new_function))

1103

new_function = (dbus.service.signal

1104

(alt_interface,

1105

attribute._dbus_signature)

1106

(types.FunctionType(

1107

nonmethod_func.func_code,

1108

nonmethod_func.func_globals,

1109

nonmethod_func.func_name,

1110

nonmethod_func.func_defaults,

1111

nonmethod_func.func_closure)))

1665

1112

# Copy annotations, if any

1666

1113

try:

1667

new_function._dbus_annotations = dict(

1668

attribute._dbus_annotations)

1114

new_function._dbus_annotations = (

1115

dict(attribute._dbus_annotations))

1669

1116

except AttributeError:

1670

1117

pass

1671

1672

1118

# Define a creator of a function to call both the

1673

1119

# original and alternate functions, so both the

1674

1120

# original and alternate signals gets sent when

1677

1123

"""This function is a scope container to pass

1678

1124

func1 and func2 to the "call_both" function

1679

1125

outside of its arguments"""

1680

1681

@functools.wraps(func2)

1682

1126

def call_both(*args, **kwargs):

1683

1127

"""This function will emit two D-Bus

1684

1128

signals by calling func1 and func2"""

1685

1129

func1(*args, **kwargs)

1686

1130

func2(*args, **kwargs)

1687

# Make wrapper function look like a D-Bus

1688

# signal

1689

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

1690

if name.startswith("_dbus_"):

1691

setattr(call_both, name, attr)

1692

1693

1131

return call_both

1694

1132

# Create the "call_both" function and add it to

1695

1133

# the class

1700

1138

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

1701

1139

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

1702

1140

# to the class.

1703

attr[attrname] = (

1704

dbus.service.method(

1705

alt_interface,

1706

attribute._dbus_in_signature,

1707

attribute._dbus_out_signature)

1708

(copy_function(attribute)))

1141

attr[attrname] = (dbus.service.method

1142

(alt_interface,

1143

attribute._dbus_in_signature,

1144

attribute._dbus_out_signature)

1145

(types.FunctionType

1146

(attribute.func_code,

1147

attribute.func_globals,

1148

attribute.func_name,

1149

attribute.func_defaults,

1150

attribute.func_closure)))

1709

1151

# Copy annotations, if any

1710

1152

try:

1711

attr[attrname]._dbus_annotations = dict(

1712

attribute._dbus_annotations)

1153

attr[attrname]._dbus_annotations = (

1154

dict(attribute._dbus_annotations))

1713

1155

except AttributeError:

1714

1156

pass

1715

1157

# Is this a D-Bus property?

1718

1160

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

1719

1161

# property with the alternate D-Bus interface

1720

1162

# name. Add it to the class.

1721

attr[attrname] = (dbus_service_property(

1722

alt_interface, attribute._dbus_signature,

1723

attribute._dbus_access,

1724

attribute._dbus_get_args_options

1725

["byte_arrays"])

1726

(copy_function(attribute)))

1163

attr[attrname] = (dbus_service_property

1164

(alt_interface,

1165

attribute._dbus_signature,

1166

attribute._dbus_access,

1167

attribute

1168

._dbus_get_args_options

1169

["byte_arrays"])

1170

(types.FunctionType

1171

(attribute.func_code,

1172

attribute.func_globals,

1173

attribute.func_name,

1174

attribute.func_defaults,

1175

attribute.func_closure)))

1727

1176

# Copy annotations, if any

1728

1177

try:

1729

attr[attrname]._dbus_annotations = dict(

1730

attribute._dbus_annotations)

1178

attr[attrname]._dbus_annotations = (

1179

dict(attribute._dbus_annotations))

1731

1180

except AttributeError:

1732

1181

pass

1733

1182

# Is this a D-Bus interface?

1736

1185

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

1737

1186

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

1738

1187

# to the class.

1739

attr[attrname] = (

1740

dbus_interface_annotations(alt_interface)

1741

(copy_function(attribute)))

1188

attr[attrname] = (dbus_interface_annotations

1189

(alt_interface)

1190

(types.FunctionType

1191

(attribute.func_code,

1192

attribute.func_globals,

1193

attribute.func_name,

1194

attribute.func_defaults,

1195

attribute.func_closure)))

1742

1196

if deprecate:

1743

1197

# Deprecate all alternate interfaces

1744

iname = "_AlternateDBusNames_interface_annotation{}"

1198

iname="_AlternateDBusNames_interface_annotation{0}"

1745

1199

for interface_name in interface_names:

1746

1747

1200

@dbus_interface_annotations(interface_name)

1748

1201

def func(self):

1749

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

1750

"true"}

1202

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

1203

"true" }

1751

1204

# Find an unused name

1752

1205

for aname in (iname.format(i)

1753

1206

for i in itertools.count()):

1757

1210

if interface_names:

1758

1211

# Replace the class with a new subclass of it with

1759

1212

# methods, signals, etc. as created above.

1760

if sys.version_info.major == 2:

1761

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

1762

(cls, ), attr)

1763

else:

1764

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

1765

(cls, ), attr)

1213

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

1214

(cls,), attr)

1766

1215

return cls

1767

1768

1216

return wrapper

1769

1217

1770

1218

1771

1219

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

1772

"se.bsnet.fukt.Mandos"})

1220

"se.bsnet.fukt.Mandos"})

1773

1221

class ClientDBus(Client, DBusObjectWithProperties):

1774

1222

"""A Client class using D-Bus

1775

1223

1776

1224

Attributes:

1777

1225

dbus_object_path: dbus.ObjectPath

1778

1226

bus: dbus.SystemBus()

1779

1227

"""

1780

1228

1781

1229

runtime_expansions = (Client.runtime_expansions

1782

+ ("dbus_object_path", ))

1783

1784

_interface = "se.recompile.Mandos.Client"

1785

1230

+ ("dbus_object_path",))

1231

1786

1232

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

1787

1788

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

1233

1234

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

1789

1235

self.bus = bus

1790

1236

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

1791

1237

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

1792

1238

# the D-Bus

1793

client_object_name = str(self.name).translate(

1239

client_object_name = unicode(self.name).translate(

1794

1240

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

1795

1241

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

1796

self.dbus_object_path = dbus.ObjectPath(

1797

"/clients/" + client_object_name)

1242

self.dbus_object_path = (dbus.ObjectPath

1243

("/clients/" + client_object_name))

1798

1244

DBusObjectWithProperties.__init__(self, self.bus,

1799

1245

self.dbus_object_path)

1800

1801

def notifychangeproperty(transform_func, dbus_name,

1802

type_func=lambda x: x,

1803

variant_level=1,

1804

invalidate_only=False,

1805

_interface=_interface):

1246

1247

def notifychangeproperty(transform_func,

1248

dbus_name, type_func=lambda x: x,

1249

variant_level=1):

1806

1250

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

1807

1251

its changes to DBus.

1808

1252

1809

1253

transform_fun: Function that takes a value and a variant_level

1810

1254

and transforms it to a D-Bus type.

1811

1255

dbus_name: D-Bus name of the variable

1813

1257

to the D-Bus. Default: no transform

1814

1258

variant_level: D-Bus variant level. Default: 1

1815

1259

"""

1816

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

1817

1260

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

1818

1261

def setter(self, value):

1819

1262

if hasattr(self, "dbus_object_path"):

1820

1263

if (not hasattr(self, attrname) or

1821

1264

type_func(getattr(self, attrname, None))

1822

1265

!= type_func(value)):

1823

if invalidate_only:

1824

self.PropertiesChanged(

1825

_interface, dbus.Dictionary(),

1826

dbus.Array((dbus_name, )))

1827

else:

1828

dbus_value = transform_func(

1829

type_func(value),

1830

variant_level=variant_level)

1831

self.PropertyChanged(dbus.String(dbus_name),

1832

dbus_value)

1833

self.PropertiesChanged(

1834

_interface,

1835

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

1836

dbus_value}),

1837

dbus.Array())

1266

dbus_value = transform_func(type_func(value),

1267

variant_level

1268

=variant_level)

1269

self.PropertyChanged(dbus.String(dbus_name),

1270

dbus_value)

1838

1271

setattr(self, attrname, value)

1839

1272

1840

1273

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

1841

1274

1842

1275

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1843

1276

approvals_pending = notifychangeproperty(dbus.Boolean,

1844

1277

"ApprovalPending",

1845

type_func=bool)

1278

type_func = bool)

1846

1279

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

1847

1280

last_enabled = notifychangeproperty(datetime_to_dbus,

1848

1281

"LastEnabled")

1849

checker = notifychangeproperty(

1850

dbus.Boolean, "CheckerRunning",

1851

type_func=lambda checker: checker is not None)

1282

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

1283

type_func = lambda checker:

1284

checker is not None)

1852

1285

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1853

1286

"LastCheckedOK")

1854

1287

last_checker_status = notifychangeproperty(dbus.Int16,

1857

1290

datetime_to_dbus, "LastApprovalRequest")

1858

1291

approved_by_default = notifychangeproperty(dbus.Boolean,

1859

1292

"ApprovedByDefault")

1860

approval_delay = notifychangeproperty(

1861

dbus.UInt64, "ApprovalDelay",

1862

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

1293

approval_delay = notifychangeproperty(dbus.UInt64,

1294

"ApprovalDelay",

1295

type_func =

1296

timedelta_to_milliseconds)

1863

1297

approval_duration = notifychangeproperty(

1864

1298

dbus.UInt64, "ApprovalDuration",

1865

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

1299

type_func = timedelta_to_milliseconds)

1866

1300

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

1867

timeout = notifychangeproperty(

1868

dbus.UInt64, "Timeout",

1869

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

1301

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

1302

type_func =

1303

timedelta_to_milliseconds)

1870

1304

extended_timeout = notifychangeproperty(

1871

1305

dbus.UInt64, "ExtendedTimeout",

1872

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

1873

interval = notifychangeproperty(

1874

dbus.UInt64, "Interval",

1875

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

1306

type_func = timedelta_to_milliseconds)

1307

interval = notifychangeproperty(dbus.UInt64,

1308

"Interval",

1309

type_func =

1310

timedelta_to_milliseconds)

1876

1311

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

1877

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

1878

invalidate_only=True)

1879

1312

1880

1313

del notifychangeproperty

1881

1314

1882

1315

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

1883

1316

try:

1884

1317

self.remove_from_connection()

1887

1320

if hasattr(DBusObjectWithProperties, "__del__"):

1888

1321

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

1889

1322

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

1890

1891

def checker_callback(self, source, condition,

1892

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

1893

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

1894

connection, command, *args,

1895

**kwargs)

1896

exitstatus = self.last_checker_status

1897

if exitstatus >= 0:

1323

1324

def checker_callback(self, pid, condition, command,

1325

*args, **kwargs):

1326

self.checker_callback_tag = None

1327

self.checker = None

1328

if os.WIFEXITED(condition):

1329

exitstatus = os.WEXITSTATUS(condition)

1898

1330

# Emit D-Bus signal

1899

1331

self.CheckerCompleted(dbus.Int16(exitstatus),

1900

# This is specific to GNU libC

1901

dbus.Int64(exitstatus << 8),

1332

dbus.Int64(condition),

1902

1333

dbus.String(command))

1903

1334

else:

1904

1335

# Emit D-Bus signal

1905

1336

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

1906

dbus.Int64(

1907

# This is specific to GNU libC

1908

(exitstatus << 8)

1909

| self.last_checker_signal),

1337

dbus.Int64(condition),

1910

1338

dbus.String(command))

1911

return ret

1912

1339

1340

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

1341

*args, **kwargs)

1342

1913

1343

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

1914

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

1344

old_checker = self.checker

1345

if self.checker is not None:

1346

old_checker_pid = self.checker.pid

1347

else:

1348

old_checker_pid = None

1915

1349

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

1916

1350

# Only if new checker process was started

1917

1351

if (self.checker is not None

1919

1353

# Emit D-Bus signal

1920

1354

self.CheckerStarted(self.current_checker_command)

1921

1355

return r

1922

1356

1923

1357

def _reset_approved(self):

1924

1358

self.approved = None

1925

1359

return False

1926

1360

1927

1361

def approve(self, value=True):

1928

1362

self.approved = value

1929

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

1930

* 1000), self._reset_approved)

1363

gobject.timeout_add(timedelta_to_milliseconds

1364

(self.approval_duration),

1365

self._reset_approved)

1931

1366

self.send_changedstate()

1932

1933

# D-Bus methods, signals & properties

1934

1935

# Interfaces

1936

1937

# Signals

1938

1367

1368

## D-Bus methods, signals & properties

1369

_interface = "se.recompile.Mandos.Client"

1370

1371

## Interfaces

1372

1373

@dbus_interface_annotations(_interface)

1374

def _foo(self):

1375

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

1376

"false"}

1377

1378

## Signals

1379

1939

1380

# CheckerCompleted - signal

1940

1381

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

1941

1382

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

1942

1383

"D-Bus signal"

1943

1384

pass

1944

1385

1945

1386

# CheckerStarted - signal

1946

1387

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

1947

1388

def CheckerStarted(self, command):

1948

1389

"D-Bus signal"

1949

1390

pass

1950

1391

1951

1392

# PropertyChanged - signal

1952

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

1953

1393

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

1954

1394

def PropertyChanged(self, property, value):

1955

1395

"D-Bus signal"

1956

1396

pass

1957

1397

1958

1398

# GotSecret - signal

1959

1399

@dbus.service.signal(_interface)

1960

1400

def GotSecret(self):

1963

1403

server to mandos-client

1964

1404

"""

1965

1405

pass

1966

1406

1967

1407

# Rejected - signal

1968

1408

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

1969

1409

def Rejected(self, reason):

1970

1410

"D-Bus signal"

1971

1411

pass

1972

1412

1973

1413

# NeedApproval - signal

1974

1414

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

1975

1415

def NeedApproval(self, timeout, default):

1976

1416

"D-Bus signal"

1977

1417

return self.need_approval()

1978

1979

# Methods

1980

1418

1419

## Methods

1420

1981

1421

# Approve - method

1982

1422

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

1983

1423

def Approve(self, value):

1984

1424

self.approve(value)

1985

1425

1986

1426

# CheckedOK - method

1987

1427

@dbus.service.method(_interface)

1988

1428

def CheckedOK(self):

1989

1429

self.checked_ok()

1990

1430

1991

1431

# Enable - method

1992

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

1993

1432

@dbus.service.method(_interface)

1994

1433

def Enable(self):

1995

1434

"D-Bus method"

1996

1435

self.enable()

1997

1436

1998

1437

# StartChecker - method

1999

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

2000

1438

@dbus.service.method(_interface)

2001

1439

def StartChecker(self):

2002

1440

"D-Bus method"

2003

1441

self.start_checker()

2004

1442

2005

1443

# Disable - method

2006

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

2007

1444

@dbus.service.method(_interface)

2008

1445

def Disable(self):

2009

1446

"D-Bus method"

2010

1447

self.disable()

2011

1448

2012

1449

# StopChecker - method

2013

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

2014

1450

@dbus.service.method(_interface)

2015

1451

def StopChecker(self):

2016

1452

self.stop_checker()

2017

2018

# Properties

2019

1453

1454

## Properties

1455

2020

1456

# ApprovalPending - property

2021

1457

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

2022

1458

def ApprovalPending_dbus_property(self):

2023

1459

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

2024

1460

2025

1461

# ApprovedByDefault - property

2026

@dbus_service_property(_interface,

2027

signature="b",

1462

@dbus_service_property(_interface, signature="b",

2028

1463

access="readwrite")

2029

1464

def ApprovedByDefault_dbus_property(self, value=None):

2030

1465

if value is None: # get

2031

1466

return dbus.Boolean(self.approved_by_default)

2032

1467

self.approved_by_default = bool(value)

2033

1468

2034

1469

# ApprovalDelay - property

2035

@dbus_service_property(_interface,

2036

signature="t",

1470

@dbus_service_property(_interface, signature="t",

2037

1471

access="readwrite")

2038

1472

def ApprovalDelay_dbus_property(self, value=None):

2039

1473

if value is None: # get

2040

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

2041

* 1000)

1474

return dbus.UInt64(self.approval_delay_milliseconds())

2042

1475

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

2043

1476

2044

1477

# ApprovalDuration - property

2045

@dbus_service_property(_interface,

2046

signature="t",

1478

@dbus_service_property(_interface, signature="t",

2047

1479

access="readwrite")

2048

1480

def ApprovalDuration_dbus_property(self, value=None):

2049

1481

if value is None: # get

2050

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

2051

* 1000)

1482

return dbus.UInt64(timedelta_to_milliseconds(

1483

self.approval_duration))

2052

1484

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

2053

1485

2054

1486

# Name - property

2055

@dbus_annotations(

2056

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

2057

1487

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

2058

1488

def Name_dbus_property(self):

2059

1489

return dbus.String(self.name)

2060

2061

# KeyID - property

2062

@dbus_annotations(

2063

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

2064

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

2065

def KeyID_dbus_property(self):

2066

return dbus.String(self.key_id)

2067

1490

2068

1491

# Fingerprint - property

2069

@dbus_annotations(

2070

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

2071

1492

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

2072

1493

def Fingerprint_dbus_property(self):

2073

1494

return dbus.String(self.fingerprint)

2074

1495

2075

1496

# Host - property

2076

@dbus_service_property(_interface,

2077

signature="s",

1497

@dbus_service_property(_interface, signature="s",

2078

1498

access="readwrite")

2079

1499

def Host_dbus_property(self, value=None):

2080

1500

if value is None: # get

2081

1501

return dbus.String(self.host)

2082

self.host = str(value)

2083

1502

self.host = unicode(value)

1503

2084

1504

# Created - property

2085

@dbus_annotations(

2086

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

2087

1505

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

2088

1506

def Created_dbus_property(self):

2089

1507

return datetime_to_dbus(self.created)

2090

1508

2091

1509

# LastEnabled - property

2092

1510

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

2093

1511

def LastEnabled_dbus_property(self):

2094

1512

return datetime_to_dbus(self.last_enabled)

2095

1513

2096

1514

# Enabled - property

2097

@dbus_service_property(_interface,

2098

signature="b",

1515

@dbus_service_property(_interface, signature="b",

2099

1516

access="readwrite")

2100

1517

def Enabled_dbus_property(self, value=None):

2101

1518

if value is None: # get

2104

1521

self.enable()

2105

1522

else:

2106

1523

self.disable()

2107

1524

2108

1525

# LastCheckedOK - property

2109

@dbus_service_property(_interface,

2110

signature="s",

1526

@dbus_service_property(_interface, signature="s",

2111

1527

access="readwrite")

2112

1528

def LastCheckedOK_dbus_property(self, value=None):

2113

1529

if value is not None:

2114

1530

self.checked_ok()

2115

1531

return

2116

1532

return datetime_to_dbus(self.last_checked_ok)

2117

1533

2118

1534

# LastCheckerStatus - property

2119

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

1535

@dbus_service_property(_interface, signature="n",

1536

access="read")

2120

1537

def LastCheckerStatus_dbus_property(self):

2121

1538

return dbus.Int16(self.last_checker_status)

2122

1539

2123

1540

# Expires - property

2124

1541

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

2125

1542

def Expires_dbus_property(self):

2126

1543

return datetime_to_dbus(self.expires)

2127

1544

2128

1545

# LastApprovalRequest - property

2129

1546

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

2130

1547

def LastApprovalRequest_dbus_property(self):

2131

1548

return datetime_to_dbus(self.last_approval_request)

2132

1549

2133

1550

# Timeout - property

2134

@dbus_service_property(_interface,

2135

signature="t",

1551

@dbus_service_property(_interface, signature="t",

2136

1552

access="readwrite")

2137

1553

def Timeout_dbus_property(self, value=None):

2138

1554

if value is None: # get

2139

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

1555

return dbus.UInt64(self.timeout_milliseconds())

2140

1556

old_timeout = self.timeout

2141

1557

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

2142

1558

# Reschedule disabling

2150

1566

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

2151

1567

is None):

2152

1568

return

2153

GLib.source_remove(self.disable_initiator_tag)

2154

self.disable_initiator_tag = GLib.timeout_add(

2155

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

2156

self.disable)

2157

1569

gobject.source_remove(self.disable_initiator_tag)

1570

self.disable_initiator_tag = (

1571

gobject.timeout_add(

1572

timedelta_to_milliseconds(self.expires - now),

1573

self.disable))

1574

2158

1575

# ExtendedTimeout - property

2159

@dbus_service_property(_interface,

2160

signature="t",

1576

@dbus_service_property(_interface, signature="t",

2161

1577

access="readwrite")

2162

1578

def ExtendedTimeout_dbus_property(self, value=None):

2163

1579

if value is None: # get

2164

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

2165

* 1000)

1580

return dbus.UInt64(self.extended_timeout_milliseconds())

2166

1581

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

2167

1582

2168

1583

# Interval - property

2169

@dbus_service_property(_interface,

2170

signature="t",

1584

@dbus_service_property(_interface, signature="t",

2171

1585

access="readwrite")

2172

1586

def Interval_dbus_property(self, value=None):

2173

1587

if value is None: # get

2174

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

1588

return dbus.UInt64(self.interval_milliseconds())

2175

1589

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

2176

1590

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

2177

1591

return

2178

1592

if self.enabled:

2179

1593

# Reschedule checker run

2180

GLib.source_remove(self.checker_initiator_tag)

2181

self.checker_initiator_tag = GLib.timeout_add(

2182

value, self.start_checker)

2183

self.start_checker() # Start one now, too

2184

1594

gobject.source_remove(self.checker_initiator_tag)

1595

self.checker_initiator_tag = (gobject.timeout_add

1596

(value, self.start_checker))

1597

self.start_checker() # Start one now, too

1598

2185

1599

# Checker - property

2186

@dbus_service_property(_interface,

2187

signature="s",

1600

@dbus_service_property(_interface, signature="s",

2188

1601

access="readwrite")

2189

1602

def Checker_dbus_property(self, value=None):

2190

1603

if value is None: # get

2191

1604

return dbus.String(self.checker_command)

2192

self.checker_command = str(value)

2193

1605

self.checker_command = unicode(value)

1606

2194

1607

# CheckerRunning - property

2195

@dbus_service_property(_interface,

2196

signature="b",

1608

@dbus_service_property(_interface, signature="b",

2197

1609

access="readwrite")

2198

1610

def CheckerRunning_dbus_property(self, value=None):

2199

1611

if value is None: # get

2202

1614

self.start_checker()

2203

1615

else:

2204

1616

self.stop_checker()

2205

1617

2206

1618

# ObjectPath - property

2207

@dbus_annotations(

2208

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

2209

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

2210

1619

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

2211

1620

def ObjectPath_dbus_property(self):

2212

return self.dbus_object_path # is already a dbus.ObjectPath

2213

1621

return self.dbus_object_path # is already a dbus.ObjectPath

1622

2214

1623

# Secret = property

2215

@dbus_annotations(

2216

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

2217

"invalidates"})

2218

@dbus_service_property(_interface,

2219

signature="ay",

2220

access="write",

2221

byte_arrays=True)

1624

@dbus_service_property(_interface, signature="ay",

1625

access="write", byte_arrays=True)

2222

1626

def Secret_dbus_property(self, value):

2223

self.secret = bytes(value)

2224

1627

self.secret = str(value)

1628

2225

1629

del _interface

2226

1630

2227

1631

2228

class ProxyClient:

2229

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

1632

class ProxyClient(object):

1633

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

2230

1634

self._pipe = child_pipe

2231

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

1635

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

2232

1636

if not self._pipe.recv():

2233

raise KeyError(key_id or fpr)

2234

1637

raise KeyError()

1638

2235

1639

def __getattribute__(self, name):

2236

1640

if name == '_pipe':

2237

1641

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

2240

1644

if data[0] == 'data':

2241

1645

return data[1]

2242

1646

if data[0] == 'function':

2243

2244

1647

def func(*args, **kwargs):

2245

1648

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

2246

1649

return self._pipe.recv()[1]

2247

2248

1650

return func

2249

1651

2250

1652

def __setattr__(self, name, value):

2251

1653

if name == '_pipe':

2252

1654

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

2255

1657

2256

1658

class ClientHandler(socketserver.BaseRequestHandler, object):

2257

1659

"""A class to handle client connections.

2258

1660

2259

1661

Instantiated once for each connection to handle it.

2260

1662

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

2261

1663

2262

1664

def handle(self):

2263

1665

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

2264

1666

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

2265

str(self.client_address))

1667

unicode(self.client_address))

2266

1668

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

2267

1669

self.server.child_pipe.fileno())

2268

2269

session = gnutls.ClientSession(self.request)

2270

2271

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

2272

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

2273

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

2274

# "+DHE-DSS"))

1670

1671

session = (gnutls.connection

1672

.ClientSession(self.request,

1673

gnutls.connection

1674

.X509Credentials()))

1675

1676

# Note: gnutls.connection.X509Credentials is really a

1677

# generic GnuTLS certificate credentials object so long as

1678

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

1679

# here despite using OpenPGP certificates.

1680

1681

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

1682

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

1683

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

1684

# "+DHE-DSS"))

2275

1685

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

2276

1686

priority = self.server.gnutls_priority

2277

1687

if priority is None:

2278

1688

priority = "NORMAL"

2279

gnutls.priority_set_direct(session._c_object,

2280

priority.encode("utf-8"),

2281

None)

2282

1689

(gnutls.library.functions

1690

.gnutls_priority_set_direct(session._c_object,

1691

priority, None))

1692

2283

1693

# Start communication using the Mandos protocol

2284

1694

# Get protocol number

2285

1695

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

2286

1696

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

2287

1697

try:

2288

1698

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

2289

raise RuntimeError(line)

1699

raise RuntimeError

2290

1700

except (ValueError, IndexError, RuntimeError) as error:

2291

1701

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

2292

1702

return

2293

1703

2294

1704

# Start GnuTLS connection

2295

1705

try:

2296

1706

session.handshake()

2297

except gnutls.Error as error:

1707

except gnutls.errors.GNUTLSError as error:

2298

1708

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

2299

1709

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

2300

1710

# established. Just abandon the request.

2301

1711

return

2302

1712

logger.debug("Handshake succeeded")

2303

1713

2304

1714

approval_required = False

2305

1715

try:

2306

if gnutls.has_rawpk:

2307

fpr = b""

2308

try:

2309

key_id = self.key_id(

2310

self.peer_certificate(session))

2311

except (TypeError, gnutls.Error) as error:

2312

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

2313

return

2314

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

2315

2316

else:

2317

key_id = b""

2318

try:

2319

fpr = self.fingerprint(

2320

self.peer_certificate(session))

2321

except (TypeError, gnutls.Error) as error:

2322

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

2323

return

2324

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

2325

2326

try:

2327

client = ProxyClient(child_pipe, key_id, fpr,

1716

try:

1717

fpr = self.fingerprint(self.peer_certificate

1718

(session))

1719

except (TypeError,

1720

gnutls.errors.GNUTLSError) as error:

1721

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

1722

return

1723

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

1724

1725

try:

1726

client = ProxyClient(child_pipe, fpr,

2328

1727

self.client_address)

2329

1728

except KeyError:

2330

1729

return

2331

1730

2332

1731

if client.approval_delay:

2333

1732

delay = client.approval_delay

2334

1733

client.approvals_pending += 1

2335

1734

approval_required = True

2336

1735

2337

1736

while True:

2338

1737

if not client.enabled:

2339

1738

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

2340

client.name)

1739

client.name)

2341

1740

if self.server.use_dbus:

2342

1741

# Emit D-Bus signal

2343

1742

client.Rejected("Disabled")

2344

1743

return

2345

1744

2346

1745

if client.approved or not client.approval_delay:

2347

# We are approved or approval is disabled

1746

#We are approved or approval is disabled

2348

1747

break

2349

1748

elif client.approved is None:

2350

1749

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

2352

1751

if self.server.use_dbus:

2353

1752

# Emit D-Bus signal

2354

1753

client.NeedApproval(

2355

client.approval_delay.total_seconds()

2356

* 1000, client.approved_by_default)

1754

client.approval_delay_milliseconds(),

1755

client.approved_by_default)

2357

1756

else:

2358

1757

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

2359

1758

client.name)

2361

1760

# Emit D-Bus signal

2362

1761

client.Rejected("Denied")

2363

1762

return

2364

2365

# wait until timeout or approved

1763

1764

#wait until timeout or approved

2366

1765

time = datetime.datetime.now()

2367

1766

client.changedstate.acquire()

2368

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

1767

client.changedstate.wait(

1768

float(timedelta_to_milliseconds(delay)

1769

/ 1000))

2369

1770

client.changedstate.release()

2370

1771

time2 = datetime.datetime.now()

2371

1772

if (time2 - time) >= delay:

2381

1782

break

2382

1783

else:

2383

1784

delay -= time2 - time

2384

2385

try:

2386

session.send(client.secret)

2387

except gnutls.Error as error:

2388

logger.warning("gnutls send failed",

2389

exc_info=error)

2390

return

2391

1785

1786

sent_size = 0

1787

while sent_size < len(client.secret):

1788

try:

1789

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

1790

except gnutls.errors.GNUTLSError as error:

1791

logger.warning("gnutls send failed",

1792

exc_info=error)

1793

return

1794

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

1795

sent, len(client.secret)

1796

- (sent_size + sent))

1797

sent_size += sent

1798

2392

1799

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

2393

1800

# bump the timeout using extended_timeout

2394

1801

client.bump_timeout(client.extended_timeout)

2395

1802

if self.server.use_dbus:

2396

1803

# Emit D-Bus signal

2397

1804

client.GotSecret()

2398

1805

2399

1806

finally:

2400

1807

if approval_required:

2401

1808

client.approvals_pending -= 1

2402

1809

try:

2403

1810

session.bye()

2404

except gnutls.Error as error:

1811

except gnutls.errors.GNUTLSError as error:

2405

1812

logger.warning("GnuTLS bye failed",

2406

1813

exc_info=error)

2407

1814

2408

1815

@staticmethod

2409

1816

def peer_certificate(session):

2410

"Return the peer's certificate as a bytestring"

2411

try:

2412

cert_type = gnutls.certificate_type_get2(session._c_object,

2413

gnutls.CTYPE_PEERS)

2414

except AttributeError:

2415

cert_type = gnutls.certificate_type_get(session._c_object)

2416

if gnutls.has_rawpk:

2417

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2418

else:

2419

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2420

# If not a valid certificate type...

2421

if cert_type not in valid_cert_types:

2422

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

2423

valid_cert_types)

2424

# ...return invalid data

2425

return b""

1817

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

1818

# If not an OpenPGP certificate...

1819

if (gnutls.library.functions

1820

.gnutls_certificate_type_get(session._c_object)

1821

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1822

# ...do the normal thing

1823

return session.peer_certificate

2426

1824

list_size = ctypes.c_uint(1)

2427

cert_list = (gnutls.certificate_get_peers

1825

cert_list = (gnutls.library.functions

1826

.gnutls_certificate_get_peers

2428

1827

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

2429

1828

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

2430

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

1829

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

1830

" certificate")

2431

1831

if list_size.value == 0:

2432

1832

return None

2433

1833

cert = cert_list[0]

2434

1834

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

2435

2436

@staticmethod

2437

def key_id(certificate):

2438

"Convert a certificate bytestring to a hexdigit key ID"

2439

# New GnuTLS "datum" with the public key

2440

datum = gnutls.datum_t(

2441

ctypes.cast(ctypes.c_char_p(certificate),

2442

ctypes.POINTER(ctypes.c_ubyte)),

2443

ctypes.c_uint(len(certificate)))

2444

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

2445

# New empty GnuTLS certificate

2446

pubkey = gnutls.pubkey_t()

2447

gnutls.pubkey_init(ctypes.byref(pubkey))

2448

# Import the raw public key into the certificate

2449

gnutls.pubkey_import(pubkey,

2450

ctypes.byref(datum),

2451

gnutls.X509_FMT_DER)

2452

# New buffer for the key ID

2453

buf = ctypes.create_string_buffer(32)

2454

buf_len = ctypes.c_size_t(len(buf))

2455

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

2456

gnutls.pubkey_get_key_id(pubkey,

2457

gnutls.KEYID_USE_SHA256,

2458

ctypes.cast(ctypes.byref(buf),

2459

ctypes.POINTER(ctypes.c_ubyte)),

2460

ctypes.byref(buf_len))

2461

# Deinit the certificate

2462

gnutls.pubkey_deinit(pubkey)

2463

2464

# Convert the buffer to a Python bytestring

2465

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

2466

# Convert the bytestring to hexadecimal notation

2467

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

2468

return hex_key_id

2469

1835

2470

1836

@staticmethod

2471

1837

def fingerprint(openpgp):

2472

1838

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2473

1839

# New GnuTLS "datum" with the OpenPGP public key

2474

datum = gnutls.datum_t(

2475

ctypes.cast(ctypes.c_char_p(openpgp),

2476

ctypes.POINTER(ctypes.c_ubyte)),

2477

ctypes.c_uint(len(openpgp)))

1840

datum = (gnutls.library.types

1841

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

1842

ctypes.POINTER

1843

(ctypes.c_ubyte)),

1844

ctypes.c_uint(len(openpgp))))

2478

1845

# New empty GnuTLS certificate

2479

crt = gnutls.openpgp_crt_t()

2480

gnutls.openpgp_crt_init(ctypes.byref(crt))

1846

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1847

(gnutls.library.functions

1848

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2481

1849

# Import the OpenPGP public key into the certificate

2482

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

2483

gnutls.OPENPGP_FMT_RAW)

1850

(gnutls.library.functions

1851

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

1852

gnutls.library.constants

1853

.GNUTLS_OPENPGP_FMT_RAW))

2484

1854

# Verify the self signature in the key

2485

1855

crtverify = ctypes.c_uint()

2486

gnutls.openpgp_crt_verify_self(crt, 0,

2487

ctypes.byref(crtverify))

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_verify_self(crt, 0,

1858

ctypes.byref(crtverify)))

2488

1859

if crtverify.value != 0:

2489

gnutls.openpgp_crt_deinit(crt)

2490

raise gnutls.CertificateSecurityError(code

2491

=crtverify.value)

1860

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1861

raise (gnutls.errors.CertificateSecurityError

1862

("Verify failed"))

2492

1863

# New buffer for the fingerprint

2493

1864

buf = ctypes.create_string_buffer(20)

2494

1865

buf_len = ctypes.c_size_t()

2495

1866

# Get the fingerprint from the certificate into the buffer

2496

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

2497

ctypes.byref(buf_len))

1867

(gnutls.library.functions

1868

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

1869

ctypes.byref(buf_len)))

2498

1870

# Deinit the certificate

2499

gnutls.openpgp_crt_deinit(crt)

1871

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2500

1872

# Convert the buffer to a Python bytestring

2501

1873

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

2502

1874

# Convert the bytestring to hexadecimal notation

2504

1876

return hex_fpr

2505

1877

2506

1878

2507

class MultiprocessingMixIn:

1879

class MultiprocessingMixIn(object):

2508

1880

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

2509

2510

1881

def sub_process_main(self, request, address):

2511

1882

try:

2512

1883

self.finish_request(request, address)

2513

1884

except Exception:

2514

1885

self.handle_error(request, address)

2515

1886

self.close_request(request)

2516

1887

2517

1888

def process_request(self, request, address):

2518

1889

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

2519

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

2520

args=(request, address))

1890

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

1891

args = (request, address))

2521

1892

proc.start()

2522

1893

return proc

2523

1894

2524

1895

2525

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1896

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2526

1897

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

2527

2528

1898

def process_request(self, request, client_address):

2529

1899

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

2530

1900

2531

1901

This function creates a new pipe in self.pipe

2532

1902

"""

2533

1903

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2534

1904

2535

1905

proc = MultiprocessingMixIn.process_request(self, request,

2536

1906

client_address)

2537

1907

self.child_pipe.close()

2538

1908

self.add_pipe(parent_pipe, proc)

2539

1909

2540

1910

def add_pipe(self, parent_pipe, proc):

2541

1911

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

2542

raise NotImplementedError()

1912

raise NotImplementedError

2543

1913

2544

1914

2545

1915

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2546

socketserver.TCPServer):

1916

socketserver.TCPServer, object):

2547

1917

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

2548

1918

2549

1919

Attributes:

2550

1920

enabled: Boolean; whether this server is activated yet

2551

1921

interface: None or a network interface name (string)

2552

1922

use_ipv6: Boolean; to use IPv6 or not

2553

1923

"""

2554

2555

1924

def __init__(self, server_address, RequestHandlerClass,

2556

interface=None,

2557

use_ipv6=True,

2558

socketfd=None):

1925

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

2559

1926

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

2560

1927

creating a new one with socket.socket().

2561

1928

"""

2567

1934

self.socketfd = socketfd

2568

1935

# Save the original socket.socket() function

2569

1936

self.socket_socket = socket.socket

2570

2571

1937

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

2572

#

1938

#

2573

1939

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

2574

1940

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

2575

1941

# patching socket.socket.)

2576

#

1942

#

2577

1943

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

2578

1944

@functools.wraps(socket.socket)

2579

1945

def socket_wrapper(*args, **kwargs):

2591

1957

# socket_wrapper(), if socketfd was set.

2592

1958

socketserver.TCPServer.__init__(self, server_address,

2593

1959

RequestHandlerClass)

2594

1960

2595

1961

def server_bind(self):

2596

1962

"""This overrides the normal server_bind() function

2597

1963

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

2598

1964

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

2599

global SO_BINDTODEVICE

2600

1965

if self.interface is not None:

2601

1966

if SO_BINDTODEVICE is None:

2602

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

2603

# common enough.

2604

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

2605

SO_BINDTODEVICE = 25

2606

try:

2607

self.socket.setsockopt(

2608

socket.SOL_SOCKET, SO_BINDTODEVICE,

2609

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

2610

except socket.error as error:

2611

if error.errno == errno.EPERM:

2612

logger.error("No permission to bind to"

2613

" interface %s", self.interface)

2614

elif error.errno == errno.ENOPROTOOPT:

2615

logger.error("SO_BINDTODEVICE not available;"

2616

" cannot bind to interface %s",

2617

self.interface)

2618

elif error.errno == errno.ENODEV:

2619

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

2620

" cannot bind", self.interface)

2621

else:

2622

raise

1967

logger.error("SO_BINDTODEVICE does not exist;"

1968

" cannot bind to interface %s",

1969

self.interface)

1970

else:

1971

try:

1972

self.socket.setsockopt(socket.SOL_SOCKET,

1973

SO_BINDTODEVICE,

1974

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

1975

except socket.error as error:

1976

if error.errno == errno.EPERM:

1977

logger.error("No permission to bind to"

1978

" interface %s", self.interface)

1979

elif error.errno == errno.ENOPROTOOPT:

1980

logger.error("SO_BINDTODEVICE not available;"

1981

" cannot bind to interface %s",

1982

self.interface)

1983

elif error.errno == errno.ENODEV:

1984

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

1985

" cannot bind", self.interface)

1986

else:

1987

raise

2623

1988

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

2624

1989

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

2625

if self.server_address[1]:

2626

self.allow_reuse_address = True

2627

1990

if not self.server_address[0]:

2628

1991

if self.address_family == socket.AF_INET6:

2629

any_address = "::" # in6addr_any

1992

any_address = "::" # in6addr_any

2630

1993

else:

2631

any_address = "0.0.0.0" # INADDR_ANY

1994

any_address = "0.0.0.0" # INADDR_ANY

2632

1995

self.server_address = (any_address,

2633

1996

self.server_address[1])

2634

1997

elif not self.server_address[1]:

2635

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

1998

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

1999

0)

2636

2000

# if self.interface:

2637

2001

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

2638

2002

# 0, # port

2644

2008

2645

2009

class MandosServer(IPv6_TCPServer):

2646

2010

"""Mandos server.

2647

2011

2648

2012

Attributes:

2649

2013

clients: set of Client objects

2650

2014

gnutls_priority GnuTLS priority string

2651

2015

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

2652

2653

Assumes a GLib.MainLoop event loop.

2016

2017

Assumes a gobject.MainLoop event loop.

2654

2018

"""

2655

2656

2019

def __init__(self, server_address, RequestHandlerClass,

2657

interface=None,

2658

use_ipv6=True,

2659

clients=None,

2660

gnutls_priority=None,

2661

use_dbus=True,

2662

socketfd=None):

2020

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

2021

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

2663

2022

self.enabled = False

2664

2023

self.clients = clients

2665

2024

if self.clients is None:

2668

2027

self.gnutls_priority = gnutls_priority

2669

2028

IPv6_TCPServer.__init__(self, server_address,

2670

2029

RequestHandlerClass,

2671

interface=interface,

2672

use_ipv6=use_ipv6,

2673

socketfd=socketfd)

2674

2030

interface = interface,

2031

use_ipv6 = use_ipv6,

2032

socketfd = socketfd)

2675

2033

def server_activate(self):

2676

2034

if self.enabled:

2677

2035

return socketserver.TCPServer.server_activate(self)

2678

2036

2679

2037

def enable(self):

2680

2038

self.enabled = True

2681

2039

2682

2040

def add_pipe(self, parent_pipe, proc):

2683

2041

# Call "handle_ipc" for both data and EOF events

2684

GLib.io_add_watch(

2685

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

2686

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

2687

functools.partial(self.handle_ipc,

2688

parent_pipe=parent_pipe,

2689

proc=proc))

2690

2691

def handle_ipc(self, source, condition,

2692

parent_pipe=None,

2693

proc=None,

2694

client_object=None):

2042

gobject.io_add_watch(parent_pipe.fileno(),

2043

gobject.IO_IN | gobject.IO_HUP,

2044

functools.partial(self.handle_ipc,

2045

parent_pipe =

2046

parent_pipe,

2047

proc = proc))

2048

2049

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

2050

proc = None, client_object=None):

2695

2051

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

2696

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

2052

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

2697

2053

# Wait for other process to exit

2698

2054

proc.join()

2699

2055

return False

2700

2056

2701

2057

# Read a request from the child

2702

2058

request = parent_pipe.recv()

2703

2059

command = request[0]

2704

2060

2705

2061

if command == 'init':

2706

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

2707

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

2708

address = request[3]

2709

2710

for c in self.clients.values():

2711

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2712

continue

2713

if key_id and c.key_id == key_id:

2714

client = c

2715

break

2716

if fpr and c.fingerprint == fpr:

2062

fpr = request[1]

2063

address = request[2]

2064

2065

for c in self.clients.itervalues():

2066

if c.fingerprint == fpr:

2717

2067

client = c

2718

2068

break

2719

2069

else:

2720

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

2721

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

2070

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

2071

"dress: %s", fpr, address)

2722

2072

if self.use_dbus:

2723

2073

# Emit D-Bus signal

2724

mandos_dbus_service.ClientNotFound(key_id or fpr,

2074

mandos_dbus_service.ClientNotFound(fpr,

2725

2075

address[0])

2726

2076

parent_pipe.send(False)

2727

2077

return False

2728

2729

GLib.io_add_watch(

2730

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

2731

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

2732

functools.partial(self.handle_ipc,

2733

parent_pipe=parent_pipe,

2734

proc=proc,

2735

client_object=client))

2078

2079

gobject.io_add_watch(parent_pipe.fileno(),

2080

gobject.IO_IN | gobject.IO_HUP,

2081

functools.partial(self.handle_ipc,

2082

parent_pipe =

2083

parent_pipe,

2084

proc = proc,

2085

client_object =

2086

client))

2736

2087

parent_pipe.send(True)

2737

2088

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

2738

2089

# same fileno

2741

2092

funcname = request[1]

2742

2093

args = request[2]

2743

2094

kwargs = request[3]

2744

2095

2745

2096

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

2746

2097

funcname)(*args,

2747

**kwargs)))

2748

2098

**kwargs)))

2099

2749

2100

if command == 'getattr':

2750

2101

attrname = request[1]

2751

if isinstance(client_object.__getattribute__(attrname),

2752

collections.Callable):

2753

parent_pipe.send(('function', ))

2102

if callable(client_object.__getattribute__(attrname)):

2103

parent_pipe.send(('function',))

2754

2104

else:

2755

parent_pipe.send((

2756

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

2757

2105

parent_pipe.send(('data', client_object

2106

.__getattribute__(attrname)))

2107

2758

2108

if command == 'setattr':

2759

2109

attrname = request[1]

2760

2110

value = request[2]

2761

2111

setattr(client_object, attrname, value)

2762

2112

2763

2113

return True

2764

2114

2765

2115

2766

2116

def rfc3339_duration_to_delta(duration):

2767

2117

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

2768

2769

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

2770

True

2771

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

2772

True

2773

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

2774

True

2775

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

2776

True

2777

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

2778

True

2779

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

2780

True

2781

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

2782

True

2118

2119

>>> rfc3339_duration_to_delta("P7D")

2120

datetime.timedelta(7)

2121

>>> rfc3339_duration_to_delta("PT60S")

2122

datetime.timedelta(0, 60)

2123

>>> rfc3339_duration_to_delta("PT60M")

2124

datetime.timedelta(0, 3600)

2125

>>> rfc3339_duration_to_delta("PT24H")

2126

datetime.timedelta(1)

2127

>>> rfc3339_duration_to_delta("P1W")

2128

datetime.timedelta(7)

2129

>>> rfc3339_duration_to_delta("PT5M30S")

2130

datetime.timedelta(0, 330)

2131

>>> rfc3339_duration_to_delta("P1DT3M20S")

2132

datetime.timedelta(1, 200)

2783

2133

"""

2784

2134

2785

2135

# Parsing an RFC 3339 duration with regular expressions is not

2786

2136

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

2787

2137

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

2788

2138

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

2789

2139

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

2790

2140

# avoid excessive use of external libraries.

2791

2141

2792

2142

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

2793

Token = collections.namedtuple("Token", (

2794

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

2795

# a "group" containing digits

2796

"value", # datetime.timedelta or None

2797

"followers")) # Tokens valid after this token

2143

Token = collections.namedtuple("Token",

2144

("regexp", # To match token; if

2145

# "value" is not None,

2146

# must have a "group"

2147

# containing digits

2148

"value", # datetime.timedelta or

2149

# None

2150

"followers")) # Tokens valid after

2151

# this token

2798

2152

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

2799

2153

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

2800

2154

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

2801

2155

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

2802

2156

datetime.timedelta(seconds=1),

2803

frozenset((token_end, )))

2157

frozenset((token_end,)))

2804

2158

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

2805

2159

datetime.timedelta(minutes=1),

2806

2160

frozenset((token_second, token_end)))

2822

2176

frozenset((token_month, token_end)))

2823

2177

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

2824

2178

datetime.timedelta(weeks=1),

2825

frozenset((token_end, )))

2179

frozenset((token_end,)))

2826

2180

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

2827

2181

frozenset((token_year, token_month,

2828

2182

token_day, token_time,

2829

token_week)))

2830

# Define starting values:

2831

# Value so far

2832

value = datetime.timedelta()

2183

token_week))),

2184

# Define starting values

2185

value = datetime.timedelta() # Value so far

2833

2186

found_token = None

2834

# Following valid tokens

2835

followers = frozenset((token_duration, ))

2836

# String left to parse

2837

s = duration

2187

followers = frozenset(token_duration,) # Following valid tokens

2188

s = duration # String left to parse

2838

2189

# Loop until end token is found

2839

2190

while found_token is not token_end:

2840

2191

# Search for any currently valid tokens

2856

2207

break

2857

2208

else:

2858

2209

# No currently valid tokens were found

2859

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

2860

.format(duration))

2210

raise ValueError("Invalid RFC 3339 duration")

2861

2211

# End token found

2862

2212

return value

2863

2213

2864

2214

2865

2215

def string_to_delta(interval):

2866

2216

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

2867

2868

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

2869

True

2870

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

2871

True

2872

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

2873

True

2874

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

2875

True

2876

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

2877

True

2878

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

2879

True

2217

2218

>>> string_to_delta('7d')

2219

datetime.timedelta(7)

2220

>>> string_to_delta('60s')

2221

datetime.timedelta(0, 60)

2222

>>> string_to_delta('60m')

2223

datetime.timedelta(0, 3600)

2224

>>> string_to_delta('24h')

2225

datetime.timedelta(1)

2226

>>> string_to_delta('1w')

2227

datetime.timedelta(7)

2228

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

2229

datetime.timedelta(0, 330)

2880

2230

"""

2881

2231

2882

2232

try:

2883

2233

return rfc3339_duration_to_delta(interval)

2884

2234

except ValueError:

2885

2235

pass

2886

2236

2887

2237

timevalue = datetime.timedelta(0)

2888

2238

for s in interval.split():

2889

2239

try:

2890

suffix = s[-1]

2240

suffix = unicode(s[-1])

2891

2241

value = int(s[:-1])

2892

2242

if suffix == "d":

2893

2243

delta = datetime.timedelta(value)

2900

2250

elif suffix == "w":

2901

2251

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

2902

2252

else:

2903

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

2904

except IndexError as e:

2253

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

2254

.format(suffix))

2255

except (ValueError, IndexError) as e:

2905

2256

raise ValueError(*(e.args))

2906

2257

timevalue += delta

2907

2258

return timevalue

2908

2259

2909

2260

2910

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

2261

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

2911

2262

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

2912

2263

2913

2264

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

2914

2265

if os.fork():

2915

2266

sys.exit()

2923

2274

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

2924

2275

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

2925

2276

raise OSError(errno.ENODEV,

2926

"{} not a character device"

2277

"{0} not a character device"

2927

2278

.format(os.devnull))

2928

2279

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

2929

2280

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

2933

2284

2934

2285

2935

2286

def main():

2936

2287

2937

2288

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

2938

2289

# Parsing of options, both command line and config file

2939

2290

2940

2291

parser = argparse.ArgumentParser()

2941

2292

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

2942

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

2293

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

2943

2294

help="show version number and exit")

2944

2295

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

2945

2296

help="Bind to interface IF")

2978

2329

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

2979

2330

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

2980

2331

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

2981

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

2982

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

2983

default=None)

2984

2332

2985

2333

options = parser.parse_args()

2986

2334

2335

if options.check:

2336

import doctest

2337

doctest.testmod()

2338

sys.exit()

2339

2987

2340

# Default values for config file for server-global settings

2988

if gnutls.has_rawpk:

2989

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

2990

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

2991

else:

2992

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

2993

":+SIGN-DSA-SHA256")

2994

server_defaults = {"interface": "",

2995

"address": "",

2996

"port": "",

2997

"debug": "False",

2998

"priority": priority,

2999

"servicename": "Mandos",

3000

"use_dbus": "True",

3001

"use_ipv6": "True",

3002

"debuglevel": "",

3003

"restore": "True",

3004

"socket": "",

3005

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

3006

"foreground": "False",

3007

"zeroconf": "True",

3008

}

3009

del priority

3010

2341

server_defaults = { "interface": "",

2342

"address": "",

2343

"port": "",

2344

"debug": "False",

2345

"priority":

2346

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

2347

"servicename": "Mandos",

2348

"use_dbus": "True",

2349

"use_ipv6": "True",

2350

"debuglevel": "",

2351

"restore": "True",

2352

"socket": "",

2353

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

2354

"foreground": "False",

2355

}

2356

3011

2357

# Parse config file for server-global settings

3012

server_config = configparser.ConfigParser(server_defaults)

2358

server_config = configparser.SafeConfigParser(server_defaults)

3013

2359

del server_defaults

3014

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

3015

# Convert the ConfigParser object to a dict

2360

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

2361

"mandos.conf"))

2362

# Convert the SafeConfigParser object to a dict

3016

2363

server_settings = server_config.defaults()

3017

2364

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

3018

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

3019

"foreground", "zeroconf"):

2365

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

3020

2366

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

3021

2367

option)

3022

2368

if server_settings["port"]:

3032

2378

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

3033

2379

["socket"])

3034

2380

del server_config

3035

2381

3036

2382

# Override the settings from the config file with command line

3037

2383

# options, if set.

3038

2384

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

3039

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

3040

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

3041

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

2385

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

2386

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

2387

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

3042

2388

value = getattr(options, option)

3043

2389

if value is not None:

3044

2390

server_settings[option] = value

3045

2391

del options

3046

2392

# Force all strings to be unicode

3047

2393

for option in server_settings.keys():

3048

if isinstance(server_settings[option], bytes):

3049

server_settings[option] = (server_settings[option]

3050

.decode("utf-8"))

2394

if type(server_settings[option]) is str:

2395

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

3051

2396

# Force all boolean options to be boolean

3052

2397

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

3053

"foreground", "zeroconf"):

2398

"foreground"):

3054

2399

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

3055

2400

# Debug implies foreground

3056

2401

if server_settings["debug"]:

3057

2402

server_settings["foreground"] = True

3058

2403

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

3059

2404

3060

2405

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

3061

3062

if (not server_settings["zeroconf"]

3063

and not (server_settings["port"]

3064

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

3065

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

3066

2406

3067

2407

# For convenience

3068

2408

debug = server_settings["debug"]

3069

2409

debuglevel = server_settings["debuglevel"]

3072

2412

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

3073

2413

stored_state_file)

3074

2414

foreground = server_settings["foreground"]

3075

zeroconf = server_settings["zeroconf"]

3076

2415

3077

2416

if debug:

3078

2417

initlogger(debug, logging.DEBUG)

3079

2418

else:

3082

2421

else:

3083

2422

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

3084

2423

initlogger(debug, level)

3085

2424

3086

2425

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

3087

syslogger.setFormatter(

3088

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

3089

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

3090

server_settings["servicename"])))

3091

2426

syslogger.setFormatter(logging.Formatter

2427

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

2428

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

2429

.format(server_settings

2430

["servicename"])))

2431

3092

2432

# Parse config file with clients

3093

client_config = configparser.ConfigParser(Client.client_defaults)

2433

client_config = configparser.SafeConfigParser(Client

2434

.client_defaults)

3094

2435

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

3095

2436

"clients.conf"))

3096

2437

3097

2438

global mandos_dbus_service

3098

2439

mandos_dbus_service = None

3099

3100

socketfd = None

3101

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

3102

socketfd = server_settings["socket"]

3103

tcp_server = MandosServer(

3104

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

3105

ClientHandler,

3106

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

3107

use_ipv6=use_ipv6,

3108

gnutls_priority=server_settings["priority"],

3109

use_dbus=use_dbus,

3110

socketfd=socketfd)

2440

2441

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

2442

server_settings["port"]),

2443

ClientHandler,

2444

interface=(server_settings["interface"]

2445

or None),

2446

use_ipv6=use_ipv6,

2447

gnutls_priority=

2448

server_settings["priority"],

2449

use_dbus=use_dbus,

2450

socketfd=(server_settings["socket"]

2451

or None))

3111

2452

if not foreground:

3112

2453

pidfilename = "/run/mandos.pid"

3113

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

3114

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

3115

2454

pidfile = None

3116

2455

try:

3117

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

2456

pidfile = open(pidfilename, "w")

3118

2457

except IOError as e:

3119

2458

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

3120

2459

exc_info=e)

3121

3122

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

3123

("mandos", "mandos"),

3124

("nobody", "nogroup")):

2460

2461

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

3125

2462

try:

3126

2463

uid = pwd.getpwnam(name).pw_uid

3127

gid = pwd.getpwnam(group).pw_gid

2464

gid = pwd.getpwnam(name).pw_gid

3128

2465

break

3129

2466

except KeyError:

3130

2467

continue

3134

2471

try:

3135

2472

os.setgid(gid)

3136

2473

os.setuid(uid)

3137

if debug:

3138

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

3139

gid))

3140

2474

except OSError as error:

3141

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

3142

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

3143

2475

if error.errno != errno.EPERM:

3144

raise

3145

2476

raise error

2477

3146

2478

if debug:

3147

2479

# Enable all possible GnuTLS debugging

3148

2480

3149

2481

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

3150

2482

# - GnuTLS manual

3151

gnutls.global_set_log_level(11)

3152

3153

@gnutls.log_func

2483

gnutls.library.functions.gnutls_global_set_log_level(11)

2484

2485

@gnutls.library.types.gnutls_log_func

3154

2486

def debug_gnutls(level, string):

3155

2487

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

3156

3157

gnutls.global_set_log_function(debug_gnutls)

3158

2488

2489

(gnutls.library.functions

2490

.gnutls_global_set_log_function(debug_gnutls))

2491

3159

2492

# Redirect stdin so all checkers get /dev/null

3160

2493

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

3161

2494

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

3162

2495

if null > 2:

3163

2496

os.close(null)

3164

2497

3165

2498

# Need to fork before connecting to D-Bus

3166

2499

if not foreground:

3167

2500

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

3168

2501

daemon()

3169

3170

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

3171

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

3172

# need to inform GLib that threads will be used.

3173

GLib.threads_init()

3174

2502

2503

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

2504

# need to inform gobject that threads will be used.

2505

gobject.threads_init()

2506

3175

2507

global main_loop

3176

2508

# From the Avahi example code

3177

2509

DBusGMainLoop(set_as_default=True)

3178

main_loop = GLib.MainLoop()

2510

main_loop = gobject.MainLoop()

3179

2511

bus = dbus.SystemBus()

3180

2512

# End of Avahi example code

3181

2513

if use_dbus:

3182

2514

try:

3183

2515

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

3184

bus,

3185

do_not_queue=True)

3186

old_bus_name = dbus.service.BusName(

3187

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

3188

do_not_queue=True)

3189

except dbus.exceptions.DBusException as e:

2516

bus, do_not_queue=True)

2517

old_bus_name = (dbus.service.BusName

2518

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

2519

do_not_queue=True))

2520

except dbus.exceptions.NameExistsException as e:

3190

2521

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

3191

2522

use_dbus = False

3192

2523

server_settings["use_dbus"] = False

3193

2524

tcp_server.use_dbus = False

3194

if zeroconf:

3195

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3196

service = AvahiServiceToSyslog(

3197

name=server_settings["servicename"],

3198

servicetype="_mandos._tcp",

3199

protocol=protocol,

3200

bus=bus)

3201

if server_settings["interface"]:

3202

service.interface = if_nametoindex(

3203

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

3204

2525

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2526

service = AvahiServiceToSyslog(name =

2527

server_settings["servicename"],

2528

servicetype = "_mandos._tcp",

2529

protocol = protocol, bus = bus)

2530

if server_settings["interface"]:

2531

service.interface = (if_nametoindex

2532

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

2533

3205

2534

global multiprocessing_manager

3206

2535

multiprocessing_manager = multiprocessing.Manager()

3207

2536

3208

2537

client_class = Client

3209

2538

if use_dbus:

3210

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

3211

2539

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

2540

3212

2541

client_settings = Client.config_parser(client_config)

3213

2542

old_client_settings = {}

3214

2543

clients_data = {}

3215

2544

3216

2545

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

3217

2546

global wnull

3218

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

2547

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

3219

2548

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

3220

2549

# mode

3221

2550

if debug or not foreground:

3222

2551

wnull.close()

3223

2552

3224

2553

# Get client data and settings from last running state.

3225

2554

if server_settings["restore"]:

3226

2555

try:

3227

2556

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

3228

if sys.version_info.major == 2:

3229

clients_data, old_client_settings = pickle.load(

3230

stored_state)

3231

else:

3232

bytes_clients_data, bytes_old_client_settings = (

3233

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

3234

# Fix bytes to strings

3235

# clients_data

3236

# .keys()

3237

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

3238

if isinstance(key, bytes)

3239

else key): value

3240

for key, value in

3241

bytes_clients_data.items()}

3242

del bytes_clients_data

3243

for key in clients_data:

3244

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

3245

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

3246

for k, v in

3247

clients_data[key].items()}

3248

clients_data[key] = value

3249

# .client_structure

3250

value["client_structure"] = [

3251

(s.decode("utf-8")

3252

if isinstance(s, bytes)

3253

else s) for s in

3254

value["client_structure"]]

3255

# .name, .host, and .checker_command

3256

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

3257

if isinstance(value[k], bytes):

3258

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

3259

if "key_id" not in value:

3260

value["key_id"] = ""

3261

elif "fingerprint" not in value:

3262

value["fingerprint"] = ""

3263

# old_client_settings

3264

# .keys()

3265

old_client_settings = {

3266

(key.decode("utf-8")

3267

if isinstance(key, bytes)

3268

else key): value

3269

for key, value in

3270

bytes_old_client_settings.items()}

3271

del bytes_old_client_settings

3272

# .host and .checker_command

3273

for value in old_client_settings.values():

3274

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

3275

if isinstance(value[attribute], bytes):

3276

value[attribute] = (value[attribute]

3277

.decode("utf-8"))

2557

clients_data, old_client_settings = (pickle.load

2558

(stored_state))

3278

2559

os.remove(stored_state_path)

3279

2560

except IOError as e:

3280

2561

if e.errno == errno.ENOENT:

3281

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

3282

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

2562

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

2563

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

3283

2564

else:

3284

2565

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

3285

2566

exc_info=e)

3286

2567

raise

3287

2568

except EOFError as e:

3288

2569

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

3289

"EOFError:",

3290

exc_info=e)

3291

2570

"EOFError:", exc_info=e)

2571

3292

2572

with PGPEngine() as pgp:

3293

for client_name, client in clients_data.items():

2573

for client_name, client in clients_data.iteritems():

3294

2574

# Skip removed clients

3295

2575

if client_name not in client_settings:

3296

2576

continue

3297

2577

3298

2578

# Decide which value to use after restoring saved state.

3299

2579

# We have three different values: Old config file,

3300

2580

# new config file, and saved state.

3305

2585

# For each value in new config, check if it

3306

2586

# differs from the old config value (Except for

3307

2587

# the "secret" attribute)

3308

if (name != "secret"

3309

and (value !=

3310

old_client_settings[client_name][name])):

2588

if (name != "secret" and

2589

value != old_client_settings[client_name]

2590

[name]):

3311

2591

client[name] = value

3312

2592

except KeyError:

3313

2593

pass

3314

2594

3315

2595

# Clients who has passed its expire date can still be

3316

# enabled if its last checker was successful. A Client

2596

# enabled if its last checker was successful. Clients

3317

2597

# whose checker succeeded before we stored its state is

3318

2598

# assumed to have successfully run all checkers during

3319

2599

# downtime.

3321

2601

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

3322

2602

if not client["last_checked_ok"]:

3323

2603

logger.warning(

3324

"disabling client {} - Client never "

3325

"performed a successful checker".format(

3326

client_name))

2604

"disabling client {0} - Client never "

2605

"performed a successful checker"

2606

.format(client_name))

3327

2607

client["enabled"] = False

3328

2608

elif client["last_checker_status"] != 0:

3329

2609

logger.warning(

3330

"disabling client {} - Client last"

3331

" checker failed with error code"

3332

" {}".format(

3333

client_name,

3334

client["last_checker_status"]))

2610

"disabling client {0} - Client "

2611

"last checker failed with error code {1}"

2612

.format(client_name,

2613

client["last_checker_status"]))

3335

2614

client["enabled"] = False

3336

2615

else:

3337

client["expires"] = (

3338

datetime.datetime.utcnow()

3339

+ client["timeout"])

2616

client["expires"] = (datetime.datetime

2617

.utcnow()

2618

+ client["timeout"])

3340

2619

logger.debug("Last checker succeeded,"

3341

" keeping {} enabled".format(

3342

client_name))

2620

" keeping {0} enabled"

2621

.format(client_name))

3343

2622

try:

3344

client["secret"] = pgp.decrypt(

3345

client["encrypted_secret"],

3346

client_settings[client_name]["secret"])

2623

client["secret"] = (

2624

pgp.decrypt(client["encrypted_secret"],

2625

client_settings[client_name]

2626

["secret"]))

3347

2627

except PGPError:

3348

2628

# If decryption fails, we use secret from new settings

3349

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

3350

client_name))

3351

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

3352

["secret"])

3353

2629

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

2630

.format(client_name))

2631

client["secret"] = (

2632

client_settings[client_name]["secret"])

2633

3354

2634

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

3355

2635

for client_name in (set(old_client_settings)

3356

2636

- set(client_settings)):

3358

2638

for client_name in (set(client_settings)

3359

2639

- set(old_client_settings)):

3360

2640

clients_data[client_name] = client_settings[client_name]

3361

2641

3362

2642

# Create all client objects

3363

for client_name, client in clients_data.items():

2643

for client_name, client in clients_data.iteritems():

3364

2644

tcp_server.clients[client_name] = client_class(

3365

name=client_name,

3366

settings=client,

3367

server_settings=server_settings)

3368

2645

name = client_name, settings = client,

2646

server_settings = server_settings)

2647

3369

2648

if not tcp_server.clients:

3370

2649

logger.warning("No clients defined")

3371

2650

3372

2651

if not foreground:

3373

2652

if pidfile is not None:

3374

pid = os.getpid()

3375

2653

try:

3376

2654

with pidfile:

3377

print(pid, file=pidfile)

2655

pid = os.getpid()

2656

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

3378

2657

except IOError:

3379

2658

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

3380

2659

pidfilename, pid)

3381

2660

del pidfile

3382

2661

del pidfilename

3383

3384

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

3385

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3386

lambda: main_loop.quit() and False)

3387

2662

2663

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

2664

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

2665

3388

2666

if use_dbus:

3389

3390

@alternate_dbus_interfaces(

3391

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

3392

class MandosDBusService(DBusObjectWithObjectManager):

2667

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

2668

"se.bsnet.fukt.Mandos"})

2669

class MandosDBusService(DBusObjectWithProperties):

3393

2670

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

3394

3395

2671

def __init__(self):

3396

2672

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

3397

3398

2673

_interface = "se.recompile.Mandos"

3399

2674

2675

@dbus_interface_annotations(_interface)

2676

def _foo(self):

2677

return { "org.freedesktop.DBus.Property"

2678

".EmitsChangedSignal":

2679

"false"}

2680

3400

2681

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

3401

2682

def ClientAdded(self, objpath):

3402

2683

"D-Bus signal"

3403

2684

pass

3404

2685

3405

2686

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

3406

def ClientNotFound(self, key_id, address):

2687

def ClientNotFound(self, fingerprint, address):

3407

2688

"D-Bus signal"

3408

2689

pass

3409

3410

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

3411

"true"})

2690

3412

2691

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

3413

2692

def ClientRemoved(self, objpath, name):

3414

2693

"D-Bus signal"

3415

2694

pass

3416

3417

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

3418

"true"})

2695

3419

2696

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

3420

2697

def GetAllClients(self):

3421

2698

"D-Bus method"

3422

return dbus.Array(c.dbus_object_path for c in

3423

tcp_server.clients.values())

3424

3425

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

3426

"true"})

2699

return dbus.Array(c.dbus_object_path

2700

for c in

2701

tcp_server.clients.itervalues())

2702

3427

2703

@dbus.service.method(_interface,

3428

2704

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

3429

2705

def GetAllClientsWithProperties(self):

3430

2706

"D-Bus method"

3431

2707

return dbus.Dictionary(

3432

{c.dbus_object_path: c.GetAll(

3433

"se.recompile.Mandos.Client")

3434

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

2708

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

2709

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

3435

2710

signature="oa{sv}")

3436

2711

3437

2712

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

3438

2713

def RemoveClient(self, object_path):

3439

2714

"D-Bus method"

3440

for c in tcp_server.clients.values():

2715

for c in tcp_server.clients.itervalues():

3441

2716

if c.dbus_object_path == object_path:

3442

2717

del tcp_server.clients[c.name]

3443

2718

c.remove_from_connection()

3444

# Don't signal the disabling

2719

# Don't signal anything except ClientRemoved

3445

2720

c.disable(quiet=True)

3446

# Emit D-Bus signal for removal

3447

self.client_removed_signal(c)

2721

# Emit D-Bus signal

2722

self.ClientRemoved(object_path, c.name)

3448

2723

return

3449

2724

raise KeyError(object_path)

3450

2725

3451

2726

del _interface

3452

3453

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3454

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

3455

def GetManagedObjects(self):

3456

"""D-Bus method"""

3457

return dbus.Dictionary(

3458

{client.dbus_object_path:

3459

dbus.Dictionary(

3460

{interface: client.GetAll(interface)

3461

for interface in

3462

client._get_all_interface_names()})

3463

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

3464

3465

def client_added_signal(self, client):

3466

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

3467

if use_dbus:

3468

# New standard signal

3469

self.InterfacesAdded(

3470

client.dbus_object_path,

3471

dbus.Dictionary(

3472

{interface: client.GetAll(interface)

3473

for interface in

3474

client._get_all_interface_names()}))

3475

# Old signal

3476

self.ClientAdded(client.dbus_object_path)

3477

3478

def client_removed_signal(self, client):

3479

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

3480

if use_dbus:

3481

# New standard signal

3482

self.InterfacesRemoved(

3483

client.dbus_object_path,

3484

client._get_all_interface_names())

3485

# Old signal

3486

self.ClientRemoved(client.dbus_object_path,

3487

client.name)

3488

2727

3489

2728

mandos_dbus_service = MandosDBusService()

3490

3491

# Save modules to variables to exempt the modules from being

3492

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

3493

mp = multiprocessing

3494

wn = wnull

3495

2729

3496

2730

def cleanup():

3497

2731

"Cleanup function; run on exit"

3498

if zeroconf:

3499

service.cleanup()

3500

3501

mp.active_children()

3502

wn.close()

2732

service.cleanup()

2733

2734

multiprocessing.active_children()

2735

wnull.close()

3503

2736

if not (tcp_server.clients or client_settings):

3504

2737

return

3505

2738

3506

2739

# Store client before exiting. Secrets are encrypted with key

3507

2740

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

3508

2741

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

3509

2742

clients = {}

3510

2743

with PGPEngine() as pgp:

3511

for client in tcp_server.clients.values():

2744

for client in tcp_server.clients.itervalues():

3512

2745

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

3513

2746

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

3514

2747

key)

3515

2748

client_dict = {}

3516

2749

3517

2750

# A list of attributes that can not be pickled

3518

2751

# + secret.

3519

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

3520

"checker", "server_settings"}

3521

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

3522

.Object):

2752

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

2753

"checker", "server_settings"))

2754

for name, typ in (inspect.getmembers

2755

(dbus.service.Object)):

3523

2756

exclude.add(name)

3524

2757

3525

2758

client_dict["encrypted_secret"] = (client

3526

2759

.encrypted_secret)

3527

2760

for attr in client.client_structure:

3528

2761

if attr not in exclude:

3529

2762

client_dict[attr] = getattr(client, attr)

3530

2763

3531

2764

clients[client.name] = client_dict

3532

2765

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

3533

2766

3534

2767

try:

3535

with tempfile.NamedTemporaryFile(

3536

mode='wb',

3537

suffix=".pickle",

3538

prefix='clients-',

3539

dir=os.path.dirname(stored_state_path),

3540

delete=False) as stored_state:

3541

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

3542

protocol=2)

3543

tempname = stored_state.name

2768

with (tempfile.NamedTemporaryFile

2769

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

2770

dir=os.path.dirname(stored_state_path),

2771

delete=False)) as stored_state:

2772

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

2773

tempname=stored_state.name

3544

2774

os.rename(tempname, stored_state_path)

3545

2775

except (IOError, OSError) as e:

3546

2776

if not debug:

3549

2779

except NameError:

3550

2780

pass

3551

2781

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

3552

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

2782

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

3553

2783

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

3554

2784

else:

3555

2785

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

3556

2786

exc_info=e)

3557

raise

3558

2787

raise e

2788

3559

2789

# Delete all clients, and settings from config

3560

2790

while tcp_server.clients:

3561

2791

name, client = tcp_server.clients.popitem()

3562

2792

if use_dbus:

3563

2793

client.remove_from_connection()

3564

# Don't signal the disabling

2794

# Don't signal anything except ClientRemoved

3565

2795

client.disable(quiet=True)

3566

# Emit D-Bus signal for removal

3567

2796

if use_dbus:

3568

mandos_dbus_service.client_removed_signal(client)

2797

# Emit D-Bus signal

2798

mandos_dbus_service.ClientRemoved(client

2799

.dbus_object_path,

2800

client.name)

3569

2801

client_settings.clear()

3570

2802

3571

2803

atexit.register(cleanup)

3572

3573

for client in tcp_server.clients.values():

2804

2805

for client in tcp_server.clients.itervalues():

3574

2806

if use_dbus:

3575

# Emit D-Bus signal for adding

3576

mandos_dbus_service.client_added_signal(client)

2807

# Emit D-Bus signal

2808

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3577

2809

# Need to initiate checking of clients

3578

2810

if client.enabled:

3579

2811

client.init_checker()

3580

2812

3581

2813

tcp_server.enable()

3582

2814

tcp_server.server_activate()

3583

2815

3584

2816

# Find out what port we got

3585

if zeroconf:

3586

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

2817

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

3587

2818

if use_ipv6:

3588

2819

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

3589

2820

" flowinfo %d, scope_id %d",

3591

2822

else: # IPv4

3592

2823

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

3593

2824

*tcp_server.socket.getsockname())

3594

3595

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

3596

2825

2826

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

2827

3597

2828

try:

3598

if zeroconf:

3599

# From the Avahi example code

3600

try:

3601

service.activate()

3602

except dbus.exceptions.DBusException as error:

3603

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

3604

cleanup()

3605

sys.exit(1)

3606

# End of Avahi example code

3607

3608

GLib.io_add_watch(

3609

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

3610

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3611

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

3612

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

3613

2829

# From the Avahi example code

2830

try:

2831

service.activate()

2832

except dbus.exceptions.DBusException as error:

2833

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

2834

cleanup()

2835

sys.exit(1)

2836

# End of Avahi example code

2837

2838

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

2839

lambda *args, **kwargs:

2840

(tcp_server.handle_request

2841

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

2842

3614

2843

logger.debug("Starting main loop")

3615

2844

main_loop.run()

3616

2845

except AvahiError as error:

3625

2854

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

3626

2855

cleanup()

3627

2856

3628

3629

def should_only_run_tests():

3630

parser = argparse.ArgumentParser(add_help=False)

3631

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

3632

args, unknown_args = parser.parse_known_args()

3633

run_tests = args.check

3634

if run_tests:

3635

# Remove --check argument from sys.argv

3636

sys.argv[1:] = unknown_args

3637

return run_tests

3638

3639

# Add all tests from doctest strings

3640

def load_tests(loader, tests, none):

3641

import doctest

3642

tests.addTests(doctest.DocTestSuite())

3643

return tests

3644

3645

2857

if __name__ == '__main__':

3646

try:

3647

if should_only_run_tests():

3648

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

3649

unittest.main()

3650

else:

3651

main()

3652

finally:

3653

logging.shutdown()

2858

main()