/mandos/trunk : revision 654

1

#!/usr/bin/python3 -bI

2

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

3

#

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

import random

82

72

83

73

import dbus

84

74

import dbus.service

85

import gi

86

from gi.repository import GLib

75

import gobject

76

import avahi

87

77

from dbus.mainloop.glib import DBusGMainLoop

88

78

import ctypes

89

79

import ctypes.util

90

80

import xml.dom.minidom

91

81

import inspect

92

82

93

if sys.version_info.major == 2:

94

__metaclass__ = type

95

str = unicode

96

97

# Show warnings by default

98

if not sys.warnoptions:

99

import warnings

100

warnings.simplefilter("default")

101

102

# Try to find the value of SO_BINDTODEVICE:

103

83

try:

104

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

105

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

106

84

SO_BINDTODEVICE = socket.SO_BINDTODEVICE

107

85

except AttributeError:

108

86

try:

109

# This is where SO_BINDTODEVICE was up to and including Python

110

# 2.6, and also 3.2:

111

87

from IN import SO_BINDTODEVICE

112

88

except ImportError:

113

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

114

# Try running the C preprocessor:

115

try:

116

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

117

"/dev/stdin"],

118

stdin=subprocess.PIPE,

119

stdout=subprocess.PIPE)

120

stdout = cc.communicate(

121

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

122

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

123

except (OSError, ValueError, IndexError):

124

# No value found

125

SO_BINDTODEVICE = None

126

127

if sys.version_info < (3, 2):

128

configparser.Configparser = configparser.SafeConfigParser

129

130

version = "1.8.9"

89

SO_BINDTODEVICE = None

90

91

version = "1.6.3"

131

92

stored_state_file = "clients.pickle"

132

93

133

94

logger = logging.getLogger()

134

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

135

syslogger = None

95

syslogger = (logging.handlers.SysLogHandler

96

(facility = logging.handlers.SysLogHandler.LOG_DAEMON,

97

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

136

98

137

99

try:

138

if_nametoindex = ctypes.cdll.LoadLibrary(

139

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

100

if_nametoindex = (ctypes.cdll.LoadLibrary

101

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

102

.if_nametoindex)

140

103

except (OSError, AttributeError):

141

142

104

def if_nametoindex(interface):

143

105

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

144

106

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

145

107

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

146

108

ifreq = fcntl.ioctl(s, SIOCGIFINDEX,

147

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

148

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]

149

113

return interface_index

150

114

151

115

152

def copy_function(func):

153

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

154

if sys.version_info.major == 2:

155

return types.FunctionType(func.func_code,

156

func.func_globals,

157

func.func_name,

158

func.func_defaults,

159

func.func_closure)

160

else:

161

return types.FunctionType(func.__code__,

162

func.__globals__,

163

func.__name__,

164

func.__defaults__,

165

func.__closure__)

166

167

168

116

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

169

117

"""init logger and add loglevel"""

170

171

global syslogger

172

syslogger = (logging.handlers.SysLogHandler(

173

facility=logging.handlers.SysLogHandler.LOG_DAEMON,

174

address="/dev/log"))

118

175

119

syslogger.setFormatter(logging.Formatter

176

120

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

177

121

' %(message)s'))

178

122

logger.addHandler(syslogger)

179

123

180

124

if debug:

181

125

console = logging.StreamHandler()

182

126

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

192

136

pass

193

137

194

138

195

class PGPEngine:

139

class PGPEngine(object):

196

140

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

197

198

141

def __init__(self):

199

142

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

200

self.gpg = "gpg"

201

try:

202

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

203

for line in output.splitlines():

204

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

205

if name == b"gpg":

206

self.gpg = path

207

break

208

except OSError as e:

209

if e.errno != errno.ENOENT:

210

raise

211

143

self.gnupgargs = ['--batch',

212

'--homedir', self.tempdir,

144

'--home', self.tempdir,

213

145

'--force-mdc',

214

'--quiet']

215

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

216

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

217

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

218

146

'--quiet',

147

'--no-use-agent']

148

219

149

def __enter__(self):

220

150

return self

221

151

222

152

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

223

153

self._cleanup()

224

154

return False

225

155

226

156

def __del__(self):

227

157

self._cleanup()

228

158

229

159

def _cleanup(self):

230

160

if self.tempdir is not None:

231

161

# Delete contents of tempdir

232

162

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

233

topdown=False):

163

topdown = False):

234

164

for filename in files:

235

165

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

236

166

for dirname in dirs:

238

168

# Remove tempdir

239

169

os.rmdir(self.tempdir)

240

170

self.tempdir = None

241

171

242

172

def password_encode(self, password):

243

173

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

244

174

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

249

179

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

250

180

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

251

181

return encoded

252

182

253

183

def encrypt(self, data, password):

254

184

passphrase = self.password_encode(password)

255

with tempfile.NamedTemporaryFile(

256

dir=self.tempdir) as passfile:

185

with tempfile.NamedTemporaryFile(dir=self.tempdir

186

) as passfile:

257

187

passfile.write(passphrase)

258

188

passfile.flush()

259

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

189

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

260

190

'--passphrase-file',

261

191

passfile.name]

262

192

+ self.gnupgargs,

263

stdin=subprocess.PIPE,

264

stdout=subprocess.PIPE,

265

stderr=subprocess.PIPE)

266

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

193

stdin = subprocess.PIPE,

194

stdout = subprocess.PIPE,

195

stderr = subprocess.PIPE)

196

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

267

197

if proc.returncode != 0:

268

198

raise PGPError(err)

269

199

return ciphertext

270

200

271

201

def decrypt(self, data, password):

272

202

passphrase = self.password_encode(password)

273

with tempfile.NamedTemporaryFile(

274

dir=self.tempdir) as passfile:

203

with tempfile.NamedTemporaryFile(dir = self.tempdir

204

) as passfile:

275

205

passfile.write(passphrase)

276

206

passfile.flush()

277

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

207

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

278

208

'--passphrase-file',

279

209

passfile.name]

280

210

+ self.gnupgargs,

281

stdin=subprocess.PIPE,

282

stdout=subprocess.PIPE,

283

stderr=subprocess.PIPE)

284

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

211

stdin = subprocess.PIPE,

212

stdout = subprocess.PIPE,

213

stderr = subprocess.PIPE)

214

decrypted_plaintext, err = proc.communicate(input

215

= data)

285

216

if proc.returncode != 0:

286

217

raise PGPError(err)

287

218

return decrypted_plaintext

288

219

289

220

290

# Pretend that we have an Avahi module

291

class avahi:

292

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

293

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

294

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

295

PROTO_INET = 0 # avahi-common/address.h

296

PROTO_INET6 = 1 # avahi-common/address.h

297

DBUS_NAME = "org.freedesktop.Avahi"

298

DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"

299

DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"

300

DBUS_PATH_SERVER = "/"

301

302

@staticmethod

303

def string_array_to_txt_array(t):

304

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

305

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

306

ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h

307

ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h

308

ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h

309

SERVER_INVALID = 0 # avahi-common/defs.h

310

SERVER_REGISTERING = 1 # avahi-common/defs.h

311

SERVER_RUNNING = 2 # avahi-common/defs.h

312

SERVER_COLLISION = 3 # avahi-common/defs.h

313

SERVER_FAILURE = 4 # avahi-common/defs.h

314

315

316

221

class AvahiError(Exception):

317

222

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

318

223

self.value = value

319

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

320

**kwargs)

321

224

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

225

def __unicode__(self):

226

return unicode(repr(self.value))

322

227

323

228

class AvahiServiceError(AvahiError):

324

229

pass

325

230

326

327

231

class AvahiGroupError(AvahiError):

328

232

pass

329

233

330

234

331

class AvahiService:

235

class AvahiService(object):

332

236

"""An Avahi (Zeroconf) service.

333

237

334

238

Attributes:

335

239

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

336

240

Used to optionally bind to the specified interface.

348

252

server: D-Bus Server

349

253

bus: dbus.SystemBus()

350

254

"""

351

352

def __init__(self,

353

interface=avahi.IF_UNSPEC,

354

name=None,

355

servicetype=None,

356

port=None,

357

TXT=None,

358

domain="",

359

host="",

360

max_renames=32768,

361

protocol=avahi.PROTO_UNSPEC,

362

bus=None):

255

256

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

257

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

258

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

259

protocol = avahi.PROTO_UNSPEC, bus = None):

363

260

self.interface = interface

364

261

self.name = name

365

262

self.type = servicetype

374

271

self.server = None

375

272

self.bus = bus

376

273

self.entry_group_state_changed_match = None

377

378

def rename(self, remove=True):

274

275

def rename(self):

379

276

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

380

277

if self.rename_count >= self.max_renames:

381

278

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

382

279

" after %i retries, exiting.",

383

280

self.rename_count)

384

281

raise AvahiServiceError("Too many renames")

385

self.name = str(

386

self.server.GetAlternativeServiceName(self.name))

387

self.rename_count += 1

282

self.name = unicode(self.server

283

.GetAlternativeServiceName(self.name))

388

284

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

389

285

self.name)

390

if remove:

391

self.remove()

286

self.remove()

392

287

try:

393

288

self.add()

394

289

except dbus.exceptions.DBusException as error:

395

if (error.get_dbus_name()

396

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

397

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

398

return self.rename(remove=False)

399

else:

400

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

401

self.cleanup()

402

os._exit(1)

403

290

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

291

self.cleanup()

292

os._exit(1)

293

self.rename_count += 1

294

404

295

def remove(self):

405

296

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

406

297

if self.entry_group_state_changed_match is not None:

408

299

self.entry_group_state_changed_match = None

409

300

if self.group is not None:

410

301

self.group.Reset()

411

302

412

303

def add(self):

413

304

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

414

305

self.remove()

431

322

dbus.UInt16(self.port),

432

323

avahi.string_array_to_txt_array(self.TXT))

433

324

self.group.Commit()

434

325

435

326

def entry_group_state_changed(self, state, error):

436

327

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

437

328

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

438

329

439

330

if state == avahi.ENTRY_GROUP_ESTABLISHED:

440

331

logger.debug("Zeroconf service established.")

441

332

elif state == avahi.ENTRY_GROUP_COLLISION:

443

334

self.rename()

444

335

elif state == avahi.ENTRY_GROUP_FAILURE:

445

336

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

446

str(error))

447

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

448

337

unicode(error))

338

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

339

.format(error))

340

449

341

def cleanup(self):

450

342

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

451

343

if self.group is not None:

456

348

pass

457

349

self.group = None

458

350

self.remove()

459

351

460

352

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

461

353

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

462

354

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

463

bad_states = {

464

avahi.SERVER_INVALID: "Zeroconf server invalid",

465

avahi.SERVER_REGISTERING: None,

466

avahi.SERVER_COLLISION: "Zeroconf server name collision",

467

avahi.SERVER_FAILURE: "Zeroconf server failure",

468

}

355

bad_states = { avahi.SERVER_INVALID:

356

"Zeroconf server invalid",

357

avahi.SERVER_REGISTERING: None,

358

avahi.SERVER_COLLISION:

359

"Zeroconf server name collision",

360

avahi.SERVER_FAILURE:

361

"Zeroconf server failure" }

469

362

if state in bad_states:

470

363

if bad_states[state] is not None:

471

364

if error is None:

474

367

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

475

368

self.cleanup()

476

369

elif state == avahi.SERVER_RUNNING:

477

try:

478

self.add()

479

except dbus.exceptions.DBusException as error:

480

if (error.get_dbus_name()

481

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

482

logger.info("Local Zeroconf service name"

483

" collision.")

484

return self.rename(remove=False)

485

else:

486

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

487

self.cleanup()

488

os._exit(1)

370

self.add()

489

371

else:

490

372

if error is None:

491

373

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

492

374

else:

493

375

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

494

376

495

377

def activate(self):

496

378

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

497

379

if self.server is None:

501

383

follow_name_owner_changes=True),

502

384

avahi.DBUS_INTERFACE_SERVER)

503

385

self.server.connect_to_signal("StateChanged",

504

self.server_state_changed)

386

self.server_state_changed)

505

387

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

506

388

507

389

508

390

class AvahiServiceToSyslog(AvahiService):

509

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

391

def rename(self):

510

392

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

511

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

512

syslogger.setFormatter(logging.Formatter(

513

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

514

.format(self.name)))

393

ret = AvahiService.rename(self)

394

syslogger.setFormatter(logging.Formatter

395

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

396

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

397

.format(self.name)))

515

398

return ret

516

399

517

400

518

# Pretend that we have a GnuTLS module

519

class gnutls:

520

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

521

522

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

523

if library is None:

524

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

525

_library = ctypes.cdll.LoadLibrary(library)

526

del library

527

528

# Unless otherwise indicated, the constants and types below are

529

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

530

531

# Constants

532

E_SUCCESS = 0

533

E_INTERRUPTED = -52

534

E_AGAIN = -28

535

CRT_OPENPGP = 2

536

CRT_RAWPK = 3

537

CLIENT = 2

538

SHUT_RDWR = 0

539

CRD_CERTIFICATE = 1

540

E_NO_CERTIFICATE_FOUND = -49

541

X509_FMT_DER = 0

542

NO_TICKETS = 1<<10

543

ENABLE_RAWPK = 1<<18

544

CTYPE_PEERS = 3

545

KEYID_USE_SHA256 = 1 # gnutls/x509.h

546

OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h

547

548

# Types

549

class session_int(ctypes.Structure):

550

_fields_ = []

551

session_t = ctypes.POINTER(session_int)

552

553

class certificate_credentials_st(ctypes.Structure):

554

_fields_ = []

555

certificate_credentials_t = ctypes.POINTER(

556

certificate_credentials_st)

557

certificate_type_t = ctypes.c_int

558

559

class datum_t(ctypes.Structure):

560

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

561

('size', ctypes.c_uint)]

562

563

class openpgp_crt_int(ctypes.Structure):

564

_fields_ = []

565

openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)

566

openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h

567

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

568

credentials_type_t = ctypes.c_int

569

transport_ptr_t = ctypes.c_void_p

570

close_request_t = ctypes.c_int

571

572

# Exceptions

573

class Error(Exception):

574

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

575

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

576

# code is passed, convert it to a string with

577

# gnutls.strerror()

578

self.code = code

579

if message is None and code is not None:

580

message = gnutls.strerror(code)

581

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

582

message, *args)

583

584

class CertificateSecurityError(Error):

585

pass

586

587

# Classes

588

class Credentials:

589

def __init__(self):

590

self._c_object = gnutls.certificate_credentials_t()

591

gnutls.certificate_allocate_credentials(

592

ctypes.byref(self._c_object))

593

self.type = gnutls.CRD_CERTIFICATE

594

595

def __del__(self):

596

gnutls.certificate_free_credentials(self._c_object)

597

598

class ClientSession:

599

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

600

self._c_object = gnutls.session_t()

601

gnutls_flags = gnutls.CLIENT

602

if gnutls.check_version(b"3.5.6"):

603

gnutls_flags |= gnutls.NO_TICKETS

604

if gnutls.has_rawpk:

605

gnutls_flags |= gnutls.ENABLE_RAWPK

606

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

607

del gnutls_flags

608

gnutls.set_default_priority(self._c_object)

609

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

610

gnutls.handshake_set_private_extensions(self._c_object,

611

True)

612

self.socket = socket

613

if credentials is None:

614

credentials = gnutls.Credentials()

615

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

616

ctypes.cast(credentials._c_object,

617

ctypes.c_void_p))

618

self.credentials = credentials

619

620

def __del__(self):

621

gnutls.deinit(self._c_object)

622

623

def handshake(self):

624

return gnutls.handshake(self._c_object)

625

626

def send(self, data):

627

data = bytes(data)

628

data_len = len(data)

629

while data_len > 0:

630

data_len -= gnutls.record_send(self._c_object,

631

data[-data_len:],

632

data_len)

633

634

def bye(self):

635

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

636

637

# Error handling functions

638

def _error_code(result):

639

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

640

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

641

if result >= 0:

642

return result

643

if result == gnutls.E_NO_CERTIFICATE_FOUND:

644

raise gnutls.CertificateSecurityError(code=result)

645

raise gnutls.Error(code=result)

646

647

def _retry_on_error(result, func, arguments):

648

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

649

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

650

while result < 0:

651

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

652

return _error_code(result)

653

result = func(*arguments)

654

return result

655

656

# Unless otherwise indicated, the function declarations below are

657

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

658

659

# Functions

660

priority_set_direct = _library.gnutls_priority_set_direct

661

priority_set_direct.argtypes = [session_t, ctypes.c_char_p,

662

ctypes.POINTER(ctypes.c_char_p)]

663

priority_set_direct.restype = _error_code

664

665

init = _library.gnutls_init

666

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

667

init.restype = _error_code

668

669

set_default_priority = _library.gnutls_set_default_priority

670

set_default_priority.argtypes = [session_t]

671

set_default_priority.restype = _error_code

672

673

record_send = _library.gnutls_record_send

674

record_send.argtypes = [session_t, ctypes.c_void_p,

675

ctypes.c_size_t]

676

record_send.restype = ctypes.c_ssize_t

677

record_send.errcheck = _retry_on_error

678

679

certificate_allocate_credentials = (

680

_library.gnutls_certificate_allocate_credentials)

681

certificate_allocate_credentials.argtypes = [

682

ctypes.POINTER(certificate_credentials_t)]

683

certificate_allocate_credentials.restype = _error_code

684

685

certificate_free_credentials = (

686

_library.gnutls_certificate_free_credentials)

687

certificate_free_credentials.argtypes = [

688

certificate_credentials_t]

689

certificate_free_credentials.restype = None

690

691

handshake_set_private_extensions = (

692

_library.gnutls_handshake_set_private_extensions)

693

handshake_set_private_extensions.argtypes = [session_t,

694

ctypes.c_int]

695

handshake_set_private_extensions.restype = None

696

697

credentials_set = _library.gnutls_credentials_set

698

credentials_set.argtypes = [session_t, credentials_type_t,

699

ctypes.c_void_p]

700

credentials_set.restype = _error_code

701

702

strerror = _library.gnutls_strerror

703

strerror.argtypes = [ctypes.c_int]

704

strerror.restype = ctypes.c_char_p

705

706

certificate_type_get = _library.gnutls_certificate_type_get

707

certificate_type_get.argtypes = [session_t]

708

certificate_type_get.restype = _error_code

709

710

certificate_get_peers = _library.gnutls_certificate_get_peers

711

certificate_get_peers.argtypes = [session_t,

712

ctypes.POINTER(ctypes.c_uint)]

713

certificate_get_peers.restype = ctypes.POINTER(datum_t)

714

715

global_set_log_level = _library.gnutls_global_set_log_level

716

global_set_log_level.argtypes = [ctypes.c_int]

717

global_set_log_level.restype = None

718

719

global_set_log_function = _library.gnutls_global_set_log_function

720

global_set_log_function.argtypes = [log_func]

721

global_set_log_function.restype = None

722

723

deinit = _library.gnutls_deinit

724

deinit.argtypes = [session_t]

725

deinit.restype = None

726

727

handshake = _library.gnutls_handshake

728

handshake.argtypes = [session_t]

729

handshake.restype = _error_code

730

handshake.errcheck = _retry_on_error

731

732

transport_set_ptr = _library.gnutls_transport_set_ptr

733

transport_set_ptr.argtypes = [session_t, transport_ptr_t]

734

transport_set_ptr.restype = None

735

736

bye = _library.gnutls_bye

737

bye.argtypes = [session_t, close_request_t]

738

bye.restype = _error_code

739

bye.errcheck = _retry_on_error

740

741

check_version = _library.gnutls_check_version

742

check_version.argtypes = [ctypes.c_char_p]

743

check_version.restype = ctypes.c_char_p

744

745

_need_version = b"3.3.0"

746

if check_version(_need_version) is None:

747

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

748

.format(_need_version))

749

750

_tls_rawpk_version = b"3.6.6"

751

has_rawpk = bool(check_version(_tls_rawpk_version))

752

753

if has_rawpk:

754

# Types

755

class pubkey_st(ctypes.Structure):

756

_fields = []

757

pubkey_t = ctypes.POINTER(pubkey_st)

758

759

x509_crt_fmt_t = ctypes.c_int

760

761

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

762

pubkey_init = _library.gnutls_pubkey_init

763

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

764

pubkey_init.restype = _error_code

765

766

pubkey_import = _library.gnutls_pubkey_import

767

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

768

x509_crt_fmt_t]

769

pubkey_import.restype = _error_code

770

771

pubkey_get_key_id = _library.gnutls_pubkey_get_key_id

772

pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,

773

ctypes.POINTER(ctypes.c_ubyte),

774

ctypes.POINTER(ctypes.c_size_t)]

775

pubkey_get_key_id.restype = _error_code

776

777

pubkey_deinit = _library.gnutls_pubkey_deinit

778

pubkey_deinit.argtypes = [pubkey_t]

779

pubkey_deinit.restype = None

780

else:

781

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

782

783

openpgp_crt_init = _library.gnutls_openpgp_crt_init

784

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

785

openpgp_crt_init.restype = _error_code

786

787

openpgp_crt_import = _library.gnutls_openpgp_crt_import

788

openpgp_crt_import.argtypes = [openpgp_crt_t,

789

ctypes.POINTER(datum_t),

790

openpgp_crt_fmt_t]

791

openpgp_crt_import.restype = _error_code

792

793

openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self

794

openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,

795

ctypes.POINTER(ctypes.c_uint)]

796

openpgp_crt_verify_self.restype = _error_code

797

798

openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit

799

openpgp_crt_deinit.argtypes = [openpgp_crt_t]

800

openpgp_crt_deinit.restype = None

801

802

openpgp_crt_get_fingerprint = (

803

_library.gnutls_openpgp_crt_get_fingerprint)

804

openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,

805

ctypes.c_void_p,

806

ctypes.POINTER(

807

ctypes.c_size_t)]

808

openpgp_crt_get_fingerprint.restype = _error_code

809

810

if check_version(b"3.6.4"):

811

certificate_type_get2 = _library.gnutls_certificate_type_get2

812

certificate_type_get2.argtypes = [session_t, ctypes.c_int]

813

certificate_type_get2.restype = _error_code

814

815

# Remove non-public functions

816

del _error_code, _retry_on_error

817

818

819

def call_pipe(connection, # : multiprocessing.Connection

820

func, *args, **kwargs):

821

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

822

823

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

824

return value on the provided multiprocessing.Connection.

825

"""

826

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

827

connection.close()

828

829

830

class Client:

401

def timedelta_to_milliseconds(td):

402

"Convert a datetime.timedelta() to milliseconds"

403

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

404

+ (td.seconds * 1000)

405

+ (td.microseconds // 1000))

406

407

408

class Client(object):

831

409

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

832

410

833

411

Attributes:

834

412

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

835

413

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

836

414

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

837

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

838

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

839

running.

840

checker_callback_tag: a GLib event source tag, or None

415

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

416

to see if the client lives.

417

'None' if no process is running.

418

checker_callback_tag: a gobject event source tag, or None

841

419

checker_command: string; External command which is run to check

842

420

if client lives. %() expansions are done at

843

421

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

844

422

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

845

checker_initiator_tag: a GLib event source tag, or None

423

checker_initiator_tag: a gobject event source tag, or None

846

424

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

847

425

client_structure: Object describing what attributes a client has

848

426

and is used for storing the client at exit

849

427

current_checker_command: string; current running checker_command

850

disable_initiator_tag: a GLib event source tag, or None

428

disable_initiator_tag: a gobject event source tag, or None

851

429

enabled: bool()

852

430

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

853

uniquely identify an OpenPGP client

854

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

855

a client using raw public keys

431

uniquely identify the client

856

432

host: string; available for use by the checker command

857

433

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

858

434

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

860

436

last_checker_status: integer between 0 and 255 reflecting exit

861

437

status of last checker. -1 reflects crashed

862

438

checker, -2 means no checker completed yet.

863

last_checker_signal: The signal which killed the last checker, if

864

last_checker_status is -1

865

439

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

866

440

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

867

441

D-Bus identifiers

874

448

disabled, or None

875

449

server_settings: The server_settings dict from main()

876

450

"""

877

451

878

452

runtime_expansions = ("approval_delay", "approval_duration",

879

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

453

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

880

454

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

881

455

"last_approval_request", "last_checked_ok",

882

456

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

883

client_defaults = {

884

"timeout": "PT5M",

885

"extended_timeout": "PT15M",

886

"interval": "PT2M",

887

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

888

"host": "",

889

"approval_delay": "PT0S",

890

"approval_duration": "PT1S",

891

"approved_by_default": "True",

892

"enabled": "True",

893

}

894

457

client_defaults = { "timeout": "PT5M",

458

"extended_timeout": "PT15M",

459

"interval": "PT2M",

460

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

461

"host": "",

462

"approval_delay": "PT0S",

463

"approval_duration": "PT1S",

464

"approved_by_default": "True",

465

"enabled": "True",

466

}

467

468

def timeout_milliseconds(self):

469

"Return the 'timeout' attribute in milliseconds"

470

return timedelta_to_milliseconds(self.timeout)

471

472

def extended_timeout_milliseconds(self):

473

"Return the 'extended_timeout' attribute in milliseconds"

474

return timedelta_to_milliseconds(self.extended_timeout)

475

476

def interval_milliseconds(self):

477

"Return the 'interval' attribute in milliseconds"

478

return timedelta_to_milliseconds(self.interval)

479

480

def approval_delay_milliseconds(self):

481

return timedelta_to_milliseconds(self.approval_delay)

482

895

483

@staticmethod

896

484

def config_parser(config):

897

485

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

904

492

for client_name in config.sections():

905

493

section = dict(config.items(client_name))

906

494

client = settings[client_name] = {}

907

495

908

496

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

909

497

# Reformat values from string types to Python types

910

498

client["approved_by_default"] = config.getboolean(

911

499

client_name, "approved_by_default")

912

500

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

913

501

"enabled")

914

915

# Uppercase and remove spaces from key_id and fingerprint

916

# for later comparison purposes with return value from the

917

# key_id() and fingerprint() functions

918

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

919

.replace(" ", ""))

502

920

503

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

921

504

.replace(" ", ""))

922

505

if "secret" in section:

923

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

924

.encode("utf-8"),

925

"base64")

506

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

926

507

elif "secfile" in section:

927

508

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

928

509

(section["secfile"])),

929

510

"rb") as secfile:

930

511

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

931

512

else:

932

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

513

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

933

514

.format(section))

934

515

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

935

516

client["extended_timeout"] = string_to_delta(

943

524

client["last_approval_request"] = None

944

525

client["last_checked_ok"] = None

945

526

client["last_checker_status"] = -2

946

527

947

528

return settings

948

949

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

529

530

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

950

531

self.name = name

951

532

if server_settings is None:

952

533

server_settings = {}

953

534

self.server_settings = server_settings

954

535

# adding all client settings

955

for setting, value in settings.items():

536

for setting, value in settings.iteritems():

956

537

setattr(self, setting, value)

957

538

958

539

if self.enabled:

959

540

if not hasattr(self, "last_enabled"):

960

541

self.last_enabled = datetime.datetime.utcnow()

964

545

else:

965

546

self.last_enabled = None

966

547

self.expires = None

967

548

968

549

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

969

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

550

# Uppercase and remove spaces from fingerprint for later

551

# comparison purposes with return value from the fingerprint()

552

# function

970

553

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

971

554

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

972

555

datetime.datetime.utcnow())

973

556

974

557

# attributes specific for this server instance

975

558

self.checker = None

976

559

self.checker_initiator_tag = None

979

562

self.current_checker_command = None

980

563

self.approved = None

981

564

self.approvals_pending = 0

982

self.changedstate = multiprocessing_manager.Condition(

983

multiprocessing_manager.Lock())

984

self.client_structure = [attr

985

for attr in self.__dict__.keys()

565

self.changedstate = (multiprocessing_manager

566

.Condition(multiprocessing_manager

567

.Lock()))

568

self.client_structure = [attr for attr in

569

self.__dict__.iterkeys()

986

570

if not attr.startswith("_")]

987

571

self.client_structure.append("client_structure")

988

989

for name, t in inspect.getmembers(

990

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

572

573

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

574

lambda obj:

575

isinstance(obj,

576

property)):

991

577

if not name.startswith("_"):

992

578

self.client_structure.append(name)

993

579

994

580

# Send notice to process children that client state has changed

995

581

def send_changedstate(self):

996

582

with self.changedstate:

997

583

self.changedstate.notify_all()

998

584

999

585

def enable(self):

1000

586

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

1001

587

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

1006

592

self.last_enabled = datetime.datetime.utcnow()

1007

593

self.init_checker()

1008

594

self.send_changedstate()

1009

595

1010

596

def disable(self, quiet=True):

1011

597

"""Disable this client."""

1012

598

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

1014

600

if not quiet:

1015

601

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

1016

602

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

1017

GLib.source_remove(self.disable_initiator_tag)

603

gobject.source_remove(self.disable_initiator_tag)

1018

604

self.disable_initiator_tag = None

1019

605

self.expires = None

1020

606

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

1021

GLib.source_remove(self.checker_initiator_tag)

607

gobject.source_remove(self.checker_initiator_tag)

1022

608

self.checker_initiator_tag = None

1023

609

self.stop_checker()

1024

610

self.enabled = False

1025

611

if not quiet:

1026

612

self.send_changedstate()

1027

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

613

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

1028

614

return False

1029

615

1030

616

def __del__(self):

1031

617

self.disable()

1032

618

1033

619

def init_checker(self):

1034

620

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

1035

621

# and every interval from then on.

1036

622

if self.checker_initiator_tag is not None:

1037

GLib.source_remove(self.checker_initiator_tag)

1038

self.checker_initiator_tag = GLib.timeout_add(

1039

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

1040

+ 1)),

1041

self.start_checker)

623

gobject.source_remove(self.checker_initiator_tag)

624

self.checker_initiator_tag = (gobject.timeout_add

625

(self.interval_milliseconds(),

626

self.start_checker))

1042

627

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

1043

628

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)

629

gobject.source_remove(self.disable_initiator_tag)

630

self.disable_initiator_tag = (gobject.timeout_add

631

(self.timeout_milliseconds(),

632

self.disable))

1047

633

# Also start a new checker *right now*.

1048

634

self.start_checker()

1049

1050

def checker_callback(self, source, condition, connection,

1051

command):

635

636

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

1052

637

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

638

self.checker_callback_tag = None

1059

639

self.checker = None

1060

1061

if returncode >= 0:

1062

self.last_checker_status = returncode

1063

self.last_checker_signal = None

640

if os.WIFEXITED(condition):

641

self.last_checker_status = os.WEXITSTATUS(condition)

1064

642

if self.last_checker_status == 0:

1065

643

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

1066

644

vars(self))

1067

645

self.checked_ok()

1068

646

else:

1069

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

647

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

648

vars(self))

1070

649

else:

1071

650

self.last_checker_status = -1

1072

self.last_checker_signal = -returncode

1073

651

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

1074

652

vars(self))

1075

return False

1076

653

1077

654

def checked_ok(self):

1078

655

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

1079

656

self.last_checked_ok = datetime.datetime.utcnow()

1080

657

self.last_checker_status = 0

1081

self.last_checker_signal = None

1082

658

self.bump_timeout()

1083

659

1084

660

def bump_timeout(self, timeout=None):

1085

661

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

1086

662

if timeout is None:

1087

663

timeout = self.timeout

1088

664

if self.disable_initiator_tag is not None:

1089

GLib.source_remove(self.disable_initiator_tag)

665

gobject.source_remove(self.disable_initiator_tag)

1090

666

self.disable_initiator_tag = None

1091

667

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

1092

self.disable_initiator_tag = GLib.timeout_add(

1093

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

668

self.disable_initiator_tag = (gobject.timeout_add

669

(timedelta_to_milliseconds

670

(timeout), self.disable))

1094

671

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

1095

672

1096

673

def need_approval(self):

1097

674

self.last_approval_request = datetime.datetime.utcnow()

1098

675

1099

676

def start_checker(self):

1100

677

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

1101

678

1102

679

If a checker already exists, leave it running and do

1103

680

nothing."""

1104

681

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

1109

686

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

1110

687

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

1111

688

# 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

689

690

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

691

try:

692

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

693

except AttributeError:

694

pass

695

except OSError as error:

696

if error.errno != errno.ECHILD:

697

raise

698

else:

699

if pid:

700

logger.warning("Checker was a zombie")

701

gobject.source_remove(self.checker_callback_tag)

702

self.checker_callback(pid, status,

703

self.current_checker_command)

1117

704

# Start a new checker if needed

1118

705

if self.checker is None:

1119

706

# Escape attributes for the shell

1120

escaped_attrs = {

1121

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

1122

for attr in self.runtime_expansions}

707

escaped_attrs = dict(

708

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

709

for attr in

710

self.runtime_expansions)

1123

711

try:

1124

712

command = self.checker_command % escaped_attrs

1125

713

except TypeError as error:

1126

714

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

1127

self.checker_command,

715

self.checker_command, exc_info=error)

716

return True # Try again later

717

self.current_checker_command = command

718

try:

719

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

720

command, self.name)

721

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

722

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

723

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

724

# always replaced by /dev/null.)

725

# The exception is when not debugging but nevertheless

726

# running in the foreground; use the previously

727

# created wnull.

728

popen_args = {}

729

if (not self.server_settings["debug"]

730

and self.server_settings["foreground"]):

731

popen_args.update({"stdout": wnull,

732

"stderr": wnull })

733

self.checker = subprocess.Popen(command,

734

close_fds=True,

735

shell=True, cwd="/",

736

**popen_args)

737

except OSError as error:

738

logger.error("Failed to start subprocess",

1128

739

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

740

return True

741

self.checker_callback_tag = (gobject.child_watch_add

742

(self.checker.pid,

743

self.checker_callback,

744

data=command))

745

# The checker may have completed before the gobject

746

# watch was added. Check for this.

747

try:

748

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

749

except OSError as error:

750

if error.errno == errno.ECHILD:

751

# This should never happen

752

logger.error("Child process vanished",

753

exc_info=error)

754

return True

755

raise

756

if pid:

757

gobject.source_remove(self.checker_callback_tag)

758

self.checker_callback(pid, status, command)

759

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

1158

760

return True

1159

761

1160

762

def stop_checker(self):

1161

763

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

1162

764

if self.checker_callback_tag:

1163

GLib.source_remove(self.checker_callback_tag)

765

gobject.source_remove(self.checker_callback_tag)

1164

766

self.checker_callback_tag = None

1165

767

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

1166

768

return

1167

769

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

1168

self.checker.terminate()

770

try:

771

self.checker.terminate()

772

#time.sleep(0.5)

773

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

774

# self.checker.kill()

775

except OSError as error:

776

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

777

raise

1169

778

self.checker = None

1170

779

1171

780

1172

def dbus_service_property(dbus_interface,

1173

signature="v",

1174

access="readwrite",

1175

byte_arrays=False):

781

def dbus_service_property(dbus_interface, signature="v",

782

access="readwrite", byte_arrays=False):

1176

783

"""Decorators for marking methods of a DBusObjectWithProperties to

1177

784

become properties on the D-Bus.

1178

785

1179

786

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

1180

787

and with one argument by "Set".

1181

788

1182

789

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

1183

790

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

1184

791

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

1187

794

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

1188

795

if byte_arrays and signature != "ay":

1189

796

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

1190

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

1191

797

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

1192

798

def decorator(func):

1193

799

func._dbus_is_property = True

1194

800

func._dbus_interface = dbus_interface

1197

803

func._dbus_name = func.__name__

1198

804

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

1199

805

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

1200

func._dbus_get_args_options = {'byte_arrays': byte_arrays}

806

func._dbus_get_args_options = {'byte_arrays': byte_arrays }

1201

807

return func

1202

1203

808

return decorator

1204

809

1205

810

1206

811

def dbus_interface_annotations(dbus_interface):

1207

812

"""Decorator for marking functions returning interface annotations

1208

813

1209

814

Usage:

1210

815

1211

816

@dbus_interface_annotations("org.example.Interface")

1212

817

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

1213

818

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

1214

819

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

1215

820

"false"}

1216

821

"""

1217

1218

822

def decorator(func):

1219

823

func._dbus_is_interface = True

1220

824

func._dbus_interface = dbus_interface

1221

825

func._dbus_name = dbus_interface

1222

826

return func

1223

1224

827

return decorator

1225

828

1226

829

1227

830

def dbus_annotations(annotations):

1228

831

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

1229

832

Usage:

1230

1231

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

1232

"org.freedesktop.DBus.Property."

1233

"EmitsChangedSignal": "false"})

833

1234

834

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

1235

835

access="r")

836

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

837

"org.freedesktop.DBus.Property."

838

"EmitsChangedSignal": "false"})

1236

839

def Property_dbus_property(self):

1237

840

return dbus.Boolean(False)

1238

1239

See also the DBusObjectWithAnnotations class.

1240

841

"""

1241

1242

842

def decorator(func):

1243

843

func._dbus_annotations = annotations

1244

844

return func

1245

1246

845

return decorator

1247

846

1248

847

1249

848

class DBusPropertyException(dbus.exceptions.DBusException):

1250

849

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

1251

850

"""

1252

pass

851

def __unicode__(self):

852

return unicode(str(self))

1253

853

1254

854

1255

855

class DBusPropertyAccessException(DBusPropertyException):

1264

864

pass

1265

865

1266

866

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.

867

class DBusObjectWithProperties(dbus.service.Object):

868

"""A D-Bus object with properties.

869

870

Classes inheriting from this can use the dbus_service_property

871

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

872

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

1272

873

"""

1273

874

1274

875

@staticmethod

1275

876

def _is_dbus_thing(thing):

1276

877

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

1277

878

1278

879

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

1279

880

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

1280

881

"""

1281

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

882

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

1282

883

False)

1283

884

1284

885

def _get_all_dbus_things(self, thing):

1285

886

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

1286

887

"""

1287

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

888

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

889

name),

1288

890

athing.__get__(self))

1289

891

for cls in self.__class__.__mro__

1290

892

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

893

inspect.getmembers(cls,

894

self._is_dbus_thing(thing)))

895

1364

896

def _get_dbus_property(self, interface_name, property_name):

1365

897

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

1366

898

property with the specified name and interface.

1367

899

"""

1368

for cls in self.__class__.__mro__:

1369

for name, value in inspect.getmembers(

1370

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

900

for cls in self.__class__.__mro__:

901

for name, value in (inspect.getmembers

902

(cls,

903

self._is_dbus_thing("property"))):

1371

904

if (value._dbus_name == property_name

1372

905

and value._dbus_interface == interface_name):

1373

906

return value.__get__(self)

1374

907

1375

908

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

909

raise DBusPropertyNotFound(self.dbus_object_path + ":"

910

+ interface_name + "."

911

+ property_name)

912

913

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

1390

914

out_signature="v")

1391

915

def Get(self, interface_name, property_name):

1392

916

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

1398

922

if not hasattr(value, "variant_level"):

1399

923

return value

1400

924

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

1401

925

1402

926

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

1403

927

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

1404

928

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

1411

935

# signatures other than "ay".

1412

936

if prop._dbus_signature != "ay":

1413

937

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

1414

"'ay' signature {!r}"

938

"'ay' signature {0!r}"

1415

939

.format(prop._dbus_signature))

1416

value = dbus.ByteArray(bytes(value))

940

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

941

for byte in value))

1417

942

prop(value)

1418

1419

@dbus.service.method(dbus.PROPERTIES_IFACE,

1420

in_signature="s",

943

944

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

1421

945

out_signature="a{sv}")

1422

946

def GetAll(self, interface_name):

1423

947

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

1424

948

standard.

1425

949

1426

950

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

1427

951

"""

1428

952

properties = {}

1438

962

if not hasattr(value, "variant_level"):

1439

963

properties[name] = value

1440

964

continue

1441

properties[name] = type(value)(

1442

value, variant_level=value.variant_level + 1)

965

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

966

value.variant_level+1)

1443

967

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

1444

1445

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

1446

def PropertiesChanged(self, interface_name, changed_properties,

1447

invalidated_properties):

1448

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

1449

standard.

1450

"""

1451

pass

1452

968

1453

969

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1454

970

out_signature="s",

1455

971

path_keyword='object_path',

1456

972

connection_keyword='connection')

1457

973

def Introspect(self, object_path, connection):

1458

974

"""Overloading of standard D-Bus method.

1459

975

1460

976

Inserts property tags and interface annotation tags.

1461

977

"""

1462

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1463

object_path,

1464

connection)

978

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

979

connection)

1465

980

try:

1466

981

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

1467

1468

982

def make_tag(document, name, prop):

1469

983

e = document.createElement("property")

1470

984

e.setAttribute("name", name)

1471

985

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

1472

986

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

1473

987

return e

1474

1475

988

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

1476

989

# Add property tags

1477

990

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

1480

993

if prop._dbus_interface

1481

994

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

1482

995

if_tag.appendChild(tag)

1483

# Add annotation tags for properties

1484

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

1485

annots = dict()

1486

for name, prop in self._get_all_dbus_things(

1487

"property"):

1488

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

1489

and prop._dbus_interface

1490

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

1491

annots.update(getattr(

1492

prop, "_dbus_annotations", {}))

1493

for name, value in annots.items():

1494

ann_tag = document.createElement(

1495

"annotation")

1496

ann_tag.setAttribute("name", name)

1497

ann_tag.setAttribute("value", value)

1498

tag.appendChild(ann_tag)

996

# Add annotation tags

997

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

998

for tag in if_tag.getElementsByTagName(typ):

999

annots = dict()

1000

for name, prop in (self.

1001

_get_all_dbus_things(typ)):

1002

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

1003

and prop._dbus_interface

1004

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

1005

annots.update(getattr

1006

(prop,

1007

"_dbus_annotations",

1008

{}))

1009

for name, value in annots.iteritems():

1010

ann_tag = document.createElement(

1011

"annotation")

1012

ann_tag.setAttribute("name", name)

1013

ann_tag.setAttribute("value", value)

1014

tag.appendChild(ann_tag)

1015

# Add interface annotation tags

1016

for annotation, value in dict(

1017

itertools.chain.from_iterable(

1018

annotations().iteritems()

1019

for name, annotations in

1020

self._get_all_dbus_things("interface")

1021

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

1022

)).iteritems():

1023

ann_tag = document.createElement("annotation")

1024

ann_tag.setAttribute("name", annotation)

1025

ann_tag.setAttribute("value", value)

1026

if_tag.appendChild(ann_tag)

1499

1027

# Add the names to the return values for the

1500

1028

# "org.freedesktop.DBus.Properties" methods

1501

1029

if (if_tag.getAttribute("name")

1520

1048

return xmlstring

1521

1049

1522

1050

1523

try:

1524

dbus.OBJECT_MANAGER_IFACE

1525

except AttributeError:

1526

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

1527

1528

1529

class DBusObjectWithObjectManager(DBusObjectWithAnnotations):

1530

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

1531

1532

Classes inheriting from this exposes the standard

1533

GetManagedObjects call and the InterfacesAdded and

1534

InterfacesRemoved signals on the standard

1535

"org.freedesktop.DBus.ObjectManager" interface.

1536

1537

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

1538

manually.

1539

"""

1540

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

1541

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

1542

def GetManagedObjects(self):

1543

"""This function must be overridden"""

1544

raise NotImplementedError()

1545

1546

@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,

1547

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

1548

def InterfacesAdded(self, object_path, interfaces_and_properties):

1549

pass

1550

1551

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

1552

def InterfacesRemoved(self, object_path, interfaces):

1553

pass

1554

1555

@dbus.service.method(dbus.INTROSPECTABLE_IFACE,

1556

out_signature="s",

1557

path_keyword='object_path',

1558

connection_keyword='connection')

1559

def Introspect(self, object_path, connection):

1560

"""Overloading of standard D-Bus method.

1561

1562

Override return argument name of GetManagedObjects to be

1563

"objpath_interfaces_and_properties"

1564

"""

1565

xmlstring = DBusObjectWithAnnotations.Introspect(self,

1566

object_path,

1567

connection)

1568

try:

1569

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

1570

1571

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

1572

# Fix argument name for the GetManagedObjects method

1573

if (if_tag.getAttribute("name")

1574

== dbus.OBJECT_MANAGER_IFACE):

1575

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

1576

if (cn.getAttribute("name")

1577

== "GetManagedObjects"):

1578

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

1579

if (arg.getAttribute("direction")

1580

== "out"):

1581

arg.setAttribute(

1582

"name",

1583

"objpath_interfaces"

1584

"_and_properties")

1585

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

1586

document.unlink()

1587

except (AttributeError, xml.dom.DOMException,

1588

xml.parsers.expat.ExpatError) as error:

1589

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

1590

exc_info=error)

1591

return xmlstring

1592

1593

1594

1051

def datetime_to_dbus(dt, variant_level=0):

1595

1052

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

1596

1053

if dt is None:

1597

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

1598

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

1054

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

1055

return dbus.String(dt.isoformat(),

1056

variant_level=variant_level)

1599

1057

1600

1058

1601

1059

def alternate_dbus_interfaces(alt_interface_names, deprecate=True):

1603

1061

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

1604

1062

interface names according to the "alt_interface_names" mapping.

1605

1063

Usage:

1606

1064

1607

1065

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

1608

1066

"net.example.AlternateInterface"})

1609

1067

class SampleDBusObject(dbus.service.Object):

1610

1068

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

1611

1069

def SampleDBusMethod():

1612

1070

pass

1613

1071

1614

1072

The above "SampleDBusMethod" on "SampleDBusObject" will be

1615

1073

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

1616

1074

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

1617

1075

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

1618

1076

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

1619

1077

1620

1078

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

1621

1079

(from DBusObjectWithProperties) and interfaces (from the

1622

1080

dbus_interface_annotations decorator).

1623

1081

"""

1624

1625

1082

def wrapper(cls):

1626

1083

for orig_interface_name, alt_interface_name in (

1627

alt_interface_names.items()):

1084

alt_interface_names.iteritems()):

1628

1085

attr = {}

1629

1086

interface_names = set()

1630

1087

# Go though all attributes of the class

1632

1089

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

1633

1090

# with the wrong interface name

1634

1091

if (not hasattr(attribute, "_dbus_interface")

1635

or not attribute._dbus_interface.startswith(

1636

orig_interface_name)):

1092

or not attribute._dbus_interface

1093

.startswith(orig_interface_name)):

1637

1094

continue

1638

1095

# Create an alternate D-Bus interface name based on

1639

1096

# the current name

1640

alt_interface = attribute._dbus_interface.replace(

1641

orig_interface_name, alt_interface_name)

1097

alt_interface = (attribute._dbus_interface

1098

.replace(orig_interface_name,

1099

alt_interface_name))

1642

1100

interface_names.add(alt_interface)

1643

1101

# Is this a D-Bus signal?

1644

1102

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

1645

1103

# Extract the original non-method undecorated

1646

1104

# function by black magic

1647

if sys.version_info.major == 2:

1648

nonmethod_func = (dict(

1105

nonmethod_func = (dict(

1649

1106

zip(attribute.func_code.co_freevars,

1650

attribute.__closure__))

1651

["func"].cell_contents)

1652

else:

1653

nonmethod_func = (dict(

1654

zip(attribute.__code__.co_freevars,

1655

attribute.__closure__))

1656

["func"].cell_contents)

1107

attribute.__closure__))["func"]

1108

.cell_contents)

1657

1109

# Create a new, but exactly alike, function

1658

1110

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

1659

1111

# with the alternate D-Bus interface name

1660

new_function = copy_function(nonmethod_func)

1661

new_function = (dbus.service.signal(

1662

alt_interface,

1663

attribute._dbus_signature)(new_function))

1112

new_function = (dbus.service.signal

1113

(alt_interface,

1114

attribute._dbus_signature)

1115

(types.FunctionType(

1116

nonmethod_func.func_code,

1117

nonmethod_func.func_globals,

1118

nonmethod_func.func_name,

1119

nonmethod_func.func_defaults,

1120

nonmethod_func.func_closure)))

1664

1121

# Copy annotations, if any

1665

1122

try:

1666

new_function._dbus_annotations = dict(

1667

attribute._dbus_annotations)

1123

new_function._dbus_annotations = (

1124

dict(attribute._dbus_annotations))

1668

1125

except AttributeError:

1669

1126

pass

1670

1671

1127

# Define a creator of a function to call both the

1672

1128

# original and alternate functions, so both the

1673

1129

# original and alternate signals gets sent when

1676

1132

"""This function is a scope container to pass

1677

1133

func1 and func2 to the "call_both" function

1678

1134

outside of its arguments"""

1679

1680

@functools.wraps(func2)

1681

1135

def call_both(*args, **kwargs):

1682

1136

"""This function will emit two D-Bus

1683

1137

signals by calling func1 and func2"""

1684

1138

func1(*args, **kwargs)

1685

1139

func2(*args, **kwargs)

1686

# Make wrapper function look like a D-Bus

1687

# signal

1688

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

1689

if name.startswith("_dbus_"):

1690

setattr(call_both, name, attr)

1691

1692

1140

return call_both

1693

1141

# Create the "call_both" function and add it to

1694

1142

# the class

1699

1147

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

1700

1148

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

1701

1149

# to the class.

1702

attr[attrname] = (

1703

dbus.service.method(

1704

alt_interface,

1705

attribute._dbus_in_signature,

1706

attribute._dbus_out_signature)

1707

(copy_function(attribute)))

1150

attr[attrname] = (dbus.service.method

1151

(alt_interface,

1152

attribute._dbus_in_signature,

1153

attribute._dbus_out_signature)

1154

(types.FunctionType

1155

(attribute.func_code,

1156

attribute.func_globals,

1157

attribute.func_name,

1158

attribute.func_defaults,

1159

attribute.func_closure)))

1708

1160

# Copy annotations, if any

1709

1161

try:

1710

attr[attrname]._dbus_annotations = dict(

1711

attribute._dbus_annotations)

1162

attr[attrname]._dbus_annotations = (

1163

dict(attribute._dbus_annotations))

1712

1164

except AttributeError:

1713

1165

pass

1714

1166

# Is this a D-Bus property?

1717

1169

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

1718

1170

# property with the alternate D-Bus interface

1719

1171

# name. Add it to the class.

1720

attr[attrname] = (dbus_service_property(

1721

alt_interface, attribute._dbus_signature,

1722

attribute._dbus_access,

1723

attribute._dbus_get_args_options

1724

["byte_arrays"])

1725

(copy_function(attribute)))

1172

attr[attrname] = (dbus_service_property

1173

(alt_interface,

1174

attribute._dbus_signature,

1175

attribute._dbus_access,

1176

attribute

1177

._dbus_get_args_options

1178

["byte_arrays"])

1179

(types.FunctionType

1180

(attribute.func_code,

1181

attribute.func_globals,

1182

attribute.func_name,

1183

attribute.func_defaults,

1184

attribute.func_closure)))

1726

1185

# Copy annotations, if any

1727

1186

try:

1728

attr[attrname]._dbus_annotations = dict(

1729

attribute._dbus_annotations)

1187

attr[attrname]._dbus_annotations = (

1188

dict(attribute._dbus_annotations))

1730

1189

except AttributeError:

1731

1190

pass

1732

1191

# Is this a D-Bus interface?

1735

1194

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

1736

1195

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

1737

1196

# to the class.

1738

attr[attrname] = (

1739

dbus_interface_annotations(alt_interface)

1740

(copy_function(attribute)))

1197

attr[attrname] = (dbus_interface_annotations

1198

(alt_interface)

1199

(types.FunctionType

1200

(attribute.func_code,

1201

attribute.func_globals,

1202

attribute.func_name,

1203

attribute.func_defaults,

1204

attribute.func_closure)))

1741

1205

if deprecate:

1742

1206

# Deprecate all alternate interfaces

1743

iname = "_AlternateDBusNames_interface_annotation{}"

1207

iname="_AlternateDBusNames_interface_annotation{0}"

1744

1208

for interface_name in interface_names:

1745

1746

1209

@dbus_interface_annotations(interface_name)

1747

1210

def func(self):

1748

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

1749

"true"}

1211

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

1212

"true" }

1750

1213

# Find an unused name

1751

1214

for aname in (iname.format(i)

1752

1215

for i in itertools.count()):

1756

1219

if interface_names:

1757

1220

# Replace the class with a new subclass of it with

1758

1221

# methods, signals, etc. as created above.

1759

if sys.version_info.major == 2:

1760

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

1761

(cls, ), attr)

1762

else:

1763

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

1764

(cls, ), attr)

1222

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

1223

(cls,), attr)

1765

1224

return cls

1766

1767

1225

return wrapper

1768

1226

1769

1227

1770

1228

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

1771

"se.bsnet.fukt.Mandos"})

1229

"se.bsnet.fukt.Mandos"})

1772

1230

class ClientDBus(Client, DBusObjectWithProperties):

1773

1231

"""A Client class using D-Bus

1774

1232

1775

1233

Attributes:

1776

1234

dbus_object_path: dbus.ObjectPath

1777

1235

bus: dbus.SystemBus()

1778

1236

"""

1779

1237

1780

1238

runtime_expansions = (Client.runtime_expansions

1781

+ ("dbus_object_path", ))

1782

1783

_interface = "se.recompile.Mandos.Client"

1784

1239

+ ("dbus_object_path",))

1240

1785

1241

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

1786

1787

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

1242

1243

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

1788

1244

self.bus = bus

1789

1245

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

1790

1246

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

1791

1247

# the D-Bus

1792

client_object_name = str(self.name).translate(

1248

client_object_name = unicode(self.name).translate(

1793

1249

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

1794

1250

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

1795

self.dbus_object_path = dbus.ObjectPath(

1796

"/clients/" + client_object_name)

1251

self.dbus_object_path = (dbus.ObjectPath

1252

("/clients/" + client_object_name))

1797

1253

DBusObjectWithProperties.__init__(self, self.bus,

1798

1254

self.dbus_object_path)

1799

1800

def notifychangeproperty(transform_func, dbus_name,

1801

type_func=lambda x: x,

1802

variant_level=1,

1803

invalidate_only=False,

1804

_interface=_interface):

1255

1256

def notifychangeproperty(transform_func,

1257

dbus_name, type_func=lambda x: x,

1258

variant_level=1):

1805

1259

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

1806

1260

its changes to DBus.

1807

1261

1808

1262

transform_fun: Function that takes a value and a variant_level

1809

1263

and transforms it to a D-Bus type.

1810

1264

dbus_name: D-Bus name of the variable

1812

1266

to the D-Bus. Default: no transform

1813

1267

variant_level: D-Bus variant level. Default: 1

1814

1268

"""

1815

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

1816

1269

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

1817

1270

def setter(self, value):

1818

1271

if hasattr(self, "dbus_object_path"):

1819

1272

if (not hasattr(self, attrname) or

1820

1273

type_func(getattr(self, attrname, None))

1821

1274

!= type_func(value)):

1822

if invalidate_only:

1823

self.PropertiesChanged(

1824

_interface, dbus.Dictionary(),

1825

dbus.Array((dbus_name, )))

1826

else:

1827

dbus_value = transform_func(

1828

type_func(value),

1829

variant_level=variant_level)

1830

self.PropertyChanged(dbus.String(dbus_name),

1831

dbus_value)

1832

self.PropertiesChanged(

1833

_interface,

1834

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

1835

dbus_value}),

1836

dbus.Array())

1275

dbus_value = transform_func(type_func(value),

1276

variant_level

1277

=variant_level)

1278

self.PropertyChanged(dbus.String(dbus_name),

1279

dbus_value)

1837

1280

setattr(self, attrname, value)

1838

1281

1839

1282

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

1840

1283

1841

1284

expires = notifychangeproperty(datetime_to_dbus, "Expires")

1842

1285

approvals_pending = notifychangeproperty(dbus.Boolean,

1843

1286

"ApprovalPending",

1844

type_func=bool)

1287

type_func = bool)

1845

1288

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

1846

1289

last_enabled = notifychangeproperty(datetime_to_dbus,

1847

1290

"LastEnabled")

1848

checker = notifychangeproperty(

1849

dbus.Boolean, "CheckerRunning",

1850

type_func=lambda checker: checker is not None)

1291

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

1292

type_func = lambda checker:

1293

checker is not None)

1851

1294

last_checked_ok = notifychangeproperty(datetime_to_dbus,

1852

1295

"LastCheckedOK")

1853

1296

last_checker_status = notifychangeproperty(dbus.Int16,

1856

1299

datetime_to_dbus, "LastApprovalRequest")

1857

1300

approved_by_default = notifychangeproperty(dbus.Boolean,

1858

1301

"ApprovedByDefault")

1859

approval_delay = notifychangeproperty(

1860

dbus.UInt64, "ApprovalDelay",

1861

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

1302

approval_delay = notifychangeproperty(dbus.UInt64,

1303

"ApprovalDelay",

1304

type_func =

1305

timedelta_to_milliseconds)

1862

1306

approval_duration = notifychangeproperty(

1863

1307

dbus.UInt64, "ApprovalDuration",

1864

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

1308

type_func = timedelta_to_milliseconds)

1865

1309

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

1866

timeout = notifychangeproperty(

1867

dbus.UInt64, "Timeout",

1868

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

1310

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

1311

type_func =

1312

timedelta_to_milliseconds)

1869

1313

extended_timeout = notifychangeproperty(

1870

1314

dbus.UInt64, "ExtendedTimeout",

1871

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

1872

interval = notifychangeproperty(

1873

dbus.UInt64, "Interval",

1874

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

1315

type_func = timedelta_to_milliseconds)

1316

interval = notifychangeproperty(dbus.UInt64,

1317

"Interval",

1318

type_func =

1319

timedelta_to_milliseconds)

1875

1320

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

1876

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

1877

invalidate_only=True)

1878

1321

1879

1322

del notifychangeproperty

1880

1323

1881

1324

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

1882

1325

try:

1883

1326

self.remove_from_connection()

1886

1329

if hasattr(DBusObjectWithProperties, "__del__"):

1887

1330

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

1888

1331

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

1889

1890

def checker_callback(self, source, condition,

1891

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

1892

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

1893

connection, command, *args,

1894

**kwargs)

1895

exitstatus = self.last_checker_status

1896

if exitstatus >= 0:

1332

1333

def checker_callback(self, pid, condition, command,

1334

*args, **kwargs):

1335

self.checker_callback_tag = None

1336

self.checker = None

1337

if os.WIFEXITED(condition):

1338

exitstatus = os.WEXITSTATUS(condition)

1897

1339

# Emit D-Bus signal

1898

1340

self.CheckerCompleted(dbus.Int16(exitstatus),

1899

# This is specific to GNU libC

1900

dbus.Int64(exitstatus << 8),

1341

dbus.Int64(condition),

1901

1342

dbus.String(command))

1902

1343

else:

1903

1344

# Emit D-Bus signal

1904

1345

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

1905

dbus.Int64(

1906

# This is specific to GNU libC

1907

(exitstatus << 8)

1908

| self.last_checker_signal),

1346

dbus.Int64(condition),

1909

1347

dbus.String(command))

1910

return ret

1911

1348

1349

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

1350

*args, **kwargs)

1351

1912

1352

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

1913

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

1353

old_checker = self.checker

1354

if self.checker is not None:

1355

old_checker_pid = self.checker.pid

1356

else:

1357

old_checker_pid = None

1914

1358

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

1915

1359

# Only if new checker process was started

1916

1360

if (self.checker is not None

1918

1362

# Emit D-Bus signal

1919

1363

self.CheckerStarted(self.current_checker_command)

1920

1364

return r

1921

1365

1922

1366

def _reset_approved(self):

1923

1367

self.approved = None

1924

1368

return False

1925

1369

1926

1370

def approve(self, value=True):

1927

1371

self.approved = value

1928

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

1929

* 1000), self._reset_approved)

1372

gobject.timeout_add(timedelta_to_milliseconds

1373

(self.approval_duration),

1374

self._reset_approved)

1930

1375

self.send_changedstate()

1931

1932

# D-Bus methods, signals & properties

1933

1934

# Interfaces

1935

1936

# Signals

1937

1376

1377

## D-Bus methods, signals & properties

1378

_interface = "se.recompile.Mandos.Client"

1379

1380

## Interfaces

1381

1382

@dbus_interface_annotations(_interface)

1383

def _foo(self):

1384

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

1385

"false"}

1386

1387

## Signals

1388

1938

1389

# CheckerCompleted - signal

1939

1390

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

1940

1391

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

1941

1392

"D-Bus signal"

1942

1393

pass

1943

1394

1944

1395

# CheckerStarted - signal

1945

1396

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

1946

1397

def CheckerStarted(self, command):

1947

1398

"D-Bus signal"

1948

1399

pass

1949

1400

1950

1401

# PropertyChanged - signal

1951

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

1952

1402

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

1953

1403

def PropertyChanged(self, property, value):

1954

1404

"D-Bus signal"

1955

1405

pass

1956

1406

1957

1407

# GotSecret - signal

1958

1408

@dbus.service.signal(_interface)

1959

1409

def GotSecret(self):

1962

1412

server to mandos-client

1963

1413

"""

1964

1414

pass

1965

1415

1966

1416

# Rejected - signal

1967

1417

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

1968

1418

def Rejected(self, reason):

1969

1419

"D-Bus signal"

1970

1420

pass

1971

1421

1972

1422

# NeedApproval - signal

1973

1423

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

1974

1424

def NeedApproval(self, timeout, default):

1975

1425

"D-Bus signal"

1976

1426

return self.need_approval()

1977

1978

# Methods

1979

1427

1428

## Methods

1429

1980

1430

# Approve - method

1981

1431

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

1982

1432

def Approve(self, value):

1983

1433

self.approve(value)

1984

1434

1985

1435

# CheckedOK - method

1986

1436

@dbus.service.method(_interface)

1987

1437

def CheckedOK(self):

1988

1438

self.checked_ok()

1989

1439

1990

1440

# Enable - method

1991

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

1992

1441

@dbus.service.method(_interface)

1993

1442

def Enable(self):

1994

1443

"D-Bus method"

1995

1444

self.enable()

1996

1445

1997

1446

# StartChecker - method

1998

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

1999

1447

@dbus.service.method(_interface)

2000

1448

def StartChecker(self):

2001

1449

"D-Bus method"

2002

1450

self.start_checker()

2003

1451

2004

1452

# Disable - method

2005

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

2006

1453

@dbus.service.method(_interface)

2007

1454

def Disable(self):

2008

1455

"D-Bus method"

2009

1456

self.disable()

2010

1457

2011

1458

# StopChecker - method

2012

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

2013

1459

@dbus.service.method(_interface)

2014

1460

def StopChecker(self):

2015

1461

self.stop_checker()

2016

2017

# Properties

2018

1462

1463

## Properties

1464

2019

1465

# ApprovalPending - property

2020

1466

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

2021

1467

def ApprovalPending_dbus_property(self):

2022

1468

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

2023

1469

2024

1470

# ApprovedByDefault - property

2025

@dbus_service_property(_interface,

2026

signature="b",

1471

@dbus_service_property(_interface, signature="b",

2027

1472

access="readwrite")

2028

1473

def ApprovedByDefault_dbus_property(self, value=None):

2029

1474

if value is None: # get

2030

1475

return dbus.Boolean(self.approved_by_default)

2031

1476

self.approved_by_default = bool(value)

2032

1477

2033

1478

# ApprovalDelay - property

2034

@dbus_service_property(_interface,

2035

signature="t",

1479

@dbus_service_property(_interface, signature="t",

2036

1480

access="readwrite")

2037

1481

def ApprovalDelay_dbus_property(self, value=None):

2038

1482

if value is None: # get

2039

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

2040

* 1000)

1483

return dbus.UInt64(self.approval_delay_milliseconds())

2041

1484

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

2042

1485

2043

1486

# ApprovalDuration - property

2044

@dbus_service_property(_interface,

2045

signature="t",

1487

@dbus_service_property(_interface, signature="t",

2046

1488

access="readwrite")

2047

1489

def ApprovalDuration_dbus_property(self, value=None):

2048

1490

if value is None: # get

2049

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

2050

* 1000)

1491

return dbus.UInt64(timedelta_to_milliseconds(

1492

self.approval_duration))

2051

1493

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

2052

1494

2053

1495

# Name - property

2054

@dbus_annotations(

2055

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

2056

1496

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

2057

1497

def Name_dbus_property(self):

2058

1498

return dbus.String(self.name)

2059

2060

# KeyID - property

2061

@dbus_annotations(

2062

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

2063

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

2064

def KeyID_dbus_property(self):

2065

return dbus.String(self.key_id)

2066

1499

2067

1500

# Fingerprint - property

2068

@dbus_annotations(

2069

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

2070

1501

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

2071

1502

def Fingerprint_dbus_property(self):

2072

1503

return dbus.String(self.fingerprint)

2073

1504

2074

1505

# Host - property

2075

@dbus_service_property(_interface,

2076

signature="s",

1506

@dbus_service_property(_interface, signature="s",

2077

1507

access="readwrite")

2078

1508

def Host_dbus_property(self, value=None):

2079

1509

if value is None: # get

2080

1510

return dbus.String(self.host)

2081

self.host = str(value)

2082

1511

self.host = unicode(value)

1512

2083

1513

# Created - property

2084

@dbus_annotations(

2085

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

2086

1514

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

2087

1515

def Created_dbus_property(self):

2088

1516

return datetime_to_dbus(self.created)

2089

1517

2090

1518

# LastEnabled - property

2091

1519

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

2092

1520

def LastEnabled_dbus_property(self):

2093

1521

return datetime_to_dbus(self.last_enabled)

2094

1522

2095

1523

# Enabled - property

2096

@dbus_service_property(_interface,

2097

signature="b",

1524

@dbus_service_property(_interface, signature="b",

2098

1525

access="readwrite")

2099

1526

def Enabled_dbus_property(self, value=None):

2100

1527

if value is None: # get

2103

1530

self.enable()

2104

1531

else:

2105

1532

self.disable()

2106

1533

2107

1534

# LastCheckedOK - property

2108

@dbus_service_property(_interface,

2109

signature="s",

1535

@dbus_service_property(_interface, signature="s",

2110

1536

access="readwrite")

2111

1537

def LastCheckedOK_dbus_property(self, value=None):

2112

1538

if value is not None:

2113

1539

self.checked_ok()

2114

1540

return

2115

1541

return datetime_to_dbus(self.last_checked_ok)

2116

1542

2117

1543

# LastCheckerStatus - property

2118

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

1544

@dbus_service_property(_interface, signature="n",

1545

access="read")

2119

1546

def LastCheckerStatus_dbus_property(self):

2120

1547

return dbus.Int16(self.last_checker_status)

2121

1548

2122

1549

# Expires - property

2123

1550

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

2124

1551

def Expires_dbus_property(self):

2125

1552

return datetime_to_dbus(self.expires)

2126

1553

2127

1554

# LastApprovalRequest - property

2128

1555

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

2129

1556

def LastApprovalRequest_dbus_property(self):

2130

1557

return datetime_to_dbus(self.last_approval_request)

2131

1558

2132

1559

# Timeout - property

2133

@dbus_service_property(_interface,

2134

signature="t",

1560

@dbus_service_property(_interface, signature="t",

2135

1561

access="readwrite")

2136

1562

def Timeout_dbus_property(self, value=None):

2137

1563

if value is None: # get

2138

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

1564

return dbus.UInt64(self.timeout_milliseconds())

2139

1565

old_timeout = self.timeout

2140

1566

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

2141

1567

# Reschedule disabling

2149

1575

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

2150

1576

is None):

2151

1577

return

2152

GLib.source_remove(self.disable_initiator_tag)

2153

self.disable_initiator_tag = GLib.timeout_add(

2154

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

2155

self.disable)

2156

1578

gobject.source_remove(self.disable_initiator_tag)

1579

self.disable_initiator_tag = (

1580

gobject.timeout_add(

1581

timedelta_to_milliseconds(self.expires - now),

1582

self.disable))

1583

2157

1584

# ExtendedTimeout - property

2158

@dbus_service_property(_interface,

2159

signature="t",

1585

@dbus_service_property(_interface, signature="t",

2160

1586

access="readwrite")

2161

1587

def ExtendedTimeout_dbus_property(self, value=None):

2162

1588

if value is None: # get

2163

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

2164

* 1000)

1589

return dbus.UInt64(self.extended_timeout_milliseconds())

2165

1590

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

2166

1591

2167

1592

# Interval - property

2168

@dbus_service_property(_interface,

2169

signature="t",

1593

@dbus_service_property(_interface, signature="t",

2170

1594

access="readwrite")

2171

1595

def Interval_dbus_property(self, value=None):

2172

1596

if value is None: # get

2173

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

1597

return dbus.UInt64(self.interval_milliseconds())

2174

1598

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

2175

1599

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

2176

1600

return

2177

1601

if self.enabled:

2178

1602

# Reschedule checker run

2179

GLib.source_remove(self.checker_initiator_tag)

2180

self.checker_initiator_tag = GLib.timeout_add(

2181

value, self.start_checker)

2182

self.start_checker() # Start one now, too

2183

1603

gobject.source_remove(self.checker_initiator_tag)

1604

self.checker_initiator_tag = (gobject.timeout_add

1605

(value, self.start_checker))

1606

self.start_checker() # Start one now, too

1607

2184

1608

# Checker - property

2185

@dbus_service_property(_interface,

2186

signature="s",

1609

@dbus_service_property(_interface, signature="s",

2187

1610

access="readwrite")

2188

1611

def Checker_dbus_property(self, value=None):

2189

1612

if value is None: # get

2190

1613

return dbus.String(self.checker_command)

2191

self.checker_command = str(value)

2192

1614

self.checker_command = unicode(value)

1615

2193

1616

# CheckerRunning - property

2194

@dbus_service_property(_interface,

2195

signature="b",

1617

@dbus_service_property(_interface, signature="b",

2196

1618

access="readwrite")

2197

1619

def CheckerRunning_dbus_property(self, value=None):

2198

1620

if value is None: # get

2201

1623

self.start_checker()

2202

1624

else:

2203

1625

self.stop_checker()

2204

1626

2205

1627

# ObjectPath - property

2206

@dbus_annotations(

2207

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

2208

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

2209

1628

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

2210

1629

def ObjectPath_dbus_property(self):

2211

return self.dbus_object_path # is already a dbus.ObjectPath

2212

1630

return self.dbus_object_path # is already a dbus.ObjectPath

1631

2213

1632

# Secret = property

2214

@dbus_annotations(

2215

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

2216

"invalidates"})

2217

@dbus_service_property(_interface,

2218

signature="ay",

2219

access="write",

2220

byte_arrays=True)

1633

@dbus_service_property(_interface, signature="ay",

1634

access="write", byte_arrays=True)

2221

1635

def Secret_dbus_property(self, value):

2222

self.secret = bytes(value)

2223

1636

self.secret = str(value)

1637

2224

1638

del _interface

2225

1639

2226

1640

2227

class ProxyClient:

2228

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

1641

class ProxyClient(object):

1642

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

2229

1643

self._pipe = child_pipe

2230

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

1644

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

2231

1645

if not self._pipe.recv():

2232

raise KeyError(key_id or fpr)

2233

1646

raise KeyError()

1647

2234

1648

def __getattribute__(self, name):

2235

1649

if name == '_pipe':

2236

1650

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

2239

1653

if data[0] == 'data':

2240

1654

return data[1]

2241

1655

if data[0] == 'function':

2242

2243

1656

def func(*args, **kwargs):

2244

1657

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

2245

1658

return self._pipe.recv()[1]

2246

2247

1659

return func

2248

1660

2249

1661

def __setattr__(self, name, value):

2250

1662

if name == '_pipe':

2251

1663

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

2254

1666

2255

1667

class ClientHandler(socketserver.BaseRequestHandler, object):

2256

1668

"""A class to handle client connections.

2257

1669

2258

1670

Instantiated once for each connection to handle it.

2259

1671

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

2260

1672

2261

1673

def handle(self):

2262

1674

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

2263

1675

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

2264

str(self.client_address))

1676

unicode(self.client_address))

2265

1677

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

2266

1678

self.server.child_pipe.fileno())

2267

2268

session = gnutls.ClientSession(self.request)

2269

2270

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

2271

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

2272

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

2273

# "+DHE-DSS"))

1679

1680

session = (gnutls.connection

1681

.ClientSession(self.request,

1682

gnutls.connection

1683

.X509Credentials()))

1684

1685

# Note: gnutls.connection.X509Credentials is really a

1686

# generic GnuTLS certificate credentials object so long as

1687

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

1688

# here despite using OpenPGP certificates.

1689

1690

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

1691

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

1692

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

1693

# "+DHE-DSS"))

2274

1694

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

2275

1695

priority = self.server.gnutls_priority

2276

1696

if priority is None:

2277

1697

priority = "NORMAL"

2278

gnutls.priority_set_direct(session._c_object,

2279

priority.encode("utf-8"),

2280

None)

2281

1698

(gnutls.library.functions

1699

.gnutls_priority_set_direct(session._c_object,

1700

priority, None))

1701

2282

1702

# Start communication using the Mandos protocol

2283

1703

# Get protocol number

2284

1704

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

2289

1709

except (ValueError, IndexError, RuntimeError) as error:

2290

1710

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

2291

1711

return

2292

1712

2293

1713

# Start GnuTLS connection

2294

1714

try:

2295

1715

session.handshake()

2296

except gnutls.Error as error:

1716

except gnutls.errors.GNUTLSError as error:

2297

1717

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

2298

1718

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

2299

1719

# established. Just abandon the request.

2300

1720

return

2301

1721

logger.debug("Handshake succeeded")

2302

1722

2303

1723

approval_required = False

2304

1724

try:

2305

if gnutls.has_rawpk:

2306

fpr = b""

2307

try:

2308

key_id = self.key_id(

2309

self.peer_certificate(session))

2310

except (TypeError, gnutls.Error) as error:

2311

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

2312

return

2313

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

2314

2315

else:

2316

key_id = b""

2317

try:

2318

fpr = self.fingerprint(

2319

self.peer_certificate(session))

2320

except (TypeError, gnutls.Error) as error:

2321

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

2322

return

2323

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

2324

2325

try:

2326

client = ProxyClient(child_pipe, key_id, fpr,

1725

try:

1726

fpr = self.fingerprint(self.peer_certificate

1727

(session))

1728

except (TypeError,

1729

gnutls.errors.GNUTLSError) as error:

1730

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

1731

return

1732

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

1733

1734

try:

1735

client = ProxyClient(child_pipe, fpr,

2327

1736

self.client_address)

2328

1737

except KeyError:

2329

1738

return

2330

1739

2331

1740

if client.approval_delay:

2332

1741

delay = client.approval_delay

2333

1742

client.approvals_pending += 1

2334

1743

approval_required = True

2335

1744

2336

1745

while True:

2337

1746

if not client.enabled:

2338

1747

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

2339

client.name)

1748

client.name)

2340

1749

if self.server.use_dbus:

2341

1750

# Emit D-Bus signal

2342

1751

client.Rejected("Disabled")

2343

1752

return

2344

1753

2345

1754

if client.approved or not client.approval_delay:

2346

# We are approved or approval is disabled

1755

#We are approved or approval is disabled

2347

1756

break

2348

1757

elif client.approved is None:

2349

1758

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

2351

1760

if self.server.use_dbus:

2352

1761

# Emit D-Bus signal

2353

1762

client.NeedApproval(

2354

client.approval_delay.total_seconds()

2355

* 1000, client.approved_by_default)

1763

client.approval_delay_milliseconds(),

1764

client.approved_by_default)

2356

1765

else:

2357

1766

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

2358

1767

client.name)

2360

1769

# Emit D-Bus signal

2361

1770

client.Rejected("Denied")

2362

1771

return

2363

2364

# wait until timeout or approved

1772

1773

#wait until timeout or approved

2365

1774

time = datetime.datetime.now()

2366

1775

client.changedstate.acquire()

2367

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

1776

client.changedstate.wait(

1777

float(timedelta_to_milliseconds(delay)

1778

/ 1000))

2368

1779

client.changedstate.release()

2369

1780

time2 = datetime.datetime.now()

2370

1781

if (time2 - time) >= delay:

2380

1791

break

2381

1792

else:

2382

1793

delay -= time2 - time

2383

2384

try:

2385

session.send(client.secret)

2386

except gnutls.Error as error:

2387

logger.warning("gnutls send failed",

2388

exc_info=error)

2389

return

2390

1794

1795

sent_size = 0

1796

while sent_size < len(client.secret):

1797

try:

1798

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

1799

except gnutls.errors.GNUTLSError as error:

1800

logger.warning("gnutls send failed",

1801

exc_info=error)

1802

return

1803

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

1804

sent, len(client.secret)

1805

- (sent_size + sent))

1806

sent_size += sent

1807

2391

1808

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

2392

1809

# bump the timeout using extended_timeout

2393

1810

client.bump_timeout(client.extended_timeout)

2394

1811

if self.server.use_dbus:

2395

1812

# Emit D-Bus signal

2396

1813

client.GotSecret()

2397

1814

2398

1815

finally:

2399

1816

if approval_required:

2400

1817

client.approvals_pending -= 1

2401

1818

try:

2402

1819

session.bye()

2403

except gnutls.Error as error:

1820

except gnutls.errors.GNUTLSError as error:

2404

1821

logger.warning("GnuTLS bye failed",

2405

1822

exc_info=error)

2406

1823

2407

1824

@staticmethod

2408

1825

def peer_certificate(session):

2409

"Return the peer's certificate as a bytestring"

2410

try:

2411

cert_type = gnutls.certificate_type_get2(session._c_object,

2412

gnutls.CTYPE_PEERS)

2413

except AttributeError:

2414

cert_type = gnutls.certificate_type_get(session._c_object)

2415

if gnutls.has_rawpk:

2416

valid_cert_types = frozenset((gnutls.CRT_RAWPK,))

2417

else:

2418

valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))

2419

# If not a valid certificate type...

2420

if cert_type not in valid_cert_types:

2421

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

2422

valid_cert_types)

2423

# ...return invalid data

2424

return b""

1826

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

1827

# If not an OpenPGP certificate...

1828

if (gnutls.library.functions

1829

.gnutls_certificate_type_get(session._c_object)

1830

!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):

1831

# ...do the normal thing

1832

return session.peer_certificate

2425

1833

list_size = ctypes.c_uint(1)

2426

cert_list = (gnutls.certificate_get_peers

1834

cert_list = (gnutls.library.functions

1835

.gnutls_certificate_get_peers

2427

1836

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

2428

1837

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

2429

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

1838

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

1839

" certificate")

2430

1840

if list_size.value == 0:

2431

1841

return None

2432

1842

cert = cert_list[0]

2433

1843

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

2434

2435

@staticmethod

2436

def key_id(certificate):

2437

"Convert a certificate bytestring to a hexdigit key ID"

2438

# New GnuTLS "datum" with the public key

2439

datum = gnutls.datum_t(

2440

ctypes.cast(ctypes.c_char_p(certificate),

2441

ctypes.POINTER(ctypes.c_ubyte)),

2442

ctypes.c_uint(len(certificate)))

2443

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

2444

# New empty GnuTLS certificate

2445

pubkey = gnutls.pubkey_t()

2446

gnutls.pubkey_init(ctypes.byref(pubkey))

2447

# Import the raw public key into the certificate

2448

gnutls.pubkey_import(pubkey,

2449

ctypes.byref(datum),

2450

gnutls.X509_FMT_DER)

2451

# New buffer for the key ID

2452

buf = ctypes.create_string_buffer(32)

2453

buf_len = ctypes.c_size_t(len(buf))

2454

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

2455

gnutls.pubkey_get_key_id(pubkey,

2456

gnutls.KEYID_USE_SHA256,

2457

ctypes.cast(ctypes.byref(buf),

2458

ctypes.POINTER(ctypes.c_ubyte)),

2459

ctypes.byref(buf_len))

2460

# Deinit the certificate

2461

gnutls.pubkey_deinit(pubkey)

2462

2463

# Convert the buffer to a Python bytestring

2464

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

2465

# Convert the bytestring to hexadecimal notation

2466

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

2467

return hex_key_id

2468

1844

2469

1845

@staticmethod

2470

1846

def fingerprint(openpgp):

2471

1847

"Convert an OpenPGP bytestring to a hexdigit fingerprint"

2472

1848

# New GnuTLS "datum" with the OpenPGP public key

2473

datum = gnutls.datum_t(

2474

ctypes.cast(ctypes.c_char_p(openpgp),

2475

ctypes.POINTER(ctypes.c_ubyte)),

2476

ctypes.c_uint(len(openpgp)))

1849

datum = (gnutls.library.types

1850

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

1851

ctypes.POINTER

1852

(ctypes.c_ubyte)),

1853

ctypes.c_uint(len(openpgp))))

2477

1854

# New empty GnuTLS certificate

2478

crt = gnutls.openpgp_crt_t()

2479

gnutls.openpgp_crt_init(ctypes.byref(crt))

1855

crt = gnutls.library.types.gnutls_openpgp_crt_t()

1856

(gnutls.library.functions

1857

.gnutls_openpgp_crt_init(ctypes.byref(crt)))

2480

1858

# Import the OpenPGP public key into the certificate

2481

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

2482

gnutls.OPENPGP_FMT_RAW)

1859

(gnutls.library.functions

1860

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

1861

gnutls.library.constants

1862

.GNUTLS_OPENPGP_FMT_RAW))

2483

1863

# Verify the self signature in the key

2484

1864

crtverify = ctypes.c_uint()

2485

gnutls.openpgp_crt_verify_self(crt, 0,

2486

ctypes.byref(crtverify))

1865

(gnutls.library.functions

1866

.gnutls_openpgp_crt_verify_self(crt, 0,

1867

ctypes.byref(crtverify)))

2487

1868

if crtverify.value != 0:

2488

gnutls.openpgp_crt_deinit(crt)

2489

raise gnutls.CertificateSecurityError(code

2490

=crtverify.value)

1869

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

1870

raise (gnutls.errors.CertificateSecurityError

1871

("Verify failed"))

2491

1872

# New buffer for the fingerprint

2492

1873

buf = ctypes.create_string_buffer(20)

2493

1874

buf_len = ctypes.c_size_t()

2494

1875

# Get the fingerprint from the certificate into the buffer

2495

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

2496

ctypes.byref(buf_len))

1876

(gnutls.library.functions

1877

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

1878

ctypes.byref(buf_len)))

2497

1879

# Deinit the certificate

2498

gnutls.openpgp_crt_deinit(crt)

1880

gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)

2499

1881

# Convert the buffer to a Python bytestring

2500

1882

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

2501

1883

# Convert the bytestring to hexadecimal notation

2503

1885

return hex_fpr

2504

1886

2505

1887

2506

class MultiprocessingMixIn:

1888

class MultiprocessingMixIn(object):

2507

1889

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

2508

2509

1890

def sub_process_main(self, request, address):

2510

1891

try:

2511

1892

self.finish_request(request, address)

2512

1893

except Exception:

2513

1894

self.handle_error(request, address)

2514

1895

self.close_request(request)

2515

1896

2516

1897

def process_request(self, request, address):

2517

1898

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

2518

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

2519

args=(request, address))

1899

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

1900

args = (request, address))

2520

1901

proc.start()

2521

1902

return proc

2522

1903

2523

1904

2524

class MultiprocessingMixInWithPipe(MultiprocessingMixIn):

1905

class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):

2525

1906

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

2526

2527

1907

def process_request(self, request, client_address):

2528

1908

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

2529

1909

2530

1910

This function creates a new pipe in self.pipe

2531

1911

"""

2532

1912

parent_pipe, self.child_pipe = multiprocessing.Pipe()

2533

1913

2534

1914

proc = MultiprocessingMixIn.process_request(self, request,

2535

1915

client_address)

2536

1916

self.child_pipe.close()

2537

1917

self.add_pipe(parent_pipe, proc)

2538

1918

2539

1919

def add_pipe(self, parent_pipe, proc):

2540

1920

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

2541

1921

raise NotImplementedError()

2542

1922

2543

1923

2544

1924

class IPv6_TCPServer(MultiprocessingMixInWithPipe,

2545

socketserver.TCPServer):

1925

socketserver.TCPServer, object):

2546

1926

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

2547

1927

2548

1928

Attributes:

2549

1929

enabled: Boolean; whether this server is activated yet

2550

1930

interface: None or a network interface name (string)

2551

1931

use_ipv6: Boolean; to use IPv6 or not

2552

1932

"""

2553

2554

1933

def __init__(self, server_address, RequestHandlerClass,

2555

interface=None,

2556

use_ipv6=True,

2557

socketfd=None):

1934

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

2558

1935

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

2559

1936

creating a new one with socket.socket().

2560

1937

"""

2566

1943

self.socketfd = socketfd

2567

1944

# Save the original socket.socket() function

2568

1945

self.socket_socket = socket.socket

2569

2570

1946

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

2571

#

1947

#

2572

1948

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

2573

1949

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

2574

1950

# patching socket.socket.)

2575

#

1951

#

2576

1952

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

2577

1953

@functools.wraps(socket.socket)

2578

1954

def socket_wrapper(*args, **kwargs):

2590

1966

# socket_wrapper(), if socketfd was set.

2591

1967

socketserver.TCPServer.__init__(self, server_address,

2592

1968

RequestHandlerClass)

2593

1969

2594

1970

def server_bind(self):

2595

1971

"""This overrides the normal server_bind() function

2596

1972

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

2597

1973

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

2598

global SO_BINDTODEVICE

2599

1974

if self.interface is not None:

2600

1975

if SO_BINDTODEVICE is None:

2601

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

2602

# common enough.

2603

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

2604

SO_BINDTODEVICE = 25

2605

try:

2606

self.socket.setsockopt(

2607

socket.SOL_SOCKET, SO_BINDTODEVICE,

2608

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

2609

except socket.error as error:

2610

if error.errno == errno.EPERM:

2611

logger.error("No permission to bind to"

2612

" interface %s", self.interface)

2613

elif error.errno == errno.ENOPROTOOPT:

2614

logger.error("SO_BINDTODEVICE not available;"

2615

" cannot bind to interface %s",

2616

self.interface)

2617

elif error.errno == errno.ENODEV:

2618

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

2619

" cannot bind", self.interface)

2620

else:

2621

raise

1976

logger.error("SO_BINDTODEVICE does not exist;"

1977

" cannot bind to interface %s",

1978

self.interface)

1979

else:

1980

try:

1981

self.socket.setsockopt(socket.SOL_SOCKET,

1982

SO_BINDTODEVICE,

1983

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

1984

except socket.error as error:

1985

if error.errno == errno.EPERM:

1986

logger.error("No permission to bind to"

1987

" interface %s", self.interface)

1988

elif error.errno == errno.ENOPROTOOPT:

1989

logger.error("SO_BINDTODEVICE not available;"

1990

" cannot bind to interface %s",

1991

self.interface)

1992

elif error.errno == errno.ENODEV:

1993

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

1994

" cannot bind", self.interface)

1995

else:

1996

raise

2622

1997

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

2623

1998

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

2624

if self.server_address[1]:

2625

self.allow_reuse_address = True

2626

1999

if not self.server_address[0]:

2627

2000

if self.address_family == socket.AF_INET6:

2628

any_address = "::" # in6addr_any

2001

any_address = "::" # in6addr_any

2629

2002

else:

2630

any_address = "0.0.0.0" # INADDR_ANY

2003

any_address = "0.0.0.0" # INADDR_ANY

2631

2004

self.server_address = (any_address,

2632

2005

self.server_address[1])

2633

2006

elif not self.server_address[1]:

2634

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

2007

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

2008

0)

2635

2009

# if self.interface:

2636

2010

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

2637

2011

# 0, # port

2643

2017

2644

2018

class MandosServer(IPv6_TCPServer):

2645

2019

"""Mandos server.

2646

2020

2647

2021

Attributes:

2648

2022

clients: set of Client objects

2649

2023

gnutls_priority GnuTLS priority string

2650

2024

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

2651

2652

Assumes a GLib.MainLoop event loop.

2025

2026

Assumes a gobject.MainLoop event loop.

2653

2027

"""

2654

2655

2028

def __init__(self, server_address, RequestHandlerClass,

2656

interface=None,

2657

use_ipv6=True,

2658

clients=None,

2659

gnutls_priority=None,

2660

use_dbus=True,

2661

socketfd=None):

2029

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

2030

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

2662

2031

self.enabled = False

2663

2032

self.clients = clients

2664

2033

if self.clients is None:

2667

2036

self.gnutls_priority = gnutls_priority

2668

2037

IPv6_TCPServer.__init__(self, server_address,

2669

2038

RequestHandlerClass,

2670

interface=interface,

2671

use_ipv6=use_ipv6,

2672

socketfd=socketfd)

2673

2039

interface = interface,

2040

use_ipv6 = use_ipv6,

2041

socketfd = socketfd)

2674

2042

def server_activate(self):

2675

2043

if self.enabled:

2676

2044

return socketserver.TCPServer.server_activate(self)

2677

2045

2678

2046

def enable(self):

2679

2047

self.enabled = True

2680

2048

2681

2049

def add_pipe(self, parent_pipe, proc):

2682

2050

# Call "handle_ipc" for both data and EOF events

2683

GLib.io_add_watch(

2684

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

2685

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

2686

functools.partial(self.handle_ipc,

2687

parent_pipe=parent_pipe,

2688

proc=proc))

2689

2690

def handle_ipc(self, source, condition,

2691

parent_pipe=None,

2692

proc=None,

2693

client_object=None):

2051

gobject.io_add_watch(parent_pipe.fileno(),

2052

gobject.IO_IN | gobject.IO_HUP,

2053

functools.partial(self.handle_ipc,

2054

parent_pipe =

2055

parent_pipe,

2056

proc = proc))

2057

2058

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

2059

proc = None, client_object=None):

2694

2060

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

2695

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

2061

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

2696

2062

# Wait for other process to exit

2697

2063

proc.join()

2698

2064

return False

2699

2065

2700

2066

# Read a request from the child

2701

2067

request = parent_pipe.recv()

2702

2068

command = request[0]

2703

2069

2704

2070

if command == 'init':

2705

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

2706

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

2707

address = request[3]

2708

2709

for c in self.clients.values():

2710

if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":

2711

continue

2712

if key_id and c.key_id == key_id:

2713

client = c

2714

break

2715

if fpr and c.fingerprint == fpr:

2071

fpr = request[1]

2072

address = request[2]

2073

2074

for c in self.clients.itervalues():

2075

if c.fingerprint == fpr:

2716

2076

client = c

2717

2077

break

2718

2078

else:

2719

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

2720

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

2079

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

2080

"dress: %s", fpr, address)

2721

2081

if self.use_dbus:

2722

2082

# Emit D-Bus signal

2723

mandos_dbus_service.ClientNotFound(key_id or fpr,

2083

mandos_dbus_service.ClientNotFound(fpr,

2724

2084

address[0])

2725

2085

parent_pipe.send(False)

2726

2086

return False

2727

2728

GLib.io_add_watch(

2729

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

2730

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

2731

functools.partial(self.handle_ipc,

2732

parent_pipe=parent_pipe,

2733

proc=proc,

2734

client_object=client))

2087

2088

gobject.io_add_watch(parent_pipe.fileno(),

2089

gobject.IO_IN | gobject.IO_HUP,

2090

functools.partial(self.handle_ipc,

2091

parent_pipe =

2092

parent_pipe,

2093

proc = proc,

2094

client_object =

2095

client))

2735

2096

parent_pipe.send(True)

2736

2097

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

2737

2098

# same fileno

2740

2101

funcname = request[1]

2741

2102

args = request[2]

2742

2103

kwargs = request[3]

2743

2104

2744

2105

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

2745

2106

funcname)(*args,

2746

**kwargs)))

2747

2107

**kwargs)))

2108

2748

2109

if command == 'getattr':

2749

2110

attrname = request[1]

2750

if isinstance(client_object.__getattribute__(attrname),

2751

collections.Callable):

2752

parent_pipe.send(('function', ))

2111

if callable(client_object.__getattribute__(attrname)):

2112

parent_pipe.send(('function',))

2753

2113

else:

2754

parent_pipe.send((

2755

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

2756

2114

parent_pipe.send(('data', client_object

2115

.__getattribute__(attrname)))

2116

2757

2117

if command == 'setattr':

2758

2118

attrname = request[1]

2759

2119

value = request[2]

2760

2120

setattr(client_object, attrname, value)

2761

2121

2762

2122

return True

2763

2123

2764

2124

2765

2125

def rfc3339_duration_to_delta(duration):

2766

2126

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

2767

2768

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

2769

True

2770

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

2771

True

2772

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

2773

True

2774

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

2775

True

2776

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

2777

True

2778

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

2779

True

2780

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

2781

True

2127

2128

>>> rfc3339_duration_to_delta("P7D")

2129

datetime.timedelta(7)

2130

>>> rfc3339_duration_to_delta("PT60S")

2131

datetime.timedelta(0, 60)

2132

>>> rfc3339_duration_to_delta("PT60M")

2133

datetime.timedelta(0, 3600)

2134

>>> rfc3339_duration_to_delta("PT24H")

2135

datetime.timedelta(1)

2136

>>> rfc3339_duration_to_delta("P1W")

2137

datetime.timedelta(7)

2138

>>> rfc3339_duration_to_delta("PT5M30S")

2139

datetime.timedelta(0, 330)

2140

>>> rfc3339_duration_to_delta("P1DT3M20S")

2141

datetime.timedelta(1, 200)

2782

2142

"""

2783

2143

2784

2144

# Parsing an RFC 3339 duration with regular expressions is not

2785

2145

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

2786

2146

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

2787

2147

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

2788

2148

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

2789

2149

# avoid excessive use of external libraries.

2790

2150

2791

2151

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

2792

Token = collections.namedtuple("Token", (

2793

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

2794

# a "group" containing digits

2795

"value", # datetime.timedelta or None

2796

"followers")) # Tokens valid after this token

2152

Token = collections.namedtuple("Token",

2153

("regexp", # To match token; if

2154

# "value" is not None,

2155

# must have a "group"

2156

# containing digits

2157

"value", # datetime.timedelta or

2158

# None

2159

"followers")) # Tokens valid after

2160

# this token

2797

2161

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

2798

2162

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

2799

2163

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

2800

2164

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

2801

2165

datetime.timedelta(seconds=1),

2802

frozenset((token_end, )))

2166

frozenset((token_end,)))

2803

2167

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

2804

2168

datetime.timedelta(minutes=1),

2805

2169

frozenset((token_second, token_end)))

2821

2185

frozenset((token_month, token_end)))

2822

2186

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

2823

2187

datetime.timedelta(weeks=1),

2824

frozenset((token_end, )))

2188

frozenset((token_end,)))

2825

2189

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

2826

2190

frozenset((token_year, token_month,

2827

2191

token_day, token_time,

2828

token_week)))

2829

# Define starting values:

2830

# Value so far

2831

value = datetime.timedelta()

2192

token_week))),

2193

# Define starting values

2194

value = datetime.timedelta() # Value so far

2832

2195

found_token = None

2833

# Following valid tokens

2834

followers = frozenset((token_duration, ))

2835

# String left to parse

2836

s = duration

2196

followers = frozenset(token_duration,) # Following valid tokens

2197

s = duration # String left to parse

2837

2198

# Loop until end token is found

2838

2199

while found_token is not token_end:

2839

2200

# Search for any currently valid tokens

2855

2216

break

2856

2217

else:

2857

2218

# No currently valid tokens were found

2858

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

2859

.format(duration))

2219

raise ValueError("Invalid RFC 3339 duration")

2860

2220

# End token found

2861

2221

return value

2862

2222

2863

2223

2864

2224

def string_to_delta(interval):

2865

2225

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

2866

2867

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

2868

True

2869

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

2870

True

2871

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

2872

True

2873

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

2874

True

2875

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

2876

True

2877

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

2878

True

2226

2227

>>> string_to_delta('7d')

2228

datetime.timedelta(7)

2229

>>> string_to_delta('60s')

2230

datetime.timedelta(0, 60)

2231

>>> string_to_delta('60m')

2232

datetime.timedelta(0, 3600)

2233

>>> string_to_delta('24h')

2234

datetime.timedelta(1)

2235

>>> string_to_delta('1w')

2236

datetime.timedelta(7)

2237

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

2238

datetime.timedelta(0, 330)

2879

2239

"""

2880

2240

2881

2241

try:

2882

2242

return rfc3339_duration_to_delta(interval)

2883

2243

except ValueError:

2884

2244

pass

2885

2245

2886

2246

timevalue = datetime.timedelta(0)

2887

2247

for s in interval.split():

2888

2248

try:

2889

suffix = s[-1]

2249

suffix = unicode(s[-1])

2890

2250

value = int(s[:-1])

2891

2251

if suffix == "d":

2892

2252

delta = datetime.timedelta(value)

2899

2259

elif suffix == "w":

2900

2260

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

2901

2261

else:

2902

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

2262

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

2263

.format(suffix))

2903

2264

except IndexError as e:

2904

2265

raise ValueError(*(e.args))

2905

2266

timevalue += delta

2906

2267

return timevalue

2907

2268

2908

2269

2909

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

2270

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

2910

2271

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

2911

2272

2912

2273

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

2913

2274

if os.fork():

2914

2275

sys.exit()

2922

2283

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

2923

2284

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

2924

2285

raise OSError(errno.ENODEV,

2925

"{} not a character device"

2286

"{0} not a character device"

2926

2287

.format(os.devnull))

2927

2288

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

2928

2289

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

2932

2293

2933

2294

2934

2295

def main():

2935

2296

2936

2297

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

2937

2298

# Parsing of options, both command line and config file

2938

2299

2939

2300

parser = argparse.ArgumentParser()

2940

2301

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

2941

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

2302

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

2942

2303

help="show version number and exit")

2943

2304

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

2944

2305

help="Bind to interface IF")

2977

2338

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

2978

2339

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

2979

2340

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

2980

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

2981

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

2982

default=None)

2983

2341

2984

2342

options = parser.parse_args()

2985

2343

2344

if options.check:

2345

import doctest

2346

fail_count, test_count = doctest.testmod()

2347

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

2348

2986

2349

# Default values for config file for server-global settings

2987

if gnutls.has_rawpk:

2988

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

2989

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

2990

else:

2991

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

2992

":+SIGN-DSA-SHA256")

2993

server_defaults = {"interface": "",

2994

"address": "",

2995

"port": "",

2996

"debug": "False",

2997

"priority": priority,

2998

"servicename": "Mandos",

2999

"use_dbus": "True",

3000

"use_ipv6": "True",

3001

"debuglevel": "",

3002

"restore": "True",

3003

"socket": "",

3004

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

3005

"foreground": "False",

3006

"zeroconf": "True",

3007

}

3008

del priority

3009

2350

server_defaults = { "interface": "",

2351

"address": "",

2352

"port": "",

2353

"debug": "False",

2354

"priority":

2355

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

2356

"servicename": "Mandos",

2357

"use_dbus": "True",

2358

"use_ipv6": "True",

2359

"debuglevel": "",

2360

"restore": "True",

2361

"socket": "",

2362

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

2363

"foreground": "False",

2364

}

2365

3010

2366

# Parse config file for server-global settings

3011

server_config = configparser.ConfigParser(server_defaults)

2367

server_config = configparser.SafeConfigParser(server_defaults)

3012

2368

del server_defaults

3013

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

3014

# Convert the ConfigParser object to a dict

2369

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

2370

"mandos.conf"))

2371

# Convert the SafeConfigParser object to a dict

3015

2372

server_settings = server_config.defaults()

3016

2373

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

3017

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

3018

"foreground", "zeroconf"):

2374

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

3019

2375

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

3020

2376

option)

3021

2377

if server_settings["port"]:

3031

2387

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

3032

2388

["socket"])

3033

2389

del server_config

3034

2390

3035

2391

# Override the settings from the config file with command line

3036

2392

# options, if set.

3037

2393

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

3038

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

3039

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

3040

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

2394

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

2395

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

2396

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

3041

2397

value = getattr(options, option)

3042

2398

if value is not None:

3043

2399

server_settings[option] = value

3044

2400

del options

3045

2401

# Force all strings to be unicode

3046

2402

for option in server_settings.keys():

3047

if isinstance(server_settings[option], bytes):

3048

server_settings[option] = (server_settings[option]

3049

.decode("utf-8"))

2403

if type(server_settings[option]) is str:

2404

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

3050

2405

# Force all boolean options to be boolean

3051

2406

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

3052

"foreground", "zeroconf"):

2407

"foreground"):

3053

2408

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

3054

2409

# Debug implies foreground

3055

2410

if server_settings["debug"]:

3056

2411

server_settings["foreground"] = True

3057

2412

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

3058

2413

3059

2414

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

3060

3061

if (not server_settings["zeroconf"]

3062

and not (server_settings["port"]

3063

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

3064

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

3065

2415

3066

2416

# For convenience

3067

2417

debug = server_settings["debug"]

3068

2418

debuglevel = server_settings["debuglevel"]

3071

2421

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

3072

2422

stored_state_file)

3073

2423

foreground = server_settings["foreground"]

3074

zeroconf = server_settings["zeroconf"]

3075

2424

3076

2425

if debug:

3077

2426

initlogger(debug, logging.DEBUG)

3078

2427

else:

3081

2430

else:

3082

2431

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

3083

2432

initlogger(debug, level)

3084

2433

3085

2434

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

3086

syslogger.setFormatter(

3087

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

3088

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

3089

server_settings["servicename"])))

3090

2435

syslogger.setFormatter(logging.Formatter

2436

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

2437

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

2438

.format(server_settings

2439

["servicename"])))

2440

3091

2441

# Parse config file with clients

3092

client_config = configparser.ConfigParser(Client.client_defaults)

2442

client_config = configparser.SafeConfigParser(Client

2443

.client_defaults)

3093

2444

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

3094

2445

"clients.conf"))

3095

2446

3096

2447

global mandos_dbus_service

3097

2448

mandos_dbus_service = None

3098

3099

socketfd = None

3100

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

3101

socketfd = server_settings["socket"]

3102

tcp_server = MandosServer(

3103

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

3104

ClientHandler,

3105

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

3106

use_ipv6=use_ipv6,

3107

gnutls_priority=server_settings["priority"],

3108

use_dbus=use_dbus,

3109

socketfd=socketfd)

2449

2450

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

2451

server_settings["port"]),

2452

ClientHandler,

2453

interface=(server_settings["interface"]

2454

or None),

2455

use_ipv6=use_ipv6,

2456

gnutls_priority=

2457

server_settings["priority"],

2458

use_dbus=use_dbus,

2459

socketfd=(server_settings["socket"]

2460

or None))

3110

2461

if not foreground:

3111

2462

pidfilename = "/run/mandos.pid"

3112

2463

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

3113

2464

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

3114

2465

pidfile = None

3115

2466

try:

3116

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

2467

pidfile = open(pidfilename, "w")

3117

2468

except IOError as e:

3118

2469

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

3119

2470

exc_info=e)

3120

3121

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

3122

("mandos", "mandos"),

3123

("nobody", "nogroup")):

2471

2472

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

3124

2473

try:

3125

2474

uid = pwd.getpwnam(name).pw_uid

3126

gid = pwd.getpwnam(group).pw_gid

2475

gid = pwd.getpwnam(name).pw_gid

3127

2476

break

3128

2477

except KeyError:

3129

2478

continue

3133

2482

try:

3134

2483

os.setgid(gid)

3135

2484

os.setuid(uid)

3136

if debug:

3137

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

3138

gid))

3139

2485

except OSError as error:

3140

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

3141

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

3142

2486

if error.errno != errno.EPERM:

3143

2487

raise

3144

2488

3145

2489

if debug:

3146

2490

# Enable all possible GnuTLS debugging

3147

2491

3148

2492

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

3149

2493

# - GnuTLS manual

3150

gnutls.global_set_log_level(11)

3151

3152

@gnutls.log_func

2494

gnutls.library.functions.gnutls_global_set_log_level(11)

2495

2496

@gnutls.library.types.gnutls_log_func

3153

2497

def debug_gnutls(level, string):

3154

2498

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

3155

3156

gnutls.global_set_log_function(debug_gnutls)

3157

2499

2500

(gnutls.library.functions

2501

.gnutls_global_set_log_function(debug_gnutls))

2502

3158

2503

# Redirect stdin so all checkers get /dev/null

3159

2504

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

3160

2505

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

3161

2506

if null > 2:

3162

2507

os.close(null)

3163

2508

3164

2509

# Need to fork before connecting to D-Bus

3165

2510

if not foreground:

3166

2511

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

3167

2512

daemon()

3168

3169

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

3170

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

3171

# need to inform GLib that threads will be used.

3172

GLib.threads_init()

3173

2513

2514

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

2515

# need to inform gobject that threads will be used.

2516

gobject.threads_init()

2517

3174

2518

global main_loop

3175

2519

# From the Avahi example code

3176

2520

DBusGMainLoop(set_as_default=True)

3177

main_loop = GLib.MainLoop()

2521

main_loop = gobject.MainLoop()

3178

2522

bus = dbus.SystemBus()

3179

2523

# End of Avahi example code

3180

2524

if use_dbus:

3181

2525

try:

3182

2526

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

3183

bus,

3184

do_not_queue=True)

3185

old_bus_name = dbus.service.BusName(

3186

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

3187

do_not_queue=True)

3188

except dbus.exceptions.DBusException as e:

2527

bus, do_not_queue=True)

2528

old_bus_name = (dbus.service.BusName

2529

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

2530

do_not_queue=True))

2531

except dbus.exceptions.NameExistsException as e:

3189

2532

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

3190

2533

use_dbus = False

3191

2534

server_settings["use_dbus"] = False

3192

2535

tcp_server.use_dbus = False

3193

if zeroconf:

3194

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

3195

service = AvahiServiceToSyslog(

3196

name=server_settings["servicename"],

3197

servicetype="_mandos._tcp",

3198

protocol=protocol,

3199

bus=bus)

3200

if server_settings["interface"]:

3201

service.interface = if_nametoindex(

3202

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

3203

2536

protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET

2537

service = AvahiServiceToSyslog(name =

2538

server_settings["servicename"],

2539

servicetype = "_mandos._tcp",

2540

protocol = protocol, bus = bus)

2541

if server_settings["interface"]:

2542

service.interface = (if_nametoindex

2543

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

2544

3204

2545

global multiprocessing_manager

3205

2546

multiprocessing_manager = multiprocessing.Manager()

3206

2547

3207

2548

client_class = Client

3208

2549

if use_dbus:

3209

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

3210

2550

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

2551

3211

2552

client_settings = Client.config_parser(client_config)

3212

2553

old_client_settings = {}

3213

2554

clients_data = {}

3214

2555

3215

2556

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

3216

2557

global wnull

3217

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

2558

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

3218

2559

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

3219

2560

# mode

3220

2561

if debug or not foreground:

3221

2562

wnull.close()

3222

2563

3223

2564

# Get client data and settings from last running state.

3224

2565

if server_settings["restore"]:

3225

2566

try:

3226

2567

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

3227

if sys.version_info.major == 2:

3228

clients_data, old_client_settings = pickle.load(

3229

stored_state)

3230

else:

3231

bytes_clients_data, bytes_old_client_settings = (

3232

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

3233

# Fix bytes to strings

3234

# clients_data

3235

# .keys()

3236

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

3237

if isinstance(key, bytes)

3238

else key): value

3239

for key, value in

3240

bytes_clients_data.items()}

3241

del bytes_clients_data

3242

for key in clients_data:

3243

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

3244

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

3245

for k, v in

3246

clients_data[key].items()}

3247

clients_data[key] = value

3248

# .client_structure

3249

value["client_structure"] = [

3250

(s.decode("utf-8")

3251

if isinstance(s, bytes)

3252

else s) for s in

3253

value["client_structure"]]

3254

# .name, .host, and .checker_command

3255

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

3256

if isinstance(value[k], bytes):

3257

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

3258

if "key_id" not in value:

3259

value["key_id"] = ""

3260

elif "fingerprint" not in value:

3261

value["fingerprint"] = ""

3262

# old_client_settings

3263

# .keys()

3264

old_client_settings = {

3265

(key.decode("utf-8")

3266

if isinstance(key, bytes)

3267

else key): value

3268

for key, value in

3269

bytes_old_client_settings.items()}

3270

del bytes_old_client_settings

3271

# .host and .checker_command

3272

for value in old_client_settings.values():

3273

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

3274

if isinstance(value[attribute], bytes):

3275

value[attribute] = (value[attribute]

3276

.decode("utf-8"))

2568

clients_data, old_client_settings = (pickle.load

2569

(stored_state))

3277

2570

os.remove(stored_state_path)

3278

2571

except IOError as e:

3279

2572

if e.errno == errno.ENOENT:

3280

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

3281

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

2573

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

2574

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

3282

2575

else:

3283

2576

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

3284

2577

exc_info=e)

3285

2578

raise

3286

2579

except EOFError as e:

3287

2580

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

3288

"EOFError:",

3289

exc_info=e)

3290

2581

"EOFError:", exc_info=e)

2582

3291

2583

with PGPEngine() as pgp:

3292

for client_name, client in clients_data.items():

2584

for client_name, client in clients_data.iteritems():

3293

2585

# Skip removed clients

3294

2586

if client_name not in client_settings:

3295

2587

continue

3296

2588

3297

2589

# Decide which value to use after restoring saved state.

3298

2590

# We have three different values: Old config file,

3299

2591

# new config file, and saved state.

3304

2596

# For each value in new config, check if it

3305

2597

# differs from the old config value (Except for

3306

2598

# the "secret" attribute)

3307

if (name != "secret"

3308

and (value !=

3309

old_client_settings[client_name][name])):

2599

if (name != "secret" and

2600

value != old_client_settings[client_name]

2601

[name]):

3310

2602

client[name] = value

3311

2603

except KeyError:

3312

2604

pass

3313

2605

3314

2606

# Clients who has passed its expire date can still be

3315

# enabled if its last checker was successful. A Client

2607

# enabled if its last checker was successful. Clients

3316

2608

# whose checker succeeded before we stored its state is

3317

2609

# assumed to have successfully run all checkers during

3318

2610

# downtime.

3320

2612

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

3321

2613

if not client["last_checked_ok"]:

3322

2614

logger.warning(

3323

"disabling client {} - Client never "

3324

"performed a successful checker".format(

3325

client_name))

2615

"disabling client {0} - Client never "

2616

"performed a successful checker"

2617

.format(client_name))

3326

2618

client["enabled"] = False

3327

2619

elif client["last_checker_status"] != 0:

3328

2620

logger.warning(

3329

"disabling client {} - Client last"

3330

" checker failed with error code"

3331

" {}".format(

3332

client_name,

3333

client["last_checker_status"]))

2621

"disabling client {0} - Client "

2622

"last checker failed with error code {1}"

2623

.format(client_name,

2624

client["last_checker_status"]))

3334

2625

client["enabled"] = False

3335

2626

else:

3336

client["expires"] = (

3337

datetime.datetime.utcnow()

3338

+ client["timeout"])

2627

client["expires"] = (datetime.datetime

2628

.utcnow()

2629

+ client["timeout"])

3339

2630

logger.debug("Last checker succeeded,"

3340

" keeping {} enabled".format(

3341

client_name))

2631

" keeping {0} enabled"

2632

.format(client_name))

3342

2633

try:

3343

client["secret"] = pgp.decrypt(

3344

client["encrypted_secret"],

3345

client_settings[client_name]["secret"])

2634

client["secret"] = (

2635

pgp.decrypt(client["encrypted_secret"],

2636

client_settings[client_name]

2637

["secret"]))

3346

2638

except PGPError:

3347

2639

# If decryption fails, we use secret from new settings

3348

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

3349

client_name))

3350

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

3351

["secret"])

3352

2640

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

2641

.format(client_name))

2642

client["secret"] = (

2643

client_settings[client_name]["secret"])

2644

3353

2645

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

3354

2646

for client_name in (set(old_client_settings)

3355

2647

- set(client_settings)):

3357

2649

for client_name in (set(client_settings)

3358

2650

- set(old_client_settings)):

3359

2651

clients_data[client_name] = client_settings[client_name]

3360

2652

3361

2653

# Create all client objects

3362

for client_name, client in clients_data.items():

2654

for client_name, client in clients_data.iteritems():

3363

2655

tcp_server.clients[client_name] = client_class(

3364

name=client_name,

3365

settings=client,

3366

server_settings=server_settings)

3367

2656

name = client_name, settings = client,

2657

server_settings = server_settings)

2658

3368

2659

if not tcp_server.clients:

3369

2660

logger.warning("No clients defined")

3370

2661

3371

2662

if not foreground:

3372

2663

if pidfile is not None:

3373

pid = os.getpid()

3374

2664

try:

3375

2665

with pidfile:

3376

print(pid, file=pidfile)

2666

pid = os.getpid()

2667

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

3377

2668

except IOError:

3378

2669

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

3379

2670

pidfilename, pid)

3380

2671

del pidfile

3381

2672

del pidfilename

3382

3383

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

3384

GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,

3385

lambda: main_loop.quit() and False)

3386

2673

2674

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

2675

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

2676

3387

2677

if use_dbus:

3388

3389

@alternate_dbus_interfaces(

3390

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

3391

class MandosDBusService(DBusObjectWithObjectManager):

2678

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

2679

"se.bsnet.fukt.Mandos"})

2680

class MandosDBusService(DBusObjectWithProperties):

3392

2681

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

3393

3394

2682

def __init__(self):

3395

2683

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

3396

3397

2684

_interface = "se.recompile.Mandos"

3398

2685

2686

@dbus_interface_annotations(_interface)

2687

def _foo(self):

2688

return { "org.freedesktop.DBus.Property"

2689

".EmitsChangedSignal":

2690

"false"}

2691

3399

2692

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

3400

2693

def ClientAdded(self, objpath):

3401

2694

"D-Bus signal"

3402

2695

pass

3403

2696

3404

2697

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

3405

def ClientNotFound(self, key_id, address):

2698

def ClientNotFound(self, fingerprint, address):

3406

2699

"D-Bus signal"

3407

2700

pass

3408

3409

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

3410

"true"})

2701

3411

2702

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

3412

2703

def ClientRemoved(self, objpath, name):

3413

2704

"D-Bus signal"

3414

2705

pass

3415

3416

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

3417

"true"})

2706

3418

2707

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

3419

2708

def GetAllClients(self):

3420

2709

"D-Bus method"

3421

return dbus.Array(c.dbus_object_path for c in

3422

tcp_server.clients.values())

3423

3424

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

3425

"true"})

2710

return dbus.Array(c.dbus_object_path

2711

for c in

2712

tcp_server.clients.itervalues())

2713

3426

2714

@dbus.service.method(_interface,

3427

2715

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

3428

2716

def GetAllClientsWithProperties(self):

3429

2717

"D-Bus method"

3430

2718

return dbus.Dictionary(

3431

{c.dbus_object_path: c.GetAll(

3432

"se.recompile.Mandos.Client")

3433

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

2719

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

2720

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

3434

2721

signature="oa{sv}")

3435

2722

3436

2723

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

3437

2724

def RemoveClient(self, object_path):

3438

2725

"D-Bus method"

3439

for c in tcp_server.clients.values():

2726

for c in tcp_server.clients.itervalues():

3440

2727

if c.dbus_object_path == object_path:

3441

2728

del tcp_server.clients[c.name]

3442

2729

c.remove_from_connection()

3443

# Don't signal the disabling

2730

# Don't signal anything except ClientRemoved

3444

2731

c.disable(quiet=True)

3445

# Emit D-Bus signal for removal

3446

self.client_removed_signal(c)

2732

# Emit D-Bus signal

2733

self.ClientRemoved(object_path, c.name)

3447

2734

return

3448

2735

raise KeyError(object_path)

3449

2736

3450

2737

del _interface

3451

3452

@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,

3453

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

3454

def GetManagedObjects(self):

3455

"""D-Bus method"""

3456

return dbus.Dictionary(

3457

{client.dbus_object_path:

3458

dbus.Dictionary(

3459

{interface: client.GetAll(interface)

3460

for interface in

3461

client._get_all_interface_names()})

3462

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

3463

3464

def client_added_signal(self, client):

3465

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

3466

if use_dbus:

3467

# New standard signal

3468

self.InterfacesAdded(

3469

client.dbus_object_path,

3470

dbus.Dictionary(

3471

{interface: client.GetAll(interface)

3472

for interface in

3473

client._get_all_interface_names()}))

3474

# Old signal

3475

self.ClientAdded(client.dbus_object_path)

3476

3477

def client_removed_signal(self, client):

3478

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

3479

if use_dbus:

3480

# New standard signal

3481

self.InterfacesRemoved(

3482

client.dbus_object_path,

3483

client._get_all_interface_names())

3484

# Old signal

3485

self.ClientRemoved(client.dbus_object_path,

3486

client.name)

3487

2738

3488

2739

mandos_dbus_service = MandosDBusService()

3489

3490

# Save modules to variables to exempt the modules from being

3491

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

3492

mp = multiprocessing

3493

wn = wnull

3494

2740

3495

2741

def cleanup():

3496

2742

"Cleanup function; run on exit"

3497

if zeroconf:

3498

service.cleanup()

3499

3500

mp.active_children()

3501

wn.close()

2743

service.cleanup()

2744

2745

multiprocessing.active_children()

2746

wnull.close()

3502

2747

if not (tcp_server.clients or client_settings):

3503

2748

return

3504

2749

3505

2750

# Store client before exiting. Secrets are encrypted with key

3506

2751

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

3507

2752

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

3508

2753

clients = {}

3509

2754

with PGPEngine() as pgp:

3510

for client in tcp_server.clients.values():

2755

for client in tcp_server.clients.itervalues():

3511

2756

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

3512

2757

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

3513

2758

key)

3514

2759

client_dict = {}

3515

2760

3516

2761

# A list of attributes that can not be pickled

3517

2762

# + secret.

3518

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

3519

"checker", "server_settings"}

3520

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

3521

.Object):

2763

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

2764

"checker", "server_settings"))

2765

for name, typ in (inspect.getmembers

2766

(dbus.service.Object)):

3522

2767

exclude.add(name)

3523

2768

3524

2769

client_dict["encrypted_secret"] = (client

3525

2770

.encrypted_secret)

3526

2771

for attr in client.client_structure:

3527

2772

if attr not in exclude:

3528

2773

client_dict[attr] = getattr(client, attr)

3529

2774

3530

2775

clients[client.name] = client_dict

3531

2776

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

3532

2777

3533

2778

try:

3534

with tempfile.NamedTemporaryFile(

3535

mode='wb',

3536

suffix=".pickle",

3537

prefix='clients-',

3538

dir=os.path.dirname(stored_state_path),

3539

delete=False) as stored_state:

3540

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

3541

protocol=2)

3542

tempname = stored_state.name

2779

with (tempfile.NamedTemporaryFile

2780

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

2781

dir=os.path.dirname(stored_state_path),

2782

delete=False)) as stored_state:

2783

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

2784

tempname=stored_state.name

3543

2785

os.rename(tempname, stored_state_path)

3544

2786

except (IOError, OSError) as e:

3545

2787

if not debug:

3548

2790

except NameError:

3549

2791

pass

3550

2792

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

3551

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

2793

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

3552

2794

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

3553

2795

else:

3554

2796

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

3555

2797

exc_info=e)

3556

2798

raise

3557

2799

3558

2800

# Delete all clients, and settings from config

3559

2801

while tcp_server.clients:

3560

2802

name, client = tcp_server.clients.popitem()

3561

2803

if use_dbus:

3562

2804

client.remove_from_connection()

3563

# Don't signal the disabling

2805

# Don't signal anything except ClientRemoved

3564

2806

client.disable(quiet=True)

3565

# Emit D-Bus signal for removal

3566

2807

if use_dbus:

3567

mandos_dbus_service.client_removed_signal(client)

2808

# Emit D-Bus signal

2809

mandos_dbus_service.ClientRemoved(client

2810

.dbus_object_path,

2811

client.name)

3568

2812

client_settings.clear()

3569

2813

3570

2814

atexit.register(cleanup)

3571

3572

for client in tcp_server.clients.values():

2815

2816

for client in tcp_server.clients.itervalues():

3573

2817

if use_dbus:

3574

# Emit D-Bus signal for adding

3575

mandos_dbus_service.client_added_signal(client)

2818

# Emit D-Bus signal

2819

mandos_dbus_service.ClientAdded(client.dbus_object_path)

3576

2820

# Need to initiate checking of clients

3577

2821

if client.enabled:

3578

2822

client.init_checker()

3579

2823

3580

2824

tcp_server.enable()

3581

2825

tcp_server.server_activate()

3582

2826

3583

2827

# Find out what port we got

3584

if zeroconf:

3585

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

2828

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

3586

2829

if use_ipv6:

3587

2830

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

3588

2831

" flowinfo %d, scope_id %d",

3590

2833

else: # IPv4

3591

2834

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

3592

2835

*tcp_server.socket.getsockname())

3593

3594

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

3595

2836

2837

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

2838

3596

2839

try:

3597

if zeroconf:

3598

# From the Avahi example code

3599

try:

3600

service.activate()

3601

except dbus.exceptions.DBusException as error:

3602

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

3603

cleanup()

3604

sys.exit(1)

3605

# End of Avahi example code

3606

3607

GLib.io_add_watch(

3608

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

3609

GLib.PRIORITY_DEFAULT, GLib.IO_IN,

3610

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

3611

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

3612

2840

# From the Avahi example code

2841

try:

2842

service.activate()

2843

except dbus.exceptions.DBusException as error:

2844

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

2845

cleanup()

2846

sys.exit(1)

2847

# End of Avahi example code

2848

2849

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

2850

lambda *args, **kwargs:

2851

(tcp_server.handle_request

2852

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

2853

3613

2854

logger.debug("Starting main loop")

3614

2855

main_loop.run()

3615

2856

except AvahiError as error:

3624

2865

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

3625

2866

cleanup()

3626

2867

3627

3628

def should_only_run_tests():

3629

parser = argparse.ArgumentParser(add_help=False)

3630

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

3631

args, unknown_args = parser.parse_known_args()

3632

run_tests = args.check

3633

if run_tests:

3634

# Remove --check argument from sys.argv

3635

sys.argv[1:] = unknown_args

3636

return run_tests

3637

3638

# Add all tests from doctest strings

3639

def load_tests(loader, tests, none):

3640

import doctest

3641

tests.addTests(doctest.DocTestSuite())

3642

return tests

3643

3644

2868

if __name__ == '__main__':

3645

try:

3646

if should_only_run_tests():

3647

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

3648

unittest.main()

3649

else:

3650

main()

3651

finally:

3652

logging.shutdown()

2869

main()